GLOBUS GCS COLLECTION CREATE MAPPED
DESCRIPTION
Create a new Mapped Collection, rooted on some given path within an existing Storage Gateway.
If the '--storage-gateway' option is not used to specify a storage gateway to use and there is only one storage gateway on the endpoint, that gateway will be used. Otherwise, '--storage-gateway' is required.
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
-
--identity-id
TEXT
-
User who should own the collection (defaults to the current user)
-
--base-path
TEXT
-
The location within the storage gateway where the collection is rooted. [default: /]
-
--storage-gateway-id
TEXT
-
The storage gateway ID to host this collection. If no value is provided but the endpoint has exactly one gateway, that gateway will be used by default.
-
--sharing-restrict-paths
[JSON_FILE|JSON|file:JSON_FILE]
-
Path restrictions for sharing data on guest collections based on this collection.
- --allow-guest-collections / --no-allow-guest-collections
-
Allow Guest Collections to be created on this Collection. If this option is later disabled on a Mapped Collection which 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. 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 to allow multiple users.
-
--sharing-user-deny
TEXT
-
Connector-specific username denied permission to create guest collections. Give this option multiple times to deny multiple users.
-
--posix-sharing-group-allow
TEXT
-
POSIX group allowed access to create guest collections (POSIX Connector only). Give this option multiple times to allow multiple groups.
-
--posix-sharing-group-deny
TEXT
-
POSIX group denied permission to create guest collections (POSIX Connector only). Give this option multiple times to deny multiple groups.
-
--google-project-id
TEXT
-
The Google Cloud Platform project ID which is used by this Collection (Google Cloud Storage backed Collections only).
-
--posix-staging-sharing-group-allow
TEXT
-
POSIX group allowed access to create guest collections (POSIX Staging Connector Only). Give this option multiple times to allow multiple groups.
-
--posix-staging-sharing-group-deny
TEXT
-
POSIX group denied permission to create guest collections (POSIX Staging Connector Only). Give this option multiple times to deny multiple groups.
- -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.