{"_id":"5c224a075a282b0045ef16f9","project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":45,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5c22412594a2a5005cc9e919","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-12-25T14:39:33.459Z","from_sync":false,"order":31,"slug":"sb-cli","title":"SB Command Line Interface"},"user":"566590c83889610d0008a253","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-25T15:17:27.990Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"##Overview\n\nUse the following commands to manage connected cloud storage via the Seven Bridges Command Line Interface.\n\n##volumes create\n\nCreate a volume. Volumes authorize the CGC to access and query objects on a specified cloud storage (Amazon Web Services or Google Cloud Storage) on your behalf.\n\nYou can set the value for service_file if you want to describe the service in a JSON file. If you do not set the value, the command expects a service object description from stdin.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb volumes create --name <name_value> [--access_mode <access_mode_value>] [--description <description_value>] [--service_file <service_file_value>] [flags]\\n\\nFlags:\\n      --name string           The name for the volume.\\n      --access_mode string    Sets the access to either read-write or read-only.\\n      --description string    Description of the volume.\\n      --service_file string   The file describing the service object. If omitted, input from stdin is expected.\\n  -h, --help                  help for create\",\n      \"language\": \"text\",\n      \"name\": \"volumes create\"\n    }\n  ]\n}\n[/block]\n ##volumes list\n\nList all the volumes you have registered.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb volumes list [flags]\\n\\nFlags:\\n  -h, --help   help for list\",\n      \"language\": \"text\",\n      \"name\": \"volumes list\"\n    }\n  ]\n}\n[/block]\n \n##volumes get\n\nGet details about the specified volume.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb volumes get <volume_id> [flags]\\n\\nArguments:\\n      volume_id   ID of the volume.\\n\\nFlags:\\n  -h, --help   help for get\",\n      \"language\": \"text\",\n      \"name\": \"volumes get\"\n    }\n  ]\n}\n[/block]\n \n##volumes update\n\nUpdate the details of the specified volume.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb volumes update <volume_id> [--access_mode <access_mode_value>] --url <url_value> --credentials <credentials_value> ... [--description <description_value>] [flags]\\n\\nArguments:\\n      volume_id   ID of the volume.\\n\\nFlags:\\n      --access_mode string        Sets the access to either read-write or read-only.\\n      --url string                Cloud provider API endpoint to use when accessing this bucket.\\n      --credentials stringSlice   Contains credentials for underlying cloud provider.\\n      --description string        Description of the volume.\\n  -h, --help                      help for update\",\n      \"language\": \"text\",\n      \"name\": \"volumes update\"\n    }\n  ]\n}\n[/block]\n \n##volumes delete\n\nDelete the specified volume. This call deletes a volume you've created to refer to storage on Amazon Web Services or Google Cloud Storage. In order for a volume to be deleted, it has to be deactivated first.\n\nNote that any files you've imported from your volume onto the CGC, known as an alias, will no longer be usable. If a new volume is created with the same `volume_id` as the deleted volume, aliases will point to files on the newly created volume instead (if those exist).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb volumes delete <volume_id> [flags]\\n\\nArguments:\\n      volume_id   ID of the volume.\\n\\nFlags:\\n  -h, --help   help for delete\",\n      \"language\": \"text\",\n      \"name\": \"volumes delete\"\n    }\n  ]\n}\n[/block]\n \n##exports list\n\nLists the export jobs initiated by the user.\n\nWhen you export a file from a project on the CGC into a volume, you write to your cloud storage bucket on Amazon Web Services or Google Cloud Storage.\n\nIf an export command is successful, the original project file will become an alias to the newly exported object on the volume. The source file will be deleted from the CGC and, if no more copies of this file exist, it will no longer count towards your total storage price on the CGC. Once you export a file from the CGC to a volume, it is no longer part of the storage on the CGC and cannot be exported again.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb exports list [flags]\\n\\nFlags:\\n  -h, --help   help for list\",\n      \"language\": \"text\",\n      \"name\": \"exports list\"\n    }\n  ]\n}\n[/block]\n \n##exports get\n\nGet information about the specified export job.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb exports get <export_id> [flags]\\n\\nArguments:\\n      export_id   ID of the export job.\\n\\nFlags:\\n  -h, --help   help for get\",\n      \"language\": \"text\",\n      \"name\": \"exports get\"\n    }\n  ]\n}\n[/block]\n \n##exports start\n\nQueue a job to export a file from a project on the CGC into a volume, ie. to your cloud storage bucket on Amazon Web Services or Google Cloud Storage. The file selected for export must not be a public file or an alias. Aliases are objects stored in your cloud storage bucket which have been made available on the CGC. The volume you are exporting to must be configured for read-write access. To do this, set the access_mode parameter to RW when creating or modifying a volume.\n\nWhen you export a file from a project on the CGC into a volume, you write to your cloud storage bucket on Amazon Web Services or Google Cloud Storage.\n\nIf an export command is successful, the original project file will become an alias to the newly exported object on the volume. The source file will be deleted from the CGC and, if no more copies of this file exist, it will no longer count towards your total storage price on the CGC. Once you export a file from the CGC to a volume, it is no longer part of the storage on the CGC and cannot be exported again. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb exports start --file <file_value> --destination_volume <destination_volume_value> --location <location_value> [--properties <properties_value> ...] [--overwrite] [flags]\\n\\nFlags:\\n      --file string                 The ID of the file for export. Must not be a public file nor an alias.\\n      --destination_volume string   The ID of the read-write volume to which the file will be exported.\\n      --location string             Volume-specific location to which the file will be exported.\\n      --properties stringSlice      Properties of the S3 volume.\\n      --overwrite                   Overwrite the file with the same name and prefix if it already exists.\\n  -h, --help                        help for start\",\n      \"language\": \"text\",\n      \"name\": \"exports start\"\n    }\n  ]\n}\n[/block]\n \n##imports list\n\nLists the import jobs initiated by the user.\n\nWhen you import a file from your volume on your cloud storage provider (Amazon Web Services or Google Cloud Storage), you are creating an alias on the CGC which points to the file in your cloud storage bucket. Aliases appear as files on the CGC and can be copied, executed, and modified as such. They refer back to the respective file on the given volume.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb imports list [--volume <volume_value>] [--project <project_value>] [--state <state_value>] [--offset <offset_value>] [--limit <limit_value>] [flags]\\n\\nFlags:\\n      --volume string    Volume ID for which imports are listed.\\n      --project string   Project ID for which imports are listed.\\n      --state string     List imports with specified state.\\n      --offset string    Set offset when listing.\\n      --limit string     Set limit when listing.\\n  -h, --help             help for list\",\n      \"language\": \"text\",\n      \"name\": \"imports list\"\n    }\n  ]\n}\n[/block]\n \n##imports get\n\nGet information about the specified import job.\t\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb imports get <import_id> [--result] [flags]\\n\\nArguments:\\n      import_id   ID of the import job.\\n\\nFlags:\\n      --result   Get only result file from import.\\n  -h, --help    help for get\",\n      \"language\": \"text\",\n      \"name\": \"imports get\"\n    }\n  ]\n}\n[/block]\n \n##imports start\nStart an import job from the specified volume.\n\nWhen you import a file from your volume on your cloud storage provider (Amazon Web Services or Google Cloud Storage), you are creating an alias on the CGC which points to the file in your cloud storage bucket. Aliases appear as files on the CGC and can be copied, executed, and modified as such. They refer back to the respective file on the given volume.\n\nThis command queues a job to import a file from a volume into a project on the CGC. Essentially, you are importing a file from your cloud storage provider (Amazon Web Services or Google Cloud Storage) via the volume onto the CGC.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb imports start --source_volume <source_volume_value> --location <location_value> --destination <destination_value> [--name <name_value>] [--overwrite] [flags]\\n\\nFlags:\\n      --source_volume string   The ID of the source volume.\\n      --location string        Volume-specific location pointing to the file to import.\\n      --destination string     The ID of the project in which to create the alias.\\n      --name string            The name of the alias. Should be unique to the project.\\n      --overwrite              Overwrite the file with the same name if it already exists.\\n  -h, --help                   help for start\",\n      \"language\": \"text\",\n      \"name\": \"imports start\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"volumes-1","type":"basic","title":"Volumes"}
##Overview Use the following commands to manage connected cloud storage via the Seven Bridges Command Line Interface. ##volumes create Create a volume. Volumes authorize the CGC to access and query objects on a specified cloud storage (Amazon Web Services or Google Cloud Storage) on your behalf. You can set the value for service_file if you want to describe the service in a JSON file. If you do not set the value, the command expects a service object description from stdin. [block:code] { "codes": [ { "code": "Usage:\n sb volumes create --name <name_value> [--access_mode <access_mode_value>] [--description <description_value>] [--service_file <service_file_value>] [flags]\n\nFlags:\n --name string The name for the volume.\n --access_mode string Sets the access to either read-write or read-only.\n --description string Description of the volume.\n --service_file string The file describing the service object. If omitted, input from stdin is expected.\n -h, --help help for create", "language": "text", "name": "volumes create" } ] } [/block] ##volumes list List all the volumes you have registered. [block:code] { "codes": [ { "code": "Usage:\n sb volumes list [flags]\n\nFlags:\n -h, --help help for list", "language": "text", "name": "volumes list" } ] } [/block] ##volumes get Get details about the specified volume. [block:code] { "codes": [ { "code": "Usage:\n sb volumes get <volume_id> [flags]\n\nArguments:\n volume_id ID of the volume.\n\nFlags:\n -h, --help help for get", "language": "text", "name": "volumes get" } ] } [/block] ##volumes update Update the details of the specified volume. [block:code] { "codes": [ { "code": "Usage:\n sb volumes update <volume_id> [--access_mode <access_mode_value>] --url <url_value> --credentials <credentials_value> ... [--description <description_value>] [flags]\n\nArguments:\n volume_id ID of the volume.\n\nFlags:\n --access_mode string Sets the access to either read-write or read-only.\n --url string Cloud provider API endpoint to use when accessing this bucket.\n --credentials stringSlice Contains credentials for underlying cloud provider.\n --description string Description of the volume.\n -h, --help help for update", "language": "text", "name": "volumes update" } ] } [/block] ##volumes delete Delete the specified volume. This call deletes a volume you've created to refer to storage on Amazon Web Services or Google Cloud Storage. In order for a volume to be deleted, it has to be deactivated first. Note that any files you've imported from your volume onto the CGC, known as an alias, will no longer be usable. If a new volume is created with the same `volume_id` as the deleted volume, aliases will point to files on the newly created volume instead (if those exist). [block:code] { "codes": [ { "code": "Usage:\n sb volumes delete <volume_id> [flags]\n\nArguments:\n volume_id ID of the volume.\n\nFlags:\n -h, --help help for delete", "language": "text", "name": "volumes delete" } ] } [/block] ##exports list Lists the export jobs initiated by the user. When you export a file from a project on the CGC into a volume, you write to your cloud storage bucket on Amazon Web Services or Google Cloud Storage. If an export command is successful, the original project file will become an alias to the newly exported object on the volume. The source file will be deleted from the CGC and, if no more copies of this file exist, it will no longer count towards your total storage price on the CGC. Once you export a file from the CGC to a volume, it is no longer part of the storage on the CGC and cannot be exported again. [block:code] { "codes": [ { "code": "Usage:\n sb exports list [flags]\n\nFlags:\n -h, --help help for list", "language": "text", "name": "exports list" } ] } [/block] ##exports get Get information about the specified export job. [block:code] { "codes": [ { "code": "Usage:\n sb exports get <export_id> [flags]\n\nArguments:\n export_id ID of the export job.\n\nFlags:\n -h, --help help for get", "language": "text", "name": "exports get" } ] } [/block] ##exports start Queue a job to export a file from a project on the CGC into a volume, ie. to your cloud storage bucket on Amazon Web Services or Google Cloud Storage. The file selected for export must not be a public file or an alias. Aliases are objects stored in your cloud storage bucket which have been made available on the CGC. The volume you are exporting to must be configured for read-write access. To do this, set the access_mode parameter to RW when creating or modifying a volume. When you export a file from a project on the CGC into a volume, you write to your cloud storage bucket on Amazon Web Services or Google Cloud Storage. If an export command is successful, the original project file will become an alias to the newly exported object on the volume. The source file will be deleted from the CGC and, if no more copies of this file exist, it will no longer count towards your total storage price on the CGC. Once you export a file from the CGC to a volume, it is no longer part of the storage on the CGC and cannot be exported again. [block:code] { "codes": [ { "code": "Usage:\n sb exports start --file <file_value> --destination_volume <destination_volume_value> --location <location_value> [--properties <properties_value> ...] [--overwrite] [flags]\n\nFlags:\n --file string The ID of the file for export. Must not be a public file nor an alias.\n --destination_volume string The ID of the read-write volume to which the file will be exported.\n --location string Volume-specific location to which the file will be exported.\n --properties stringSlice Properties of the S3 volume.\n --overwrite Overwrite the file with the same name and prefix if it already exists.\n -h, --help help for start", "language": "text", "name": "exports start" } ] } [/block] ##imports list Lists the import jobs initiated by the user. When you import a file from your volume on your cloud storage provider (Amazon Web Services or Google Cloud Storage), you are creating an alias on the CGC which points to the file in your cloud storage bucket. Aliases appear as files on the CGC and can be copied, executed, and modified as such. They refer back to the respective file on the given volume. [block:code] { "codes": [ { "code": "Usage:\n sb imports list [--volume <volume_value>] [--project <project_value>] [--state <state_value>] [--offset <offset_value>] [--limit <limit_value>] [flags]\n\nFlags:\n --volume string Volume ID for which imports are listed.\n --project string Project ID for which imports are listed.\n --state string List imports with specified state.\n --offset string Set offset when listing.\n --limit string Set limit when listing.\n -h, --help help for list", "language": "text", "name": "imports list" } ] } [/block] ##imports get Get information about the specified import job. [block:code] { "codes": [ { "code": "Usage:\n sb imports get <import_id> [--result] [flags]\n\nArguments:\n import_id ID of the import job.\n\nFlags:\n --result Get only result file from import.\n -h, --help help for get", "language": "text", "name": "imports get" } ] } [/block] ##imports start Start an import job from the specified volume. When you import a file from your volume on your cloud storage provider (Amazon Web Services or Google Cloud Storage), you are creating an alias on the CGC which points to the file in your cloud storage bucket. Aliases appear as files on the CGC and can be copied, executed, and modified as such. They refer back to the respective file on the given volume. This command queues a job to import a file from a volume into a project on the CGC. Essentially, you are importing a file from your cloud storage provider (Amazon Web Services or Google Cloud Storage) via the volume onto the CGC. [block:code] { "codes": [ { "code": "Usage:\n sb imports start --source_volume <source_volume_value> --location <location_value> --destination <destination_value> [--name <name_value>] [--overwrite] [flags]\n\nFlags:\n --source_volume string The ID of the source volume.\n --location string Volume-specific location pointing to the file to import.\n --destination string The ID of the project in which to create the alias.\n --name string The name of the alias. Should be unique to the project.\n --overwrite Overwrite the file with the same name if it already exists.\n -h, --help help for start", "language": "text", "name": "imports start" } ] } [/block]