PowerShell

Get a Remote File's Group

Demonstrates the Chilkat SFtp.GetFileGroup method, which returns a remote file's group ownership. The arguments are the remote path (or handle), whether symbolic links are followed, and whether the first argument is a handle.

Background: The group is the second half of Unix ownership, and it drives the "group" permission bits — the mechanism by which several accounts share access to the same files. As with the owner, the server may return a numeric GID when it cannot resolve a name, and the value is meaningful only on servers that implement Unix-style ownership.

Chilkat PowerShell Downloads

Download Chilkat for PowerShell

PowerShell

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

$success = $false

#  Demonstrates the SFtp.GetFileGroup method, which returns a remote file's group ownership.  The
#  1st argument is the remote path (or handle), the 2nd selects whether symbolic links are
#  followed, and the 3rd indicates whether the 1st argument is a handle.

$sftp = New-Object Chilkat.SFtp

#  Connect, authenticate, and initialize the SFTP subsystem.
$port = 22
$success = $sftp.Connect("sftp.example.com",$port)
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
$password = "mySshPassword"

$success = $sftp.AuthenticatePw("mySshLogin",$password)
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

$success = $sftp.InitializeSftp()
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

#  The 2nd argument (bFollowLinks) selects whether a symbolic link is followed to its target.
#  The 3rd argument (bIsHandle) is $false here because the 1st argument is a path, not an
#  open handle.
$bFollowLinks = $true
$bIsHandle = $false

$group = $sftp.GetFileGroup("subdir/report.pdf",$bFollowLinks,$bIsHandle)
if ($sftp.LastMethodSuccess -eq $false) {
    $($sftp.LastErrorText)
    exit
}

$("Group: " + $group)

$sftp.Disconnect()