vsphere-automation-sdk-python/nsx/nsx_policy/com.vmware.nsx_policy.cluster.html



<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>com.vmware.nsx_policy.cluster package &mdash; NSX-T Policy SDK 3.0.3.0.0 documentation</title>
  

  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <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>

    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="com.vmware.nsx_policy.global_infra package" href="com.vmware.nsx_policy.global_infra.html" />
    <link rel="prev" title="com.vmware.nsx_policy.aaa package" href="com.vmware.nsx_policy.aaa.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">
        <div class="wy-side-nav-search" >
          

            <a href="index.html" class="icon icon-home"> NSX-T Policy SDK
          

          </a>

          
              <div class="version">
                3.0.3.0.0
              </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.nsx_policy_client">com.vmware.nsx_policy_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-policy-client-for-vmc-module">com.vmware.nsx_policy_client_for_vmc module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</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>
          <a href="index.html">NSX-T Policy SDK</a>
        
      </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" class="icon icon-home"></a> &raquo;</li>
        
          <li><a href="com.html">com package</a> &raquo;</li>
        
          <li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
        
          <li><a href="com.vmware.nsx_policy.html">com.vmware.nsx_policy package</a> &raquo;</li>
        
      <li>com.vmware.nsx_policy.cluster package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/com.vmware.nsx_policy.cluster.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.nsx_policy.cluster">
<span id="com-vmware-nsx-policy-cluster-package"></span><h1>com.vmware.nsx_policy.cluster package<a class="headerlink" href="#module-com.vmware.nsx_policy.cluster" 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.nsx_policy.cluster.backups_client">
<span id="com-vmware-nsx-policy-cluster-backups-client-module"></span><h2>com.vmware.nsx_policy.cluster.backups_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.cluster.backups_client" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Config">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><code class="descname">Config</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_GLOBAL_MANAGER">
<code class="descname">UPDATE_FRAME_TYPE_GLOBAL_MANAGER</code><em class="property"> = 'GLOBAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_GLOBAL_MANAGER" title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Config.update" title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Config.update()</span></code></a>.</p>
</dd></dl>

<dl class="attribute">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_LOCAL_LOCAL_MANAGER">
<code class="descname">UPDATE_FRAME_TYPE_LOCAL_LOCAL_MANAGER</code><em class="property"> = 'LOCAL_LOCAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_LOCAL_LOCAL_MANAGER" title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Config.update" title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Config.update()</span></code></a>.</p>
</dd></dl>

<dl class="attribute">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_LOCAL_MANAGER">
<code class="descname">UPDATE_FRAME_TYPE_LOCAL_MANAGER</code><em class="property"> = 'LOCAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_LOCAL_MANAGER" title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Config.update" title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Config.update()</span></code></a>.</p>
</dd></dl>

<dl class="attribute">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_NSX_INTELLIGENCE">
<code class="descname">UPDATE_FRAME_TYPE_NSX_INTELLIGENCE</code><em class="property"> = 'NSX_INTELLIGENCE'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_NSX_INTELLIGENCE" title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Config.update" title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Config.update()</span></code></a>.</p>
</dd></dl>

