<spanid="com-vmware-nsx-policy-cluster-package"></span><h1>com.vmware.nsx_policy.cluster package<aclass="headerlink"href="#module-com.vmware.nsx_policy.cluster"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-nsx-policy-cluster-backups-client-module"></span><h2>com.vmware.nsx_policy.cluster.backups_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.cluster.backups_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><codeclass="sig-name descname">Config</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.Config"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">UPDATE_FRAME_TYPE_GLOBAL_MANAGER</code><emclass="property"> = 'GLOBAL_MANAGER'</em><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">frameType</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.cluster.backups_client.Config.update"title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Config.update()</span></code></a>.</p>
<codeclass="sig-name descname">UPDATE_FRAME_TYPE_LOCAL_LOCAL_MANAGER</code><emclass="property"> = 'LOCAL_LOCAL_MANAGER'</em><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">frameType</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.cluster.backups_client.Config.update"title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Config.update()</span></code></a>.</p>
<codeclass="sig-name descname">UPDATE_FRAME_TYPE_LOCAL_MANAGER</code><emclass="property"> = 'LOCAL_MANAGER'</em><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">frameType</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.cluster.backups_client.Config.update"title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Config.update()</span></code></a>.</p>
<codeclass="sig-name descname">UPDATE_FRAME_TYPE_NSX_INTELLIGENCE</code><emclass="property"> = 'NSX_INTELLIGENCE'</em><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">frameType</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.cluster.backups_client.Config.update"title="com.vmware.nsx_policy.cluster.backups_client.Config.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Config.update()</span></code></a>.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.Config.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">backup_configuration</span></em>, <emclass="sig-param"><spanclass="n">frame_type</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">site_id</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.Config.update"title="Permalink to this definition">¶</a></dt>
<li><p><strong>frame_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Frame type (optional, default to LOCAL_LOCAL_MANAGER)</p></li>
<li><p><strong>site_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Site ID (optional, default to localhost)</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><codeclass="sig-name descname">History</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.History"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.History.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><codeclass="sig-name descname">Overview</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.Overview"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">LIST_FRAME_TYPE_GLOBAL_MANAGER</code><emclass="property"> = 'GLOBAL_MANAGER'</em><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">frameType</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list"title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Overview.list()</span></code></a>.</p>
<codeclass="sig-name descname">LIST_FRAME_TYPE_LOCAL_LOCAL_MANAGER</code><emclass="property"> = 'LOCAL_LOCAL_MANAGER'</em><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">frameType</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list"title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Overview.list()</span></code></a>.</p>
<codeclass="sig-name descname">LIST_FRAME_TYPE_LOCAL_MANAGER</code><emclass="property"> = 'LOCAL_MANAGER'</em><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">frameType</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list"title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Overview.list()</span></code></a>.</p>
<codeclass="sig-name descname">LIST_FRAME_TYPE_NSX_INTELLIGENCE</code><emclass="property"> = 'NSX_INTELLIGENCE'</em><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">frameType</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.cluster.backups_client.Overview.list"title="com.vmware.nsx_policy.cluster.backups_client.Overview.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Overview.list()</span></code></a>.</p>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cursor</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">frame_type</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">included_fields</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">page_size</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">show_backups_list</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">site_id</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sort_ascending</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sort_by</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>frame_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Frame type (optional, default to LOCAL_LOCAL_MANAGER)</p></li>
<li><p><strong>included_fields</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>show_backups_list</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Need a list of backups (optional, default to true)</p></li>
<li><p><strong>site_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Site ID (optional, default to localhost)</p></li>
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><codeclass="sig-name descname">Status</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.Status"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.Status.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">stub_config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-nsx-policy-cluster-restore-client-module"></span><h2>com.vmware.nsx_policy.cluster.restore_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.cluster.restore_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><codeclass="sig-name descname">Backuptimestamps</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cursor</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">included_fields</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">page_size</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sort_ascending</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sort_by</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps.get"title="Permalink to this definition">¶</a></dt>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>included_fields</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum number of results to return in this page (server may return
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><codeclass="sig-name descname">Config</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.Config"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.Config.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">restore_configuration</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.Config.update"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><codeclass="sig-name descname">InstructionResources</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.InstructionResources"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">instruction_id</span></em>, <emclass="sig-param"><spanclass="n">cursor</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">included_fields</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">page_size</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sort_ascending</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sort_by</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.InstructionResources.get"title="Permalink to this definition">¶</a></dt>
<li><p><strong>instruction_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Id of the instruction set whose instructions are to be returned
(required)</p></li>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>included_fields</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum number of results to return in this page (server may return
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">stub_config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.StubFactory"title="Permalink to this definition">¶</a></dt>