{ "content": [ { "type": "text", "text": "# sos-upload(1) (man)\n\n**Summary:** sosupload - Upload files like previously generated sos reports or logs to a policy specific location\n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| — | --case-id | NUMBER | Specify a case identifier to associate with the archive. Identifiers may include al‐ phanumeric characters, commas and p |\n| — | --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 locati |\n| — | --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 |\n| — | --upload-pass | PASS | Specify the password to use for authentication with the destination server. If this option is omitted and upload is requ |\n| — | --upload-directory | DIR | Specify a directory to upload to, if one is not specified by a vendor default location or if your destination server doe |\n| — | --upload-method | METHOD | Specify the HTTP method to use for uploading to the provided --upload-url. Valid val‐ ues are 'auto' (default), 'put', o |\n| — | --upload-no-ssl-verify | — | Disable SSL verification for HTTPS uploads. This may be used to allow uploading to lo‐ cations that have self-signed cer |\n| — | --upload-protocol | PROTO | Manually specify the protocol to use for uploading to the target upload-url. Normally this is determined via the upload |\n| — | --upload-target | TARGET | Manually specify the upload target to use for uploading. Possible targets are: redhat, canonical, generic, local. If thi |\n| — | — | — | Endpoint to upload to for S3 bucket |\n| — | — | — | Region to upload to for S3 bucket |\n| — | — | — | Name of the S3 bucket to upload to |\n| — | — | — | Access key for the S3 bucket |\n| — | --upload-s3-secret-key | KEY | Secret key for the S3 bucket |\n| — | --upload-s3-object-prefix | PREFIX | Prefix for the S3 object/key |\n\n## See Also\n\n- sos(1)\n- sos-report(1)\n- sos-clean(1)\n- sos.conf(5)\n- sos-collect(1)\n\n## Section Outline\n\n- **NAME** (3 lines)\n- **SYNOPSIS** (1 lines) — 1 subsections\n - sos upload FILE [options] (17 lines)\n- **DESCRIPTION** (3 lines)\n- **REQUIRED ARGUMENTS** (4 lines)\n- **OPTIONS** (1 lines) — 15 subsections\n - --case-id NUMBER (4 lines)\n - --upload-url URL (9 lines)\n - --upload-user USER (10 lines)\n - --upload-pass PASS (16 lines)\n - --upload-directory DIR (3 lines)\n - --upload-method METHOD (6 lines)\n - --upload-no-ssl-verify (6 lines)\n - --upload-protocol PROTO (13 lines)\n - --upload-target TARGET (5 lines)\n - ---upload-s3-endpoint ENDPOINT (3 lines)\n - ---upload-s3-region REGION (3 lines)\n - ---upload-s3-bucket BUCKET (3 lines)\n - ---upload-s3-access-key KEY (3 lines)\n - - --upload-s3-secret-key KEY (3 lines)\n - - --upload-s3-object-prefix PREFIX (3 lines)\n- **SEE ALSO** (3 lines)\n- **MAINTAINER** (2 lines) — 1 subsections\n - AUTHORS & CONTRIBUTORS (5 lines)\n\n## Full Content\n\n### NAME\n\nsosupload - Upload files like previously generated sos reports or logs to a policy specific\nlocation\n\n### SYNOPSIS\n\n#### sos upload FILE [options]\n\n[--case-id id]\n[--upload-url url]\n[--upload-user user]\n[--upload-pass pass]\n[--upload-directory dir]\n[--upload-method]\n[--upload-no-ssl-verify]\n[--upload-protocol protocol]\n[--upload-target target]\n[--upload-s3-endpoint endpoint]\n[--upload-s3-region region]\n[--upload-s3-bucket bucket]\n[--upload-s3-access-key key]\n[--upload-s3-secret-key key]\n[--upload-s3-object-prefix prefix]\n\n### DESCRIPTION\n\nupload is an sos subcommand to upload sos reports, logs, vmcores, or other files to a policy\ndefined remote location, or a user defined one.\n\n### REQUIRED ARGUMENTS\n\nFILE\n\nThe path to the archive that is to be uploaded.\n\n### OPTIONS\n\n#### --case-id NUMBER\n\nSpecify a case identifier to associate with the archive. Identifiers may include al‐\nphanumeric characters, commas and periods ('.'). This applies only to Red Hat up‐\nloads.\n\n#### --upload-url URL\n\nIf a vendor does not provide a default upload location, or if you would like to upload\nthe archive to a different location, specify the address here.\n\nAn upload protocol MUST be specified in this URL. Currently uploading is supported for\nHTTPS, SFTP, and FTP protocols.\n\nIf your destination server listens on a non-standard port, specify the listening port\nin the URL.\n\n#### --upload-user USER\n\nIf a vendor does not provide a default user for uploading, specify the username here.\n\nIf --batch is used and this option is omitted, no username will be collected and thus\nuploads will fail if no vendor default is set.\n\nYou also have the option of providing this value via the SOSUPLOADUSER environment\nvariable. If this variable is set, then no username prompt will occur and --batch may\nbe used provided all other required values (case number, upload password) are pro‐\nvided.\n\n#### --upload-pass PASS\n\nSpecify the password to use for authentication with the destination server.\n\nIf this option is omitted and upload is requested, you will be prompted for one.\n\nIf --batch is used, this prompt will not occur, so any uploads are likely to fail un‐\nless this option is used.\n\nNote that this will result in the plaintext string appearing in `ps` output that may\nbe collected by sos and be in the archive. If a password must be provided by you for\nuploading, it is strongly recommended to not use --batch and enter the password when\nprompted rather than using this option.\n\nYou also have the option of providing this value via the SOSUPLOADPASSWORD environment\nvariable. If this variable is set, then no password prompt will occur and --batch may\nbe used provided all other required values (case number, upload user) are provided.\n\n#### --upload-directory DIR\n\nSpecify a directory to upload to, if one is not specified by a vendor default location\nor if your destination server does not allow writes to '/'.\n\n#### --upload-method METHOD\n\nSpecify the HTTP method to use for uploading to the provided --upload-url. Valid val‐\nues are 'auto' (default), 'put', or 'post'. The use of 'auto' will default to the\nmethod required by the policy-default upload location, if one exists.\n\nThis option has no effect on upload protocols other than HTTPS.\n\n#### --upload-no-ssl-verify\n\nDisable SSL verification for HTTPS uploads. This may be used to allow uploading to lo‐\ncations that have self-signed certificates, or certificates that are otherwise un‐\ntrusted by the local system.\n\nDefault behavior is to perform SSL verification against all upload locations.\n\n#### --upload-protocol PROTO\n\nManually specify the protocol to use for uploading to the target upload-url.\n\nNormally this is determined via the upload address, assuming that the protocol is part\nof the address provided, e.g. 'https://example.com'. By using this option, sos will\nskip the protocol check and use the method defined for the specified PROTO.\n\nFor RHEL systems, setting this option to sftp will skip the initial attempt to upload\nto the Red Hat Customer Portal, and only attempt an upload to Red Hat's SFTP server,\nwhich is typically used as a fallback target.\n\nValid values for PROTO are: 'auto' (default), 'https', 'ftp', 'sftp', 's3'.\n\n#### --upload-target TARGET\n\nManually specify the upload target to use for uploading. Possible targets are: redhat,\ncanonical, generic, local. If this option is not called, sos will try to determine\nthe local target and use it for uploads.\n\n#### ---upload-s3-endpoint ENDPOINT\n\nEndpoint to upload to for S3 bucket\n\n#### ---upload-s3-region REGION\n\nRegion to upload to for S3 bucket\n\n#### ---upload-s3-bucket BUCKET\n\nName of the S3 bucket to upload to\n\n#### ---upload-s3-access-key KEY\n\nAccess key for the S3 bucket\n\n#### - --upload-s3-secret-key KEY\n\nSecret key for the S3 bucket\n\n#### - --upload-s3-object-prefix PREFIX\n\nPrefix for the S3 object/key\n\n### SEE ALSO\n\nsos(1) sos-report(1) sos-clean(1) sos.conf(5) sos-collect(1)\n\n### MAINTAINER\n\nMaintained on GitHub at https://github.com/sosreport/sos\n\n#### AUTHORS & CONTRIBUTORS\n\nSee AUTHORS file in the package documentation.\n\n\n\nDecember 2024 UPLOAD(1)\n\n" } ], "structuredContent": { "command": "sos-upload", "section": "1", "mode": "man", "summary": "sosupload - Upload files like previously generated sos reports or logs to a policy specific location", "synopsis": "", "flags": [ { "flag": "", "long": "--case-id", "arg": "NUMBER", "description": "Specify a case identifier to associate with the archive. Identifiers may include al‐ phanumeric characters, commas and periods ('.'). This applies only to Red Hat up‐ loads." }, { "flag": "", "long": "--upload-url", "arg": "URL", "description": "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." }, { "flag": "", "long": "--upload-user", "arg": "USER", "description": "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 pro‐ vided." }, { "flag": "", "long": "--upload-pass", "arg": "PASS", "description": "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 un‐ less 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." }, { "flag": "", "long": "--upload-directory", "arg": "DIR", "description": "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 '/'." }, { "flag": "", "long": "--upload-method", "arg": "METHOD", "description": "Specify the HTTP method to use for uploading to the provided --upload-url. Valid val‐ ues 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." }, { "flag": "", "long": "--upload-no-ssl-verify", "arg": null, "description": "Disable SSL verification for HTTPS uploads. This may be used to allow uploading to lo‐ cations that have self-signed certificates, or certificates that are otherwise un‐ trusted by the local system. Default behavior is to perform SSL verification against all upload locations." }, { "flag": "", "long": "--upload-protocol", "arg": "PROTO", "description": "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'." }, { "flag": "", "long": "--upload-target", "arg": "TARGET", "description": "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." }, { "flag": "", "long": null, "arg": null, "description": "Endpoint to upload to for S3 bucket" }, { "flag": "", "long": null, "arg": null, "description": "Region to upload to for S3 bucket" }, { "flag": "", "long": null, "arg": null, "description": "Name of the S3 bucket to upload to" }, { "flag": "", "long": null, "arg": null, "description": "Access key for the S3 bucket" }, { "flag": "", "long": "--upload-s3-secret-key", "arg": "KEY", "description": "Secret key for the S3 bucket" }, { "flag": "", "long": "--upload-s3-object-prefix", "arg": "PREFIX", "description": "Prefix for the S3 object/key" } ], "examples": [], "see_also": [ { "name": "sos", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/sos/1/json" }, { "name": "sos-report", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/sos-report/1/json" }, { "name": "sos-clean", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/sos-clean/1/json" }, { "name": "sos.conf", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/sos.conf/5/json" }, { "name": "sos-collect", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/sos-collect/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 3, "subsections": [] }, { "name": "SYNOPSIS", "lines": 1, "subsections": [ { "name": "sos upload FILE [options]", "lines": 17 } ] }, { "name": "DESCRIPTION", "lines": 3, "subsections": [] }, { "name": "REQUIRED ARGUMENTS", "lines": 4, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "--case-id NUMBER", "lines": 4, "long": "--case-id", "arg": "NUMBER" }, { "name": "--upload-url URL", "lines": 9, "long": "--upload-url", "arg": "URL" }, { "name": "--upload-user USER", "lines": 10, "long": "--upload-user", "arg": "USER" }, { "name": "--upload-pass PASS", "lines": 16, "long": "--upload-pass", "arg": "PASS" }, { "name": "--upload-directory DIR", "lines": 3, "long": "--upload-directory", "arg": "DIR" }, { "name": "--upload-method METHOD", "lines": 6, "long": "--upload-method", "arg": "METHOD" }, { "name": "--upload-no-ssl-verify", "lines": 6, "long": "--upload-no-ssl-verify" }, { "name": "--upload-protocol PROTO", "lines": 13, "long": "--upload-protocol", "arg": "PROTO" }, { "name": "--upload-target TARGET", "lines": 5, "long": "--upload-target", "arg": "TARGET" }, { "name": "---upload-s3-endpoint ENDPOINT", "lines": 3 }, { "name": "---upload-s3-region REGION", "lines": 3 }, { "name": "---upload-s3-bucket BUCKET", "lines": 3 }, { "name": "---upload-s3-access-key KEY", "lines": 3 }, { "name": "- --upload-s3-secret-key KEY", "lines": 3, "long": "--upload-s3-secret-key", "arg": "KEY" }, { "name": "- --upload-s3-object-prefix PREFIX", "lines": 3, "long": "--upload-s3-object-prefix", "arg": "PREFIX" } ] }, { "name": "SEE ALSO", "lines": 3, "subsections": [] }, { "name": "MAINTAINER", "lines": 2, "subsections": [ { "name": "AUTHORS & CONTRIBUTORS", "lines": 5 } ] } ] } }