PowerShell

SFTP Get/Set File Permission

See more SFTP Examples

Demonstrates how to set the permissions of a file on the SFTP server. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$sftp = New-Object Chilkat.SFtp

# Connect to the SSH/SFTP server.  
$hostname = "sftp.example.com"
$port = 22
$success = $sftp.Connect($hostname,$port)
if ($success -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
$success = $sftp.AuthenticatePw("myLogin","myPassword")
if ($success -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# After authenticating, the SFTP subsystem must be initialized:
$success = $sftp.InitializeSftp()
if ($success -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# Get the file permissions for the "hamlet.xml" file on the server.
# The hamlet.xml file is located in the qa_data directory found under the HOME directory of the SSH user account.
# We are passing the remote file path (we are not passing a file handle returned by a previous call to OpenFile).
$isHandle = $false
$followLinks = $true
$permVal = $sftp.GetFilePermissions("qa_data/hamlet.xml",$followLinks,$isHandle)
if ($permVal -lt 0) {
    $($sftp.LastErrorText)
    exit
}

# Note: Filesystem permissions on Linux/Unix/MacOSX are typically written in octal (POSIX file permissions).  For example 0644 is octal.
# To convert to decimal: octal 644 = 6*8^2 + 4*8 + 4 = 420 (decimal)
# 
# The server may return a permissions value (in octal) such as 100644.
# The "100" indicates the file type, such as regular file or directory. 

# Show the decimal value of the permissions
$("decimal permissions value: " + $permVal)

# To set the file permissions, pass the integer value.
# Let's change the permissions to 0664, which is 6*8^2 + 6*8 + 4 = 436 (decimal)
$success = $sftp.SetPermissions("qa_data/hamlet.xml",$isHandle,436)
if ($success -ne $true) {
    $($sftp.LastErrorText)
    exit
}

$("Success.")