<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="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><codeclass="descname">Config</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.Config"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="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>
<dd><p>Get a configuration of a file server and timers for automated backup.
Fields that contain secrets (password, passphrase) are not returned.</p>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>backup_configuration</em><spanclass="sig-paren">)</span><aclass="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>
<emclass="property">class </em><codeclass="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><codeclass="descname">History</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.History"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="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>
<dd><p>Get history of previous backup operations</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><codeclass="descname">Status</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.backups_client.Status"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="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="descclassname">com.vmware.nsx_policy.cluster.backups_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</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-nodes-client-module"></span><h2>com.vmware.nsx_policy.cluster.nodes_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.cluster.nodes_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.nsx_policy.cluster.nodes_client.</code><codeclass="descname">Status</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.nodes_client.Status"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="descname">GET_SOURCE_CACHED</code><emclass="property"> = 'cached'</em><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.nodes_client.Status.GET_SOURCE_CACHED"title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <codeclass="docutils literal notranslate"><spanclass="pre">source</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.cluster.nodes_client.Status.get"title="com.vmware.nsx_policy.cluster.nodes_client.Status.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Status.get()</span></code></a>.</p>
<codeclass="descname">GET_SOURCE_REALTIME</code><emclass="property"> = 'realtime'</em><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.nodes_client.Status.GET_SOURCE_REALTIME"title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <codeclass="docutils literal notranslate"><spanclass="pre">source</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.cluster.nodes_client.Status.get"title="com.vmware.nsx_policy.cluster.nodes_client.Status.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Status.get()</span></code></a>.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>node_id</em>, <em>source=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.nodes_client.Status.get"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">getall</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.nodes_client.Status.getall"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.nsx_policy.cluster.nodes_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.nodes_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="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><codeclass="descname">Backuptimestamps</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="descname">get</code><spanclass="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><spanclass="sig-paren">)</span><aclass="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
<li><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)</li>
<li><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)</li>
<li><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><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)</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><codeclass="descname">Config</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.Config"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="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>
<dd><p>Get configuration information for the file server used to store
backed-up files. Fields that contain secrets (password, passphrase) are
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>restore_configuration</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.Config.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Configure file server where the backed-up files used for the Restore
<emclass="property">class </em><codeclass="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><codeclass="descname">InstructionResources</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.InstructionResources"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="descname">get</code><spanclass="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><spanclass="sig-paren">)</span><aclass="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
<li><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)</li>
<li><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)</li>
<li><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)</li>
<li><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><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)</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.nsx_policy.cluster.restore_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.cluster.restore_client.StubFactory"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.