You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-11-27 22:18:36 +02:00
113 lines
3.6 KiB
Plaintext
Vendored
113 lines
3.6 KiB
Plaintext
Vendored
---
|
|
sidebar_position: 7
|
|
description: Execute custom command and other functions to work with FTP 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, FTP]
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# Execute custom command
|
|
Executes a specific (SITE) server command and returns the response
|
|
|
|
|
|
|
|
`Function ExecuteCustomCommand(Val Connection, Val CommandText) Export`
|
|
|
|
| Parameter | CLI option | Type | Required | Description |
|
|
|-|-|-|-|-|
|
|
| Connection | --conn | Arbitrary | ✔ | Existing connection or connection configuration |
|
|
| CommandText | --cmd | String | ✔ | Text of the executed command |
|
|
|
|
|
|
Returns: Map Of KeyAndValue - Processing result
|
|
|
|
<br/>
|
|
|
|
:::tip
|
|
The result can be returned as text or Base64 binary data in the structure `{"BYTES": <B64 string>}`
|
|
|
|
FTP Command: `SITE`
|
|
:::
|
|
<br/>
|
|
|
|
|
|
```bsl title="1C:Enterprise/OneScript code example"
|
|
Host = FunctionParameters["FTP_IP"];
|
|
Port = FunctionParameters["FTP_Port"];
|
|
Login = FunctionParameters["FTP_User"];
|
|
Password = FunctionParameters["FTP_Password"];
|
|
|
|
UseProxy = True;
|
|
FTPS = True;
|
|
|
|
ProxySettings = Undefined;
|
|
TLSSettings = Undefined; // FTPS
|
|
|
|
FTPSettings = OPI_FTP.GetConnectionSettings(Host, Port, Login, Password);
|
|
|
|
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_FTP.GetProxySettings(ProxyAddress, ProxyPort, ProxyType, ProxyLogin, ProxyPassword);
|
|
|
|
EndIf;
|
|
|
|
If FTPS Then
|
|
TLSSettings = OPI_FTP.GetTLSSettings(True);
|
|
EndIf;
|
|
|
|
Connection = OPI_FTP.CreateConnection(FTPSettings, ProxySettings, TLSSettings);
|
|
|
|
If OPI_FTP.IsConnector(Connection) Then
|
|
|
|
CommandText = "UMASK";
|
|
Result = OPI_FTP.ExecuteCustomCommand(Connection, CommandText);
|
|
|
|
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 ftp ExecuteCustomCommand \
|
|
--conn "{'set':{'advanced_resolve':true,'domain':'172.33.0.11','login':'bayselonarrend','passive':true,'password':'***','port':'21','read_timeout':'120','write_timeout':'120'},'tls':{'accept_invalid_certs':true,'ca_cert_path':null,'use_tls':true},'proxy':{'login':'proxyuser','password':'***','port':'1080','proxy_type':'socks5','server':'127.0.0.1'}}" \
|
|
--cmd "UMASK"
|
|
```
|
|
</TabItem>
|
|
|
|
<TabItem value="bat" label="CMD/Bat" default>
|
|
```batch
|
|
:: JSON data can also be passed as a path to a .json file
|
|
|
|
oint ftp ExecuteCustomCommand ^
|
|
--conn "{'set':{'advanced_resolve':true,'domain':'172.33.0.11','login':'bayselonarrend','passive':true,'password':'***','port':'21','read_timeout':'120','write_timeout':'120'},'tls':{'accept_invalid_certs':true,'ca_cert_path':null,'use_tls':true},'proxy':{'login':'proxyuser','password':'***','port':'1080','proxy_type':'socks5','server':'127.0.0.1'}}" ^
|
|
--cmd "UMASK"
|
|
```
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
|
|
```json title="Result"
|
|
{
|
|
"data": "200 Your current UMASK is 022\r\n",
|
|
"result": true,
|
|
"status": 200,
|
|
"close_connection": {
|
|
"result": true
|
|
}
|
|
}
|
|
```
|