1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-29 22:27:42 +02:00
Files
OpenIntegrations/docs/en/md/SFTP/File-management/Delete-file.mdx

114 lines
3.6 KiB
Plaintext
Raw Normal View History

2025-09-26 09:27:29 +03:00
---
sidebar_position: 2
description: Delete file and other functions to work with SFTP in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, SFTP]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Delete file
Delete file from server
`Function DeleteFile(Val Connection, Val Path) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Connection | --conn | Arbitrary | ✔ | Existing connection or connection configuration |
2025-10-05 19:19:32 +03:00
| Path | --path | String | ✔ | Path to file on server |
2025-09-26 09:27:29 +03:00
Returns: Map Of KeyAndValue - Processing result
<br/>
```bsl title="1C:Enterprise/OneScript code example"
2025-10-20 19:41:52 +03:00
Host = FunctionParameters["SSH_Host"];
Port = FunctionParameters["SSH_Port"];
2025-09-26 09:27:29 +03:00
UseProxy = True;
ProxySettings = Undefined;
AuthorizationType = "By login and password";
If AuthorizationType = "By login and password" Then
2025-10-20 19:41:52 +03:00
Login = FunctionParameters["SSH_User"];
Password = FunctionParameters["SSH_Password"];
2025-09-26 09:27:29 +03:00
2025-10-05 19:19:32 +03:00
SFTPSettings = OPI_SFTP.GetSettingsLoginPassword(Host, Port, Login, Password);
2025-09-26 09:27:29 +03:00
ElsIf AuthorizationType = "By key" Then
2025-10-20 19:41:52 +03:00
Login = FunctionParameters["SSH_User"];
2025-09-26 09:27:29 +03:00
PrivateKey = "./ssh_key";
PublicKey = "./ssh_key.pub";
2025-10-05 19:19:32 +03:00
SFTPSettings = OPI_SFTP.GetSettingsPrivateKey(Host, Port, Login, PrivateKey, PublicKey);
2025-09-26 09:27:29 +03:00
Else
2025-10-20 19:41:52 +03:00
Login = FunctionParameters["SSH_User"];
2025-10-05 19:19:32 +03:00
SFTPSettings = OPI_SFTP.GetSettingsViaAgent(Host, Port, Login);
2025-09-26 09:27:29 +03:00
EndIf;
If UseProxy Then
2025-10-20 19:41:52 +03:00
ProxyType = FunctionParameters["Proxy_Type"]; // http, socks5, socks4
2025-09-26 09:27:29 +03:00
2025-10-20 19:41:52 +03:00
ProxyAddress = FunctionParameters["Proxy_IP"];
ProxyPort = FunctionParameters["Proxy_Port"];
ProxyLogin = FunctionParameters["Proxy_User"];
ProxyPassword = FunctionParameters["Proxy_Password"];
2025-09-26 09:27:29 +03:00
ProxySettings = OPI_SFTP.GetProxySettings(ProxyAddress, ProxyPort, ProxyType, ProxyLogin, ProxyPassword);
EndIf;
2025-10-05 19:19:32 +03:00
Connection = OPI_SFTP.CreateConnection(SFTPSettings, ProxySettings);
2025-09-26 09:27:29 +03:00
If OPI_SFTP.IsConnector(Connection) Then
Result = OPI_SFTP.DeleteFile(Connection, "files_folder/pic_from_binary.png");
Else
Result = Connection; // Error of connection
EndIf;
```
2025-10-07 19:27:04 +03:00
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
# JSON data can also be passed as a path to a .json file
oint sftp DeleteFile \
2025-10-15 14:32:00 +03:00
--conn "{'proxy':{'login':'proxyuser','password':'***','port':'8071','proxy_type':'http','server':'127.0.0.1'},'set':{'auth_type':'private_key','host':'172.33.0.13','key_path':'***','passphrase':null,'password':null,'port':'2222','pub_path':'/tmp/2clco5hb.neb.tmp','username':'bayselonarrend'}}" \
2025-10-07 19:27:04 +03:00
--path "files_folder/pic_from_binary.png"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
:: JSON data can also be passed as a path to a .json file
oint sftp DeleteFile ^
2025-10-15 14:32:00 +03:00
--conn "{'proxy':{'login':'proxyuser','password':'***','port':'8071','proxy_type':'http','server':'127.0.0.1'},'set':{'auth_type':'private_key','host':'172.33.0.13','key_path':'***','passphrase':null,'password':null,'port':'2222','pub_path':'/tmp/2clco5hb.neb.tmp','username':'bayselonarrend'}}" ^
2025-10-07 19:27:04 +03:00
--path "files_folder/pic_from_binary.png"
```
</TabItem>
</Tabs>
```json title="Result"
{
2025-10-15 14:32:00 +03:00
"result": true,
"close_connection": {
"result": true
}
2025-10-07 19:27:04 +03:00
}
```