Document toolboxDocument toolbox

SMB Actions

[ 1 Connect SMB with Devo SOAR ] [ 2 Actions for SMB ] [ 2.1 List Files ] [ 2.1.1 Input Field ] [ 2.1.2 Output ] [ 2.2 Download File ] [ 2.3 Upload File ] [ 2.3.1 Input Field ] [ 2.3.2 Output ] [ 2.4 Move File ] [ 2.4.1 Input Field ] [ 2.4.2 Output ] [ 2.5 Delete File ] [ 2.5.1 Input Field ] [ 2.5.2 Output ] [ 3 Release Notes ]

Server Message Block (SMB) is a network communication protocol for providing shared access to files, printers, and serial ports between nodes on a network.

Connect SMB with Devo SOAR

  1. Navigate to Automations > Integrations.

  2. Search for SMB Actions.

  3. Click Details, then the + icon. Enter the required information in the following fields.

  4. Label: Enter a connection name.

  5. Reference Values: Define variables here to templatize integration connections and actions. For example, you can use https://www.{{hostname}}.com where, hostname is a variable defined in this input. For more information on how to add data, see 'Add Data' Input Type for Integrations.

  6. Verify SSL: Select option to verify connecting server's SSL certificate (Default is Verify SSL Certificate).

  7. Remote Agent: Run this integration using the Devo SOAR Remote Agent.

  8. Server Address: Server address for SMB connection.

  9. Server Port (Optional): Port for SMB connection (Default is 445 port).

  10. Username: Username for SMB connection.

  11. Password: Password for SMB connection.

  12. After you've entered all the details, click Connect.

Actions for SMB

List Files

Retrieve a directory listing of files/folders at the path.

Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

Input Name

Description

Required

Input Name

Description

Required

NETBIOS Name Column Name

Column name from the parent table that contains NETBIOS name of the remote server.

Required

Service Name Column Name

Column name from the parent table that contains the name of the shared folder.

Required

Output

A JSON object containing multiple rows of result:

  • has_error: True/False

  • error: message/null

  • result: List of files.

Download File

Download a file at the path on the service name.

Inputs to this Action:

  • Connection: Choose a connection that you have created.

  • NETBIOS Name Column Name: Column name from the parent table that contains NETBIOS name of the remote server.

  • Service Name Column Name: Column name from the parent table that contains the name of the shared folder.

  • Path Column Name: Column name from the parent table that contains path relative to the service name.

Output of Action:
A JSON object containing multiple rows of result:

  • has_error: True/False

  • error: message/null

  • result: File Id.

Upload File

Upload the file at the path on the service name.

Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

Input Name

Description

Required

Input Name

Description

Required

NETBIOS Name Column Name

Column name from the parent table that contains NETBIOS name of the remote server.

Required

Service Name Column Name

Column name from the parent table that contains the name of the shared folder.

Required

Path Column Name

Column name from the parent table that contains path relative to the service name.

Required

File Id Column Name

Column name from the parent table that contains file id.

Required

Output

A JSON object containing multiple rows of result:

  • has_error: True/False

  • error: message/null

  • result: Success/Failure message.

Move File

Move a file at old path to new path shared at service name.

Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

Input Name

Description

Required

Input Name

Description

Required

NETBIOS Name Column Name

Column name from the parent table that contains NETBIOS name of the remote server.

Required

Service Name Column Name

Column name from the parent table that contains the name of the shared folder.

Required

Source Path Column Name

Column name from the parent table that contains source path relative to the service name.

Required

Destination Path Column Name

Column name from the parent table that contains the destination path relative to the service name.

Required

Output

A JSON object containing multiple rows of result:

  • has_error: True/False

  • error: message/null

  • result: Success/Failure message.

Delete File

Delete a file at path shared at service name.

Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

Input Name

Description

Required

Input Name

Description

Required

NETBIOS Name Column Name

Column name from the parent table that contains NETBIOS name of the remote server.

Required

Service Name Column Name

Column name from the parent table that contains the name of the shared folder.

Required

Path Column Name

Column name from the parent table that contains path relative to the service name.

Required

Output

A JSON object containing multiple rows of result:

  • has_error: True/False

  • error: message/null

  • result: Success/Failure message.

Release Notes

  • v2.0.0 - Updated architecture to support IO via filesystem