<dl class="method">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.get">
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a configuration of a file server and timers for automated backup.
Fields that contain secrets (password, passphrase) are not returned.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BackupConfiguration" title="com.vmware.nsx_policy.model_client.BackupConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BackupConfiguration</span></code></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_policy.model.BackupConfiguration</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code> 
Service Unavailable</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code> 
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code> 
Internal Server Error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code> 
Forbidden</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code> 
Not Found</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>backup_configuration</em>, <em>frame_type=None</em>, <em>site_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Configure file server and timers for automated backup. If secret fields
are omitted (password, passphrase) then use the previously set value.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>backup_configuration</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BackupConfiguration" title="com.vmware.nsx_policy.model_client.BackupConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BackupConfiguration</span></code></a>) – (required)</li>
<li><strong>frame_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Frame type (optional, default to LOCAL_LOCAL_MANAGER)</li>
<li><strong>site_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Site ID (optional, default to localhost)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BackupConfiguration" title="com.vmware.nsx_policy.model_client.BackupConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BackupConfiguration</span></code></a></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_policy.model.BackupConfiguration</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code> 
Service Unavailable</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code> 
Bad Request, Precondition Failed</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code> 
Internal Server Error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code> 
Forbidden</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code> 
Not Found</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="com.vmware.nsx_policy.cluster.backups_client.History">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><code class="descname">History</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.History" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="com.vmware.nsx_policy.cluster.backups_client.History.get">
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.History.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get history of previous backup operations</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BackupOperationHistory" title="com.vmware.nsx_policy.model_client.BackupOperationHistory"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BackupOperationHistory</span></code></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_policy.model.BackupOperationHistory</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code> 
Service Unavailable</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code> 
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code> 
Internal Server Error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code> 
Forbidden</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code> 
Not Found</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><code class="descname">Overview</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_GLOBAL_MANAGER">
<code class="descname">LIST_FRAME_TYPE_GLOBAL_MANAGER</code><em class="property"> = 'GLOBAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_GLOBAL_MANAGER" title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list" title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Overview.list()</span></code></a>.</p>
</dd></dl>

<dl class="attribute">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_LOCAL_LOCAL_MANAGER">
<code class="descname">LIST_FRAME_TYPE_LOCAL_LOCAL_MANAGER</code><em class="property"> = 'LOCAL_LOCAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_LOCAL_LOCAL_MANAGER" title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list" title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Overview.list()</span></code></a>.</p>
</dd></dl>

<dl class="attribute">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_LOCAL_MANAGER">
<code class="descname">LIST_FRAME_TYPE_LOCAL_MANAGER</code><em class="property"> = 'LOCAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_LOCAL_MANAGER" title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list" title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Overview.list()</span></code></a>.</p>
</dd></dl>

<dl class="attribute">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_NSX_INTELLIGENCE">
<code class="descname">LIST_FRAME_TYPE_NSX_INTELLIGENCE</code><em class="property"> = 'NSX_INTELLIGENCE'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_NSX_INTELLIGENCE" title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list" title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Overview.list()</span></code></a>.</p>
</dd></dl>

