Globus Connect Server Collection List

Name

globus-connect-server collection list - List collections on an endpoint

Synopsis

globus-connect-server collection list [OPTIONS]…​

Description

The globus-connect-server collection list command displays a summary of the collections that exist on an endpoint.

By default, this command displays a table of data that includes the collection id, name, owner, type (mapped or guest), storage gateway id and created and last data access times. Alternatively, it can display a JSON document containing the list results. Use the -F json command-line option to enable this output format.

The default output only includes the public configuration data for the collections. To request the private configuration data as well, you must have an administrator role on the collection assigned to one of your identities and use the --include-private-policies flag. For high-assurance endpoints this data is only visible if the request is done with an administrator id that is valid in the session and meets the authentication requirements of the storage gateway that the collection is providing access to.

You can filter the list of collections that are queried and displayed in two different ways. You can filter Guest collections by the ID of the mapped collection that they are sharing data from by using the --mapped-collection-id COLLECTION_ID parameter. You can also use the --filter FILTER_LIST parameter to apply one or more of the following filters to the results:

mapped-collections

Filter out collections which do not have the collection_type property set to "mapped".

guest-collections

Filter out collections which do not have the collection_type property set to "guest".

managed-by-me

Filter out collections where none of the caller’s identities have a role association for the collection.

created-by-me

Filter out collections where none of the callers identities match the identity_id property of the collection.

last-access < YYYY-MM-DD
last-access <= YYYY-MM-DD
last-access = YYYY-MM-DD
last-access >= YYYY-MM-DD
last-access > YYYY-MM-DD

Only collections accessed before or after the given date

created-at < YYYY-MM-DD
created-at <= YYYY-MM-DD
created-at = YYYY-MM-DD
created-at >= YYYY-MM-DD
created-at > YYYY-MM-DD

Only collections created before or after the given date

Note
Multiple filters may be specified on the command-line, but certain combinations (such as filtering only mapped collections and only guest collections) will always yield an empty result.

Options

-h, --help

Show help message and exit.

--version

Show the version and exit.

--include-private-policies

Flag to include the private policies. See above for information about requirements to view private policies.

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

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

--mapped-collection-id UUID

Filter results to Guest Collections on a specific Mapped Collection. This is the ID of the Mapped Collection.

--storage-gateway-id UUID (new in 5.4.67)

Filter results to Collections on a specific Storage Gateway. This is the ID of the Storage Gateway.

--use-explicit-host IP_ADDRESS (new in 5.4.23)

IP address of the GCS node to use for this request. If not specified, any available GCS node in the endpoint will be used.

--filter "mapped-collections"
--filter "guest-collections"
--filter "managed-by-me"
--filter "created-by-me"
--filter "last-access < YYYY-MM-DD" (new in 5.4.60)
--filter "last-access ⇐ YYYY-MM-DD"
--filter "last-access = YYYY-MM-DD"
--filter "last-access >= YYYY-MM-DD"
--filter "last-access > YYYY-MM-DD"
--filter "created-at < YYYY-MM-DD"
--filter "created-at ⇐ YYYY-MM-DD"
--filter "created-at = YYYY-MM-DD"
--filter "created-at >= YYYY-MM-DD"
--filter "created-at > YYYY-MM-DD"

Filter output as described above. This may be passed multiple times to apply several filters to the results.

Example

This example lists the guest collections on an endpoint, showing those which haven’t been accessed since Jan 1, 2022.

globus-connect-server collection list \
    --filter guest_collections \
    --filter "last_access <= 2022-01-01"
Example List
ID                                   | Display Name                | Owner                | Collection Type | Storage Gateway ID                   | Created    | Last Access
------------------------------------ | --------------------------- | -------------------- | --------------- | ------------------------------------ | ---------- | -----------
0ad549ce-f6cb-4c6e-a597-eabee476aa69 | Example Data Collection     | user@example.org     | guest           | 69d165fa-6977-4c3b-91db-00b943d84d2a | 2020-03-02 | 2021-11-22
2922cfc7-dc87-4506-875d-d273c4c5646a | Another Data Collection     | user@example.org     | guest           | 69d165fa-6977-4c3b-91db-00b943d84d2a | 2021-03-02 | 2021-12-22

If the --format list is used, the output consists of only the collection IDs:

globus-connect-server collection list \
    --filter guest_collections \
    --filter "last_access <= 2022-01-01" \
    --format list
Example List IDs
0ad549ce-f6cb-4c6e-a597-eabee476aa69
2922cfc7-dc87-4506-875d-d273c4c5646a