GLOBUS GCS COLLECTION CREATE GUEST

NAME

globus gcs collection create guest - Create a GCSv5 Guest Collection.

SYNOPSIS

globus gcs collection create guest [OPTIONS] MAPPED_COLLECTION_ID COLLECTION_BASE_PATH DISPLAY_NAME

DESCRIPTION

Create a GCSv5 Guest Collection.

Create a new guest collection, named DISPLAY_NAME, as a child of MAPPED_COLLECTION_ID. This new guest collection’s file system will be rooted at COLLECTION_BASE_PATH, a file path on the mapped collection.

OPTIONS

--user-credential-id UUID

ID identifying a registered local user to associate with the new collection

--local-username TEXT

[Alternative to --user-credential-id] Local username to associate with the new collection (must match exactly one pre-registered User Credential ID)

--verify [force|disable|default]

Set the policy for this collection for file integrity verification after transfer. 'force' requires all transfers to perform verification. 'disable' disables all verification checks. 'default' allows the user to decide on verification at Transfer task submit time. When set on mapped collections, this policy is inherited by any guest collections

--public / --private

Set the collection to be public or private.

--user-message-link TEXT

Link to additional messaging for clients to display to users when interacting with this collection. Should be an HTTP or HTTPS URL

--user-message TEXT

A message for clients to display to users when interacting with this collection

--force-encryption / --no-force-encryption

Force the collection to encrypt transfers

--default-directory TEXT

Default directory when browsing or executing tasks on the collection

--keywords TEXT,TEXT,…​

Comma separated list of keywords to help searches for the collection

--department TEXT

Department which operates the collection

--organization TEXT

Organization for the collection

--contact-email TEXT

Contact email for the collection

--contact-info TEXT

Contact info for the collection

--info-link TEXT

Link for info about the collection

--description TEXT

Description for the collection

--identity-id TEXT

User who should own the collection (defaults to the current user)

--activity-notifications {all,succeeded,failed,source,destination}

Comma-separated list of conditions. Activity-monitoring roles on a guest collection will receive email notifications when a matching transfer task completes.

'source' and 'destination' filter to tasks where the collection is the source or destination of the transfer, respectively. Similarly, 'succeeded' and 'failed' filter based on the task’s status. 'all' enables notifications for all transfer tasks. Use "" to remove the activity notification policy.

For example, a value of 'destination,failed' sends notifications only when the collection is the destination and the transfer failed.

--enable-https / --disable-https

Explicitly enable or disable HTTPS support (requires a managed endpoint with API v1.1.0)

-v, --verbose

Control level of output, make it more verbose.

--quiet

Suppress non-essential output. This is higher precedence than --verbose.

-h, --help

Show this message and exit.

-F, --format [unix|json|text]

Output format for stdout. Defaults to text.

--jmespath, --jq TEXT

A JMESPath expression to apply to json output. Forces the format to be json processed by this expression.

--map-http-status TEXT

Map HTTP statuses to any of these exit codes: 0,1,50-99. e.g. "404=50,403=51"

EXIT STATUS

0 on success.

1 if a network or server error occurred, unless --map-http-status has been used to change exit behavior on http error codes.

2 if the command was used improperly.

3 if the command was used on the wrong type of object, e.g. a collection command used on an endpoint.

4 if the command has authentication or authorization requirements which were not met, as in ConsentRequired errors or missing logins.