SMB
App Vendor: SMB
App Category: IT Services
App Version in Orchestrate: 1.1.0
About App
The SMB (Server Message Block) app allows security teams to integrate with the SMB enterprise application to communicate with the remote servers, and access files and other resources. Using the SMB app, you can open, edit, and share files.
The SMB app in the Orchestrate application performs the following actions:
Action | Description |
|---|---|
Get a list of shared drives | This action retrieves a list of shared drives as services from the SMB server using the SMB application. |
Upload a file | This action uploads a local file to a remote file path system on the SMB server using the SMB application. |
Download a file | This action downloads a remote file from the SMB server to the local file system using the SMB application. |
Get a list of directories | This action retrieves a list of directories from the SMB server using the SMB application. |
Configuration Parameters
The following configuration parameters are required for the SMB app to communicate with the SMB enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the SMB hostname or IP address to integrate with. | Text | Required | |
Username | Enter the SMB username. | Text | Required | |
Server name | Enter the SMB server name. | Text | Required | |
Port | Enter the SMB server port. | Text | Required | |
Password | Enter the SMB password. | Password | Required | |
Secure NTLM2 | An option to either skip or make the connection NTLM2 secure. | Text | Optional | Allowed values:
Default value: no |
Direct TCP | An option to either skip or connect directly over TCP. | Text | Optional | Allowed values:
Default value: no |
Action: Upload a file
This action uploads a local file to a remote file path system on the SMB server using the SMB application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Shared drive | Enter the shared drive as a service name. Example: "sharedrive101" | Text | Required | |
Local file path | Enter the local file path. Example: "/tmp/0a612-0d0b-4261-9b5e-2f49/testfile01.txt" | Text | Required | |
Remote file path | Enter the remote file path. Example: "rest-api/data/testfile01.txt" | Text | Required |
Example Request
[
{
"shared_drive": "samba-share"
"local_filepath": "/tmp/0a612-0d0b-4261-9b5e-2f49/testfile01.txt"
"remote_filepath": "rest-api/data/testfile01.txt"
}
] |
Action: Download a file
This action downloads a remote file to the local file system from the SMB server using the SMB application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Shared drive | Enter the shared drive as a service name. Example: "sharedrive101" | Text | Required | |
Remote file path | Enter the remote file path. Example: "rest-api/data/testfile01.txt" | Text | Required | |
Local file name | Enter the local file name. By default, the file name is taken from the remote file path. | Text | Optional |
Example Request
[
{
"shared_drive": "samba-share"
"remote_filepath": "rest-api/data/testfile01.txt"
}
] |
Action: Get a list of directories
This action retrieves a list of directories from the SMB server using the SMB application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Shared drive | Enter the shared drive as a service name. Example: "sharedrive101" | Text | Required | |
Directory | Enter the name of the directory. | Text | Optional | Default value: "/" |
Example Request
[
{
"shared_drive": "samba-share"
}
] |