<dl class="method">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview.list">
<code class="descname">list</code><span class="sig-paren">(</span><em>cursor=None</em>, <em>frame_type=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>show_backups_list=None</em>, <em>site_id=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a configuration of a file server, timers for automated backup,
latest backup status, backups list for a site. Fields that contain
secrets (password, passphrase) are not returned.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</li>
<li><strong>frame_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Frame type (optional, default to LOCAL_LOCAL_MANAGER)</li>
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</li>
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</li>
<li><strong>show_backups_list</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Need a list of backups (optional, default to true)</li>
<li><strong>site_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Site ID (optional, default to localhost)</li>
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BackupOverview" title="com.vmware.nsx_policy.model_client.BackupOverview"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BackupOverview</span></code></a></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_policy.model.BackupOverview</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code> 
Service Unavailable</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code> 
Bad Request, Precondition Failed</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code> 
Internal Server Error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code> 
Forbidden</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code> 
Not Found</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Status">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Status" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="com.vmware.nsx_policy.cluster.backups_client.Status.get">
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Status.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get status of active backup operations</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CurrentBackupOperationStatus" title="com.vmware.nsx_policy.model_client.CurrentBackupOperationStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.CurrentBackupOperationStatus</span></code></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_policy.model.CurrentBackupOperationStatus</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code> 
Service Unavailable</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code> 
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code> 
Internal Server Error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code> 
Forbidden</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code> 
Not Found</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="com.vmware.nsx_policy.cluster.backups_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.StubFactory" title="Permalink to this definition">¶</a></dt>
<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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="module-com.vmware.nsx_policy.cluster.restore_client">
<span id="com-vmware-nsx-policy-cluster-restore-client-module"></span><h2>com.vmware.nsx_policy.cluster.restore_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.cluster.restore_client" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><code class="descname">Backuptimestamps</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns timestamps for all backup files that are available on the SFTP
server.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</li>
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</li>
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</li>
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ClusterBackupInfoListResult" title="com.vmware.nsx_policy.model_client.ClusterBackupInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.ClusterBackupInfoListResult</span></code></a></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_policy.model.ClusterBackupInfoListResult</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code> 
Service Unavailable</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code> 
Bad Request, Precondition Failed</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code> 
Internal Server Error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code> 
Forbidden</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code> 
Not Found</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="com.vmware.nsx_policy.cluster.restore_client.Config">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><code class="descname">Config</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.Config" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="com.vmware.nsx_policy.cluster.restore_client.Config.get">
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.Config.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Deprecated. Please use API /cluster/backups/config, to get remote file
server(where backuped-up files are stored) details durign restore. In
older versions - Get configuration information for the file server used
to store backed-up files. Fields that contain secrets (password,
passphrase) are not returned.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RestoreConfiguration" title="com.vmware.nsx_policy.model_client.RestoreConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.RestoreConfiguration</span></code></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_policy.model.RestoreConfiguration</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code> 
Service Unavailable</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code> 
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code> 
Internal Server Error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code> 
Forbidden</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code> 
Not Found</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="com.vmware.nsx_policy.cluster.restore_client.Config.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>restore_configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.Config.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Deprecated. Please use API /cluster/backups/config, to configure remote
file server(where backed-up files are stored) details during restore.
In older versions - Configure file server where the backed-up files
used for the Restore operation are available.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>restore_configuration</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RestoreConfiguration" title="com.vmware.nsx_policy.model_client.RestoreConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.RestoreConfiguration</span></code></a>) – (required)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RestoreConfiguration" title="com.vmware.nsx_policy.model_client.RestoreConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.RestoreConfiguration</span></code></a></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_policy.model.RestoreConfiguration</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code> 
Service Unavailable</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code> 
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code> 
Internal Server Error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code> 
Forbidden</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code> 
Not Found</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="com.vmware.nsx_policy.cluster.restore_client.InstructionResources">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><code class="descname">InstructionResources</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.InstructionResources" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="com.vmware.nsx_policy.cluster.restore_client.InstructionResources.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>instruction_id</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.InstructionResources.get" title="Permalink to this definition">¶</a></dt>
<dd><p>For restore operations requiring user input e.g. performing an action,
accepting/rejecting an action, etc. the information to be conveyed to
users is provided in this call.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>instruction_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the instruction set whose instructions are to be returned
(required)</li>
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</li>
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</li>
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</li>
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ActionableResourceListResult" title="com.vmware.nsx_policy.model_client.ActionableResourceListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.ActionableResourceListResult</span></code></a></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_policy.model.ActionableResourceListResult</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code> 
Service Unavailable</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code> 
Bad Request, Precondition Failed</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code> 
Internal Server Error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code> 
Forbidden</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code> 
Not Found</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="com.vmware.nsx_policy.cluster.restore_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.StubFactory" title="Permalink to this definition">¶</a></dt>
<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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
</div>


           </div>
           
          </div>
          <footer>
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
        <a href="com.vmware.nsx_policy.global_infra.html" class="btn btn-neutral float-right" title="com.vmware.nsx_policy.global_infra package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
        <a href="com.vmware.nsx_policy.aaa.html" class="btn btn-neutral float-left" title="com.vmware.nsx_policy.aaa package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; Copyright 2021, VMware, Inc..

    </p>
  </div>
    
    
    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    
    <a href="https://github.com/readthedocs/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);
      });
  </script>

  
