mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
2480 lines
244 KiB
HTML
2480 lines
244 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" >
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" />
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|||
|
|
|
|||
|
|
<title>com.vmware.vcenter.vm.guest package — vSphere Automation SDK for Python. 7.0.3.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 src="_static/jquery.js"></script>
|
|||
|
|
<script src="_static/underscore.js"></script>
|
|||
|
|
<script src="_static/doctools.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.vcenter.vm.hardware package" href="com.vmware.vcenter.vm.hardware.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.vcenter.vm package" href="com.vmware.vcenter.vm.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"> vSphere Automation SDK for Python.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
7.0.3.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.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">vSphere Automation SDK for Python.</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> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.vcenter.vm.html">com.vmware.vcenter.vm package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware.vcenter.vm.guest package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.vcenter.vm.guest.rst.txt" rel="nofollow"> View page source</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<div class="section" id="module-com.vmware.vcenter.vm.guest">
|
|||
|
|
<span id="com-vmware-vcenter-vm-guest-package"></span><h1>com.vmware.vcenter.vm.guest package<a class="headerlink" href="#module-com.vmware.vcenter.vm.guest" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<div class="section" id="submodules">
|
|||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.vcenter.vm.guest.filesystem_client">
|
|||
|
|
<span id="com-vmware-vcenter-vm-guest-filesystem-client-module"></span><h2>com.vmware.vcenter.vm.guest.filesystem_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.guest.filesystem_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest.filesystem_client</span></code> module provides classes
|
|||
|
|
for dealing with the filesystem of the guest operating system.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Directories">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.guest.filesystem_client.</span></code><code class="sig-name descname"><span class="pre">Directories</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Directories" 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>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Directories</span></code> class provides methods to manage directories in the
|
|||
|
|
guest filesystem. This class was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Directories.create">
|
|||
|
|
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">create_parents</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Directories.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Creates a directory in the guest operating system.</p>
|
|||
|
|
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Machine to perform the operation on.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.Credentials" title="com.vmware.vcenter.vm.guest_client.Credentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Credentials</span></code></a>) – The guest authentication data.</p></li>
|
|||
|
|
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The complete path to the directory to be created.</p></li>
|
|||
|
|
<li><p><strong>create_parents</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>) – Whether any parent directories should be created. If any failure
|
|||
|
|
occurs, some parent directories could be left behind.
|
|||
|
|
If None parent directories are not created.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> already exists.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> does not exist and <code class="docutils literal notranslate"><span class="pre">create_parents</span></code> is not set. The
|
|||
|
|
value of <code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will
|
|||
|
|
contain all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">credentials</span></code> object was not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> cannot be created because the guest authentication will
|
|||
|
|
not allow the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is not supported by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is disabled by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.GuestOperations.Modify</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Directories.create_temporary">
|
|||
|
|
<code class="sig-name descname"><span class="pre">create_temporary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Directories.create_temporary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Creates a temporary directory.</p>
|
|||
|
|
<p>Creates a new unique temporary directory for the user to use as needed.
|
|||
|
|
The guest operating system may clean up the directory after a guest
|
|||
|
|
specific amount of time if <code class="docutils literal notranslate"><span class="pre">parent_path</span></code> is not set, or the user can
|
|||
|
|
remove the directory when no longer needed.</p>
|
|||
|
|
<p>The new directory name will be created in a guest-specific format using
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">prefix</span></code>, a guest generated string and <code class="docutils literal notranslate"><span class="pre">suffix</span></code> in <code class="docutils literal notranslate"><span class="pre">parent_path</span></code>.</p>
|
|||
|
|
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Machine to perform the operation on.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.Credentials" title="com.vmware.vcenter.vm.guest_client.Credentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Credentials</span></code></a>) – The guest authentication data.</p></li>
|
|||
|
|
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The prefix to be given to the new temporary directory.</p></li>
|
|||
|
|
<li><p><strong>suffix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The suffix to be given to the new temporary directory.</p></li>
|
|||
|
|
<li><p><strong>parent_path</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>) – The complete path to the directory in which to create the new
|
|||
|
|
directory.
|
|||
|
|
Directory If None a guest-specific default will be used.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The absolute path of the temporary directory that is created.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">parent_path</span></code> is not a directory. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">parent_path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">parent_path</span></code> is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> and does not exist. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">credentials</span></code> object was not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">parent_path</span></code> cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if a file cannot be created because the guest authentication will
|
|||
|
|
not allow the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is not supported by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is disabled by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.GuestOperations.Modify</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Directories.delete">
|
|||
|
|
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recursive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Directories.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Deletes a directory in the guest operating system.</p>
|
|||
|
|
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Machine to perform the operation on.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.Credentials" title="com.vmware.vcenter.vm.guest_client.Credentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Credentials</span></code></a>) – The guest authentication data.</p></li>
|
|||
|
|
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The complete path to the directory to be deleted.</p></li>
|
|||
|
|
<li><p><strong>recursive</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>) – If true, all files and subdirectories are also deleted. If false,
|
|||
|
|
the directory must be empty for the operation to succeed.
|
|||
|
|
If None, any directory content is not deleted.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is not a directory. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is not found. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> has content and <code class="docutils literal notranslate"><span class="pre">recursive</span></code> is None.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">credentials</span></code> object was not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> cannot be deleted because the guest authentication will
|
|||
|
|
not allow the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is not supported by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is disabled by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.GuestOperations.Modify</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Directories.move">
|
|||
|
|
<code class="sig-name descname"><span class="pre">move</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Directories.move" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Renames a directory in the guest.</p>
|
|||
|
|
<p>Renames the directory, or copies and deletes the old contents as
|
|||
|
|
required by the underlying filsystem.</p>
|
|||
|
|
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Machine to perform the operation on.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.Credentials" title="com.vmware.vcenter.vm.guest_client.Credentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Credentials</span></code></a>) – The guest authentication data.</p></li>
|
|||
|
|
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The complete path to the directory to be moved.</p></li>
|
|||
|
|
<li><p><strong>new_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The complete path to where the directory is moved or its new name.
|
|||
|
|
It cannot be a path to an existing directory or an existing file.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">new_path</span></code> already exists.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is not a directory. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">new_path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is not found. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the parent directory of <code class="docutils literal notranslate"><span class="pre">new_path</span></code> does not exist. The value
|
|||
|
|
of <code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will
|
|||
|
|
contain all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">credentials</span></code> object was not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if a path cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if a path cannot be renamed or moved because the guest
|
|||
|
|
authentication will not allow the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is not supported by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is disabled by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.GuestOperations.Modify</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.guest.filesystem_client.</span></code><code class="sig-name descname"><span class="pre">ErrorReason</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason" 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.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ErrorReason</span></code> class defines the reasons a file or directory operation
|
|||
|
|
failed. This enumeration was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason" title="com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason"><code class="xref py py-class docutils literal notranslate"><span class="pre">ErrorReason</span></code></a> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.DIRECTORY_NOT_EMPTY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DIRECTORY_NOT_EMPTY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ErrorReason(string='DIRECTORY_NOT_EMPTY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.DIRECTORY_NOT_EMPTY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Directory not empty. This class attribute was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.FILE_NOT_FOUND">
|
|||
|
|
<code class="sig-name descname"><span class="pre">FILE_NOT_FOUND</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ErrorReason(string='FILE_NOT_FOUND')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.FILE_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The file is not found. This class attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.FILE_TOO_LARGE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">FILE_TOO_LARGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ErrorReason(string='FILE_TOO_LARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.FILE_TOO_LARGE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The file is too large. This class attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.NOT_A_DIRECTORY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">NOT_A_DIRECTORY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ErrorReason(string='NOT_A_DIRECTORY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.NOT_A_DIRECTORY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The argument is not a directory. This class attribute was added in vSphere
|
|||
|
|
API 7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.NOT_A_FILE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">NOT_A_FILE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ErrorReason(string='NOT_A_FILE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.NOT_A_FILE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>An argument is not a file. This class attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.NO_DISK_SPACE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">NO_DISK_SPACE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ErrorReason(string='NO_DISK_SPACE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.NO_DISK_SPACE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>There is insufficent disk space. This class attribute was added in vSphere
|
|||
|
|
API 7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.PATH_TOO_LONG">
|
|||
|
|
<code class="sig-name descname"><span class="pre">PATH_TOO_LONG</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ErrorReason(string='PATH_TOO_LONG')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason.PATH_TOO_LONG" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The file path is too long. This class attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.guest.filesystem_client.</span></code><code class="sig-name descname"><span class="pre">FileErrorDetails</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reason</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">FileErrorDetails</span></code> class describes additional error information for
|
|||
|
|
file and directory operations. This class was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>reason</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason" title="com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason"><code class="xref py py-class docutils literal notranslate"><span class="pre">ErrorReason</span></code></a>) – The reason for the error. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>file_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The file path associated with the error. This attribute was added
|
|||
|
|
in vSphere API 7.0.2.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.guest.filesystem_client.</span></code><code class="sig-name descname"><span class="pre">Files</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files" 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>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files</span></code> class provides methods to manage the files in the guest
|
|||
|
|
filesystem. This class was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.FileAttributesInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FileAttributesInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">last_modified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">last_accessed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">symlink_target</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filesystem_family</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">win_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posix_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FileAttributesInfo" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files.FileAttributesInfo</span></code> class describes the attributes of a file
|
|||
|
|
in a guest operating system. This class was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>last_modified</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time the file was last modified. This attribute was
|
|||
|
|
added in vSphere API 7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>last_accessed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time the file was last accessed. This attribute was
|
|||
|
|
added in vSphere API 7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>symlink_target</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>) – The target for the file if it’s a symbolic link. This is currently
|
|||
|
|
only set for Posix guest operating systems, but may be supported in
|
|||
|
|
the future on Windows guest operating systems that support symbolic
|
|||
|
|
links. This attribute was added in vSphere API 7.0.2.0.
|
|||
|
|
Set if the file is a symbolic link.</p></li>
|
|||
|
|
<li><p><strong>filesystem_family</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.FilesystemFamily</span></code></a>) – The type of guest filesystem. This attribute was added in vSphere
|
|||
|
|
API 7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>win_attributes</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.WindowsFileAttributesInfo" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.WindowsFileAttributesInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.WindowsFileAttributesInfo</span></code></a>) – Windows-specific file information. This attribute was added in
|
|||
|
|
vSphere API 7.0.2.0.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">filesystemFamily</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily.WINDOWS" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily.WINDOWS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Files.FilesystemFamily.WINDOWS</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>posix_attributes</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.PosixFileAttributesInfo" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.PosixFileAttributesInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.PosixFileAttributesInfo</span></code></a>) – Posix-specific file information. This attribute was added in
|
|||
|
|
vSphere API 7.0.2.0.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">filesystemFamily</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily.POSIX" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily.POSIX"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Files.FilesystemFamily.POSIX</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.FileAttributesUpdateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FileAttributesUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">last_modified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">last_accessed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">windows</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FileAttributesUpdateSpec" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>File attributes used for updating an existing file with
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.update" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Files.update()</span></code></a>. This class was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>last_modified</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The date and time the file was last modified. This attribute was
|
|||
|
|
added in vSphere API 7.0.2.0.
|
|||
|
|
If None the value will not be changed.</p></li>
|
|||
|
|
<li><p><strong>last_accessed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The date and time the file was last accessed. This attribute was
|
|||
|
|
added in vSphere API 7.0.2.0.
|
|||
|
|
If None the value will not be changed.</p></li>
|
|||
|
|
<li><p><strong>windows</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.WindowsFileAttributesUpdateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.WindowsFileAttributesUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.WindowsFileAttributesUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Windows-specific file update information. This attribute was added
|
|||
|
|
in vSphere API 7.0.2.0.
|
|||
|
|
Set if the guest operating system is Windows.</p></li>
|
|||
|
|
<li><p><strong>posix</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.PosixFileAttributesUpdateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.PosixFileAttributesUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.PosixFileAttributesUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Posix-specific file update information. This attribute was added in
|
|||
|
|
vSphere API 7.0.2.0.
|
|||
|
|
Set if the guest operating system is Posix.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilesystemFamily</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily" 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.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files.FilesystemFamily</span></code> class defines the types of guest operating
|
|||
|
|
fllesystem. This enumeration was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">FilesystemFamily</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily.POSIX">
|
|||
|
|
<code class="sig-name descname"><span class="pre">POSIX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">FilesystemFamily(string='POSIX')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily.POSIX" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Linux, Solaris, etc. This class attribute was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily.WINDOWS">
|
|||
|
|
<code class="sig-name descname"><span class="pre">WINDOWS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">FilesystemFamily(string='WINDOWS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily.WINDOWS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The guest OS is a Windows variant. This class attribute was added in
|
|||
|
|
vSphere API 7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.FilterSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">match_pattern</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FilterSpec" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files.FilterSpec</span></code> class contains information used to filter the
|
|||
|
|
results when listing files (see <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.list" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Files.list()</span></code></a>). This class was added
|
|||
|
|
in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>match_pattern</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>) – The perl-compatible regular expression used to filter the returned
|
|||
|
|
files. This attribute was added in vSphere API 7.0.2.0.
|
|||
|
|
If None the pattern <strong>‘.*’</strong> (match everything) is used.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.Info">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Info" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files.Info</span></code> class describes a file or directory in the guest
|
|||
|
|
operating system. Returned by <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.get" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Files.get()</span></code></a>. This class was added in
|
|||
|
|
vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Type" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.Type</span></code></a>) – The type of file. This attribute was added in vSphere API 7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The file size in bytes. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>attributes</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FileAttributesInfo" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.FileAttributesInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.FileAttributesInfo</span></code></a>) – Attributes of a file. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.IterationSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IterationSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.IterationSpec" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files.IterationSpec</span></code> class contains attributes used to break results
|
|||
|
|
into pages when listing files. See <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.list" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Files.list()</span></code></a>). This class was
|
|||
|
|
added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>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>) – Specifies the maximum number of results to return. This attribute
|
|||
|
|
was added in vSphere API 7.0.2.0.
|
|||
|
|
If None information about at most 50 files will be returned.</p></li>
|
|||
|
|
<li><p><strong>index</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>) – Which result to start the list with. If this value exceeds the
|
|||
|
|
number of results, an empty list will be returned. This attribute
|
|||
|
|
was added in vSphere API 7.0.2.0.
|
|||
|
|
If None, the start of the list of files will be returned.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.LastIterationStatus">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">LastIterationStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.LastIterationStatus" 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.enum.Enum</span></code></p>
|
|||
|
|
<p>The last status for the iterator. A field of this type is returned as part
|
|||
|
|
of the result and indicates to the caller of the API whether it can
|
|||
|
|
continue to make requests for more data. The last status only reports on
|
|||
|
|
the state of the iteration at the time data was last returned. As a result,
|
|||
|
|
it not does guarantee if the next call will succeed in getting more data or
|
|||
|
|
not. Failures to retrieve results will be returned as Error responses.
|
|||
|
|
These last statuses are only returned when the iterator is operating as
|
|||
|
|
expected. This enumeration was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">LastIterationStatus</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.LastIterationStatus.END_OF_DATA">
|
|||
|
|
<code class="sig-name descname"><span class="pre">END_OF_DATA</span></code><em class="property"> <span class="pre">=</span> <span class="pre">LastIterationStatus(string='END_OF_DATA')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.LastIterationStatus.END_OF_DATA" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Iterator has finished iterating through its inventory. There are currently
|
|||
|
|
no more entities to return and the caller can terminate iteration. If the
|
|||
|
|
iterator returned some data, the marker may be set to allow the iterator to
|
|||
|
|
continue from where it left off when additional data does become available.
|
|||
|
|
This value is used to indicate that all available data has been returned by
|
|||
|
|
the iterator. This class attribute was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.LastIterationStatus.READY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">READY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">LastIterationStatus(string='READY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.LastIterationStatus.READY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Iterator has more data pending and is ready to provide it. The caller can
|
|||
|
|
request the next page of data at any time. The number of results returned
|
|||
|
|
may be less than the requested size. In other words, the iterator may not
|
|||
|
|
fill the page. The iterator has returned at least 1 result. This class
|
|||
|
|
attribute was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.ListResult">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ListResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">total</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_index</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_index</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.ListResult" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files.ListResult</span></code> class describes the results of a
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.list" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Files.list()</span></code></a> method. This class was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>files</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Summary" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.Summary</span></code></a>) – A list of <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Summary" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.Summary</span></code></a> classes containing information for
|
|||
|
|
all the matching files. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>total</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The total number of results from the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.list" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Files.list()</span></code></a>. This is a
|
|||
|
|
hint to the user of the iterator regarding how many items are
|
|||
|
|
available to be retrieved. The total could change if the inventory
|
|||
|
|
of items are being changed. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>start_index</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>) – Positional index into the logical item list of the first item
|
|||
|
|
returned in the list of results. The first item in the logical item
|
|||
|
|
list has an index of 0. This is a hint to the user of the iterator
|
|||
|
|
regarding the logical position in the iteration. For example, this
|
|||
|
|
can be used to display to the user which page of the iteration is
|
|||
|
|
being shown. The total could change if the inventory of items are
|
|||
|
|
being changed. This attribute was added in vSphere API 7.0.2.0.
|
|||
|
|
If None no items were returned.</p></li>
|
|||
|
|
<li><p><strong>end_index</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>) – Positional index into the logical item list of the last item
|
|||
|
|
returned in the list of results. The first item in the logical item
|
|||
|
|
list has an index of 0. This is a hint to the user of the iterator
|
|||
|
|
regarding the logical position in the iteration. For example, this
|
|||
|
|
can be used to display to the user which page of the iteration is
|
|||
|
|
being shown. The total could change if the inventory of items are
|
|||
|
|
being changed. This attribute was added in vSphere API 7.0.2.0.
|
|||
|
|
If None no items were returned.</p></li>
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.LastIterationStatus" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.LastIterationStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.LastIterationStatus</span></code></a>) – The last status for the iterator that indicates whether any more
|
|||
|
|
results can be expected if the caller continues to make requests
|
|||
|
|
for more data using the iterator. This attribute was added in
|
|||
|
|
vSphere API 7.0.2.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.PosixFileAttributesInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PosixFileAttributesInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">owner</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.PosixFileAttributesInfo" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files.PosixFileAttributesInfo</span></code> class describes information about
|
|||
|
|
file attributes specific to Posix Guest operating systems. This class was
|
|||
|
|
added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>owner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The owner ID. This attribute was added in vSphere API 7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The group ID. This attribute was added in vSphere API 7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The file permissions in chmod(2) format. This attribute is
|
|||
|
|
presented as octal. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.PosixFileAttributesUpdateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PosixFileAttributesUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">owner_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.PosixFileAttributesUpdateSpec" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files.PosixFileAttributesUpdateSpec</span></code> class describes attributes that
|
|||
|
|
can be changed for a Posix file. This class was added in vSphere API
|
|||
|
|
7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>owner_id</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>) – The owner ID. This attribute was added in vSphere API 7.0.2.0.
|
|||
|
|
If None the value will not be changed.</p></li>
|
|||
|
|
<li><p><strong>group_id</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>) – The group ID. This attribute was added in vSphere API 7.0.2.0.
|
|||
|
|
If None the value will not be changed.</p></li>
|
|||
|
|
<li><p><strong>permissions</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>) – The file permissions in chmod(2) format. This attribute is
|
|||
|
|
interpreted as octal. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.
|
|||
|
|
If None the value will not be changed.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.Summary">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Summary" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files.Summary</span></code> class describes a file or directory in the guest
|
|||
|
|
operating system returned by a <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.list" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Files.list()</span></code></a> method. This class was
|
|||
|
|
added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>filename</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the file or directory with any leading directories
|
|||
|
|
removed. This attribute was added in vSphere API 7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Type" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.Type</span></code></a>) – The type of file. This attribute was added in vSphere API 7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The file size in bytes. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.Type">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Type" 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.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files.Type</span></code> class defines the valid types of files. This enumeration
|
|||
|
|
was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.Type.DIRECTORY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DIRECTORY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='DIRECTORY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Type.DIRECTORY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>directory. This class attribute was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.Type.FILE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">FILE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='FILE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Type.FILE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>normal file. This class attribute was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.Type.SYMLINK">
|
|||
|
|
<code class="sig-name descname"><span class="pre">SYMLINK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='SYMLINK')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Type.SYMLINK" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>symbolic link. This class attribute was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.WindowsFileAttributesInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">WindowsFileAttributesInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hidden</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">read_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.WindowsFileAttributesInfo" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The {\@name WindowsFileAttributesInfo) class describes file attributes
|
|||
|
|
specific to Windows Guest operating systems. This class was added in
|
|||
|
|
vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>hidden</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – The file is hidden. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>read_only</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – The file is read-only. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time the file was created. This attribute was added in
|
|||
|
|
vSphere API 7.0.2.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.WindowsFileAttributesUpdateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">WindowsFileAttributesUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hidden</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">read_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.WindowsFileAttributesUpdateSpec" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Files.WindowsFileAttributesUpdateSpec</span></code> class describes attributes
|
|||
|
|
that can be changed for a Windows file. This class was added in vSphere API
|
|||
|
|
7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>hidden</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>) – The file is hidden. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.
|
|||
|
|
If {term unset} the value will not be changed.</p></li>
|
|||
|
|
<li><p><strong>read_only</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>) – The file is read-only. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.
|
|||
|
|
If {term unset} the value will not be changed.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.create_temporary">
|
|||
|
|
<code class="sig-name descname"><span class="pre">create_temporary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.create_temporary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Creates a temporary file.</p>
|
|||
|
|
<p>Creates a new unique temporary file for the user to use as needed. The
|
|||
|
|
user is responsible for removing it when it is no longer needed.</p>
|
|||
|
|
<p>The new file name will be created in a guest-specific format using
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">prefix</span></code>, a guest generated string and <code class="docutils literal notranslate"><span class="pre">suffix</span></code> in <code class="docutils literal notranslate"><span class="pre">parent_path</span></code>.</p>
|
|||
|
|
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Machine to perform the operation on.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.Credentials" title="com.vmware.vcenter.vm.guest_client.Credentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Credentials</span></code></a>) – The guest authentication data.</p></li>
|
|||
|
|
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The prefix to be given to the new temporary file.</p></li>
|
|||
|
|
<li><p><strong>suffix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The suffix to be given to the new temporary file.</p></li>
|
|||
|
|
<li><p><strong>parent_path</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>) – The complete path to the directory in which to create the file.
|
|||
|
|
Directory to use if specified, otherwise a guest-specific default
|
|||
|
|
will be used.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The absolute path of the temporary file that is created.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">parent_path</span></code> is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> and is not a directory. The
|
|||
|
|
value of <code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will
|
|||
|
|
contain all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">parent_path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">parent_path</span></code> is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> and does not exist. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">credentials</span></code> object was not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">parent_path</span></code> cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if a file cannot be created because the guest authentication will
|
|||
|
|
not allow the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is not supported by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is disabled by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.GuestOperations.Modify</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.delete">
|
|||
|
|
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Deletes a file in the guest operating system</p>
|
|||
|
|
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Machine to perform the operation on.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.Credentials" title="com.vmware.vcenter.vm.guest_client.Credentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Credentials</span></code></a>) – The guest authentication data.</p></li>
|
|||
|
|
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The complete path to the file or symbolic link to be deleted.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is not a file. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is not found. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">credentials</span></code> object was not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> cannot be deleted because the guest authentication will
|
|||
|
|
not allow the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is not supported by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is disabled by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.GuestOperations.Modify</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.get">
|
|||
|
|
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about a file or directory in the guest.</p>
|
|||
|
|
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Machine to perform the operation on.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.Credentials" title="com.vmware.vcenter.vm.guest_client.Credentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Credentials</span></code></a>) – The guest authentication data.</p></li>
|
|||
|
|
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The complete path to the file.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Info" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.Info" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.Info</span></code></a> object containing information for the file.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is not found. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">credentials</span></code> object was not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> cannot be listed because the guest authentication will
|
|||
|
|
not allow the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is not supported by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is disabled by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.GuestOperations.Query</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.list">
|
|||
|
|
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iteration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about files and directories in the guest.</p>
|
|||
|
|
<p>Files are returned in operating system-specific (inode) order. If the
|
|||
|
|
directory is modified between queries, missing or duplicate results can
|
|||
|
|
occur.</p>
|
|||
|
|
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Machine to perform the operation on.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.Credentials" title="com.vmware.vcenter.vm.guest_client.Credentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Credentials</span></code></a>) – The guest authentication data.</p></li>
|
|||
|
|
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The complete path to the directory or file to query.</p></li>
|
|||
|
|
<li><p><strong>iteration</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.IterationSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.IterationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.IterationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The specification of a page of results to be retrieved.
|
|||
|
|
If None, the first page will be retrieved.</p></li>
|
|||
|
|
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FilterSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification to match files for which information should be
|
|||
|
|
returned.
|
|||
|
|
If None, the behavior is the equivalent to a
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FilterSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.FilterSpec</span></code></a> with all attributes None which means all
|
|||
|
|
filenames match the filter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.ListResult" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.ListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.ListResult</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>A <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.ListResult" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.ListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.ListResult</span></code></a> object containing information for all
|
|||
|
|
the matching files in <code class="docutils literal notranslate"><span class="pre">filter</span></code> and the total number of files that
|
|||
|
|
can be returned.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If {\@param.iteration} contains invalid data.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If <code class="docutils literal notranslate"><span class="pre">filter</span></code> contains an invalid regular expression.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is not found. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> cannot be listed because the guest authentication will
|
|||
|
|
not allow the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">credentials</span></code> object was not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is not supported by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is disabled by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.GuestOperations.Query</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.move">
|
|||
|
|
<code class="sig-name descname"><span class="pre">move</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.move" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Renames a file in the guest.</p>
|
|||
|
|
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Machine to perform the operation on.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.Credentials" title="com.vmware.vcenter.vm.guest_client.Credentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Credentials</span></code></a>) – The guest authentication data.</p></li>
|
|||
|
|
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The complete path to the original file or symbolic link to be
|
|||
|
|
moved.</p></li>
|
|||
|
|
<li><p><strong>new_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The complete path to the new file. It cannot be a path to an
|
|||
|
|
existing directory.</p></li>
|
|||
|
|
<li><p><strong>overwrite</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>) – If true, the destination file is overwritten.
|
|||
|
|
If None, the destination file is not overwritten.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">new_path</span></code> already exists and <code class="docutils literal notranslate"><span class="pre">overwrite</span></code> is false.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is not a file. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">new_path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> does not exist. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the parent directory of <code class="docutils literal notranslate"><span class="pre">new_path</span></code> does not exist. The value
|
|||
|
|
of <code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will
|
|||
|
|
contain all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">credentials</span></code> object was not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if a path cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if a path cannot be renamed because the guest authentication will
|
|||
|
|
not allow the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is not supported by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is disabled by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.GuestOperations.Modify</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Files.update">
|
|||
|
|
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_attributes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Changes the file attributes of a specified file or directory inside the
|
|||
|
|
guest.</p>
|
|||
|
|
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Machine to perform the operation on.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.Credentials" title="com.vmware.vcenter.vm.guest_client.Credentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Credentials</span></code></a>) – The guest authentication data.</p></li>
|
|||
|
|
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The complete path to the file or directory to be changed in the
|
|||
|
|
guest. If the file points to an symbolic link, then the attributes
|
|||
|
|
of the target file are changed.</p></li>
|
|||
|
|
<li><p><strong>file_attributes</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FileAttributesUpdateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.FileAttributesUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.FileAttributesUpdateSpec</span></code></a>) – Specifies the different file attributes of the guest file to be
|
|||
|
|
changed. See <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Files.FileAttributesUpdateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Files.FileAttributesUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Files.FileAttributesUpdateSpec</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">file_attributes</span></code> does not apply to the guest operating
|
|||
|
|
system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is not a file. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is too long. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> is not found. The value of
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will contain
|
|||
|
|
all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">credentials</span></code> object was not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">path</span></code> cannot be updated because the guest authentication will
|
|||
|
|
not allow the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is not supported by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is disabled by the VMware Tools in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.GuestOperations.Modify</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.guest.filesystem_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Transfers">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.guest.filesystem_client.</span></code><code class="sig-name descname"><span class="pre">Transfers</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers" 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>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Transfers</span></code> class provides methods to copy files into and out of the
|
|||
|
|
guest file system. This class was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.CreateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.CreateSpec" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Transfers.CreateSpec</span></code> class describes the details of a file transfer
|
|||
|
|
operation. This class was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The complete destination path in the guest to transfer the file to
|
|||
|
|
or from the client. It cannot be a path to a directory or a
|
|||
|
|
symbolic link. This attribute was added in vSphere API 7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>attributes</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.FileCreationAttributes" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.FileCreationAttributes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transfers.FileCreationAttributes</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Details about the file to be transferred into the guest. This
|
|||
|
|
attribute was added in vSphere API 7.0.2.0.
|
|||
|
|
Must be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the file is being transferred to the guest.
|
|||
|
|
Must not be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the file is being transferred from the
|
|||
|
|
guest.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.FileCreationAttributes">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FileCreationAttributes</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">last_modified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">last_accessed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">windows</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.FileCreationAttributes" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Transfers.FileCreationAttributes</span></code> class describes file attributes
|
|||
|
|
used when transferring a file into the guest. This class was added in
|
|||
|
|
vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The size in bytes of the file to be transferred into the guest.
|
|||
|
|
This attribute was added in vSphere API 7.0.2.0.</p></li>
|
|||
|
|
<li><p><strong>overwrite</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>) – Whether an existing file should be overwritten. This attribute was
|
|||
|
|
added in vSphere API 7.0.2.0.
|
|||
|
|
If None any existing file will not be overwritten.</p></li>
|
|||
|
|
<li><p><strong>last_modified</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The date and time the file was last modified. This attribute was
|
|||
|
|
added in vSphere API 7.0.2.0.
|
|||
|
|
If None the value will be the time when the file is transferred
|
|||
|
|
into the guest.</p></li>
|
|||
|
|
<li><p><strong>last_accessed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The date and time the file was last accessed. This attribute was
|
|||
|
|
added in vSphere API 7.0.2.0.
|
|||
|
|
If None the value will be the time when the file is transferred
|
|||
|
|
into the guest.</p></li>
|
|||
|
|
<li><p><strong>windows</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.WindowsFileAttributesCreateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.WindowsFileAttributesCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transfers.WindowsFileAttributesCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Windows-specific file creation information. This attribute was
|
|||
|
|
added in vSphere API 7.0.2.0.
|
|||
|
|
If None, the behavior is equivalent to a
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.WindowsFileAttributesCreateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.WindowsFileAttributesCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transfers.WindowsFileAttributesCreateSpec</span></code></a> with all
|
|||
|
|
attributes None which means the defaults are used. May only be
|
|||
|
|
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the guest operating system is Windows.</p></li>
|
|||
|
|
<li><p><strong>posix</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transfers.PosixFileAttributesCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Posix-specific file creation information. This attribute was added
|
|||
|
|
in vSphere API 7.0.2.0.
|
|||
|
|
If None, the behavior is equivalent to a
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transfers.PosixFileAttributesCreateSpec</span></code></a> with all
|
|||
|
|
attributes None which means the defaults are used. May only be
|
|||
|
|
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the guest operating system is Posix.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PosixFileAttributesCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">owner_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Transfers.PosixFileAttributesCreateSpec</span></code> class describes creation
|
|||
|
|
information about file attributes specific to Posix guest operating
|
|||
|
|
systems. This class was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>owner_id</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>) – The owner ID. If this property is not specified when passing a
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transfers.PosixFileAttributesCreateSpec</span></code></a> object to
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.create" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Transfers.create()</span></code></a>, the default value will be the owner Id of
|
|||
|
|
the user who invoked the file transfer operation. This attribute
|
|||
|
|
was added in vSphere API 7.0.2.0.
|
|||
|
|
Defaults to uid of user invoking the operation.</p></li>
|
|||
|
|
<li><p><strong>group_id</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>) – The group ID. If this property is not specified when passing a
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transfers.PosixFileAttributesCreateSpec</span></code></a> object to
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.create" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Transfers.create()</span></code></a>, the default value will be the group Id of
|
|||
|
|
the user who invoked the file transfer operation. This attribute
|
|||
|
|
was added in vSphere API 7.0.2.0.
|
|||
|
|
Defaults to gid of user invoking the operation.</p></li>
|
|||
|
|
<li><p><strong>permissions</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>) – The file permissions in chmod(2) format. If this property is not
|
|||
|
|
specified when passing a
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.PosixFileAttributesCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transfers.PosixFileAttributesCreateSpec</span></code></a> object to
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.create" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Transfers.create()</span></code></a>, the file will be created with 0644
|
|||
|
|
permissions. This attribute is interpreted as octal. This attribute
|
|||
|
|
was added in vSphere API 7.0.2.0.
|
|||
|
|
Defaults to 0644.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.WindowsFileAttributesCreateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">WindowsFileAttributesCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hidden</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">read_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.WindowsFileAttributesCreateSpec" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Transfers.WindowsFileAttributesCreateSpec</span></code> class describes creation
|
|||
|
|
information about file attributes specific to Windows guest operating
|
|||
|
|
systems. This class was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>hidden</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>) – The file is hidden. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.
|
|||
|
|
If None the file will not be hidden.</p></li>
|
|||
|
|
<li><p><strong>read_only</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>) – The file is read-only. This attribute was added in vSphere API
|
|||
|
|
7.0.2.0.
|
|||
|
|
If None the file will be writeable.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.create">
|
|||
|
|
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Initiates an operation to transfer a file to or from the guest.</p>
|
|||
|
|
<p>If the power state of the Virtual Machine is changed when the file
|
|||
|
|
transfer is in progress, or the Virtual Machine is migrated, then the
|
|||
|
|
transfer operation is aborted.</p>
|
|||
|
|
<p>When transferring a file into the guest and overwriting an existing
|
|||
|
|
file, the old file attributes are not preserved.</p>
|
|||
|
|
<p>In order to ensure a secure connection to the host when transferring a
|
|||
|
|
file using HTTPS, the X.509 certificate for the host must be used to
|
|||
|
|
authenticate the remote end of the connection. The certificate of the
|
|||
|
|
host that the virtual machine is running on can be retrieved using the
|
|||
|
|
following fields: XXX insert link to certificate in Host config XXX</p>
|
|||
|
|
<p>. This method was added in vSphere API 7.0.2.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Machine to perform the operation on.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.Credentials" title="com.vmware.vcenter.vm.guest_client.Credentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Credentials</span></code></a>) – The guest authentication credentials.</p></li>
|
|||
|
|
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.Transfers.CreateSpec" title="com.vmware.vcenter.vm.guest.filesystem_client.Transfers.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transfers.CreateSpec</span></code></a>) – A specification of the type of file transfer and any applicable
|
|||
|
|
attibutes.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The URL to which the user has to send an HTTP request. The URL will
|
|||
|
|
become invalid once a successful request is sent. If the file is
|
|||
|
|
being transferred from the guest, an HTTP GET should be used. If
|
|||
|
|
the file is being transferred to the guest, HTTP PUT should be
|
|||
|
|
used.
|
|||
|
|
The URL is valid only for 10 minutes from the time it is generated.
|
|||
|
|
The URL becomes invalid whenever the virtual machine is powered
|
|||
|
|
off, suspended, unregistered or migrated to a new host. The host
|
|||
|
|
part of the URL is returned as <strong>*</strong> if the hostname to be used is
|
|||
|
|
the name of the server to which the call was made. For example, if
|
|||
|
|
the call is made to <strong>esx-svr-1.domain1.com</strong>, and the file is
|
|||
|
|
available for download from
|
|||
|
|
<a class="reference external" href="https://esx-svr-1.domain1.com/guestFile?id=1&token=1234">https://esx-svr-1.domain1.com/guestFile?id=1&token=1234</a>, the URL
|
|||
|
|
returned may be {\@literal
|
|||
|
|
aHR0cHM6Ly8mIzQyOy9ndWVzdEZpbGU/aWQ9MSZ0b2tlbj0xMjM0}. The client
|
|||
|
|
replaces the asterisk with the server name on which it invoked the
|
|||
|
|
call.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Transfers.CreateSpec.path</span></code> in <code class="docutils literal notranslate"><span class="pre">spec</span></code> exists and
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Transfers.FileCreationAttributes.overwrite</span></code> is false when
|
|||
|
|
transferring a file to the guest.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Transfers.CreateSpec.path</span></code> in <code class="docutils literal notranslate"><span class="pre">spec</span></code> is not a file. The
|
|||
|
|
value of <code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will
|
|||
|
|
contain all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Transfers.CreateSpec.path</span></code> in <code class="docutils literal notranslate"><span class="pre">spec</span></code> is too long. The
|
|||
|
|
value of <code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will
|
|||
|
|
contain all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Transfers.CreateSpec.path</span></code> in <code class="docutils literal notranslate"><span class="pre">spec</span></code> is not found. The
|
|||
|
|
value of <code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error.data</span></code> will
|
|||
|
|
contain all the attributes defined in the <a class="reference internal" href="#com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails" title="com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileErrorDetails</span></code></a>
|
|||
|
|
providing additional information about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if is insuffcient space for the new file when transferring a file
|
|||
|
|
to the guest.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">credentials</span></code> object was not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Transfers.CreateSpec.path</span></code> in <code class="docutils literal notranslate"><span class="pre">spec</span></code> cannot be
|
|||
|
|
accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Transfers.CreateSpec.path</span></code> in <code class="docutils literal notranslate"><span class="pre">spec</span></code> cannot be copied
|
|||
|
|
because the guest authentication will not allow the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is not supported by the VMware Tools in the guest
|
|||
|
|
OS.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the operation is disabled by the VMware Tools in the guest OS.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.GuestOperations.Modify</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.vcenter.vm.guest.networking_client">
|
|||
|
|
<span id="com-vmware-vcenter-vm-guest-networking-client-module"></span><h2>com.vmware.vcenter.vm.guest.networking_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.guest.networking_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest.networking_client</span></code> module provides classes
|
|||
|
|
for dealing with the guest operating system networking.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.guest.networking_client.</span></code><code class="sig-name descname"><span class="pre">Interfaces</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces" 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>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Interfaces</span></code> class provides methods for retrieving guest operating
|
|||
|
|
system network interface information. This class was added in vSphere API
|
|||
|
|
7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.Info">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dns_values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mac_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wins_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nic</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.Info" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Interfaces.Info</span></code> class describes a virtual network adapter
|
|||
|
|
configured in the guest operating system. This class was added in vSphere
|
|||
|
|
API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>dns_values</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.DnsAssignedValues" title="com.vmware.vcenter.vm.guest_client.DnsAssignedValues"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.DnsAssignedValues</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Client DNS values. Data assigned by DNS. This attribute was added
|
|||
|
|
in vSphere API 7.0.0.0.
|
|||
|
|
If None no DNS assigned value exists.</p></li>
|
|||
|
|
<li><p><strong>mac_address</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>) – MAC address of the adapter. This attribute was added in vSphere API
|
|||
|
|
7.0.0.0.
|
|||
|
|
If None then not supported by the Guest OS.</p></li>
|
|||
|
|
<li><p><strong>dns</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.DnsConfigInfo" title="com.vmware.vcenter.vm.guest_client.DnsConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.DnsConfigInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – DNS configuration of the adapter. See
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Networking.Info.dns</span></code> for
|
|||
|
|
system wide settings. This attribute was added in vSphere API
|
|||
|
|
7.0.0.0.
|
|||
|
|
If None then not assigned by the Guest OS.</p></li>
|
|||
|
|
<li><p><strong>ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpConfigInfo" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.IpConfigInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IP configuration settings of the adapter. This attribute was added
|
|||
|
|
in vSphere API 7.0.0.0.
|
|||
|
|
If None then not supported by the Guest OS.</p></li>
|
|||
|
|
<li><p><strong>wins_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <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>) – The IP addresses of any WINS name servers for the adapter. This
|
|||
|
|
attribute was added in vSphere API 7.0.0.0.
|
|||
|
|
If None then not supported by the Guest OS.</p></li>
|
|||
|
|
<li><p><strong>nic</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>) – Link to the corresponding virtual device. This attribute was added
|
|||
|
|
in vSphere API 7.0.0.0.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>. When methods return a
|
|||
|
|
value of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.
|
|||
|
|
If None then the interface is not backed by a virtual device.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IpAddressInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ip_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix_length</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressInfo" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Interfaces.IpAddressInfo</span></code> class describes a specific IP Address.
|
|||
|
|
This class was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>ip_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IPv4 address is specified using dotted decimal notation. For
|
|||
|
|
example, “192.0.2.1”. IPv6 addresses are 128-bit addresses
|
|||
|
|
specified using eight fields of up to four hexadecimal digits. A
|
|||
|
|
colon separates each field (:). For example,
|
|||
|
|
2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of
|
|||
|
|
the symbol ‘::’ to represent multiple 16-bit groups of contiguous
|
|||
|
|
0’s only once in an address as described in RFC 2373. This
|
|||
|
|
attribute was added in vSphere API 7.0.0.0.</p></li>
|
|||
|
|
<li><p><strong>prefix_length</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Denotes the length of a generic Internet network address prefix.
|
|||
|
|
Prefix length: the valid range of values is 0-32 for IPv4, and
|
|||
|
|
0-128 for IPv6. A value of n corresponds to an IP address mask that
|
|||
|
|
has n contiguous 1-bits from the most significant bit (MSB), with
|
|||
|
|
all other bits set to 0. A value of zero is valid only if the
|
|||
|
|
calling context defines it. This attribute was added in vSphere API
|
|||
|
|
7.0.0.0.</p></li>
|
|||
|
|
<li><p><strong>origin</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.IpAddressOrigin</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – How this address was configured. This attribute was added in
|
|||
|
|
vSphere API 7.0.0.0.
|
|||
|
|
If None the data was not available.</p></li>
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.IpAddressStatus</span></code></a>) – The state of this ipAddress. This attribute was added in vSphere
|
|||
|
|
API 7.0.0.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IpAddressOrigin</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin" 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.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Interfaces.IpAddressOrigin</span></code> class specifies how an IP address was
|
|||
|
|
obtained for an interface. See RFC 4293 IpAddressOriginTC. This enumeration
|
|||
|
|
was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IpAddressOrigin</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.DHCP">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DHCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressOrigin(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.DHCP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The address is configured through dhcp. This class attribute was added in
|
|||
|
|
vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.LINKLAYER">
|
|||
|
|
<code class="sig-name descname"><span class="pre">LINKLAYER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressOrigin(string='LINKLAYER')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.LINKLAYER" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The address is obtained through stateless autoconfiguration (autoconf). See
|
|||
|
|
RFC 4862, IPv6 Stateless Address Autoconfiguration. This class attribute
|
|||
|
|
was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.MANUAL">
|
|||
|
|
<code class="sig-name descname"><span class="pre">MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressOrigin(string='MANUAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.MANUAL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The address is configured manually. This class attribute was added in
|
|||
|
|
vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.OTHER">
|
|||
|
|
<code class="sig-name descname"><span class="pre">OTHER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressOrigin(string='OTHER')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.OTHER" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Any other type of address configuration other than the below mentioned ones
|
|||
|
|
will fall under this category. For e.g., automatic address configuration
|
|||
|
|
for the link local address falls under this type. This class attribute was
|
|||
|
|
added in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.RANDOM">
|
|||
|
|
<code class="sig-name descname"><span class="pre">RANDOM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressOrigin(string='RANDOM')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.RANDOM" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The address is chosen by the system at random e.g., an IPv4 address within
|
|||
|
|
169.254/16, or an RFC 3041 privacy address. This class attribute was added
|
|||
|
|
in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IpAddressStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus" 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.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Interfaces.IpAddressStatus</span></code> class defines the present status of an
|
|||
|
|
address on an interface. See RFC 4293 IpAddressStatusTC. This enumeration
|
|||
|
|
was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IpAddressStatus</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.DEPRECATED">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DEPRECATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressStatus(string='DEPRECATED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.DEPRECATED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that this is a valid but deprecated address that should no longer
|
|||
|
|
be used as a source address. This class attribute was added in vSphere API
|
|||
|
|
7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.DUPLICATE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DUPLICATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressStatus(string='DUPLICATE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.DUPLICATE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates the address has been determined to be non-unique on the link,
|
|||
|
|
this address will not be reachable. This class attribute was added in
|
|||
|
|
vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.INACCESSIBLE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">INACCESSIBLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressStatus(string='INACCESSIBLE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.INACCESSIBLE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the address is not accessible because interface is not
|
|||
|
|
operational. This class attribute was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.INVALID">
|
|||
|
|
<code class="sig-name descname"><span class="pre">INVALID</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressStatus(string='INVALID')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.INVALID" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that this isn’t a valid address. This class attribute was added
|
|||
|
|
in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.PREFERRED">
|
|||
|
|
<code class="sig-name descname"><span class="pre">PREFERRED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressStatus(string='PREFERRED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.PREFERRED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that this is a valid address. This class attribute was added in
|
|||
|
|
vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.TENTATIVE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">TENTATIVE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressStatus(string='TENTATIVE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.TENTATIVE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the uniqueness of the address on the link is presently being
|
|||
|
|
verified. This class attribute was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.UNKNOWN">
|
|||
|
|
<code class="sig-name descname"><span class="pre">UNKNOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAddressStatus(string='UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the status cannot be determined. This class attribute was
|
|||
|
|
added in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpConfigInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IpConfigInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ip_addresses</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dhcp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpConfigInfo" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Interfaces.IpConfigInfo</span></code> class describes the protocol version
|
|||
|
|
independent address reporting data object for network interfaces. This
|
|||
|
|
class was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>ip_addresses</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressInfo" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.IpAddressInfo</span></code></a>) – IP addresses configured on the interface. This attribute was added
|
|||
|
|
in vSphere API 7.0.0.0.</p></li>
|
|||
|
|
<li><p><strong>dhcp</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.DhcpConfigInfo" title="com.vmware.vcenter.vm.guest_client.DhcpConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.DhcpConfigInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Client side DHCP for an interface. This attribute was added in
|
|||
|
|
vSphere API 7.0.0.0.
|
|||
|
|
If None the IP was not configured by DHCP.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.list">
|
|||
|
|
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about the networking interfaces in the guest
|
|||
|
|
operating system. This method was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine ID
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.list" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.Info" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the interfaces configured in the guest operating
|
|||
|
|
system. Interfaces are ordered in a guest operating system specific
|
|||
|
|
determined order.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Routes">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.guest.networking_client.</span></code><code class="sig-name descname"><span class="pre">Routes</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Routes" 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>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Routes</span></code> class provides methods for retrieving guest operating system
|
|||
|
|
network routing information. This class was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Routes.Info">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix_length</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gateway_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interface_index</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Routes.Info" 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.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Routes.Info</span></code> class describes an individual host, network or default
|
|||
|
|
destination network reachable through a gateway. This class was added in
|
|||
|
|
vSphere API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IP Address of the destination IP network. IPv4 address is specified
|
|||
|
|
using dotted decimal notation. For example, “192.0.2.1”. IPv6
|
|||
|
|
addresses are 128-bit specified using as eight fields of up to four
|
|||
|
|
hexadecimal digits. A colon separates each field (:). For example,
|
|||
|
|
2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of
|
|||
|
|
symbol ‘::’ to represent multiple 16-bit groups of contiguous 0’s
|
|||
|
|
only once in an address as described in RFC 2373. This attribute
|
|||
|
|
was added in vSphere API 7.0.0.0.</p></li>
|
|||
|
|
<li><p><strong>prefix_length</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The prefix length. For IPv4 the value range is 0-32. For IPv6
|
|||
|
|
prefixLength is a decimal value range 0-128. The property
|
|||
|
|
represents the number of contiguous, higher-order bits of the
|
|||
|
|
address that make up the network portion of the IP address. This
|
|||
|
|
attribute was added in vSphere API 7.0.0.0.</p></li>
|
|||
|
|
<li><p><strong>gateway_address</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>) – Where to send the packets for this route. Unicast IP Address of the
|
|||
|
|
next hop router. IPv4 address is specified using dotted decimal
|
|||
|
|
notation. For example, “192.0.2.1”. IPv6 addresses are 128-bit
|
|||
|
|
specified using as eight fields of up to four hexadecimal digits. A
|
|||
|
|
colon separates each field (:). For example,
|
|||
|
|
2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of
|
|||
|
|
symbol ‘::’ to represent multiple 16-bit groups of contiguous 0’s
|
|||
|
|
only once in an address as described in RFC 2373. This attribute
|
|||
|
|
was added in vSphere API 7.0.0.0.
|
|||
|
|
If None no gateway is set for the route.</p></li>
|
|||
|
|
<li><p><strong>interface_index</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>) – The network interface associated with this route. This is an index
|
|||
|
|
into the result of <a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.list" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Interfaces.list()</span></code></a> The index refers to the
|
|||
|
|
relative position of an element in a <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>. For example, an
|
|||
|
|
index of 0 refers to the first element in the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> while
|
|||
|
|
an index of 1 refers to the second element. This attribute was
|
|||
|
|
added in vSphere API 7.0.0.0.
|
|||
|
|
If None the route is not associated with a network interface.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.Routes.list">
|
|||
|
|
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Routes.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about network routing in the guest operating
|
|||
|
|
system. This method was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine ID
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Routes.list" title="com.vmware.vcenter.vm.guest.networking_client.Routes.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Routes.Info" title="com.vmware.vcenter.vm.guest.networking_client.Routes.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Routes.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the network routes configured in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest.networking_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.guest.networking_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
<a href="com.vmware.vcenter.vm.hardware.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.vm.hardware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
|
<a href="com.vmware.vcenter.vm.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.vm package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
© 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>
|