Bare Metal Solution API . projects . locations . sshKeys

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, sshKeyId=None, x__xgafv=None)

Register a public SSH key in the specified project for use with the interactive serial console feature.

delete(name, x__xgafv=None)

Deletes a public SSH key registered in the specified project.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, sshKeyId=None, x__xgafv=None)
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.
  "name": "A String", # Output only. The name of this SSH key. Currently, the only valid value for the location is "global".
  "publicKey": "A String", # 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'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.
  "name": "A String", # Output only. The name of this SSH key. Currently, the only valid value for the location is "global".
  "publicKey": "A String", # The public SSH key. This must be in OpenSSH .authorized_keys format.
}
delete(name, x__xgafv=None)
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 "global". (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); }
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
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 "global". (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.
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
  "sshKeys": [ # The SSH keys registered in the project.
    { # An SSH key, used for authorizing with the interactive serial console feature.
      "name": "A String", # Output only. The name of this SSH key. Currently, the only valid value for the location is "global".
      "publicKey": "A String", # The public SSH key. This must be in OpenSSH .authorized_keys format.
    },
  ],
}
list_next()
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 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.