paramiko の API リファレンス

paramiko (paramiko/paramiko) の公開 API 72 件 —— クラス 29、関数 2、メソッド 41。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

種別	件数
クラス	29
関数	2
メソッド	41

API 一覧

methodparamiko.agent.Agent.close()

Close the SSH agent connection.

classparamiko.agent.AgentClientProxy

Class proxying request as a client: #.

classparamiko.agent.AgentKey

Private key held in a local SSH agent.

classparamiko.agent.AgentProxyThread

Class in charge of communication between two channels.

classparamiko.agent.AgentRemoteProxy

Class to be used when wanting to ask a remote SSH Agent

classparamiko.agent.AgentServerProxy

Allows an SSH server to access a forwarded agent.

classparamiko.auth_handler.AuthHandler

Internal class to handle the mechanics of authentication.

classparamiko.auth_handler.AuthOnlyHandler

AuthHandler, and just auth, no service requests!

classparamiko.auth_strategy.AuthResult

Represents a partial or complete SSH authentication attempt.

classparamiko.auth_strategy.InMemoryPrivateKey

An in-memory, decrypted `.PKey` object.

classparamiko.auth_strategy.Password

Password authentication.

classparamiko.auth_strategy.PrivateKey

Essentially a mixin for private keys.

classparamiko.ber.BER

Robey's tiny little attempt at a BER decoder.

classparamiko.channel.Channel

A secure tunnel across an SSH `.Transport`.

methodparamiko.channel.Channel.close()

Close the channel.

methodparamiko.channel.Channel.exec_command(command)

Execute a command on the server.

methodparamiko.channel.Channel.get_id()

Return the `int` ID # for this channel.

methodparamiko.channel.Channel.recv(nbytes)

Receive data from the channel.

methodparamiko.channel.Channel.resize_pty(width=80, height=24, width_pixels=0, height_pixels=0)

Resize the pseudo-terminal.

methodparamiko.channel.Channel.send(s)

Send data to the channel.

methodparamiko.channel.Channel.set_name(name)

Set a name for this channel.

classparamiko.channel.ChannelFile

A file-like wrapper around `.Channel`.

classparamiko.channel.ChannelStderrFile

A file-like wrapper around `.Channel` stderr.

classparamiko.channel.ChannelStdinFile

A file-like wrapper around `.Channel` stdin.

classparamiko.client.RejectPolicy

Policy for automatically rejecting the unknown hostname & key.

classparamiko.client.SSHClient

A high-level representation of a session with an SSH server.

methodparamiko.client.SSHClient.get_host_keys()

Get the local `.HostKeys` object.

methodparamiko.client.SSHClient.open_sftp()

Open an SFTP session on the SSH server.

methodparamiko.client.SSHClient.save_host_keys(filename)

Save the host keys back to a file.

methodparamiko.client.SSHClient.set_log_channel(name)

Set the channel for logging.

classparamiko.config.LazyFqdn

Returns the host's fqdn on request as string.

classparamiko.hostkeys.HostKeyEntry

Representation of a line in an OpenSSH-style "known hosts" file.

classparamiko.hostkeys.HostKeys

Representation of an OpenSSH-style "known hosts" file.

methodparamiko.hostkeys.HostKeys.add(hostname, keytype, key)

Add a host key entry to the table.

methodparamiko.message.Message.add(*seq)

Add a sequence of items to the stream.

methodparamiko.message.Message.add_adaptive_int(n)

Add an integer to the stream.

methodparamiko.message.Message.add_boolean(b)

Add a boolean value to the stream.

methodparamiko.message.Message.add_int(n)

Add an integer to the stream.

methodparamiko.message.Message.add_int64(n)

Add a 64-bit int to the stream.

methodparamiko.message.Message.add_list(l)

Add a list of strings to the stream.

methodparamiko.message.Message.add_string(s)

Add a bytestring to the stream.

methodparamiko.message.Message.get_adaptive_int()

Fetch an int from the stream.

methodparamiko.message.Message.get_binary()

Alias for `get_string` (obtains a bytestring).

methodparamiko.message.Message.get_boolean()

Fetch a boolean from the stream.

methodparamiko.message.Message.get_int()

Fetch an int from the stream.

methodparamiko.message.Message.get_int64()

Fetch a 64-bit int from the stream.

methodparamiko.message.Message.get_string()

Fetch a "string" from the stream.

methodparamiko.message.Message.get_text()

Fetch a Unicode string from the stream.

classparamiko.packet.NeedRekeyException

Exception indicating a rekey is needed.

classparamiko.packet.Packetizer

Implementation of the base SSH packet protocol.

methodparamiko.packet.Packetizer.readline(timeout)

Read a line from the socket.

classparamiko.pkey.PKey

Base class for public keys.

classparamiko.proxy.ProxyCommand

Wraps a subprocess running ProxyCommand-driven programs.

methodparamiko.rsakey.RSAKey.generate(bits, progress_func=None)

Generate a new private RSA key.

classparamiko.server.SubsystemHandler

Handler for a subsystem in server mode.

classparamiko.sftp_client.SFTP

An alias for `.SFTPClient` for backwards compatibility.

classparamiko.sftp_client.SFTPClient

SFTP client object.

methodparamiko.sftp_client.SFTPClient.open(filename, mode='r', bufsize=-1)

Open a file on the remote server.

methodparamiko.sftp_client.SFTPClient.remove(path)

Remove the file at the given path.

methodparamiko.sftp_client.SFTPClient.rmdir(path)

Remove the folder named ``path``.

methodparamiko.sftp_file.SFTPFile.close()

Close the file.

methodparamiko.sftp_file.SFTPFile.seek(offset, whence=0)

Set the file's current position.

methodparamiko.sftp_file.SFTPFile.truncate(size)

Change the size of this file.

classparamiko.sftp_server.SFTPServer

Server-side SFTP subsystem support.

methodparamiko.transport.SecurityOptions.ciphers()

Symmetric encryption ciphers

methodparamiko.transport.SecurityOptions.compression()

Compression algorithms

methodparamiko.transport.SecurityOptions.digests()

Digest (one-way hash) algorithms

methodparamiko.transport.SecurityOptions.kex()

Key exchange algorithms

methodparamiko.transport.SecurityOptions.key_types()

Public-key algorithms

methodparamiko.transport.Transport.use_compression(compress=True)

Turn on/off compression.

funcparamiko.util.b(s, encoding='utf8')

cast unicode or bytes to bytes

funcparamiko.util.u(s, encoding='utf8')

cast bytes or unicode to unicode

この情報について

掲載しているシグネチャは paramiko/paramiko の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る