Versions Compared

Key

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

...

Retrieves a file. It takes the following arguments:

  • [MANDATORY] -i The id for the file to retrieve.

  • [MANDATORY] -c The id for the collection to retrieve the file for.

  • [OPTIONAL] -p The id of the pillar where the file should be retrieved from. If no argument, then the file will be retrieved from the fastest pillars.

  • [OPTIONAL] -l The location where the file should be placed (either total path or directory). If no argument, then in the directory where the script is located.

...

Get the list of files in a collection 'get-file-ids.sh' command. It takes the following arguments:

  • [MANDATORY] -c The id for the collection to retrieve the file for.

  • [OPTIONAL] -i The id of the file to retrieve. If no such argument, then the id of all files are retrieved.

  • [OPTIONAL] -p The id of the pillar where the id should be retrieved.

...

Lists the checksum for the files in the indicated collection. It takes the following arguments:

  • [MANDATORY] -c The id for the collection to retrieve the file forchecksums from.

  • [OPTIONAL] -i The id of the file to retrieve the checksum from. If no such argument, then the checksums of all files are retrieved.

  • [OPTIONAL] -p The id of the pillar where the Fto retrieve checksums from.
  • [OPTIONAL] -S The salt of checksum to request in the response. Requires the ChecksumType (algorithm) argument.

  • [OPTIONAL] -R The algorithm of checksum to request in the response from the pillars. Allowed values are: MD5, SHA1, SHA256, SHA384, SHA512. If using a salt, prefix the listed types with HMAC_, eg. HMAC_MD5.

...

Puts a file into a collection. It takes the following arguments:

  • [MANDATORY] -c The id for the collection to place the the file in.

  • -f The path to the file, which is wanted to be put.
  • -u The URL where the file can be downloaded.
    • [MANDATORY]
    -c The id for the collection to place the the file in
    • Most have either -f or -u arguments, though never both.
  • -r The checksum of the new file
    • -r is required, if -u argument is used, and optional if -f is used.
  • -i The id for the file to perform the operation on.
    • -i is required, if -u argument is used, and optional if -f is used.
  • [OPTIONAL] -S The salt of checksum to request in the response. Requires the ChecksumType argument.

  • [OPTIONAL] -R The algorithm of checksum to request in the response from the pillars.

  • [OPTIONAL] -i A ID for the file (default is the name of the file)p The pillar to put the file at. If left out, then the file is put to all pillars.

delete

Deletes a file in the bitrepository. It takes the following arguments:

  • IS_THIS_IN_USE [MANDATORY]-f The path to the file, which is wanted to be deleted (the actual file is required for calculating the checksums etc. for performing the delete operation).p The id of the pillar where the file should be delete.

  • [MANDATORY] -i The id for the file to perform the operation on
  • [MANDATORY] -c The id for the collection to place the the file in.

  • [MANDATORY] [OPTIONAL]-C The checksum of the file to be delete (in the collection default checksum specficiationspecificiation).

  • [OPTIONAL] -S The salt of checksum to request in the response. Requires the ChecksumType argument.

  • [MANDATORY] -i The id for the file to perform the operation on

    [OPTIONAL] -R The algorithm of checksum to request in the response from the pillars.

  • [MANDATORY] -p The id of the pillar where the file should be delete.

  • .

replace-file

Replaces a file in the bitrepository with the provided file. It takes the following arguments:

  • [MANDATORY] -c The id for the collection to perform the operation on

  • [MANDATORY] -C The checksum of the file to be replaced.

  • [MANDATORY] -p The id of the pillar where the should be performed.

  • -f The path to the new file for the replacement.
  • -u The URL where the replacement file can be downloaded.
    • [MANDATORY] Most have either -f or -u arguments, though never both.
  • -r The checksum of the new file
    • -r is required, if -u argument is used, and optional if -f is used.
  • -i The id for the file to perform the operation on.
    • -i is required, if -u argument is used, and optional if -f is used.
  • -R [OPTIONAL] The algorithm of checksum to request in the response from the pillars
  • -S [OPTIONAL] The salt of checksum to request in the response. Requires the ChecksumType argument.
    • -S requires the -R argument.