globus-connect-server collection create - Create a collection


globus-connect-server collection create STORAGE_GATEWAY_ID BASE_PATH DISPLAY_NAME [OPTIONS]…​


The globus-connect-server collection create command creates a new mapped collection. When you create a mapped collection, you are allow your users access to their own data on a Storage Gateway via the GridFTP and HTTPS protocols.

There are three required arguments to this command:


The ID of the storage gateway which contains the data you want to provide access to. This will need to be created before creating the collection by using the storage-gateway create command.


This is the path which is the root of the mapped collection. You can use / to provide access to the entire namespace of the storage gateway (depending on the path restrictions policy of the gateway), or you can restrict it to some subtree of the data available by using a different value here.


The name of the collection. This is not guaranteed to be unique, but can be used as a first piece of information for for your users to find the collection.

Other command line options allow additional metadata to help users search for the collection, control visibility of the collection, provide policies for sharing data on a collection, or requiring data encryption when accessing the collection.

Note that any of the options used when creating the collection may be updated using the globus-connect-server collection update command.


A collection can be public or private. A public collection may show up in search results for any globus users. A private collection is only visible by those with role assignments.

The --public and -private command-line options determine whether a collection is public or not.


Many of the options to this command allow you to set metadata on your collection to help your users find the collections that are relevant to their needs. The more metadata you supply, the easier it will be for them to find relevant collections.

The --keywords, --department, --organization, and --description options all provide data to improve results when searching for collections.

The --contact-email, --contact-info, and --info-link options will provide data that will help your users find out more about what data you provide in the collection.

Guest Collections

With Globus Connect Server v5.4, it is possible to create guest collections that allow users to share access to their data on a mapped collection with other Globus users. This must be explicitly enabled on a mapped collection by using the --allow-guest-collections command-line option. If this is not set, then users are not allowed to share data.

Additionally, you can set path restrictions for guest collections. For example, you could allow read-only access to the data on the storage gateway, or completely deny access to some subdirectories. Use the --sharing-restrict-paths command line option to configure this.

Currently, guest collections can only be created via the web application or the GCS Manager API. For most users, it’s easiest to visit the mapped collection on the web, click on the Shares tab and then the Create New Shared Collection button.


Guest collections are a premium feature and require the Globus Connect Server endpoint to be managed.


-h, --help

Show help message and exit.


Show the version and exit.

-F, --format "text"|"json"

Output format for this command. If the format is json, then the resulting role document is displayed.


Allow guest collections to be created on this collection. This option is only usable on mapped collections. If this option is disabled on a mapped collection which already has associated Guest Collections, those collections will no longer be accessible.

--sharing-restrict-paths JSON|file:JSON_FILE

Path restrictions for sharing data on guest collections based on this collection. This option is only usable on mapped collections. In the first syntax, you pass a PathRestrictions as a string; in the second syntax you pass the path to a file containing the PathRestrictions object.


When set, all transfers to and from this collection are always encrypted. If not set, this can be configured on a per-transfer basis.

--keywords string,string,…​

Comma separated list of keywords to help searches for the collection

--department DEPARTMENT

Department which operates the collection

--organization ORGANIZATION

Organization for the Collection

--contact-email EMAIL

Contact email for the Collection

--contact-info INFO

Contact info for the Collection

--info-link URL

Link to a web page containing info about the collection.

--description STRING

Description of the collection.


Set the Collection to be public or private (defaults to public)

--identity-id IDENTITY

Globus Auth identity to who acts as the owner of this collection.

--google-project-id PROJECT

For Google Cloud Storage backed Collections only. The Google Cloud Platform project ID to use when accessing this collection.