You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-11-29 22:27:42 +02:00
114 lines
3.6 KiB
Plaintext
Vendored
114 lines
3.6 KiB
Plaintext
Vendored
---
|
|
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 |
|
|
| Path | --path | String | ✔ | Path to file on server |
|
|
|
|
|
|
Returns: Map Of KeyAndValue - Processing result
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
```bsl title="1C:Enterprise/OneScript code example"
|
|
Host = FunctionParameters["SSH_Host"];
|
|
Port = FunctionParameters["SSH_Port"];
|
|
|
|
UseProxy = True;
|
|
ProxySettings = Undefined;
|
|
AuthorizationType = "By login and password";
|
|
|
|
If AuthorizationType = "By login and password" Then
|
|
|
|
Login = FunctionParameters["SSH_User"];
|
|
Password = FunctionParameters["SSH_Password"];
|
|
|
|
SFTPSettings = OPI_SFTP.GetSettingsLoginPassword(Host, Port, Login, Password);
|
|
|
|
ElsIf AuthorizationType = "By key" Then
|
|
|
|
Login = FunctionParameters["SSH_User"];
|
|
PrivateKey = "./ssh_key";
|
|
PublicKey = "./ssh_key.pub";
|
|
|
|
SFTPSettings = OPI_SFTP.GetSettingsPrivateKey(Host, Port, Login, PrivateKey, PublicKey);
|
|
|
|
Else
|
|
|
|
Login = FunctionParameters["SSH_User"];
|
|
SFTPSettings = OPI_SFTP.GetSettingsViaAgent(Host, Port, Login);
|
|
|
|
EndIf;
|
|
|
|
If UseProxy Then
|
|
|
|
ProxyType = FunctionParameters["Proxy_Type"]; // http, socks5, socks4
|
|
|
|
ProxyAddress = FunctionParameters["Proxy_IP"];
|
|
ProxyPort = FunctionParameters["Proxy_Port"];
|
|
ProxyLogin = FunctionParameters["Proxy_User"];
|
|
ProxyPassword = FunctionParameters["Proxy_Password"];
|
|
|
|
ProxySettings = OPI_SFTP.GetProxySettings(ProxyAddress, ProxyPort, ProxyType, ProxyLogin, ProxyPassword);
|
|
|
|
EndIf;
|
|
|
|
Connection = OPI_SFTP.CreateConnection(SFTPSettings, ProxySettings);
|
|
|
|
If OPI_SFTP.IsConnector(Connection) Then
|
|
Result = OPI_SFTP.DeleteFile(Connection, "files_folder/pic_from_binary.png");
|
|
Else
|
|
Result = Connection; // Error of connection
|
|
EndIf;
|
|
```
|
|
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="bash" label="Bash" default>
|
|
```bash
|
|
# JSON data can also be passed as a path to a .json file
|
|
|
|
oint sftp DeleteFile \
|
|
--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'}}" \
|
|
--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 ^
|
|
--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'}}" ^
|
|
--path "files_folder/pic_from_binary.png"
|
|
```
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
|
|
```json title="Result"
|
|
{
|
|
"result": true,
|
|
"close_connection": {
|
|
"result": true
|
|
}
|
|
}
|
|
```
|