GLOBUS COLLECTION UPDATE

NAME

globus collection update - Update a Collection definition.

SYNOPSIS

globus collection update [OPTIONS] COLLECTION_ID

DESCRIPTION

Update a Mapped or Guest Collection.

OPTIONS

--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

--display-name TEXT

Name for the collection

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

Path restrictions for sharing data on guest collections based on this collection. This option is only usable on Mapped Collections.

--allow-guest-collections / --no-allow-guest-collections

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.

--disable-anonymous-writes / --enable-anonymous-writes

Allow anonymous write ACLs on Guest Collections attached to this Mapped Collection. This option is only usable on non high assurance Mapped Collections and the setting is inherited by the hosted Guest Collections. Anonymous write ACLs are enabled by default (requires an endpoint with API v1.8.0).

--domain-name TEXT

DNS host name for the collection (mapped collections only). This may be either a host name or a fully-qualified domain name, but if it is the latter it must be a subdomain of the endpoint’s domain.

--enable-https / --disable-https

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

--sharing-user-allow TEXT

Connector-specific username allowed to create guest collections. Give this option multiple times in a single command to allow multiple users. Set a value of "" to clear this.

--sharing-user-deny TEXT

Connector-specific username denied permission to create guest collections. Give this option multiple times in a single command to deny multiple users. Set a value of "" to clear this.

--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.

-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.