</body>
</html>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
 								<!DOCTYPE html>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<html class="writer-html4" lang="en" >
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<head>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								  <meta charset="utf-8" />
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								  <title>com.vmware.nsx_policy.cluster package &mdash; NSX-T Policy SDK 3.0.3.0.0 documentation</title>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
 								  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								  <!--[if lt IE 9]>
 								    <script src="_static/js/html5shiv.min.js"></script>
 								  <![endif]-->
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												Update NSX documentation to M7

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2019-05-29 14:05:24 -04:00
+								      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								        <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>
-												Update NSX documentation to M7

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2019-05-29 14:05:24 -04:00
 								    <script type="text/javascript" src="_static/js/theme.js"></script>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												Update NSX documentation to M7

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2019-05-29 14:05:24 -04:00
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								    <link rel="index" title="Index" href="genindex.html" />
 								    <link rel="search" title="Search" href="search.html" />
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								    <link rel="next" title="com.vmware.nsx_policy.global_infra package" href="com.vmware.nsx_policy.global_infra.html" />
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								    <link rel="prev" title="com.vmware.nsx_policy.aaa package" href="com.vmware.nsx_policy.aaa.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">
-												Update NSX documentation to M7

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2019-05-29 14:05:24 -04:00
+								        <div class="wy-side-nav-search" >
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								            <a href="index.html" class="icon icon-home"> NSX-T Policy SDK
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
 								          </a>
 								              <div class="version">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+.0.3.0.0
-												add vsphere, vmc and nsx API docs

											
										
										
											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>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								        <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.nsx_policy_client">com.vmware.nsx_policy_client module</a></li>
-												Upgrade NSX SDKs to VMC 1.11 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-06-05 18:48:31 -04:00
+								<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-policy-client-for-vmc-module">com.vmware.nsx_policy_client_for_vmc module</a></li>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</ul>
 								</li>
 								</ul>
 								</li>
 								</ul>
 								</li>
 								</ul>
 								        </div>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								      </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>
 								          <a href="index.html">NSX-T Policy SDK</a>
 								      </nav>
 								      <div class="wy-nav-content">
 								        <div class="rst-content">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<div role="navigation" aria-label="breadcrumbs navigation">
 								  <ul class="wy-breadcrumbs">
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
 								          <li><a href="com.html">com package</a> &raquo;</li>
 								          <li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
 								          <li><a href="com.vmware.nsx_policy.html">com.vmware.nsx_policy package</a> &raquo;</li>
 								      <li>com.vmware.nsx_policy.cluster package</li>
 								      <li class="wy-breadcrumbs-aside">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								            <a href="_sources/com.vmware.nsx_policy.cluster.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.nsx_policy.cluster">
 								<span id="com-vmware-nsx-policy-cluster-package"></span><h1>com.vmware.nsx_policy.cluster package<a class="headerlink" href="#module-com.vmware.nsx_policy.cluster" 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.nsx_policy.cluster.backups_client">
 								<span id="com-vmware-nsx-policy-cluster-backups-client-module"></span><h2>com.vmware.nsx_policy.cluster.backups_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.cluster.backups_client" title="Permalink to this headline">¶</a></h2>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="class">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Config">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><code class="descname">Config</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											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>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
 								</tr>
 								</tbody>
 								</table>
 								<dl class="attribute">
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_GLOBAL_MANAGER">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">UPDATE_FRAME_TYPE_GLOBAL_MANAGER</code><em class="property"> = 'GLOBAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_GLOBAL_MANAGER" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Config.update" title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Config.update()</span></code></a>.</p>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="attribute">
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_LOCAL_LOCAL_MANAGER">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">UPDATE_FRAME_TYPE_LOCAL_LOCAL_MANAGER</code><em class="property"> = 'LOCAL_LOCAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_LOCAL_LOCAL_MANAGER" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Config.update" title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Config.update()</span></code></a>.</p>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="attribute">
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_LOCAL_MANAGER">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">UPDATE_FRAME_TYPE_LOCAL_MANAGER</code><em class="property"> = 'LOCAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_LOCAL_MANAGER" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Config.update" title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Config.update()</span></code></a>.</p>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="attribute">
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_NSX_INTELLIGENCE">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">UPDATE_FRAME_TYPE_NSX_INTELLIGENCE</code><em class="property"> = 'NSX_INTELLIGENCE'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.UPDATE_FRAME_TYPE_NSX_INTELLIGENCE" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Config.update" title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Config.update()</span></code></a>.</p>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="method">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.get">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.get" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dd><p>Get a configuration of a file server and timers for automated backup.
 								Fields that contain secrets (password, passphrase) are not returned.</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BackupConfiguration" title="com.vmware.nsx_policy.model_client.BackupConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BackupConfiguration</span></code></a></td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_policy.model.BackupConfiguration</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
 								Service Unavailable</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
 								Bad Request, Precondition Failed</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
 								Internal Server Error</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
 								Forbidden</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
 								Not Found</td>
 								</tr>
 								</tbody>
 								</table>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="method">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Config.update">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">update</code><span class="sig-paren">(</span><em>backup_configuration</em>, <em>frame_type=None</em>, <em>site_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Config.update" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dd><p>Configure file server and timers for automated backup. If secret fields
 								are omitted (password, passphrase) then use the previously set value.</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 								<li><strong>backup_configuration</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BackupConfiguration" title="com.vmware.nsx_policy.model_client.BackupConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BackupConfiguration</span></code></a>) – (required)</li>
 								<li><strong>frame_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Frame type (optional, default to LOCAL_LOCAL_MANAGER)</li>
 								<li><strong>site_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Site ID (optional, default to localhost)</li>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								</ul>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BackupConfiguration" title="com.vmware.nsx_policy.model_client.BackupConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BackupConfiguration</span></code></a></p>
 								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_policy.model.BackupConfiguration</p>
 								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
