UPLOAD(1) General Commands Manual UPLOAD(1)
NAME
sos_upload - Upload files like previously generated sos reports or logs
to a policy specific location
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]
DESCRIPTION
upload is an sos subcommand to upload sos reports, logs, vmcores, or
other files to a policy defined remote location, or a user defined one.
REQUIRED ARGUMENTS
FILE
The path to the archive that is to be uploaded.
OPTIONS
--case-id NUMBER
Specify a case identifier to associate with the archive. Iden-
tifiers may include alphanumeric characters, commas and periods
('.'). This applies only to Red Hat uploads.
--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 up-
loading is supported for HTTPS, SFTP, and FTP protocols.
If your destination server listens on a non-standard port, spec-
ify the listening port in the URL.
--upload-user USER
If a vendor does not provide a default user for uploading, spec-
ify 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 SOSU-
PLOADUSER 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 pro-
vided.
--upload-pass PASS
Specify the password to use for authentication with the destina-
tion 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 SOSU-
PLOADPASSWORD environment variable. If this variable is set,
then no password prompt will occur and --batch may be used pro-
vided all other required values (case number, upload user) are
provided.
--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 sys-
tem.
Default behavior is to perform SSL verification against all up-
load 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 ini-
tial 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. Possi-
ble targets are: redhat, canonical, generic, local. If this op-
tion is not called, sos will try to determine the local target
and use it for uploads.
---upload-s3-endpoint ENDPOINT
Endpoint to upload to for S3 bucket
---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
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.
December 2024 UPLOAD(1)
Generated by dwww version 1.16 on Tue Dec 16 15:21:45 CET 2025.