ReadFile

Details

ID	`ReadFile`
Language	python
From Version	5.0.0
Docker Image	`demisto/python3:3.12.13.10404775`
Tags	Utility ingestion

README

Load the contents of a file into context.

Script Data

Name	Description
Script Type	python2
Tags	Utility, ingestion
Cortex XSOAR Version	5.0.0

Used In

This script is used in the following playbooks and scripts.

Integration Troubleshooting
Rapid IOC Hunting Playbook

Inputs

Argument Name	Description
entryID	War Room entryID of the file to read.
maxFileSize	Maximal file size to load, in bytes. Default is 1MB.
input_encoding	The character encoding of the file.
output_data_type	The data type to which the output data is converted.
output_metadata	Set true in order to output additional metadata on the file, to context

Outputs

Path	Description	Type
FileData	Data read from the War Room file.	Unknown
ReadFile.Data	Data read from the War Room file.	Unknown
ReadFile.EntryID	File entry ID.	string
ReadFile.FileSize	File size.	number
ReadFile.EOF	Whether the file has reached end-of-file.	boolean

Source

ReadFile.py ReadFile_test.py ReadFile.yml

Download History Raw

args:
- default: true
  description: War Room entryID of the file to read.
  name: entryID
  required: true
- description: Maximal file size to load, in bytes. Default is 1MB.
  name: maxFileSize
- auto: PREDEFINED
  description: The character encoding of the file.
  name: input_encoding
  predefined:
  - binary
  - utf-8
  - utf-16
  - ascii
  - gbk
- name: output_data_type
  auto: PREDEFINED
  predefined:
  - raw
  - base64
  - json
  description: The data type to which the output data is converted.
  defaultValue: raw
- name: output_metadata
  auto: PREDEFINED
  predefined:
  - "true"
  - "false"
  description: Set true in order to output additional metadata on the file, to context.
  defaultValue: "false"
comment: Load the contents of a file into context.
commonfields:
  id: ReadFile
  version: -1
enabled: true
name: ReadFile
outputs:
- contextPath: FileData
  description: Data read from the War Room file.
  type: Unknown
- contextPath: ReadFile.Data
  description: Data read from the War Room file.
  type: Unknown
- contextPath: ReadFile.EntryID
  description: File entry ID.
  type: string
- contextPath: ReadFile.FileSize
  description: File size.
  type: number
- contextPath: ReadFile.EOF
  description: Whether the file has reached end-of-file.
  type: boolean
script: ''
tags:
- Utility
- ingestion
timeout: '0'
type: python
subtype: python3
runas: DBotWeakRole
fromversion: 5.0.0
dockerimage: demisto/python3:3.12.13.10404775
tests:
- No tests (auto formatted)