• PHP Manual
  • Function Reference
  • Other Services
  • SSH2
  • SSH2 Functions
  • ssh2_auth_agent
  • ssh2_auth_hostbased_file
  • ssh2_auth_none
  • ssh2_auth_password
  • ssh2_auth_pubkey_file
  • ssh2_connect
  • ssh2_disconnect
  • ssh2_exec
  • ssh2_fetch_stream
  • ssh2_fingerprint
  • ssh2_forward_accept
  • ssh2_forward_listen
  • ssh2_methods_negotiated
  • ssh2_poll
  • ssh2_publickey_add
  • ssh2_publickey_init
  • ssh2_publickey_list
  • ssh2_publickey_remove
  • ssh2_scp_recv
  • ssh2_scp_send
  • ssh2_send_eof
  • ssh2_sftp
  • ssh2_sftp_chmod
  • ssh2_sftp_lstat
  • ssh2_sftp_mkdir
  • ssh2_sftp_readlink
  • ssh2_sftp_realpath
  • ssh2_sftp_rename
  • ssh2_sftp_rmdir
  • ssh2_sftp_stat
  • ssh2_sftp_symlink
  • ssh2_sftp_unlink
  • ssh2_shell
  • ssh2_tunnel
ssh2_sftp_stat
ssh2_sftp_unlink
SSH2 Functions
PHP Manual

ssh2_sftp_symlink

Create a symlink

Description

bool ssh2_sftp_symlink(resource $sftp, string $target, string $link)

Creates a symbolic link named link on the remote filesystem pointing to target.

Parameters

sftp

An SSH2 SFTP resource opened by ssh2_sftp.

target

Target of the symbolic link.

link

Return Values

Returns true on success or false on failure.

Examples

Example #1 Creating a symbolic link

<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');
$sftp = ssh2_sftp($connection);

ssh2_sftp_symlink($sftp, '/var/run/mysql.sock', '/tmp/mysql.sock');
?>

See Also

  • ssh2_sftp_readlink
  • symlink