Server Message Block (SMB)

Use the SMB integration to upload and download files from an SMB protocol.

Configure SMB on Demisto

If you did not configure the Server IP / Hostname, Server NetBIOS (AD) Name, or Domain parameters, you can configure them later on as command arguments. In that case, the test command in the instance configuration will return an error.

1. Navigate to Settings > Integrations > Servers & Services .
2. Search for SMB.
3. Click Add instance to create and configure a new integration instance.
   
   • Name : a textual name for the integration instance.
   • Server IP / Hostname
   • Port
   • Server NetBIOS (AD) Name
   • Domain
   • Username
   • Use system proxy settings
4. Click Test to validate the URLs, token, and connection.

Commands

You can execute these commands from the Demisto CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

1. Download a file: smb-download
2. Upload a file: smb-upload

1. Download a file

---

Downloads a file from an SMB server.

Base Command

smb-download

Input

Argument Name	Description	Required
hostname	Server IP address or hostname, for example, 1.2.3.4.	Optional
nbname	Name of the server NetBIOS (AD).	Optional
domain	The host domain.	Optional
file_path	The path to the file, starting from the share	Required
download_and_attach	If "yes", the file is downloaded and attached. If "no", only the output is attached. Default is "yes".	Optional

Command Example

!smb-download file_path=/Shared/test.txt

Context Output

War Room Output

2. Upload a file

---

Uploads a file to an SMB server.

Base Command

smb-upload

Input

Argument Name	Description	Required
hostname	Server IP address or hostname, for example, 1.2.3.4.	Optional
nbname	Name of the server NetBIOS (AD).	Optional
domain	The host domain.	Optional
file-path	The path to the file, starting from the share, for example: Share/Folder/File.	Required
entryID	The entry ID to the file to send to the share.	Optional
content	The content of the file to send to the share	Optional

Troubleshooting

The following error might be due to an incorrect file path, or a permissions issue.