Versions Compared

Old Version 10

changes.mady.by.user Tim Donohue

Saved on

compared with

New Version 11

changes.mady.by.user Tim Donohue

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FlagIngest or ExportDescription / Usage
-a (--all)both ingest and export

For Ingest: recursively ingest all child AIPs (referenced from this AIP).

For Export: recursively export all child objects (referenced from this parent object)

-d (--disseminate)export-onlyThis flag simply triggers the export of AIPs from the system. See Exporting AIPs
-e (–eperson) [email-address]ingest-onlyThe email address of the EPerson who is ingesting the AIPs. Oftentimes this should be an Administrative account.
-f (--force-replace)ingest-onlyIngest the AIPs in "Force Replace Mode" (must be specified in conjunction with -r flag), where existing objects will be replaced by the contents of the AIP.
-h (--help)both ingest and exportReturn help information. You should specify with -t for additional package specific help information
-i (--identifier) [handle]both ingest and export

For Ingest: Only valid in "Force Replace Mode". In that mode this is the identifier of the object to replace.

For Export: The identifier of the object to export to an AIP

-k (--keep-existing)ingest-onlySpecifies to use "Restore, Keep Existing Mode" during ingest (must be specified in conjunction with -r flag). In this mode, existing objects in DSpace will NOT be replaced by their AIPs, but missing objects will be restored from AIPs.
-o (--option) [setting]=[value]both ingest and exportThis flag is used to pass Additional Packager Options to the Packager command. Each type of packager may define its own custom Additional Options. For AIPs, the valid options are documented in the Additional Packager Options section below. This is repeatable (e.g. -o [setting1]=[value] -o [setting2]=value)
-p (--parent) [handle]ingest onlyHandle(s) of the parent Community or Collection to into which an AIP should be ingested. This may be repeatable.
-r (--restore)ingest onlySpecifies that this ingest is either "Restore Mode" (when standalone), "Restore, Keep Existing Mode" (when used with -k flag) or "Force Replace Mode" (when used with -f flag)
-s (--submit)ingest onlySpecifies that this ingest is in "Submit Mode" where an AIP is treated as a new object and assigned a new Handle/Identifier, etc.
-t (--type) [package-type]both ingest and exportSpecifies the type of package which is being ingested or exported. This controls which Ingester or Disseminator class is called. For AIPs, this is always set to "-t AIP"
-u (--no-user-interaction)both ingest and exportSkips over all user interaction (e.g. question prompts). This flag can be used when running the packager from a script or cron job to bypass all user interaction. See also Disable User Interaction for Cron

 

Additional Packager Options

...