FILELIST

Name

filelist

Location

The CLI executable is available at:

<installation_dir>/app/bin

Purpose

Lists files contained in a queue, optionally filtering the result set based on selection criteria.

Synopsis

  • filelist [options] <QueueManagerName> <QueueName>

  • filelist -h

Description

The filelist command retrieves and displays the list of files currently contained in a specified queue.

The command supports filtering and selection criteria to restrict the output to a subset of files based on metadata attributes.

Unless explicitly overridden, files are always returned in a deterministic and predefined order.

This command is provided to ensure backward compatibility with legacy automation and operational scripts. See Compatibility Command Line Interfaces to map QueueManagerName and QueueName concepts into Data Mover Smart concepts.

Arguments

Argument
Description
Required

QueueManagerName

Name of the Queue Manager hosting the queue

Yes

QueueName

Name of the queue to be listed

Yes

Options

Option
Parameter
Description

[-c]

CorrelId

Filter by Correlation ID (CorrelId)

[-i]

IntNum

Filter by Internal Number (IntNum)

[-u]

UserId

User registered in Data Mover Smart

[-p]

UserPwd

Password of the UserId

[-o]

CSV

Displays metadata using command-separated values

[-o]

NODefault | NoDef

Excludes default file properties from the output

[-o]

NOBanner

Ignored

[-b]

MetadataCode

Requests a metadata identified by a numeric code; multiple -b options are supported; metadata are returned in the exact order in which the codes are specified on the command line

[-m]

Metadata

Requests a macro-metadata identified by a numeric code; multiple -m options are supported; metadata are returned in the exact order in which the codes are specified on the command line

[-v]

Ignored

Exit status

Code
Legacy code
Meaning

0

SP0000

File successfully dispatched

1

SP6001

Invalid number of arguments

1

SP8002

VFS does not exist

1

SP2085

Folder name does not exist

3

SP6301

Source file not found

Last updated