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 verfication. '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
--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
--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
--user-message-link TEXT: Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an http or https URL with this collection
--user-message TEXT: A message for clients to display to users when interacting with this collection
--disable-https: Explicitly disable HTTPS supprt (requires a managed endpoint with API v1.1.0)
--enable-https: Explicitly enable HTTPS supprt (requires a managed endpoint with API v1.1.0)
--default-directory TEXT: Default directory when browsing the collection
--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
--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)
--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
--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
--force-encryption / --no-force-encryption: When set, all transfers to and from this collection are always encrypted
--display-name TEXT: New name for the collection
--keywords TEXT,TEXT,…: New comma separated list of keywords to help searches for the collection
--department TEXT: New department which operates the collection
--organization TEXT: New organization for the collection
--contact-email TEXT: New contact email for the collection
--contact-info TEXT: New contact Info for the collection
--info-link TEXT: New link for info about the collection
--description TEXT: New description for the collection
--public / --private: Set the collection to be public or private
-v, --verbose: Control level of output
-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.