File Watcher Command Line Reference

Article Id
kb303
Published
17 Jan 2019 at 16:33
Last Updated
18 Jan 2019 at 16:24
Reading Time
2 minutes, 56 seconds

Introduction

This article details the command line arguments or switches used by FileWatcher.

Command Line Arguments

Command line arguments used by FileWatcher are separate into two groups. The first argument defines what operation FileWatcher should perform - create inventory, compare inventory or load a job file. All subsequent arguments are used to specify values that may be used for an operation.

For example, the command FileWatcher /N /IF "C:\MyFolder" /IS "C:\MyInventories" contains 3 arguments:

  • /N specifies the operation, in the case create a new inventory.
  • /IF specifies the path to the folder to be inventoried
  • /IS specifies the path to which the inventory file and log are to be saved.

Please note: command line switches are case insensitive.

Operation Argument

The first command line argument defines the operation or action to be performed by FileWatcher.

/N

or

/NewInventory

Create a new inventory.

  • Requires the /IF and /IS arguments

Example: FileWatcher /N /IF "C:\MyFolder" /IS "C:\MyInventories"

/C

or

/Compare

Compares an existing inventory against a folder.

  • Requires the /I command line argument specifying the the path to the inventory file.
  • Optionally, /T argument may be used to define the path to the folder to compare the inventory against. If /T is not specified, then the comparison will take place against the originally inventoried folder (the path is saved in the inventory file).

/J

or

/Job

Load inventory jobs from an XML file.

Example: FileWatcher /J /JobFile "C:\MyJobs.xml"

Other Arguments

All other command line arguments are used to specify values required for individual FileWatcher actions.

/CF

or

/CompareFolder

Specifies at target folder to used in an inventory comparison

For example /CF "C:\MyFolder"

/CI

or

/CompareInventory

Specifies the filepath to an existing inventory file.

Only used in comparison operations.

For example: /CI "C:\MyInventories\Inventory001.xml"

/CL

or

/CompareLog

Used to specify a specific filename and path for the comparison log. If not specified, the log file will be saved the current path with an automatically generated filename based on the current date and time.

For example /CL "D:\CompareResult.log"

This argument supports the keyword '$datetime$' to automatically insert the current date and time in the filename. For example, /CL ""D:\CompareLog-$datetime$.log"" will become /CL D:\CompareLog-18-Jan-2019_160712.log

To disable log output, use the value NO_LOG, for example /CL NO_LOG

/EFE

or

/ExcludedFileExtensions

An optional list - in comma separate values (CSV) format - specifying any file extensions to be excluded from an inventory or comparison.

For example: /EFE "bmp,txt,xls"

/EP

or

/ExcludedPaths

An optional list - in comma separated values (CSV) format - specifying and paths (file or folders) that are to be excluded from an inventory or comparison.

If including paths containing whitespace or names longer than 8 characters, then enclose within quotation marks.

Example: /EP "C:\TestFolder,C:\Folder2\myfile.doc"

/IF

or

/InventoryFolder

Specify the path to a folder to be inventoried.

Example: /IF "C:\MyFolder"

/IS

or

/InventorySave

Specifies the path to where an inventory should be saved.

IMPORTANT: This cannot be the same or within the folder path specified using /IF

Example: /IS "C:\MyInventories"

/JF

or

/JobFile

Specifies the path to a FileWatcher Job File.

Example: /JF "C:\MyJobs.xml"

     
Copyright © 2011 - 2024 Calzada Media Limited. All Rights Reserved