GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  NET::SSH2::SFTP (3)

.ds Aq ’

NAME

Net::SSH2::SFTP - SSH 2 Secure FTP object

CONTENTS

DESCRIPTION

An SFTP object is created by the Net::SSH2 sftp method.

    error

Returns the last SFTP error (one of the LIBSSH2_FX_* constants). Use this when Net::SSH2::error returns LIBSSH2_ERROR_SFTP_PROTOCOL. In list context, returns (code, error name).

    open ( file [, flags [, mode ]]] )

Open or create a file on the remote host. The flags are the standard O_RDONLY, O_WRONLY, O_RDWR, O_APPEND, O_CREAT, O_TRUNC, and O_EXCL, which may be combined as usual. Flags default to O_RDONLY and mode to 0666 (create only). Returns a Net::SSH2::File object on success.

    opendir ( dir )

Open a directory on the remote host; returns a Net::SSH2::Dir object on success.

    unlink ( file )

Delete the remote file.

    rename ( old, new [, flags ] )

Rename old to new. Flags are taken from LIBSSH2_SFTP_RENAME_*, and may be combined; the default is to use all (overwrite, atomic, native).

    mkdir ( path [, mode ] )

Create directory; mode defaults to 0777.

    rmdir ( path )

Remove directory.

    stat ( path [, follow ] )

Get file attributes for the given path. If follow is set (default), will follow symbolic links. On success, returns a hash containing the following:
mode
size
uid
gid
atime
mtime

    setstat ( path, key, value... )

Set file attributes for given path; keys are the same as those returned by stat; note that it’s not necessary to pass them all.

    symlink ( path, target [, type ] )

Create a symbolic link to a given target.

    readlink ( path )

Return the target of the given link, undef on failure.

    realpath ( path )

Resolve a filename’s path; returns the resolved path, or undef on error.

SEE ALSO

Net::SSH2.

Check Net::SFTP::Foreign for a high level, perlish and easy to use SFTP client module. It can work on top of Net::SSH2 via the Net::SFTP::Foreign::Backend::Net_SSH2 backend module.

AUTHOR

David B. Robins, <dbrobins@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2005, 2006 by David B. Robins; all rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.0 or, at your option, any later version of Perl 5 you may have available.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 NET::SSH2::SFTP (3) 2015-09-28

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.