-												Update NSX documentation to M7

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2019-05-29 14:05:24 -04:00
+								Service Unavailable</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
-												Update NSX documentation to M7

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2019-05-29 14:05:24 -04:00
+								Bad Request, Precondition Failed</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
-												Update NSX documentation to M7

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2019-05-29 14:05:24 -04:00
+								Internal Server Error</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
-												Update NSX documentation to M7

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2019-05-29 14:05:24 -04:00
+								Forbidden</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
-												Update NSX documentation to M7

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2019-05-29 14:05:24 -04:00
+								Not Found</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								</tbody>
 								</table>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="class">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.History">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><code class="descname">History</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.History" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											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>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
 								</tr>
 								</tbody>
 								</table>
 								<dl class="method">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.History.get">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.History.get" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dd><p>Get history of previous backup operations</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BackupOperationHistory" title="com.vmware.nsx_policy.model_client.BackupOperationHistory"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BackupOperationHistory</span></code></a></td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_policy.model.BackupOperationHistory</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
 								Service Unavailable</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
 								Bad Request, Precondition Failed</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
 								Internal Server Error</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
 								Forbidden</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
 								Not Found</td>
 								</tr>
 								</tbody>
 								</table>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="class">
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><code class="descname">Overview</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -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>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
 								</tr>
 								</tbody>
 								</table>
 								<dl class="attribute">
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_GLOBAL_MANAGER">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">LIST_FRAME_TYPE_GLOBAL_MANAGER</code><em class="property"> = 'GLOBAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_GLOBAL_MANAGER" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list" title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Overview.list()</span></code></a>.</p>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="attribute">
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_LOCAL_LOCAL_MANAGER">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">LIST_FRAME_TYPE_LOCAL_LOCAL_MANAGER</code><em class="property"> = 'LOCAL_LOCAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_LOCAL_LOCAL_MANAGER" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list" title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Overview.list()</span></code></a>.</p>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="attribute">
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_LOCAL_MANAGER">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">LIST_FRAME_TYPE_LOCAL_MANAGER</code><em class="property"> = 'LOCAL_MANAGER'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_LOCAL_MANAGER" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list" title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Overview.list()</span></code></a>.</p>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="attribute">
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_NSX_INTELLIGENCE">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">LIST_FRAME_TYPE_NSX_INTELLIGENCE</code><em class="property"> = 'NSX_INTELLIGENCE'</em><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.LIST_FRAME_TYPE_NSX_INTELLIGENCE" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">frameType</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list" title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Overview.list()</span></code></a>.</p>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="method">
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Overview.list">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">list</code><span class="sig-paren">(</span><em>cursor=None</em>, <em>frame_type=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>show_backups_list=None</em>, <em>site_id=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dd><p>Get a configuration of a file server, timers for automated backup,
 								latest backup status, backups list for a site. Fields that contain
 								secrets (password, passphrase) are not returned.</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 								<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
 								by current result page) (optional)</li>
 								<li><strong>frame_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Frame type (optional, default to LOCAL_LOCAL_MANAGER)</li>
 								<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
 								result (optional)</li>
 								<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
 								fewer) (optional, default to 1000)</li>
 								<li><strong>show_backups_list</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Need a list of backups (optional, default to true)</li>
 								<li><strong>site_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Site ID (optional, default to localhost)</li>
 								<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
 								<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								</ul>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BackupOverview" title="com.vmware.nsx_policy.model_client.BackupOverview"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BackupOverview</span></code></a></p>
 								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_policy.model.BackupOverview</p>
 								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								Service Unavailable</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								Bad Request, Precondition Failed</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								Internal Server Error</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								Forbidden</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								Not Found</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								</tbody>
 								</table>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								</dd></dl>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="class">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Status">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Status" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											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>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
 								</tr>
 								</tbody>
 								</table>
 								<dl class="method">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.Status.get">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.Status.get" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dd><p>Get status of active backup operations</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CurrentBackupOperationStatus" title="com.vmware.nsx_policy.model_client.CurrentBackupOperationStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.CurrentBackupOperationStatus</span></code></a></td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_policy.model.CurrentBackupOperationStatus</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
 								Service Unavailable</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
 								Bad Request, Precondition Failed</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
 								Internal Server Error</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
 								Forbidden</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
 								Not Found</td>
 								</tr>
 								</tbody>
 								</table>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="class">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.backups_client.StubFactory">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.backups_client.StubFactory" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											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>
