docs/dyn/baremetalsolution_v2.projects.locations.sshKeys.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.sshKeys.html">sshKeys</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="#create">create(parent, body=None, sshKeyId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Register a public SSH key in the specified project for use with the interactive serial console feature.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a public SSH key registered in the specified project.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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="create">create(parent, body=None, sshKeyId=None, x__xgafv=None)</code>
  <pre>Register a public SSH key in the specified project for use with the interactive serial console feature.

Args:
  parent: string, Required. The parent containing the SSH keys. (required)
  body: object, The request body.
    The object takes the form of:

{ # An SSH key, used for authorizing with the interactive serial console feature.
  &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this SSH key. Currently, the only valid value for the location is &quot;global&quot;.
  &quot;publicKey&quot;: &quot;A String&quot;, # The public SSH key. This must be in OpenSSH .authorized_keys format.
}

  sshKeyId: string, Required. The ID to use for the key, which will become the final component of the key&#x27;s resource name. This value must match the regex: [a-zA-Z0-9@.\-_]{1,64}
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An SSH key, used for authorizing with the interactive serial console feature.
  &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this SSH key. Currently, the only valid value for the location is &quot;global&quot;.
  &quot;publicKey&quot;: &quot;A String&quot;, # The public SSH key. This must be in OpenSSH .authorized_keys format.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a public SSH key registered in the specified project.

Args:
  name: string, Required. The name of the SSH key to delete. Currently, the only valid value for the location is &quot;global&quot;. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.

Args:
  parent: string, Required. The parent containing the SSH keys. Currently, the only valid value for the location is &quot;global&quot;. (required)
  pageSize: integer, The maximum number of items to return.
  pageToken: string, The next_page_token value returned from a previous List request, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response of ListSSHKeys.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
  &quot;sshKeys&quot;: [ # The SSH keys registered in the project.
    { # An SSH key, used for authorizing with the interactive serial console feature.
      &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this SSH key. Currently, the only valid value for the location is &quot;global&quot;.
      &quot;publicKey&quot;: &quot;A String&quot;, # The public SSH key. This must be in OpenSSH .authorized_keys format.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>