UPLOAD(1)

📦
version 4.12.1 · 3 versions
, in centos-stream 10, centos-stream 9, fedora 43, fedora 44

💖 UPLOAD(1) — the sos upload era 💖

okay bestie, welcome to the General Commands Manual page for UPLOAD(1), aka the glow-up for sos_upload. this is the group chat where your archive finally leaves the nest 🦋

✨ NAME ✨

sos_upload — upload files like previously generated sos reports or logs to a policy specific location. yes, literally that. the vibes are: you made a report, now you're sending it. periodt. 💅

✨ SYNOPSIS ✨

sos upload FILE [options]
          [--case-id id]
          [--upload-url url]
          [--upload-user user]
          [--upload-pass pass]
          [--upload-directory dir]
          [--upload-method]
          [--upload-no-ssl-verify]
          [--upload-protocol protocol]
          [--upload-target target]
          [--upload-s3-endpoint  endpoint]
          [--upload-s3-region region]
          [--upload-s3-bucket bucket]
          [--upload-s3-access-key key]
          [--upload-s3-secret-key key]
          [--upload-s3-object-prefix prefix]
          [--preauth]
          [--upload-threads threads]

✨ DESCRIPTION ✨

upload is an sos subcommand that sends your sos reports, logs, vmcores, or honestly any other file to a policy defined remote location, or to one you defined yourself. main character energy: it goes where you tell it to go 🎀

🌸 REQUIRED ARGUMENTS 🌸

  • FILE — the path to the archive that is to be uploaded. no file, no upload, iykyk 🙈

💅 OPTIONS 💅

  • --case-id NUMBER — specify a case identifier to associate with the archive. Identifiers may include alphanumeric characters, commas and periods (.). This applies only to Red Hat uploads. (yes, only Red Hat, don't try it elsewhere and act surprised)
  • --upload-url URL — if a vendor does not provide a default upload location, or if you would like to upload the archive to a different location, specify the address here.

An upload protocol MUST be specified in this URL. Currently uploading is supported for HTTPS, SFTP, and FTP protocols.

If your destination server listens on a non-standard port, specify the listening port in the URL.

  • --upload-user USER — if a vendor does not provide a default user for uploading, specify the username here.

If --batch is used and this option is omitted, no username will be collected and thus uploads will fail if no vendor default is set. 💀

You also have the option of providing this value via the SOSUPLOADUSER environment variable. If this variable is set, then no username prompt will occur and --batch may be used provided all other required values (case number, upload password) are provided.

  • --upload-pass PASS — specify the password to use for authentication with the destination server.

If this option is omitted and upload is requested, you will be prompted for one.

If --batch is used, this prompt will not occur, so any uploads are likely to fail unless this option is used.

Note that this will result in the plaintext string appearing in ps output that may be collected by sos and be in the archive. If a password must be provided by you for uploading, it is strongly recommended to not use --batch and enter the password when prompted rather than using this option.

You also have the option of providing this value via the SOSUPLOADPASSWORD environment variable. If this variable is set, then no password prompt will occur and --batch may be used provided all other required values (case number, upload user) are provided.

bestie the ps thing is real and it WILL snitch on your password. don't be that girl 😭
  • --upload-directory DIR — specify a directory to upload to, if one is not specified by a vendor default location, or if your destination server does not allow writes to /.
  • --upload-method METHOD — specify the HTTP method to use for uploading to the provided --upload-url. Valid values are 'auto' (default), 'put', or 'post'. The use of 'auto' will default to the method required by the policy-default upload location, if one exists.

This option has no effect on upload protocols other than HTTPS.

  • --upload-no-ssl-verify — disable SSL verification for HTTPS uploads. This may be used to allow uploading to locations that have self-signed certificates, or certificates that are otherwise untrusted by the local system.

Default behavior is to perform SSL verification against all upload locations.

  • --upload-protocol PROTO — manually specify the protocol to use for uploading to the target upload-url.

Normally this is determined via the upload address, assuming that the protocol is part of the address provided, e.g. 'https://example.com'. By using this option, sos will skip the protocol check and use the method defined for the specified PROTO.

For RHEL systems, setting this option to sftp will skip the initial attempt to upload to the Red Hat Customer Portal, and only attempt an upload to Red Hat's SFTP server, which is typically used as a fallback target.

Valid values for PROTO are: 'auto' (default), 'https', 'ftp', 'sftp', 's3'.

  • --upload-target TARGET — manually specify the upload target to use for uploading. Possible targets are: redhat, canonical, generic, local. If this option is not called, sos will try to determine the local target and use it for uploads.
  • --upload-s3-endpoint ENDPOINT — --upload-threads THREADS Number of threads to use for multipart uploads (1-16, default: 4). When an archive exceeds a certain size, defined in the targets, it is uploaded in parallel chunks using this many threads. Higher values speed up the upload but consume more bandwidth and memory, as each thread holds a 128 MiB chunk in memory.
  • ---upload-s3-endpoint ENDPOINT — Endpoint to upload to for S3 bucket. (yes, three dashes. that's how it's written in the manual, and I am not about to edit the original, not today 🔥)
  • --upload-s3-region REGION — Region to upload to for S3 bucket.
  • --upload-s3-bucket BUCKET — Name of the S3 bucket to upload to.
  • --upload-s3-access-key KEY — Access key for the S3 bucket.
  • --upload-s3-secret-key KEY — Secret key for the S3 bucket.
  • --upload-s3-object-prefix PREFIX — Prefix for the S3 object/key.
  • --preauth — Pre-authorize this system by running the authentication flow and storing the resulting token locally (see TOKEN STORAGE), without uploading a file. Useful to prepare a system for later, unattended uploads. Only supported for upload targets that use token-based authentication.

🎀 TOKEN STORAGE 🎀

When using web-based authentication for uploads, sos stores the refresh token locally in the file ~/.sos-oidc-token.json so that subsequent uploads do not require re-authenticating through a browser.

Note: the token is stored in plain text with file permissions set to 0600 (owner read/write only). If these permissions are changed, sos will issue a warning. Users should ensure that the storage location and its parent directories have appropriately restrictive permissions. 🫶

🌈 SEE ALSO 🌈

sos(1) sos-report(1) sos-clean(1) sos.conf(5) sos-collect(1)

👑 MAINTAINER 👑

Maintained on GitHub at https://github.com/sosreport/sos

⭐ AUTHORS & CONTRIBUTORS ⭐

See AUTHORS file in the package documentation.

and that's the whole page bestie ✨ this one's dated December 2024 and comes from the General Commands Manual of the sos project — go upload something iconic 💖🦋🎀

📦 where this page comes from