-												Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709)

Signed-off-by: Gordon Good <ggood@vmware.com>

											
										
										
											2018-11-01 14:01:54 -04:00
+								<p>Initialize StubFactoryBase</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
 								</tr>
 								</tbody>
 								</table>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								</div>
 								<div class="section" id="module-com.vmware.nsx_policy.cluster.restore_client">
 								<span id="com-vmware-nsx-policy-cluster-restore-client-module"></span><h2>com.vmware.nsx_policy.cluster.restore_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.cluster.restore_client" title="Permalink to this headline">¶</a></h2>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="class">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><code class="descname">Backuptimestamps</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											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>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
 								</tr>
 								</tbody>
 								</table>
 								<dl class="method">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps.get">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">get</code><span class="sig-paren">(</span><em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps.get" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dd><p>Returns timestamps for all backup files that are available on the SFTP
 								server.</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 								<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
 								by current result page) (optional)</li>
 								<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
 								result (optional)</li>
 								<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
 								fewer) (optional, default to 1000)</li>
 								<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
 								<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</ul>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ClusterBackupInfoListResult" title="com.vmware.nsx_policy.model_client.ClusterBackupInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.ClusterBackupInfoListResult</span></code></a></p>
 								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_policy.model.ClusterBackupInfoListResult</p>
 								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								Service Unavailable</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								Bad Request, Precondition Failed</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								Internal Server Error</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								Forbidden</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								Not Found</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								</tbody>
 								</table>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="class">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.restore_client.Config">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><code class="descname">Config</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.Config" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											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>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
 								</tr>
 								</tbody>
 								</table>
 								<dl class="method">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.restore_client.Config.get">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.Config.get" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dd><p>Deprecated. Please use API /cluster/backups/config, to get remote file
 								server(where backuped-up files are stored) details durign restore. In
 								older versions - Get configuration information for the file server used
 								to store backed-up files. Fields that contain secrets (password,
 								passphrase) are not returned.</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RestoreConfiguration" title="com.vmware.nsx_policy.model_client.RestoreConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.RestoreConfiguration</span></code></a></td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_policy.model.RestoreConfiguration</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
 								Service Unavailable</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
 								Bad Request, Precondition Failed</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
 								Internal Server Error</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
 								Forbidden</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
 								Not Found</td>
 								</tr>
 								</tbody>
 								</table>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="method">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.restore_client.Config.update">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">update</code><span class="sig-paren">(</span><em>restore_configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.Config.update" title="Permalink to this definition">¶</a></dt>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
+								<dd><p>Deprecated. Please use API /cluster/backups/config, to configure remote
 								file server(where backed-up files are stored) details during restore.
 								In older versions - Configure file server where the backed-up files
 								used for the Restore operation are available.</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>restore_configuration</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RestoreConfiguration" title="com.vmware.nsx_policy.model_client.RestoreConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.RestoreConfiguration</span></code></a>) – (required)</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RestoreConfiguration" title="com.vmware.nsx_policy.model_client.RestoreConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.RestoreConfiguration</span></code></a></td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_policy.model.RestoreConfiguration</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
 								Service Unavailable</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
 								Bad Request, Precondition Failed</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
 								Internal Server Error</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
 								Forbidden</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
 								Not Found</td>
 								</tr>
 								</tbody>
 								</table>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="class">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.restore_client.InstructionResources">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><code class="descname">InstructionResources</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.InstructionResources" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											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>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
 								</tr>
 								</tbody>
 								</table>
 								<dl class="method">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.restore_client.InstructionResources.get">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<code class="descname">get</code><span class="sig-paren">(</span><em>instruction_id</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.InstructionResources.get" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dd><p>For restore operations requiring user input e.g. performing an action,
 								accepting/rejecting an action, etc. the information to be conveyed to
 								users is provided in this call.</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 								<li><strong>instruction_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the instruction set whose instructions are to be returned
 								(required)</li>
 								<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
 								by current result page) (optional)</li>
 								<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
 								result (optional)</li>
 								<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
 								fewer) (optional, default to 1000)</li>
 								<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
 								<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</ul>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ActionableResourceListResult" title="com.vmware.nsx_policy.model_client.ActionableResourceListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.ActionableResourceListResult</span></code></a></p>
 								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_policy.model.ActionableResourceListResult</p>
 								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								Service Unavailable</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								Bad Request, Precondition Failed</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								Internal Server Error</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								Forbidden</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								Not Found</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								</td>
 								</tr>
 								</tbody>
 								</table>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								</dd></dl>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<dl class="class">
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dt id="com.vmware.nsx_policy.cluster.restore_client.StubFactory">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.cluster.restore_client.StubFactory" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											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>
-												Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709)

