docs/dyn/baremetalsolution_v2.projects.locations.nfsshares.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="baremetalsolution_v2.html">Bare Metal Solution API</a> . <a href="baremetalsolution_v2.projects.html">projects</a> . <a href="baremetalsolution_v2.projects.locations.html">locations</a> . <a href="baremetalsolution_v2.projects.locations.nfsshares.html">nfsshares</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#rename">rename(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">RenameNfsShare sets a new name for an nfsshare. Use with caution, previous names become immediately invalidated.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="rename">rename(name, body=None, x__xgafv=None)</code>
  <pre>RenameNfsShare sets a new name for an nfsshare. Use with caution, previous names become immediately invalidated.

Args:
  name: string, Required. The `name` field is used to identify the nfsshare. Format: projects/{project}/locations/{location}/nfsshares/{nfsshare} (required)
  body: object, The request body.
    The object takes the form of:

{ # Message requesting rename of a server.
  &quot;newNfsshareId&quot;: &quot;A String&quot;, # Required. The new `id` of the nfsshare.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An NFS share.
  &quot;allowedClients&quot;: [ # List of allowed access points.
    { # Represents an &#x27;access point&#x27; for the share.
      &quot;allowDev&quot;: True or False, # Allow dev flag. Which controls whether to allow creation of devices.
      &quot;allowSuid&quot;: True or False, # Allow the setuid flag.
      &quot;allowedClientsCidr&quot;: &quot;A String&quot;, # The subnet of IP addresses permitted to access the share.
      &quot;mountPermissions&quot;: &quot;A String&quot;, # Mount permissions.
      &quot;network&quot;: &quot;A String&quot;, # The network the access point sits on.
      &quot;nfsPath&quot;: &quot;A String&quot;, # Output only. The path to access NFS, in format shareIP:/InstanceID InstanceID is the generated ID instead of customer provided name. example like &quot;10.0.0.0:/g123456789-nfs001&quot;
      &quot;noRootSquash&quot;: True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
      &quot;shareIp&quot;: &quot;A String&quot;, # Output only. The IP address of the share on this network. Assigned automatically during provisioning based on the network&#x27;s services_cidr.
    },
  ],
  &quot;id&quot;: &quot;A String&quot;, # Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfs_share_id and will replace it in the future.
  &quot;labels&quot;: { # Labels as key value pairs.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. The name of the NFS share.
  &quot;nfsShareId&quot;: &quot;A String&quot;, # Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use `id` instead.
  &quot;requestedSizeGib&quot;: &quot;A String&quot;, # The requested size, in GiB.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the NFS share.
  &quot;storageType&quot;: &quot;A String&quot;, # Immutable. The storage type of the underlying volume.
  &quot;volume&quot;: &quot;A String&quot;, # Output only. The underlying volume of the share. Created automatically during provisioning.
}</pre>
</div>

</body></html>