Simple SFTP

Details

ID	`Simple SFTP`
Provider	Open Source
Category	Utilities
From Version	6.2.0
Docker Image	`demisto/netmiko:1.0.0.9067966`
Supported Modules	Agentix XSIAM

README

sftp-listdir

List Directories SFTP command given directory path. Defaults to current directory upon sftp login.

Base Command

sftp-listdir

Input

Argument Name	Description	Required
directory	The directory from which to list the all directories. Default is ..	Optional

Context Output

There is no context output for this command.

sftp-copyfrom

Copies contents of file specified from the sftp server and prints it to the war room

Base Command

sftp-copyfrom

Input

Argument Name	Description	Required
file_path	Please provide file path as seen by the sftp user upon login.	Required
return_file	Defaults to False where text based file content will be printed. Please specify as True to download the file in case of non-text based files. Possible values are: True, False. Default is False.	Optional

Context Output

There is no context output for this command.

sftp-upload-file

Uploads a file from the War Room using it’s Entry ID to the SFTP Server at a given path

Base Command

sftp-upload-file

Input

Argument Name	Description	Required
path	Destination path on SFTP Server to upload the file to	Required
file_entry_id	War-room Entry ID for the file to upload	Required

Context Output

There is no context output for this command.

Configuration parameters

host — Host (required)
proxy — Use system proxy settings
authentication — Username (required)
port — Port

Commands (3)

sftp-copyfrom
Copies contents of file specified from the sftp server and prints it to the war room
sftp-listdir
List Directories SFTP command given directory path. Defaults to current directory upon sftp login.
sftp-upload-file
Upload a file to a path on the SFTP Server

Source

SimpleSFTP.py SimpleSFTP.yml SimpleSFTP_description.md

Download History Raw

commonfields:
  id: Simple SFTP
  version: -1
name: Simple SFTP
display: Simple SFTP
category: Utilities
provider: Open Source
description: Simple SFTP Integration to copy files from SFTP Server using paramiko.
configuration:
- display: Host
  name: host
  type: 0
  required: true
- display: Use system proxy settings
  name: proxy
  type: 8
  required: false
- display: Username
  name: authentication
  type: 9
  required: true
- display: Port
  name: port
  defaultvalue: '22'
  type: 0
  additionalinfo: Defaults to 22
  required: false
script:
  script: ''
  type: python
  commands:
  - name: sftp-listdir
    arguments:
    - name: directory
      defaultValue: .
      description: The directory from which to list the all directories.
    description: List Directories SFTP command given directory path. Defaults to current directory upon sftp login.
  - name: sftp-copyfrom
    arguments:
    - name: file_path
      required: true
      description: Please provide file path as seen by the sftp user upon login.
    - name: return_file
      auto: PREDEFINED
      predefined:
      - 'True'
      - 'False'
      description: Defaults to False where text based file content will be printed. Please specify as True to download the file in case of non-text based files.
      defaultValue: 'False'
    description: Copies contents of file specified from the sftp server and prints it to the war room
  - name: sftp-upload-file
    arguments:
    - description: Directory to upload the file to.
      name: path
      required: true
    - description: Warroom Entry ID for the file to upload.
      name: file_entry_id
      required: true
    description: Upload a file to a path on the SFTP Server
  dockerimage: demisto/netmiko:1.0.0.9067966
  subtype: python3
fromversion: 6.2.0
tests:
- No tests (auto formatted)