Page History

...

fedora-dsinfo

Anchor
dsinfo dsinfo

Wiki Markup*fedora-dsinfo* \ [host\] \ [port\] \ [user\] \ [password\] \ [pid\] \ [protocol\] \ [context\]

Where:

• host - the hostname of the Fedora server; default is localhost
• port - the port number on which the Fedora server is running; default is 8080
• user - the Fedora user (e.g. fedoraAdmin)
• password - the Fedora user's password
• pid - the pid of the object whose datastream information should be shown
• protocol - how to connect to repository, either http or https
• context - an _optional_ parameter indicating the webapp context. This is only necessary if the Fedora server was installed under a context name other than 'fedora' (see Alternative Webapp Context Configuration).

...

fedora-export

Anchor
export export

...

*fedora-export* \ [host:port\] \ [user\] \ [password\] \ [pid \ | ftyps\] \ [format\] \ [econtext\] \ [path\] \ [protocol\] \ [context\]

Where:

• host:port - the repository's hostname and the port separated by colon
• user - the Fedora user (e.g. fedoraAdmin)
• password - the Fedora user's password
• pid | ftyps - Either the identifier (PID) of the object to export from the repository OR the types of objects to export (FTYPS). FTYPS can be any combination of the characters O, D, and M, specifying which Fedora object type(s) should be exported. O=regular data objects, D=behavior definitions, M=behavior mechanisms.
• format - The XML format to export. Valid options are: info:fedora/fedora-system:FOXML-1.1 (for FOXML 1.1), info:fedora/fedora-system:FOXML-1.0 (for FOXML 1.0), info:fedora/fedora-system:METSFedoraExt-1.1 (for METS), info:fedora/fedora-system:ATOM-1.0 (for ATOM), or default.
• econtext - The export context (which indicates what use case the output should be prepared for. Valid options are: public, migrate, archive, or default.
• path - the export directory
• protocol - how to connect to repository, either http or https
• context - an _optional_ parameter indicating the webapp context. This is only necessary if the Fedora server was installed under a context name other than 'fedora' (see Alternative Webapp Context Configuration).

...

fedora-find

Anchor
find find

Wiki Markup*fedora-find* \fedora-find [host\] \ [port\] \ [user\] \ [password\] \ [fields\] \ [phrase\] \ [protocol\] \ [context\]

• user - the Fedora user (e.g. fedoraAdmin)
• password - the Fedora user's password

...

fedora-ingest

Anchor
ingest ingest

...

*fedora-ingest* f\[ile\] \ [path\] \ [format\] \ [targetHost:targetPort\] \ [targetUser\] \ [targetPassword\] \ [targetProtocol\] \ [log\] \ [context\] *
fedora-ingest* d\[ir\] \ [path\] \ [format\] \ [targetHost:targetPort\] \ [targetUser\] \ [targetPassword\] \ [targetProtocol\] \ [log\] \ [context\] *
fedora-ingest* r\[epos\] \ [sourceHost:sourcePort\] \ [sourceUser\] \ [sourcePassword\] \ [pid \ | \ *\] \ [targetHost:targetPort\] \ [targetUser\] \ [targetPassword\] \ [sourceProtocol\] \ [targetProtocol\] \ [log\] \ [context\]

Where:

• Wiki Markup*f\[ile\]* or *d\[ir\]* or *r\[epos\]* \ - indicates whether the ingest is from a file, directory, or repository as source.
• path - the local file or directory name
• format - the XML format of the ingest file(s). Valid options are: info:fedora/fedora-system:FOXML-1.1 (for FOXML 1.1), info:fedora/fedora-system:FOXML-1.0 (for FOXML 1.0), info:fedora/fedora-system:METSFedoraExt-1.1 (for METS), or info:fedora/fedora-system:ATOM-1.0 (for ATOM) Objects ingested in a format other than FOXML1.1 format are updated to conform to FOXML 1.1 as part of the ingest process
• sourceHost/targetHost - the source or target repository's hostname
• sourcePort/targetPort - the source or target repository's port number
• sourceUser/targetUser - the id of the source or target repository user
• sourcePassword/targetPassword - the password of the source or target repository user
• pid | * - Either the identifier (PID) of the object to export from the repository OR * to indicate all objects from the source repository
• sourceProtocol - the protocol to communicate with source repository, either http or https
• targetProtocol - the protocol to communicate with target repository, either http or https
• log - the optional log message. If unspecified, the log message will indicate the source of the object(s)
• context - an _optional_ parameter indicating the webapp context. This is only necessary if the Fedora server was installed under a context name other than 'fedora' (see Alternative Webapp Context Configuration). NOTE: This parameter can only be used if the 'log' parameter has been used as well.

...

fedora-ingest-demos

Anchor
indemo indemo

Wiki Markup*fedora-ingest-demos* \ [host\] \ [port\] \ [user\] \ [password\] \ [protocol\] \ [context\]

Where:

• host - the hostname of the Fedora server; default is localhost
• port - the port number on which the Fedora server is running; default is 8080
• user - the Fedora user (e.g. fedoraAdmin)
• password - the Fedora user's password
• protocol - how to connect to repository, either http or https
• context - an _optional_ parameter indicating the webapp context. This is only necessary if the Fedora server was installed under a context name other than 'fedora' (see Alternative Webapp Context Configuration).

...

fedora-purge purge

Anchor
purge

...

purge

*fedora-purge* \ [host:port\] \ [user\] \ [password\] \ [pid\] \ [protocol\] \ [log\] \ [context\]

Where:

• host - the hostname of the Fedora server; default is localhost
• port - the port number on which the Fedora server is running; default is 8080
• user - the Fedora user (e.g. fedoraAdmin)
• password - the Fedora user's password
• pid - the PID of the object to permanently remove
• protocol - the protocol to communicate with repository, either http or https
• log - an optional log message explaining the removal
• context - an _optional_ parameter indicating the webapp context. This is only necessary if the Fedora server was installed under a context name other than 'fedora' (see Alternative Webapp Context Configuration).

...

The fedora-modify command line utility enables the running of the batch modify utility from the command line.  The default behavior is to only validate the directives.  To actually execute them, you must specify a value for execute-directives.  A sample file showing all the available directives is available in FEDORA_HOME/client/demo/batch-demo/modify-batch-directives.xml.

Wiki Markup*fedora-modify* \ [host:port\] \ [user\] \ [password\] \ [directives-filepath\] \ [log-filepath\] \ [protocol\] \ [execute-directives\] \ [context\]

Where:

• host:port - the hostname and port of the target Fedora server
• user - the Fedora administrator username (e.g., fedoraAdmin)
• password - the password for the Fedora administrator user
• directives-filepath - the full path to the file containing the batch modify directives
• log-filepath - the full path to the file where logs will be written
• protocol - the protocol to communicate with repository, either http or https
• execute-directives - an optional parameter indicating whether to actually process the directives.  This can have any value, and when specified, means that the directives should actually be executed. If unspecified, the directives will be validated only.
• context - an optional parameter indicating the webapp context. This is only necessary if the Fedora server was installed under a context name other than 'fedora' (see Alternative Webapp Context Configuration). NOTE: This parameter can only be used if the 'execute-directives' has been specified as well.

...

The fedora-batch-build command line utility enables the running of the batch build utility of the Administrator GUI client from the command line. The batch build utility creates a "batch" of Fedora objects based on the specified template file and the corresponding directory of object-specific files. Refer to the documentation on the Batch Utility for more details on how to use the batch build utility.

Wiki Markup*fedora-batch-build* \build [object-template-file\] \ [object-specific-dir\] \ [object-directory\] \ [log-filepath\] \ [log-format\]

Where:

• object-template-file - the full path to the batch template file
• obj-specific-dir - the full path to the directory containing the object-specific files
• object-directory - the full path to the directory where the generated objects will be built
• log-filepath - the full path to the file where logs will be written
• log-format - the format of the log file. Valid values are text or xml.

...

The fedora-batch-ingest command line utility enables the running of the batch ingest utility of the Administrator GUI client from the command line. The batch ingest utility ingests a "batch" of Fedora objects from the specified directory into the repository. Refer to the documentation on the Batch Utility for more details on how to use the batch ingest utilityunmigrated-wiki-markup

*fedora-batch-ingest* \ [object-directory\] \ [log-filepath\] \ [log-format\] \ [format\] \ [host:port\] \ [user\] \ [password\] \ [protocol\] \ [context\]

Where:

• obj-directory - the full path to the directory containing the objects to be ingested
• log-filepath - the full path to the file where logs will be written
• log-format - the format of the log file. Valid values are text or xml
• format - the XML format of the ingest file(s). Valid options are: info:fedora/fedora-system:FOXML-1.1 (for FOXML 1.1), info:fedora/fedora-system:FOXML-1.0 (for FOXML 1.0)
• host:port - the hostname and port of the target Fedora server
• user - the Fedora administrator username (e.g., fedoraAdmin)
• password - the password for the Fedora administrator user
• protocol - the protocol to communicate with Fedora server, either http or https.
• context - an _optional_ parameter indicating the webapp context. This is only necessary if the Fedora server was installed under a context name other than 'fedora' (see Alternative Webapp Context Configuration).

...

The fedora-batch-buildingest command line utility enables the running of the batch build & ingest utility of the Administrator GUI client from the command line. The batch build & ingest utility creates a "batch" of Fedora objects based on the specified template file and the corresponding directory of object-specific files and then ingests them into the repository.unmigrated-wiki-markup

*fedora-batch-buildingest* \ [object-template-file\] \ [object-specific-dir\] \ [object-directory\] \ [log-filepath\] \ [log-format\] \ [host:port\] \ [user\] \ [password\] \ [protocol\] \ [context\]

Where:

• object-template-file - the full path to the batch template file.
• obj-specific-dir - the full path to the directory containing the object-specific files.
• object-directory - the full path to the directory where the generated objects will be built.
• log-filepath - the full path to the file where logs will be written.
• log-format - the format of the log file. Valid values are text or xml.
• host:port - the hostname and port of the target Fedora server.
• user - the Fedora administrator username (e.g., fedoraAdmin).
• password - the password for the Fedora administrator user.
• protocol - the protocol to communicate with Fedora server, either http or https.
• context - an _optional_ parameter indicating the webapp context. This is only necessary if the Fedora server was installed under a context name other than 'fedora' (see Alternative Webapp Context Configuration).

...

The fedora-validate-objects command line utility runs a validation task against a set of objects in the specified repository. Access to the repository is provided via the "-serverurl", "-username" and "-password" parameters. The set of objects is specified using either a "terms" phrase, a "query" sequence, or a "pidfile" (one of these is required, but more than one is not allowed). The "terms" and "query" parameters correspond to the strings used by the FindObjects method of API-A-LITE. The PID file is a plain text file containing one PID per line, ignoring blank lines and comment lines (lines that start with '#').The output of the validator can be controlled with the Log4J properties file. This can be used to suppress certain categories of messages or to restrict output by severity level.

Wiki Markup*fedora-validate-objects* \ -serverurl \ [server-base-url\] \ -username \ [user\] \ -password \ [password\] \ {-terms \ [terms\] \ | \ -query [query] \ | \ -pidfile \ [path\]\} \ -logConfig \ [log4j-properties-file\]

Where:

• server-base-url - the full URL used to connect with the Fedora server: e.g. http://localhost:8080/fedora

...