GLOBUS ENDPOINT SEARCH

NAME

globus endpoint search - Find and discover endpoints.

SYNOPSIS

globus endpoint search [OPTIONS] FILTER_FULLTEXT

globus endpoint search --filter-scope SCOPE [OPTIONS] [FILTER_FULLTEXT]

DESCRIPTION

Search for Globus endpoints with search filters. If --filter-scope is set to the default of 'all', then FILTER_FULLTEXT is required.

If FILTER_FULLTEXT is given, endpoints which have attributes (display name, legacy name, description, organization, department, keywords) that match the search text will be returned. The result size limit is 100 endpoints.

OPTIONS

--filter-scope [all|administered-by-me|my-endpoints|my-gcp-endpoints|recently-used|in-use|shared-by-me|shared-with-me]

The set of endpoints to search over. [default: all]

--filter-owner-id TEXT

Filter search results to endpoints owned by a specific identity. Can be the Identity ID, or the Identity Username, as in "go@globusid.org"

--limit INTEGER RANGE

The maximum number of results to return. [default: 25; 1⇐x⇐1000]

--filter-entity-type [GCP_mapped_collection|GCP_guest_collection|GCSv5_endpoint|GCSv5_mapped_collection|GCSv5_guest_collection]

Filter search results to endpoints of a specific entity type.

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

EXAMPLES

Search for the Globus tutorial endpoints

$ globus endpoint search Tutorial --filter-owner-id go@globusid.org

Search for endpoints owned by the current user

$ globus endpoint search --filter-scope my-endpoints

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.