diff --git a/vmc-draas/_sources/index.rst.txt b/vmc-draas/_sources/index.rst.txt index 9ba9b8d8..cc5a66e3 100644 --- a/vmc-draas/_sources/index.rst.txt +++ b/vmc-draas/_sources/index.rst.txt @@ -1,5 +1,5 @@ .. draas documentation master file, created by - sphinx-quickstart on Fri Aug 20 05:24:53 2021. + sphinx-quickstart on Mon Sep 26 05:42:38 2022. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. diff --git a/vmc-draas/_static/documentation_options.js b/vmc-draas/_static/documentation_options.js index 3f220a6d..f6dd67cc 100644 --- a/vmc-draas/_static/documentation_options.js +++ b/vmc-draas/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '1.18.0', + VERSION: '1.20.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/vmc-draas/_static/pygments.css b/vmc-draas/_static/pygments.css index 582d5c3a..08bec689 100644 --- a/vmc-draas/_static/pygments.css +++ b/vmc-draas/_static/pygments.css @@ -5,22 +5,22 @@ td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5 span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } .highlight .hll { background-color: #ffffcc } .highlight { background: #f8f8f8; } -.highlight .c { color: #408080; font-style: italic } /* Comment */ +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ .highlight .err { border: 1px solid #FF0000 } /* Error */ .highlight .k { color: #008000; font-weight: bold } /* Keyword */ .highlight .o { color: #666666 } /* Operator */ -.highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */ -.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #BC7A00 } /* Comment.Preproc */ -.highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */ -.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ .highlight .gd { color: #A00000 } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ -.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gr { color: #E40000 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.highlight .gi { color: #00A000 } /* Generic.Inserted */ -.highlight .go { color: #888888 } /* Generic.Output */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ .highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ @@ -33,15 +33,15 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .highlight .kt { color: #B00040 } /* Keyword.Type */ .highlight .m { color: #666666 } /* Literal.Number */ .highlight .s { color: #BA2121 } /* Literal.String */ -.highlight .na { color: #7D9029 } /* Name.Attribute */ +.highlight .na { color: #687822 } /* Name.Attribute */ .highlight .nb { color: #008000 } /* Name.Builtin */ .highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ .highlight .no { color: #880000 } /* Name.Constant */ .highlight .nd { color: #AA22FF } /* Name.Decorator */ -.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */ -.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0000FF } /* Name.Function */ -.highlight .nl { color: #A0A000 } /* Name.Label */ +.highlight .nl { color: #767600 } /* Name.Label */ .highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ .highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #19177C } /* Name.Variable */ @@ -58,11 +58,11 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ .highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ .highlight .s2 { color: #BA2121 } /* Literal.String.Double */ -.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ .highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ -.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ .highlight .sx { color: #008000 } /* Literal.String.Other */ -.highlight .sr { color: #BB6688 } /* Literal.String.Regex */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ .highlight .s1 { color: #BA2121 } /* Literal.String.Single */ .highlight .ss { color: #19177C } /* Literal.String.Symbol */ .highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ diff --git a/vmc-draas/com.html b/vmc-draas/com.html index 774ab835..5203e0c4 100644 --- a/vmc-draas/com.html +++ b/vmc-draas/com.html @@ -7,7 +7,7 @@ - com package — draas 1.18.0 documentation + com package — draas 1.20.0 documentation @@ -63,7 +63,7 @@
- 1.18.0 + 1.20.0
@@ -177,13 +177,13 @@
  • Subpackages
  • Submodules
    • -
  • com.vmware.vmc.draas_client module
    • +
  • com.vmware.vmc.draas_client module
    • @@ -209,7 +209,7 @@

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..

    diff --git a/vmc-draas/com.vmware.html b/vmc-draas/com.vmware.html index 7eab145d..71648cb3 100644 --- a/vmc-draas/com.vmware.html +++ b/vmc-draas/com.vmware.html @@ -7,7 +7,7 @@ - com.vmware package — draas 1.18.0 documentation + com.vmware package — draas 1.20.0 documentation @@ -63,7 +63,7 @@
    - 1.18.0 + 1.20.0
    @@ -180,13 +180,13 @@
  • Subpackages
  • Submodules
    • -
  • com.vmware.vmc.draas_client module
    • +
  • com.vmware.vmc.draas_client module
    • @@ -208,7 +208,7 @@

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..

    diff --git a/vmc-draas/com.vmware.vmc.draas.html b/vmc-draas/com.vmware.vmc.draas.html index 4eecde45..56fb678e 100644 --- a/vmc-draas/com.vmware.vmc.draas.html +++ b/vmc-draas/com.vmware.vmc.draas.html @@ -7,7 +7,7 @@ - com.vmware.vmc.draas package — draas 1.18.0 documentation + com.vmware.vmc.draas package — draas 1.20.0 documentation @@ -63,7 +63,7 @@
    - 1.18.0 + 1.20.0
    @@ -179,8 +179,685 @@

    Submodules

    -
    -

    com.vmware.vmc.draas.model_client module

    +
    +

    com.vmware.vmc.draas.model_client module

    +
    +
    +class com.vmware.vmc.draas.model_client.AbstractEntity(updated=None, user_id=None, created=None, updated_by_user_id=None, version=None, updated_by_user_name=None, user_name=None, id=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • updated (datetime.datetime) –

      • +

    • user_id (str) – User id that last updated this record

      • +

    • created (datetime.datetime) –

      • +

    • updated_by_user_id (str) – User id that last updated this record

      • +

    • version (long) – Version of this entity format: int32

      • +

    • updated_by_user_name (str) – User name that last updated this record

      • +

    • user_name (str) – User name that last updated this record

      • +

    • id (str) –

      • +
    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig(srm_extension_key_suffix=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +

    srm_extension_key_suffix (str or None) – Optional custom extension key suffix for SRM. If not specified, +default extension key will be used. The custom extension suffix +must contain 13 characters or less, be composed of letters, +numbers, ., -, and _ characters. The extension suffix must begin +and end with a letter or number. The suffix is appended to +com.vmware.vcDr- to form the full extension key.

    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.BuildVersion(version=None, build_number=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    The build version.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • version (str or None) –

      • +

    • build_number (str or None) –

      • +
    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.ErrorResponse(status=None, path=None, retryable=None, error_code=None, error_messages=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • status (long) – HTTP status code

      • +

    • path (str) – Originating request URI

      • +

    • retryable (bool) – If true, client should retry operation

      • +

    • error_code (str) – unique error code

      • +

    • error_messages (list of str) – localized error messages

      • +
    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.Fault(message=None, cause=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • message (str or None) –

      • +

    • cause (vmware.vapi.struct.VapiStruct or None) –

      • +
    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.HmsIssueInfo(target_object_mo_id=None, severity=None, issue_type=None, target_object_name=None, fault=None, triggered_time=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • target_object_mo_id (str) –

      • +

    • severity (str) –

      • +

    • issue_type (str) –

      • +

    • target_object_name (str or None) –

      • +

    • fault (Fault or None) –

      • +

    • triggered_time (datetime.datetime) –

      • +
    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.HmsReplicationIssueInfo(target_object_mo_id=None, severity=None, issue_type=None, target_object_name=None, fault=None, triggered_time=None, direction=None, source_site_uuid=None, destination_site_uuid=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • target_object_mo_id (str) –

      • +

    • severity (str) –

      • +

    • issue_type (str) –

      • +

    • target_object_name (str or None) –

      • +

    • fault (Fault or None) –

      • +

    • triggered_time (datetime.datetime) –

      • +

    • direction (str or None) –

      • +

    • source_site_uuid (str or None) –

      • +

    • destination_site_uuid (str or None) –

      • +
    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.HmsSiteIssueInfo(target_object_mo_id=None, severity=None, issue_type=None, target_object_name=None, fault=None, triggered_time=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • target_object_mo_id (str) –

      • +

    • severity (str) –

      • +

    • issue_type (str) –

      • +

    • target_object_name (str or None) –

      • +

    • fault (Fault or None) –

      • +

    • triggered_time (datetime.datetime) –

      • +
    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.ProvisionSrmConfig(srm_extension_key_suffix=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +

    srm_extension_key_suffix (str or None) – Optional custom extension key suffix for SRM. If not specified, +default extension key will be used.

    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.ReplicaDisk(space_requirement=None, name=None, collection_id=None, datastores_for_single_host_move=None, movable=None, disk_id=None, datastore_mo_id=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • space_requirement (float or None) –

      • +

    • name (str or None) –

      • +

    • collection_id (str or None) –

      • +

    • datastores_for_single_host_move (list of vmware.vapi.struct.VapiStruct or None) –

      • +

    • movable (bool or None) –

      • +

    • disk_id (str or None) –

      • +

    • datastore_mo_id (str or None) –

      • +
    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.ReplicaDiskCollection(collection_id=None, generated=None, disks=None, placeholder_vm_mo_id=None, name=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • collection_id (str or None) –

      • +

    • generated (datetime.datetime or None) –

      • +

    • disks (list of ReplicaDisk or None) –

      • +

    • placeholder_vm_mo_id (str or None) –

      • +

    • name (str or None) –

      • +
    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.ReportPeriodConfig(report_end_day_inclusive=None, report_start_day_inclusive=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • report_end_day_inclusive (datetime.datetime or None) –

      • +

    • report_start_day_inclusive (datetime.datetime or None) –

      • +
    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.SiteRecovery(updated=None, user_id=None, created=None, updated_by_user_id=None, version=None, updated_by_user_name=None, user_name=None, id=None, site_recovery_state=None, vr_node=None, srm_nodes=None, vrs_nodes=None, sddc_id=None, draas_h5_url=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
    +
    +
    +
    +
    +SITE_RECOVERY_STATE_ACTIVATED = 'ACTIVATED'
    +
    + +
    +
    +SITE_RECOVERY_STATE_ACTIVATING = 'ACTIVATING'
    +
    + +
    +
    +SITE_RECOVERY_STATE_CANCELED = 'CANCELED'
    +
    + +
    +
    +SITE_RECOVERY_STATE_DEACTIVATED = 'DEACTIVATED'
    +
    + +
    +
    +SITE_RECOVERY_STATE_DEACTIVATING = 'DEACTIVATING'
    +
    + +
    +
    +SITE_RECOVERY_STATE_DELETED = 'DELETED'
    +
    + +
    +
    +SITE_RECOVERY_STATE_FAILED = 'FAILED'
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas.model_client.SiteRecoveryNode(vm_moref_id=None, ip_address=None, hostname=None, id=None, state=None, type=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
    +
    +
    +
    +
    +STATE_CANCELED = 'CANCELED'
    +
    + +
    +
    +STATE_DELETING = 'DELETING'
    +
    + +
    +
    +STATE_DEPLOYING = 'DEPLOYING'
    +
    + +
    +
    +STATE_FAILED = 'FAILED'
    +
    + +
    +
    +STATE_PROVISIONED = 'PROVISIONED'
    +
    + +
    +
    +STATE_READY = 'READY'
    +
    + +
    +
    +TYPE_SRM = 'SRM'
    +
    + +
    +
    +TYPE_VRMS = 'VRMS'
    +
    + +
    +
    +TYPE_VRS = 'VRS'
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion(build_version=None, node_type=None, node_id=None, full_version=None, node_ip=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
    +
    +
    +
    +
    +NODE_TYPE_SRM = 'SRM'
    +
    + +
    +
    +NODE_TYPE_VRMS = 'VRMS'
    +
    + +
    +
    +NODE_TYPE_VRS = 'VRS'
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas.model_client.SiteRecoveryVersions(generated=None, sddc_id=None, node_versions=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • generated (datetime.datetime or None) –

      • +

    • sddc_id (str or None) –

      • +

    • node_versions (list of SiteRecoveryNodeVersion or None) – list of site recovery node version

      • +
    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.SrmNode(vm_moref_id=None, ip_address=None, hostname=None, id=None, state=None, type=None, srm_extension_key_suffix=None, srm_extension_key=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
    +
    +
    +
    +
    +STATE_CANCELED = 'CANCELED'
    +
    + +
    +
    +STATE_DELETING = 'DELETING'
    +
    + +
    +
    +STATE_DEPLOYING = 'DEPLOYING'
    +
    + +
    +
    +STATE_FAILED = 'FAILED'
    +
    + +
    +
    +STATE_PROVISIONED = 'PROVISIONED'
    +
    + +
    +
    +STATE_READY = 'READY'
    +
    + +
    +
    +TYPE_SRM = 'SRM'
    +
    + +
    +
    +TYPE_VRMS = 'VRMS'
    +
    + +
    +
    +TYPE_VRS = 'VRS'
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas.model_client.StubFactory(stub_config)
    +

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    +
    +
    Parameters
    +

    stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas.model_client.Task(updated=None, user_id=None, created=None, updated_by_user_id=None, version=None, updated_by_user_name=None, user_name=None, id=None, status=None, resource_id=None, start_time=None, retries=None, task_type=None, task_progress_phases=None, tenant_id=None, error_message=None, parent_task_id=None, progress_percent=None, estimated_remaining_minutes=None, params=None, end_time=None, task_version=None, resource_type=None, sub_status=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • updated (datetime.datetime) –

      • +

    • user_id (str) – User id that last updated this record

      • +

    • created (datetime.datetime) –

      • +

    • updated_by_user_id (str) – User id that last updated this record

      • +

    • version (long) – Version of this entity format: int32

      • +

    • updated_by_user_name (str) – User name that last updated this record

      • +

    • user_name (str) – User name that last updated this record

      • +

    • id (str) –

      • +

    • status (str or None) –

      Possible values are:

      + +

      • +

    • resource_id (str or None) – UUID of resources task is acting upon

      • +

    • start_time (datetime.datetime or None) –

      • +

    • retries (long or None) –

      • +

    • task_type (str or None) –

      • +

    • task_progress_phases (list of TaskProgressPhase or None) – Task progress phases involved in current task execution

      • +

    • tenant_id (str or None) –

      • +

    • error_message (str or None) –

      • +

    • parent_task_id (str or None) –

      • +

    • progress_percent (long or None) – Estimated progress percentage the task executed format: int32

      • +

    • estimated_remaining_minutes (long or None) – Estimated remaining time in minute of the task execution, < 0 means +no estimation for the task. format: int32

      • +

    • params (vmware.vapi.struct.VapiStruct or None) –

      • +

    • end_time (datetime.datetime or None) –

      • +

    • task_version (str or None) –

      • +

    • resource_type (str or None) – Type of resource being acted upon

      • +

    • sub_status (str or None) –

      • +
    +
    +
    +
    +
    +STATUS_CANCELED = 'CANCELED'
    +
    + +
    +
    +STATUS_CANCELING = 'CANCELING'
    +
    + +
    +
    +STATUS_FAILED = 'FAILED'
    +
    + +
    +
    +STATUS_FINISHED = 'FINISHED'
    +
    + +
    +
    +STATUS_STARTED = 'STARTED'
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas.model_client.TaskProgressPhase(id=None, name=None, progress_percent=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    A task progress can be (but does NOT have to be) divided to more meaningful +progress phases.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    +
    +
    Parameters
    +
      +

    • id (str) – The identifier of the task progress phase

      • +

    • name (str) – The display name of the task progress phase

      • +

    • progress_percent (long) – The percentage of the phase that has completed format: int32

      • +
    +
    +
    +
    +
    @@ -198,7 +875,7 @@

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..

    diff --git a/vmc-draas/com.vmware.vmc.html b/vmc-draas/com.vmware.vmc.html index d2991bf4..d267eca9 100644 --- a/vmc-draas/com.vmware.vmc.html +++ b/vmc-draas/com.vmware.vmc.html @@ -7,7 +7,7 @@ - com.vmware.vmc package — draas 1.18.0 documentation + com.vmware.vmc package — draas 1.20.0 documentation @@ -63,7 +63,7 @@
    - 1.18.0 + 1.20.0
    @@ -180,7 +180,7 @@ @@ -189,8 +189,599 @@

    Submodules

    -
    -

    com.vmware.vmc.draas_client module

    +
    +

    com.vmware.vmc.draas_client module

    +
    +
    +class com.vmware.vmc.draas_client.GetSrmConfigExport(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    +
    Parameters
    +

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    +
    +
    +
    +
    +get(org, sddc, srm_node)
    +

    Get content of the config export file needed for CVDS migration.

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • sddc (str) – sddc identifier (required)

      • +

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

      • +
    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.NotFound +Cannot find config-export file in the site recovery node target +path

    +
    +
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas_client.GranularReporter(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    +
    Parameters
    +

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    +
    +
    +
    +
    +create_usage_report(org, report_period_config=None)
    +

    Create granular usage report for specific time period

    +
    +
    Parameters
    +
    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas_client.ReplicaDiskCollections(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    +
    Parameters
    +

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    +
    +
    +
    +
    +get(org, sddc, datastore_mo_id=None)
    +

    Query replica disk collections

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • sddc (str) – sddc identifier (required)

      • +

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

      • +
    +
    +
    Return type
    +

    list of com.vmware.vmc.draas.model_client.ReplicaDiskCollection

    +
    +
    Returns
    +

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.NotFound +Not found

    +
    +
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas_client.SiteRecovery(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    +
    Parameters
    +

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    +
    +
    +
    +
    +delete(org, sddc, force=None)
    +

    Deactivate site recovery for the specified sddc

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • sddc (str) – sddc identifier (required)

      • +

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

      • +
    +
    +
    Return type
    +

    com.vmware.vmc.draas.model_client.Task

    +
    +
    Returns
    +

    com.vmware.vmc.draas.model.Task

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.InvalidRequest +Invalid action or bad argument

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.NotFound +Cannot find site recovery configuration for sddc identifier

    +
    +
    +
    + +
    +
    +get(org, sddc)
    +

    Query site recovery configuration for the specified sddc

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • sddc (str) – sddc identifier (required)

      • +
    +
    +
    Return type
    +

    com.vmware.vmc.draas.model_client.SiteRecovery

    +
    +
    Returns
    +

    com.vmware.vmc.draas.model.SiteRecovery

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.InvalidRequest +Invalid action or bad argument

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    +
    + +
    +
    +post(org, sddc, activate_site_recovery_config=None)
    +

    Activate site recovery for the specified sddc

    +
    +
    Parameters
    +
    +
    +
    Return type
    +

    com.vmware.vmc.draas.model_client.Task

    +
    +
    Returns
    +

    com.vmware.vmc.draas.model.Task

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.InvalidRequest +Invalid action or bad argument

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.NotFound +Cannot find site recovery configuration for sddc identifier

    +
    +
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas_client.SiteRecoverySrmNodes(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    +
    Parameters
    +

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    +
    +
    +
    +
    +delete(org, sddc, srm_node)
    +

    Delete a SRM server.

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • sddc (str) – sddc identifier (required)

      • +

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

      • +
    +
    +
    Return type
    +

    com.vmware.vmc.draas.model_client.Task

    +
    +
    Returns
    +

    com.vmware.vmc.draas.model.Task

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.InvalidRequest +Invalid action or bad argument

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.NotFound +Cannot find SDDC or SRM node

    +
    +
    +
    + +
    +
    +post(org, sddc, provision_srm_config=None)
    +

    Provision an additional SRM server.

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • sddc (str) – sddc identifier (required)

      • +

    • provision_srm_config (com.vmware.vmc.draas.model_client.ProvisionSrmConfig or None) – Customization, for example can specify custom extension key suffix +for SRM. (optional)

      • +
    +
    +
    Return type
    +

    com.vmware.vmc.draas.model_client.Task

    +
    +
    Returns
    +

    com.vmware.vmc.draas.model.Task

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.InvalidRequest +Invalid action or bad argument

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.NotFound +Cannot find site recovery configuration for sddc identifier

    +
    +
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas_client.SiteRecoveryVersions(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    +
    Parameters
    +

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    +
    +
    +
    +
    +get(org, sddc)
    +

    Query site recovery versions for the specified sddc

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • sddc (str) – sddc identifier (required)

      • +
    +
    +
    Return type
    +

    com.vmware.vmc.draas.model_client.SiteRecoveryVersions

    +
    +
    Returns
    +

    com.vmware.vmc.draas.model.SiteRecoveryVersions

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.InvalidRequest +Invalid action or bad argument

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.NotFound +Cannot find site recovery versions for sddc identifier

    +
    +
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas_client.StubFactory(stub_config)
    +

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    +
    +
    Parameters
    +

    stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

    +
    +
    +
    + +
    +
    +class com.vmware.vmc.draas_client.Task(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    +
    Parameters
    +

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    +
    +
    +
    +
    +get(org, task)
    +

    Retrieve details of a task.

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • task (str) – task identifier (required)

      • +
    +
    +
    Return type
    +

    com.vmware.vmc.draas.model_client.Task

    +
    +
    Returns
    +

    com.vmware.vmc.draas.model.Task

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.NotFound +Cannot find the task with given identifier

    +
    +
    +
    + +
    +
    +list(org, filter=None)
    +

    List all tasks with optional filtering.

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • filter (str or None) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’, +‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-‘ +(minus) String Operators: ‘startswith’, ‘endswith’, ‘length’, +‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed +using ‘.’ Dates must be formatted as yyyy-MM-dd or +yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single +quotes, escape single quote with two single quotes The special +literal ‘created’ will be mapped to the time the resource was first +created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and +(org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - +$filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) +and (sddc.status eq ‘READY’) (optional)

      • +
    +
    +
    Return type
    +

    list of com.vmware.vmc.draas.model_client.Task

    +
    +
    Returns
    +

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    +
    + +
    +
    +update(org, task, action=None)
    +

    Request that a running task be canceled. This is advisory only, some +tasks may not be cancelable, and some tasks might take an arbitrary +amount of time to respond to a cancelation request. The task must be +monitored to determine subsequent status.

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • task (str) – task identifier (required)

      • +

    • action (str or None) – If = ‘cancel’, task will be canceled (optional)

      • +
    +
    +
    Return type
    +

    com.vmware.vmc.draas.model_client.Task

    +
    +
    Returns
    +

    com.vmware.vmc.draas.model.Task

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.InvalidRequest +Invalid action or bad argument

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.NotFound +Cannot find the task with given identifier

    +
    +
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas_client.VrReplicationIssues(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    +
    Parameters
    +

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    +
    +
    +
    +
    +get(org, sddc)
    +

    Query VR replication issues

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • sddc (str) – sddc identifier (required)

      • +
    +
    +
    Return type
    +

    list of com.vmware.vmc.draas.model_client.HmsReplicationIssueInfo

    +
    +
    Returns
    +

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.NotFound +Not found

    +
    +
    +
    + +
    + +
    +
    +class com.vmware.vmc.draas_client.VrSiteIssues(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    +
    Parameters
    +

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    +
    +
    +
    +
    +get(org, sddc)
    +

    Query VR site issues

    +
    +
    Parameters
    +
      +

    • org (str) – Organization identifier (required)

      • +

    • sddc (str) – sddc identifier (required)

      • +
    +
    +
    Return type
    +

    list of com.vmware.vmc.draas.model_client.HmsSiteIssueInfo

    +
    +
    Returns
    +

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    +
    Raise
    +

    com.vmware.vapi.std.errors_client.NotFound +Not found

    +
    +
    +
    + +
    +
    @@ -208,7 +799,7 @@

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..

    diff --git a/vmc-draas/enumeration.html b/vmc-draas/enumeration.html index aa940922..9c3d5aee 100644 --- a/vmc-draas/enumeration.html +++ b/vmc-draas/enumeration.html @@ -7,7 +7,7 @@ - Interface definition language to python mapping for enumerated types — draas 1.18.0 documentation + Interface definition language to python mapping for enumerated types — draas 1.20.0 documentation @@ -61,7 +61,7 @@
    - 1.18.0 + 1.20.0
    @@ -246,7 +246,7 @@ enumerated type class.

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..

    diff --git a/vmc-draas/genindex.html b/vmc-draas/genindex.html index ed1a19c7..ef3532d7 100644 --- a/vmc-draas/genindex.html +++ b/vmc-draas/genindex.html @@ -7,7 +7,7 @@ - Index — draas 1.18.0 documentation + Index — draas 1.20.0 documentation @@ -61,7 +61,7 @@
    - 1.18.0 + 1.20.0
    @@ -159,11 +159,45 @@

    Index

    - C + A + | B + | C + | D + | E + | F + | G + | H + | L | M + | N + | P + | R + | S + | T + | U | V
    +

    A

    + + + +
    + +

    B

    + + +
    +

    C

    - + +
    -
    • com.vmware.vmc @@ -198,6 +230,108 @@
    + +

    D

    + + +
    + +

    E

    + + +
    + +

    F

    + + +
    + +

    G

    + + + +
    + +

    H

    + + + +
    + +

    L

    + +

    M

    @@ -214,17 +348,207 @@
  • com.vmware.vmc
  • com.vmware.vmc.draas +
    • +
  • com.vmware.vmc.draas.model_client +
    • +
  • com.vmware.vmc.draas_client
  • vmware
  • vmware.vapi
  • vmware.vapi.vmc +
    • +
  • vmware.vapi.vmc.csp_filter
    • +

    N

    + + + +
    + +

    P

    + + + +
    + +

    R

    + + + +
    + +

    S

    + + + +
    + +

    T

    + + + +
    + +

    U

    + + +
    +

    V

    - +
    -
    • vmware.vapi.vmc @@ -252,6 +574,19 @@
    @@ -265,7 +600,7 @@

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..

    diff --git a/vmc-draas/index.html b/vmc-draas/index.html index 43b8ce65..055ba759 100644 --- a/vmc-draas/index.html +++ b/vmc-draas/index.html @@ -7,7 +7,7 @@ - Welcome to draas’s documentation! — draas 1.18.0 documentation + Welcome to draas’s documentation! — draas 1.20.0 documentation @@ -62,7 +62,7 @@
    - 1.18.0 + 1.20.0
    @@ -171,13 +171,13 @@
  • Subpackages
  • Submodules
    • -
  • com.vmware.vmc.draas_client module
    • +
  • com.vmware.vmc.draas_client module
    • @@ -195,7 +195,7 @@
  • vmware.vapi.vmc package
    • @@ -231,7 +231,7 @@

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..

    diff --git a/vmc-draas/objects.inv b/vmc-draas/objects.inv index e66145d1..75cb14d7 100644 Binary files a/vmc-draas/objects.inv and b/vmc-draas/objects.inv differ diff --git a/vmc-draas/py-modindex.html b/vmc-draas/py-modindex.html index 4bcfcc8c..0197ba6b 100644 --- a/vmc-draas/py-modindex.html +++ b/vmc-draas/py-modindex.html @@ -7,7 +7,7 @@ - Python Module Index — draas 1.18.0 documentation + Python Module Index — draas 1.20.0 documentation @@ -64,7 +64,7 @@
    - 1.18.0 + 1.20.0
    @@ -189,6 +189,16 @@     com.vmware.vmc.draas + + +     + com.vmware.vmc.draas.model_client + + + +     + com.vmware.vmc.draas_client +   v @@ -208,6 +218,11 @@     vmware.vapi.vmc + + +     + vmware.vapi.vmc.csp_filter + @@ -220,7 +235,7 @@

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..

    diff --git a/vmc-draas/search.html b/vmc-draas/search.html index 0cc1583a..471256f1 100644 --- a/vmc-draas/search.html +++ b/vmc-draas/search.html @@ -7,7 +7,7 @@ - Search — draas 1.18.0 documentation + Search — draas 1.20.0 documentation @@ -64,7 +64,7 @@
    - 1.18.0 + 1.20.0
    @@ -178,7 +178,7 @@

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..

    diff --git a/vmc-draas/searchindex.js b/vmc-draas/searchindex.js index ec4149fa..b17ad38a 100644 --- a/vmc-draas/searchindex.js +++ b/vmc-draas/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["com","com.vmware","com.vmware.vmc","com.vmware.vmc.draas","enumeration","index","vmware","vmware.vapi","vmware.vapi.vmc"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["com.rst","com.vmware.rst","com.vmware.vmc.rst","com.vmware.vmc.draas.rst","enumeration.rst","index.rst","vmware.rst","vmware.vapi.rst","vmware.vapi.vmc.rst"],objects:{"":{com:[0,0,0,"-"],vmware:[6,0,0,"-"]},"com.vmware":{vmc:[2,0,0,"-"]},"com.vmware.vmc":{draas:[3,0,0,"-"]},"vmware.vapi":{vmc:[8,0,0,"-"]},com:{vmware:[1,0,0,"-"]},vmware:{vapi:[7,0,0,"-"]}},objnames:{"0":["py","module","Python module"]},objtypes:{"0":"py:module"},terms:{"class":4,"enum":4,"import":4,"new":4,The:4,allow:4,api:4,attribut:4,attrit:4,back:4,base:4,bind:4,both:4,can:4,client:[5,6,7],com:[4,5],commun:4,contain:4,creat:4,createspec:4,csp_filter:[5,6,7],current:4,defin:4,descript:4,doe:4,draa:[0,1,2],draas_client:[0,1,5],els:4,entiti:4,entity_metadata:4,explain:4,file:4,filepath:4,first:4,folder:4,follow:4,from:4,futur:4,gener:4,get:4,has:4,have:4,how:4,includ:4,index:5,instanc:4,instanti:4,json:4,mai:4,metadata:4,metadata_cli:4,method:4,model_cli:[0,1,2,5],modul:[0,1,4,5,6,7],name:4,newer:4,older:4,one:4,onli:4,packag:5,page:[4,5],paramet:4,pass:4,print:4,program:4,provid:4,receiv:4,remot:4,repres:4,respons:4,sdk:4,search:5,see:4,send:4,server:4,servic:4,sinc:4,sourc:4,source_info:4,source_svc:4,sourcetyp:4,spec:4,special:4,specifi:4,str:4,string:4,submodul:[0,1,5,6,7],subpackag:5,support:4,system:4,thi:4,two:4,unknown:4,use:4,valu:4,vapi:[4,5,6],variabl:4,version:4,vmc:[0,1,5,6,7],vmware:[0,4,5],want:4,when:4,which:4,would:4,you:4,your:4},titles:["com package","com.vmware package","com.vmware.vmc package","com.vmware.vmc.draas package","Interface definition language to python mapping for enumerated types","Welcome to draas\u2019s documentation!","vmware package","vmware.vapi package","vmware.vapi.vmc package"],titleterms:{client:8,code:4,com:[0,1,2,3],content:5,csp_filter:8,definit:4,document:[4,5],draa:[3,5],draas_client:2,enumer:4,exampl:4,indic:5,interfac:4,languag:4,map:4,model_cli:3,modul:[2,3,8],packag:[0,1,2,3,6,7,8],python:4,submodul:[2,3,8],subpackag:[0,1,2,6,7],tabl:5,type:4,vapi:[7,8],vmc:[2,3,8],vmware:[1,2,3,6,7,8],welcom:5}}) \ No newline at end of file +Search.setIndex({docnames:["com","com.vmware","com.vmware.vmc","com.vmware.vmc.draas","enumeration","index","vmware","vmware.vapi","vmware.vapi.vmc"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["com.rst","com.vmware.rst","com.vmware.vmc.rst","com.vmware.vmc.draas.rst","enumeration.rst","index.rst","vmware.rst","vmware.vapi.rst","vmware.vapi.vmc.rst"],objects:{"":{com:[0,0,0,"-"],vmware:[6,0,0,"-"]},"com.vmware":{vmc:[2,0,0,"-"]},"com.vmware.vmc":{draas:[3,0,0,"-"],draas_client:[2,0,0,"-"]},"com.vmware.vmc.draas":{model_client:[3,0,0,"-"]},"com.vmware.vmc.draas.model_client":{AbstractEntity:[3,1,1,""],ActivateSiteRecoveryConfig:[3,1,1,""],BuildVersion:[3,1,1,""],ErrorResponse:[3,1,1,""],Fault:[3,1,1,""],HmsIssueInfo:[3,1,1,""],HmsReplicationIssueInfo:[3,1,1,""],HmsSiteIssueInfo:[3,1,1,""],ProvisionSrmConfig:[3,1,1,""],ReplicaDisk:[3,1,1,""],ReplicaDiskCollection:[3,1,1,""],ReportPeriodConfig:[3,1,1,""],SiteRecovery:[3,1,1,""],SiteRecoveryNode:[3,1,1,""],SiteRecoveryNodeVersion:[3,1,1,""],SiteRecoveryVersions:[3,1,1,""],SrmNode:[3,1,1,""],StubFactory:[3,1,1,""],Task:[3,1,1,""],TaskProgressPhase:[3,1,1,""]},"com.vmware.vmc.draas.model_client.SiteRecovery":{SITE_RECOVERY_STATE_ACTIVATED:[3,2,1,""],SITE_RECOVERY_STATE_ACTIVATING:[3,2,1,""],SITE_RECOVERY_STATE_CANCELED:[3,2,1,""],SITE_RECOVERY_STATE_DEACTIVATED:[3,2,1,""],SITE_RECOVERY_STATE_DEACTIVATING:[3,2,1,""],SITE_RECOVERY_STATE_DELETED:[3,2,1,""],SITE_RECOVERY_STATE_FAILED:[3,2,1,""]},"com.vmware.vmc.draas.model_client.SiteRecoveryNode":{STATE_CANCELED:[3,2,1,""],STATE_DELETING:[3,2,1,""],STATE_DEPLOYING:[3,2,1,""],STATE_FAILED:[3,2,1,""],STATE_PROVISIONED:[3,2,1,""],STATE_READY:[3,2,1,""],TYPE_SRM:[3,2,1,""],TYPE_VRMS:[3,2,1,""],TYPE_VRS:[3,2,1,""]},"com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion":{NODE_TYPE_SRM:[3,2,1,""],NODE_TYPE_VRMS:[3,2,1,""],NODE_TYPE_VRS:[3,2,1,""]},"com.vmware.vmc.draas.model_client.SrmNode":{STATE_CANCELED:[3,2,1,""],STATE_DELETING:[3,2,1,""],STATE_DEPLOYING:[3,2,1,""],STATE_FAILED:[3,2,1,""],STATE_PROVISIONED:[3,2,1,""],STATE_READY:[3,2,1,""],TYPE_SRM:[3,2,1,""],TYPE_VRMS:[3,2,1,""],TYPE_VRS:[3,2,1,""]},"com.vmware.vmc.draas.model_client.Task":{STATUS_CANCELED:[3,2,1,""],STATUS_CANCELING:[3,2,1,""],STATUS_FAILED:[3,2,1,""],STATUS_FINISHED:[3,2,1,""],STATUS_STARTED:[3,2,1,""]},"com.vmware.vmc.draas_client":{GetSrmConfigExport:[2,1,1,""],GranularReporter:[2,1,1,""],ReplicaDiskCollections:[2,1,1,""],SiteRecovery:[2,1,1,""],SiteRecoverySrmNodes:[2,1,1,""],SiteRecoveryVersions:[2,1,1,""],StubFactory:[2,1,1,""],Task:[2,1,1,""],VrReplicationIssues:[2,1,1,""],VrSiteIssues:[2,1,1,""]},"com.vmware.vmc.draas_client.GetSrmConfigExport":{get:[2,3,1,""]},"com.vmware.vmc.draas_client.GranularReporter":{create_usage_report:[2,3,1,""]},"com.vmware.vmc.draas_client.ReplicaDiskCollections":{get:[2,3,1,""]},"com.vmware.vmc.draas_client.SiteRecovery":{"delete":[2,3,1,""],get:[2,3,1,""],post:[2,3,1,""]},"com.vmware.vmc.draas_client.SiteRecoverySrmNodes":{"delete":[2,3,1,""],post:[2,3,1,""]},"com.vmware.vmc.draas_client.SiteRecoveryVersions":{get:[2,3,1,""]},"com.vmware.vmc.draas_client.Task":{get:[2,3,1,""],list:[2,3,1,""],update:[2,3,1,""]},"com.vmware.vmc.draas_client.VrReplicationIssues":{get:[2,3,1,""]},"com.vmware.vmc.draas_client.VrSiteIssues":{get:[2,3,1,""]},"vmware.vapi":{vmc:[8,0,0,"-"]},"vmware.vapi.vmc":{csp_filter:[8,0,0,"-"]},"vmware.vapi.vmc.csp_filter":{CSPSecurityContextFilter:[8,1,1,""]},"vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter":{get_max_retries:[8,3,1,""],get_security_context:[8,3,1,""],should_retry:[8,3,1,""]},com:{vmware:[1,0,0,"-"]},vmware:{vapi:[7,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method"},terms:{"00z":2,"09t13":2,"2016":2,"278710ff4e":2,"4d4e":2,"6b6d":2,"case":8,"class":[2,3,4,8],"default":3,"enum":4,"export":2,"float":3,"import":4,"int":8,"long":3,"new":[4,8],"return":[2,8],"true":[2,3,8],NOT:3,Not:2,The:[2,3,4],VRS:3,abstractent:3,access:8,act:3,action:2,activ:[2,3],activate_site_recovery_config:2,activatesiterecoveryconfig:[2,3],add:[2,8],addit:2,advisori:2,aefb:2,after:8,all:2,allow:[4,8],amount:2,api:[4,8],append:3,arbitrari:2,argument:[2,3],attribut:[2,3,4],attrit:4,back:4,bad:2,base:[2,3,4,8],begin:3,being:3,binari:2,bind:[2,3,4],bool:[2,3,8],both:4,build:3,build_numb:3,build_vers:3,buildvers:3,ca637f38609:2,call:8,can:[2,3,4],cancel:[2,3],cannot:2,caus:3,chain:8,charact:3,client:[3,5,6,7],code:3,collect:2,collection_id:3,com:[4,5],commun:4,complet:3,compos:[2,3],config:[2,3],configur:2,contain:[2,3,4],content:2,context:8,core:8,creat:[2,3,4,8],create_usage_report:2,createspec:4,csp:8,csp_filter:[5,6,7],cspsecuritycontextfilt:8,current:[3,4],custom:[2,3],cvd:2,data:[3,8],datastor:2,datastore_mo_id:[2,3],datastores_for_single_host_mov:3,date:2,datetim:3,ddthh:2,deactiv:[2,3],defin:4,delet:[2,3],deploi:3,descript:4,destination_site_uuid:3,detail:2,determin:2,direct:3,disk:[2,3],disk_id:3,displai:3,div:2,divid:3,doe:[3,4],draa:[0,1,2],draas_client:[0,1,5],draas_h5_url:3,either:8,els:[4,8],enclos:2,end:3,end_tim:3,endswith:2,entiti:[3,4],entity_metadata:4,error:[3,8],error_cod:3,error_messag:3,error_valu:8,errorrespons:3,errors_cli:2,errorvalu:8,escap:2,estim:3,estimated_remaining_minut:3,exampl:2,exchang:8,execut:[3,8],explain:4,express:2,extens:[2,3],fail:3,fals:8,fault:3,file:[2,4],filepath:4,filter:[2,8],find:2,finish:3,first:[2,4],folder:4,follow:4,forbidden:2,forc:2,forcefulli:2,form:3,format:[2,3],found:2,from:4,full:3,full_vers:3,futur:4,gener:[3,4],get:[2,4,8],get_max_retri:8,get_security_context:8,getsrmconfigexport:2,given:2,granular:2,granularreport:2,has:[3,4],have:[3,4],hmsissueinfo:3,hmsreplicationissueinfo:[2,3],hmssiteissueinfo:[2,3],hostnam:3,how:4,http:[3,8],identifi:[2,3],includ:4,index:5,initi:[2,3,8],instanc:[2,3,4],instanti:4,int32:3,invalid:2,invalidrequest:2,involv:3,ip_address:3,issu:2,issue_typ:3,json:4,kei:[2,3],last:3,length:2,less:3,letter:3,list:[2,3],liter:2,local:3,mai:[2,4],make:8,map:2,max:8,mean:3,meaning:3,messag:3,metadata:4,metadata_cli:4,method:[4,8],might:2,migrat:2,minu:2,minut:3,mod:2,model:2,model_cli:[0,1,2,5],modul:[0,1,4,5,6,7],monitor:2,more:3,moref:2,movabl:3,mul:2,must:[2,3],name:[3,4],need:2,nest:2,newer:4,node:[2,3],node_id:3,node_ip:3,node_typ:3,node_type_srm:3,node_type_vr:3,node_type_vrm:3,node_vers:3,none:[2,3],notfound:2,number:[3,8],object:8,obtain:8,occur:8,older:4,on_error:8,one:4,onli:[2,4],oper:[2,3],option:[2,3],org:2,org_id:2,organ:2,origin:3,packag:5,page:[4,5],param:3,paramet:[2,3,4,8],parent_task_id:3,pass:[4,8],path:[2,3],percentag:3,period:2,phase:3,placeholder_vm_mo_id:3,possibl:3,post:2,print:4,program:4,progress:3,progress_perc:3,provid:[4,8],provis:[2,3],provision_srm_config:2,provisionsrmconfig:[2,3],queri:2,quot:2,rais:2,readi:[2,3],receiv:4,record:3,recoveri:[2,3],refresh:8,refresh_token:8,refresh_url:8,remain:3,remot:4,replic:2,replica:2,replicadisk:3,replicadiskcollect:[2,3],report:2,report_end_day_inclus:3,report_period_config:2,report_start_day_inclus:3,reportperiodconfig:[2,3],repres:[2,4],request:[2,3,8],requir:2,resourc:[2,3],resource_id:3,resource_typ:3,respond:2,respons:4,retri:[3,8],retriev:[2,8],retryabl:3,run:2,same:3,sddc:2,sddc_id:3,sdk:4,search:[2,5],secur:8,security_context_filt:8,securitycontext:8,securitycontextfilt:8,see:4,send:4,server:[2,4],servic:4,session:8,sever:3,should:[2,3,8],should_retri:8,sinc:4,singl:2,site:[2,3],site_recovery_st:3,site_recovery_state_activ:3,site_recovery_state_cancel:3,site_recovery_state_deactiv:3,site_recovery_state_delet:3,site_recovery_state_fail:3,siterecoveri:[2,3],siterecoverynod:3,siterecoverynodevers:3,siterecoverysrmnod:2,siterecoveryvers:[2,3],some:2,sourc:4,source_info:4,source_site_uuid:3,source_svc:4,sourcetyp:4,space_requir:3,spec:4,special:[2,4],specif:2,specifi:[2,3,4,8],srm:[2,3],srm_extension_kei:3,srm_extension_key_suffix:3,srm_node:[2,3],srmnode:3,sss:2,start:3,start_tim:3,startswith:2,state:3,state_cancel:3,state_delet:3,state_deploi:3,state_fail:3,state_provis:3,state_readi:3,statu:[2,3],status_cancel:3,status_fail:3,status_finish:3,status_start:3,std:2,str:[2,3,4,8],string:[2,4],struct:3,stub:[2,3],stub_config:[2,3],stubconfigur:[2,3],stubfactori:[2,3],stubfactorybas:[2,3],sub:2,sub_statu:3,submodul:[0,1,5,6,7],subpackag:5,subsequ:2,suffix:[2,3],support:4,system:4,take:2,target:2,target_object_mo_id:3,target_object_nam:3,task:[2,3],task_progress_phas:3,task_typ:3,task_vers:3,taskprogressphas:3,tenant_id:3,thi:[2,3,4,8],time:[2,3],token:8,tolow:2,toupper:2,triggered_tim:3,two:[2,4],type:[2,3,8],type_srm:3,type_vr:3,type_vrm:3,unari:2,unauthent:[2,8],unauthor:[2,8],uniqu:3,unknown:4,updat:[2,3],updated_by_user_id:3,updated_by_user_nam:3,upon:3,uri:3,url:8,usag:2,use:[4,8],used:[2,3],user:3,user_id:3,user_nam:3,using:[2,8],uuid:3,valu:[3,4,8],vapi:[2,3,4,5,6],vapiinterfac:2,vapistruct:3,variabl:4,vcdr:3,version:[2,3,4],vm_moref_id:3,vmc:[0,1,5,6,7],vmware:[0,4,5],vr_node:3,vrm:3,vrreplicationissu:2,vrs_node:3,vrsiteissu:2,want:4,when:4,whether:8,which:4,would:4,you:4,your:4,yyyi:2},titles:["com package","com.vmware package","com.vmware.vmc package","com.vmware.vmc.draas package","Interface definition language to python mapping for enumerated types","Welcome to draas\u2019s documentation!","vmware package","vmware.vapi package","vmware.vapi.vmc package"],titleterms:{client:8,code:4,com:[0,1,2,3],content:5,csp_filter:8,definit:4,document:[4,5],draa:[3,5],draas_client:2,enumer:4,exampl:4,indic:5,interfac:4,languag:4,map:4,model_cli:3,modul:[2,3,8],packag:[0,1,2,3,6,7,8],python:4,submodul:[2,3,8],subpackag:[0,1,2,6,7],tabl:5,type:4,vapi:[7,8],vmc:[2,3,8],vmware:[1,2,3,6,7,8],welcom:5}}) \ No newline at end of file diff --git a/vmc-draas/vmware.html b/vmc-draas/vmware.html index afd76ab6..3791c948 100644 --- a/vmc-draas/vmware.html +++ b/vmc-draas/vmware.html @@ -7,7 +7,7 @@ - vmware package — draas 1.18.0 documentation + vmware package — draas 1.20.0 documentation @@ -63,7 +63,7 @@
    - 1.18.0 + 1.20.0
    @@ -176,7 +176,7 @@
  • vmware.vapi.vmc package
    • @@ -202,7 +202,7 @@

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..

    diff --git a/vmc-draas/vmware.vapi.html b/vmc-draas/vmware.vapi.html index 776a979d..85436dd5 100644 --- a/vmc-draas/vmware.vapi.html +++ b/vmc-draas/vmware.vapi.html @@ -7,7 +7,7 @@ - vmware.vapi package — draas 1.18.0 documentation + vmware.vapi package — draas 1.20.0 documentation @@ -63,7 +63,7 @@
    - 1.18.0 + 1.20.0
    @@ -179,7 +179,7 @@
  • vmware.vapi.vmc package
    • @@ -201,7 +201,7 @@

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..

    diff --git a/vmc-draas/vmware.vapi.vmc.html b/vmc-draas/vmware.vapi.vmc.html index ff8ed7d5..198bc494 100644 --- a/vmc-draas/vmware.vapi.vmc.html +++ b/vmc-draas/vmware.vapi.vmc.html @@ -7,7 +7,7 @@ - vmware.vapi.vmc package — draas 1.18.0 documentation + vmware.vapi.vmc package — draas 1.20.0 documentation @@ -62,7 +62,7 @@
    - 1.18.0 + 1.20.0
    @@ -179,8 +179,80 @@

    vmware.vapi.vmc.client module

    -
    -

    vmware.vapi.vmc.csp_filter module

    +
    +

    vmware.vapi.vmc.csp_filter module

    +

    CSP Refresh token based SecurityContextFilter

    +
    +
    +class vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter(session, refresh_token, refresh_url)
    +

    Bases: vmware.vapi.security.client.security_context_filter.SecurityContextFilter

    +

    CSP Security Context filter in API Provider chain adds the security +context based on a refresh token to the execution context passed in.

    +

    Initialize SecurityContextFilter

    +
    +
    Parameters
    +
      +

    • session (requests.Session) – Requests Session object to use for making HTTP calls

      • +

    • refresh_token (str) – Refresh token to use for obtaining an access token

      • +

    • refresh_url (str) – URL that allows exchanging a refresh token for an +access token

      • +
    +
    +
    +
    +
    +get_max_retries()
    +

    Get the max number of retries

    +
    +
    Return type
    +

    int

    +
    +
    Returns
    +

    Number of retries

    +
    +
    +
    + +
    +
    +get_security_context(on_error)
    +

    Retrieve security context. If this method is called after an error +occured, then a new access token is obtained using the refresh token and +a new security context is created.

    +
    +
    Parameters
    +

    on_error (bool) – Whether this method is called after getting an error

    +
    +
    Return type
    +

    vmware.vapi.core.SecurityContext

    +
    +
    Returns
    +

    Security context

    +
    +
    +
    + +
    +
    +should_retry(error_value)
    +

    Returns whether the request should be retried or not based on the error +specified.

    +
    +
    Parameters
    +

    error_value (vmware.vapi.data.value.ErrorValue) – Method error

    +
    +
    Return type
    +

    bool

    +
    +
    Returns
    +

    Returns True if request should be retried in case the error is +either Unauthenticated or Unauthorized else False

    +
    +
    +
    + +
    +
    @@ -197,7 +269,7 @@

    - © Copyright 2021, VMware, Inc.. + © Copyright 2022, VMware, Inc..