Signed-off-by: Gordon Good <ggood@vmware.com>

											
										
										
											2018-11-01 14:01:54 -04:00
+								<p>Initialize StubFactoryBase</p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								<table class="docutils field-list" frame="void" rules="none">
 								<col class="field-name" />
 								<col class="field-body" />
 								<tbody valign="top">
 								<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
 								</tr>
 								</tbody>
 								</table>
-												add vsphere, vmc and nsx API docs

											
										
										
											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">
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								        <a href="com.vmware.nsx_policy.global_infra.html" class="btn btn-neutral float-right" title="com.vmware.nsx_policy.global_infra package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
 								        <a href="com.vmware.nsx_policy.aaa.html" class="btn btn-neutral float-left" title="com.vmware.nsx_policy.aaa package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								    </div>
 								  <hr/>
 								  <div role="contentinfo">
 								    <p>
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								        &#169; Copyright 2021, VMware, Inc..
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
 								    </p>
 								  </div>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
-												Upgrade NSX docs to M14 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2021-03-31 18:40:01 -04:00
+								    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
-												Upgrade NSX SDKs to VMC 1.12 release

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2020-09-21 16:47:14 -04:00
 								    provided by <a href="https://readthedocs.org">Read the Docs</a>.
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
 								</footer>
 								        </div>
 								      </div>
 								    </section>
 								  </div>
 								  <script type="text/javascript">
 								      jQuery(function () {
-												Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709)

Signed-off-by: Gordon Good <ggood@vmware.com>

											
										
										
											2018-11-01 14:01:54 -04:00
+								          SphinxRtdTheme.Navigation.enable(true);
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								      });
-												Update NSX documentation to M7

Signed-Off-By: Gordon Good <ggood@vmware.com>

											
										
										
											2019-05-29 14:05:24 -04:00
+								  </script>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
 								</body>
 								</html>