2018-08-07 19:42:25 -04:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2020-01-27 03:59:56 -05:00
< title > com.vmware.vcenter.hvc.links package — vSphere Automation SDK for Python. 7.0.0.0 documentation< / title >
2018-08-07 19:42:25 -04:00
2019-05-28 13:52:35 -04:00
< script type = "text/javascript" src = "_static/js/modernizr.min.js" > < / script >
2018-08-07 19:42:25 -04:00
2019-05-28 13:52:35 -04:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "_static/language_data.js" > < / script >
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
2018-08-07 19:42:25 -04:00
2019-05-28 13:52:35 -04:00
2018-08-07 19:42:25 -04:00
2019-05-28 13:52:35 -04:00
2018-09-20 17:27:25 -04:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
2018-08-07 19:42:25 -04:00
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "com.vmware.vcenter.storage package" href = "com.vmware.vcenter.storage.html" / >
< link rel = "prev" title = "com.vmware.vcenter.hvc package" href = "com.vmware.vcenter.hvc.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
2019-05-28 13:52:35 -04:00
< div class = "wy-side-nav-search" >
2018-08-07 19:42:25 -04:00
2019-05-28 13:52:35 -04:00
< a href = "index.html" class = "icon icon-home" > vSphere Automation SDK for Python.
2018-08-07 19:42:25 -04:00
< / a >
< div class = "version" >
2020-01-27 03:59:56 -05:00
7.0.0.0
2018-08-07 19:42:25 -04:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Contents:< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "com.html" > com package< / a > < ul class = "current" >
< li class = "toctree-l2 current" > < a class = "reference internal" href = "com.html#subpackages" > Subpackages< / a > < ul class = "current" >
< li class = "toctree-l3 current" > < a class = "reference internal" href = "com.vmware.html" > com.vmware package< / a > < ul class = "current" >
< li class = "toctree-l4 current" > < a class = "reference internal" href = "com.vmware.html#subpackages" > Subpackages< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.appliance_client" > com.vmware.appliance_client module< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.cis_client" > com.vmware.cis_client module< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.content_client" > com.vmware.content_client module< / a > < / li >
2019-05-28 13:52:35 -04:00
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.vapi_client" > com.vmware.vapi_client module< / a > < / li >
2018-08-07 19:42:25 -04:00
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.vcenter_client" > com.vmware.vcenter_client module< / a > < / li >
2020-01-27 03:59:56 -05:00
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.vstats_client" > com.vmware.vstats_client module< / a > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "vmware.html" > vmware package< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
2019-05-28 13:52:35 -04:00
< a href = "index.html" > vSphere Automation SDK for Python.< / a >
2018-08-07 19:42:25 -04:00
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" > Docs< / a > » < / li >
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
< li > < a href = "com.vmware.vcenter.html" > com.vmware.vcenter package< / a > » < / li >
< li > < a href = "com.vmware.vcenter.hvc.html" > com.vmware.vcenter.hvc package< / a > » < / li >
< li > com.vmware.vcenter.hvc.links package< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/com.vmware.vcenter.hvc.links.rst.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "module-com.vmware.vcenter.hvc.links" >
< span id = "com-vmware-vcenter-hvc-links-package" > < / span > < h1 > com.vmware.vcenter.hvc.links package< a class = "headerlink" href = "#module-com.vmware.vcenter.hvc.links" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "submodules" >
< h2 > Submodules< a class = "headerlink" href = "#submodules" title = "Permalink to this headline" > ¶< / a > < / h2 >
< / div >
< div class = "section" id = "module-com.vmware.vcenter.hvc.links.sync_client" >
< span id = "com-vmware-vcenter-hvc-links-sync-client-module" > < / span > < h2 > com.vmware.vcenter.hvc.links.sync_client module< a class = "headerlink" href = "#module-com.vmware.vcenter.hvc.links.sync_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
< dl class = "class" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers" >
2019-08-29 02:53:26 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.vcenter.hvc.links.sync_client.< / code > < code class = "sig-name descname" > Providers< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< p > The < code class = "docutils literal notranslate" > < span class = "pre" > Providers< / span > < / code > class provides methods to create a sync session, get
2020-01-27 03:59:56 -05:00
information on Sync. Usage beyond VMware Cloud on AWS is not supported.
< strong > Warning:< / strong > This class is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.< / p >
2019-05-28 13:52:35 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
< dl class = "class" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.Credentials" >
2019-08-29 02:53:26 -04:00
< em class = "property" > class < / em > < code class = "sig-name descname" > Credentials< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > user_name=None< / em > , < em class = "sig-param" > password=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.Credentials" title = "Permalink to this definition" > ¶< / a > < / dt >
2019-05-28 13:52:35 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.struct.VapiStruct< / span > < / code > < / p >
< p > The < code class = "docutils literal notranslate" > < span class = "pre" > Providers.Credentials< / span > < / code > class specifies user credentials to make a
successful connection to remote endpoint. < strong > Warning:< / strong > This class is
2020-01-27 03:59:56 -05:00
available as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.< / p >
2019-05-28 13:52:35 -04:00
< div class = "admonition tip" >
< p class = "admonition-title" > Tip< / p >
< p > The arguments are used to initialize data attributes with the same
names.< / p >
< / div >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > user_name< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < strong > Warning:< / strong > This attribute is
2020-01-27 03:59:56 -05:00
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.< / p > < / li >
2019-05-28 13:52:35 -04:00
< li > < p > < strong > password< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < strong > Warning:< / strong > This attribute is available as
2020-01-27 03:59:56 -05:00
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.< / p > < / li >
2019-05-28 13:52:35 -04:00
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
2018-08-07 19:42:25 -04:00
< dl class = "class" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.Info" >
2019-08-29 02:53:26 -04:00
< em class = "property" > class < / em > < code class = "sig-name descname" > Info< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > last_sync_time=None< / em > , < em class = "sig-param" > status=None< / em > , < em class = "sig-param" > polling_interval_in_seconds=None< / em > , < em class = "sig-param" > current_session_info=None< / em > , < em class = "sig-param" > status_message=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.Info" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.struct.VapiStruct< / span > < / code > < / p >
< p > The < code class = "docutils literal notranslate" > < span class = "pre" > Providers.Info< / span > < / code > class contains information about sync for a
2020-01-27 03:59:56 -05:00
provider. < strong > Warning:< / strong > This class is available as Technology Preview. These
are early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.< / p >
2018-08-07 19:42:25 -04:00
< div class = "admonition tip" >
2019-05-28 13:52:35 -04:00
< p class = "admonition-title" > Tip< / p >
< p > The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.< / p >
< / div >
2019-05-28 13:52:35 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > last_sync_time< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > datetime.datetime< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
2018-08-07 19:42:25 -04:00
either a background sync or a force sync was started for the
2020-01-27 03:59:56 -05:00
provider. < strong > Warning:< / strong > This attribute is available as Technology
Preview. These are early access APIs provided to test, automate and
provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.
2019-05-28 13:52:35 -04:00
If None no sync was found for the provider.< / p > < / li >
< li > < p > < strong > status< / strong > (< a class = "reference internal" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.Status" title = "com.vmware.vcenter.hvc.links.sync_client.Providers.Status" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Providers.Status< / span > < / code > < / a > ) – < strong > Warning:< / strong > This attribute is
2020-01-27 03:59:56 -05:00
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.< / p > < / li >
2019-05-28 13:52:35 -04:00
< li > < p > < strong > polling_interval_in_seconds< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > ) –
2020-01-27 03:59:56 -05:00
provider. < strong > Warning:< / strong > This attribute is available as Technology
Preview. These are early access APIs provided to test, automate and
provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.< / p > < / li >
2019-05-28 13:52:35 -04:00
< li > < p > < strong > current_session_info< / strong > (< a class = "reference internal" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo" title = "com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Providers.SessionInfo< / span > < / code > < / a > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
2020-01-27 03:59:56 -05:00
< strong > Warning:< / strong > This attribute is available as Technology Preview.
These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback,
VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.
2018-08-07 19:42:25 -04:00
If None there is no outstanding sync session created for this
2019-05-28 13:52:35 -04:00
provider< / p > < / li >
< li > < p > < strong > status_message< / strong > (< a class = "reference internal" href = "com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title = "com.vmware.vapi.std_client.LocalizableMessage" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std_client.LocalizableMessage< / span > < / code > < / a > ) – < strong > Warning:< / strong > This
2020-01-27 03:59:56 -05:00
attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.
2018-08-07 19:42:25 -04:00
This attribute is optional and it is only relevant when the value
2019-05-28 13:52:35 -04:00
of < code class = "docutils literal notranslate" > < span class = "pre" > status< / span > < / code > is < a class = "reference internal" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED" title = "com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED" > < code class = "xref py py-attr docutils literal notranslate" > < span class = "pre" > Providers.Status.FAILED< / span > < / code > < / a > .< / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-28 13:52:35 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.RESOURCE_TYPE" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > RESOURCE_TYPE< / code > < em class = "property" > = 'com.vmware.vcenter.hvc.links.sync.Providers'< / em > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.RESOURCE_TYPE" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Resource type for Sync Providers. < strong > Warning:< / strong > This class attribute is
2020-01-27 03:59:56 -05:00
available as Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology Preview APIs
might only be applicable to specific environments.< / p >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "class" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo" >
2019-08-29 02:53:26 -04:00
< em class = "property" > class < / em > < code class = "sig-name descname" > SessionInfo< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > stage=None< / em > , < em class = "sig-param" > completed_work=None< / em > , < em class = "sig-param" > total_work=None< / em > , < em class = "sig-param" > completion_time=None< / em > , < em class = "sig-param" > start_time=None< / em > , < em class = "sig-param" > exception=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.struct.VapiStruct< / span > < / code > < / p >
< p > The < code class = "docutils literal notranslate" > < span class = "pre" > Providers.SessionInfo< / span > < / code > class contains sync session information.
2020-01-27 03:59:56 -05:00
< strong > Warning:< / strong > This class is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.< / p >
2018-08-07 19:42:25 -04:00
< div class = "admonition tip" >
2019-05-28 13:52:35 -04:00
< p class = "admonition-title" > Tip< / p >
< p > The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.< / p >
< / div >
2019-05-28 13:52:35 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > stage< / strong > (< a class = "reference internal" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage" title = "com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Providers.SessionInfo.Stage< / span > < / code > < / a > ) – < strong > Warning:< / strong > This attribute is
2020-01-27 03:59:56 -05:00
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.< / p > < / li >
2019-05-28 13:52:35 -04:00
< li > < p > < strong > completed_work< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > ) – < strong > Warning:< / strong > This attribute is
2020-01-27 03:59:56 -05:00
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.< / p > < / li >
2019-05-28 13:52:35 -04:00
< li > < p > < strong > total_work< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > ) – < strong > Warning:< / strong > This attribute is
2020-01-27 03:59:56 -05:00
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.< / p > < / li >
2019-05-28 13:52:35 -04:00
< li > < p > < strong > completion_time< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > datetime.datetime< / span > < / code > ) – < strong > Warning:< / strong > This
2020-01-27 03:59:56 -05:00
attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.
2019-05-28 13:52:35 -04:00
If None there is an ongoing sync that has not completed< / p > < / li >
< li > < p > < strong > start_time< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > datetime.datetime< / span > < / code > ) – < strong > Warning:< / strong > This attribute
2020-01-27 03:59:56 -05:00
is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.< / p > < / li >
2019-05-28 13:52:35 -04:00
< li > < p > < strong > exception< / strong > (< a class = "reference internal" href = "com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title = "com.vmware.vapi.std_client.LocalizableMessage" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std_client.LocalizableMessage< / span > < / code > < / a > ) –
2020-01-27 03:59:56 -05:00
< strong > Warning:< / strong > This attribute is available as Technology Preview.
These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback,
VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.
2018-08-07 19:42:25 -04:00
This attribute is optional and it is only relevant when the value
2019-05-28 13:52:35 -04:00
of < code class = "docutils literal notranslate" > < span class = "pre" > stage< / span > < / code > is < a class = "reference internal" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED" title = "com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED" > < code class = "xref py py-attr docutils literal notranslate" > < span class = "pre" > Providers.SessionInfo.Stage.FAILED< / span > < / code > < / a > .< / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-28 13:52:35 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< dl class = "class" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage" >
2019-08-29 02:53:26 -04:00
< em class = "property" > class < / em > < code class = "sig-name descname" > Stage< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > string< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.enum.Enum< / span > < / code > < / p >
< p > The < code class = "docutils literal notranslate" > < span class = "pre" > Providers.SessionInfo.Stage< / span > < / code > class defines the different stages of
2020-01-27 03:59:56 -05:00
Sync. < strong > Warning:< / strong > This enumeration is available as Technology Preview.
These are early access APIs provided to test, automate and provide feedback
on the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.< / p >
2018-08-07 19:42:25 -04:00
< div class = "admonition note" >
2019-05-28 13:52:35 -04:00
< p class = "admonition-title" > Note< / p >
< p > This class represents an enumerated type in the interface language
2018-08-07 19:42:25 -04:00
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See < a class = "reference internal" href = "enumeration.html#enumeration-description" > < span class = "std std-ref" > enumerated
type description page< / span > < / a > .< / p >
< / div >
2019-05-28 13:52:35 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > string< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Stage< / span > < / code > instance.< / p >
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< dl class = "attribute" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_APPLICATION" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > CHANGE_APPLICATION< / code > < em class = "property" > = Stage(string='CHANGE_APPLICATION')< / em > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_APPLICATION" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Changes are being applied to the destination replica. < strong > Warning:< / strong > This
2020-01-27 03:59:56 -05:00
class attribute is available as Technology Preview. These are early access
APIs provided to test, automate and provide feedback on the feature. Since
this can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.< / p >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_DETECTION" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > CHANGE_DETECTION< / code > < em class = "property" > = Stage(string='CHANGE_DETECTION')< / em > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_DETECTION" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Changes are being detected on the source replica. < strong > Warning:< / strong > This class
2020-01-27 03:59:56 -05:00
attribute is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since this
can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.< / p >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_ENUMERATION" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > CHANGE_ENUMERATION< / code > < em class = "property" > = Stage(string='CHANGE_ENUMERATION')< / em > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_ENUMERATION" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Changes from the source replica are being enumerated. < strong > Warning:< / strong > This
2020-01-27 03:59:56 -05:00
class attribute is available as Technology Preview. These are early access
APIs provided to test, automate and provide feedback on the feature. Since
this can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.< / p >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.COMPLETED" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > COMPLETED< / code > < em class = "property" > = Stage(string='COMPLETED')< / em > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.COMPLETED" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Sync has completed. < strong > Warning:< / strong > This class attribute is available as
2020-01-27 03:59:56 -05:00
Technology Preview. These are early access APIs provided to test, automate
and provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology Preview APIs
might only be applicable to specific environments.< / p >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > FAILED< / code > < em class = "property" > = Stage(string='FAILED')< / em > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 03:59:56 -05:00
< dd > < p > Sync failed. < strong > Warning:< / strong > This class attribute is available as Technology
Preview. These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback, VMware
does not guarantee backwards compatibility and recommends against using
them in production environments. Some Technology Preview APIs might only be
applicable to specific environments.< / p >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.WAITING" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > WAITING< / code > < em class = "property" > = Stage(string='WAITING')< / em > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.WAITING" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Session is waiting for progress to be set. < strong > Warning:< / strong > This class
2020-01-27 03:59:56 -05:00
attribute is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since this
can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.< / p >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.Status" >
2019-08-29 02:53:26 -04:00
< em class = "property" > class < / em > < code class = "sig-name descname" > Status< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > string< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.Status" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.enum.Enum< / span > < / code > < / p >
< p > The < code class = "docutils literal notranslate" > < span class = "pre" > Providers.Status< / span > < / code > class defines valid sync status. < strong > Warning:< / strong > This
2020-01-27 03:59:56 -05:00
enumeration is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since this
can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.< / p >
2018-08-07 19:42:25 -04:00
< div class = "admonition note" >
2019-05-28 13:52:35 -04:00
< p class = "admonition-title" > Note< / p >
< p > This class represents an enumerated type in the interface language
2018-08-07 19:42:25 -04:00
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See < a class = "reference internal" href = "enumeration.html#enumeration-description" > < span class = "std std-ref" > enumerated
type description page< / span > < / a > .< / p >
< / div >
2019-05-28 13:52:35 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > string< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Status< / span > < / code > instance.< / p >
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< dl class = "attribute" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > FAILED< / code > < em class = "property" > = Status(string='FAILED')< / em > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 03:59:56 -05:00
< dd > < p > If Sync failed. < strong > Warning:< / strong > This class attribute is available as
Technology Preview. These are early access APIs provided to test, automate
and provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology Preview APIs
might only be applicable to specific environments.< / p >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.Status.NO_SYNC_FOUND" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > NO_SYNC_FOUND< / code > < em class = "property" > = Status(string='NO_SYNC_FOUND')< / em > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.NO_SYNC_FOUND" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > If Sync has not been triggered. < strong > Warning:< / strong > This class attribute is
2020-01-27 03:59:56 -05:00
available as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.< / p >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.Status.SUCCEEDED" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > SUCCEEDED< / code > < em class = "property" > = Status(string='SUCCEEDED')< / em > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.SUCCEEDED" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > If Sync was successful. < strong > Warning:< / strong > This class attribute is available as
2020-01-27 03:59:56 -05:00
Technology Preview. These are early access APIs provided to test, automate
and provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology Preview APIs
might only be applicable to specific environments.< / p >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.Summary" >
2019-08-29 02:53:26 -04:00
< em class = "property" > class < / em > < code class = "sig-name descname" > Summary< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > provider=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.Summary" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.struct.VapiStruct< / span > < / code > < / p >
< p > The < code class = "docutils literal notranslate" > < span class = "pre" > Providers.Summary< / span > < / code > class contains information about a provider.
2020-01-27 03:59:56 -05:00
< strong > Warning:< / strong > This class is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.< / p >
2018-08-07 19:42:25 -04:00
< div class = "admonition tip" >
2019-05-28 13:52:35 -04:00
< p class = "admonition-title" > Tip< / p >
< p > The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.< / p >
< / div >
2019-05-28 13:52:35 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > provider< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < strong > Warning:< / strong > This attribute is available as
2020-01-27 03:59:56 -05:00
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.
2018-08-07 19:42:25 -04:00
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
< code class = "docutils literal notranslate" > < span class = "pre" > com.vmware.vcenter.hvc.links.sync.Providers< / span > < / code > . When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
2019-05-28 13:52:35 -04:00
< code class = "docutils literal notranslate" > < span class = "pre" > com.vmware.vcenter.hvc.links.sync.Providers< / span > < / code > .< / p >
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.get" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > link< / em > , < em class = "sig-param" > provider< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 03:59:56 -05:00
< dd > < p > Gets Sync information for a sync provider. Usage beyond VMware Cloud on
AWS is not supported. < strong > Warning:< / strong > This method is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility
and recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.< / p >
2019-05-28 13:52:35 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > link< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) –
2018-08-07 19:42:25 -04:00
The parameter must be an identifier for the resource type:
2019-05-28 13:52:35 -04:00
< code class = "docutils literal notranslate" > < span class = "pre" > com.vmware.vcenter.hvc.Links< / span > < / code > .< / p > < / li >
< li > < p > < strong > provider< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) –
2018-08-07 19:42:25 -04:00
The parameter must be an identifier for the resource type:
2019-05-28 13:52:35 -04:00
< code class = "docutils literal notranslate" > < span class = "pre" > com.vmware.vcenter.hvc.sync.Providers< / span > < / code > .< / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-28 13:52:35 -04:00
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.Info" title = "com.vmware.vcenter.hvc.links.sync_client.Providers.Info" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Providers.Info< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > The Info of sync information for the provider.< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title = "com.vmware.vapi.std.errors_client.Error" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Error< / span > < / code > < / a >
2018-08-07 19:42:25 -04:00
if the system reports an error while responding to the request.< / p >
2019-05-28 13:52:35 -04:00
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < a class = "reference internal" href = "com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title = "com.vmware.vapi.std.errors_client.NotFound" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code > < / a >
2018-08-07 19:42:25 -04:00
if the sync provider associated with < code class = "docutils literal notranslate" > < span class = "pre" > provider< / span > < / code > does not exist.< / p >
2019-05-28 13:52:35 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title = "com.vmware.vapi.std.errors_client.Unauthorized" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code > < / a >
2018-08-07 19:42:25 -04:00
if the user is not authorized to perform this operation.< / p >
2019-05-28 13:52:35 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.list" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > link< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 03:59:56 -05:00
< dd > < p > Enumerates the sync providers. Usage beyond VMware Cloud on AWS is not
supported. < strong > Warning:< / strong > This method is available as Technology Preview.
These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback,
VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology Preview
APIs might only be applicable to specific environments.< / p >
2019-05-28 13:52:35 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > link< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) –
2018-08-07 19:42:25 -04:00
The parameter must be an identifier for the resource type:
2019-05-28 13:52:35 -04:00
< code class = "docutils literal notranslate" > < span class = "pre" > com.vmware.vcenter.hvc.Links< / span > < / code > .< / p >
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.list" title = "com.vmware.vcenter.hvc.links.sync_client.Providers.list" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > list< / span > < / code > < / a > of < a class = "reference internal" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.Summary" title = "com.vmware.vcenter.hvc.links.sync_client.Providers.Summary" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Providers.Summary< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > The < a class = "reference internal" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.list" title = "com.vmware.vcenter.hvc.links.sync_client.Providers.list" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > list< / span > < / code > < / a > of sync provider information.< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title = "com.vmware.vapi.std.errors_client.Error" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Error< / span > < / code > < / a >
If list fails.< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < a class = "reference internal" href = "com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title = "com.vmware.vapi.std.errors_client.Unauthorized" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code > < / a >
If the user is not authorized to perform this operation.< / p >
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.Providers.start" >
2019-08-29 02:53:26 -04:00
< code class = "sig-name descname" > start< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > link< / em > , < em class = "sig-param" > provider< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.Providers.start" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Initiates synchronization between the local and remote replicas for the
2020-01-27 03:59:56 -05:00
sync provider. Usage beyond VMware Cloud on AWS is not supported.
< strong > Warning:< / strong > This method is available as Technology Preview. These are
early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.< / p >
2019-05-28 13:52:35 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > link< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) –
2018-08-07 19:42:25 -04:00
The parameter must be an identifier for the resource type:
2019-05-28 13:52:35 -04:00
< code class = "docutils literal notranslate" > < span class = "pre" > com.vmware.vcenter.hvc.Links< / span > < / code > .< / p > < / li >
< li > < p > < strong > provider< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) –
2018-08-07 19:42:25 -04:00
The parameter must be an identifier for the resource type:
2019-05-28 13:52:35 -04:00
< code class = "docutils literal notranslate" > < span class = "pre" > com.vmware.vcenter.hvc.sync.Providers< / span > < / code > .< / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-28 13:52:35 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title = "com.vmware.vapi.std.errors_client.Error" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Error< / span > < / code > < / a >
2018-08-07 19:42:25 -04:00
if the system reports an error while responding to the request.< / p >
2019-05-28 13:52:35 -04:00
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < a class = "reference internal" href = "com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title = "com.vmware.vapi.std.errors_client.NotFound" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code > < / a >
2018-08-07 19:42:25 -04:00
if the link associated with < code class = "docutils literal notranslate" > < span class = "pre" > link< / span > < / code > does not exist if the provider
associated with < code class = "docutils literal notranslate" > < span class = "pre" > provider< / span > < / code > is not registered for sync< / p >
2019-05-28 13:52:35 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title = "com.vmware.vapi.std.errors_client.Unauthorized" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code > < / a >
2018-08-07 19:42:25 -04:00
if the user is not authorized to perform this operation.< / p >
2019-05-28 13:52:35 -04:00
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < a class = "reference internal" href = "com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title = "com.vmware.vapi.std.errors_client.ResourceBusy" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ResourceBusy< / span > < / code > < / a >
2018-08-07 19:42:25 -04:00
if a sync is already running.< / p >
2019-05-28 13:52:35 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
< dt id = "com.vmware.vcenter.hvc.links.sync_client.StubFactory" >
2019-08-29 02:53:26 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.vcenter.hvc.links.sync_client.< / code > < code class = "sig-name descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.vcenter.hvc.links.sync_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
< p > Initialize StubFactoryBase< / p >
2019-05-28 13:52:35 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "com.vmware.vcenter.storage.html" class = "btn btn-neutral float-right" title = "com.vmware.vcenter.storage package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2019-05-28 13:52:35 -04:00
< a href = "com.vmware.vcenter.hvc.html" class = "btn btn-neutral float-left" title = "com.vmware.vcenter.hvc package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2018-08-07 19:42:25 -04:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2020-01-27 03:59:56 -05:00
© Copyright 2020, VMware, Inc.
2018-08-07 19:42:25 -04:00
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
2019-05-28 13:52:35 -04:00
< / script >
2018-08-07 19:42:25 -04:00
< / body >
< / html >
