Overview

A Globus Connect Server endpoint is a deployment of Globus Connect Server version 5. A single endpoint may optionally include multiple data transfer nodes. he endpoint provides a link between a Globus Connect Server deployment and the Globus Transfer service. The endpoint describes services for accessing data via GridFTP and HTTPS and also for configuring and managing the policies associated with that access.

The endpoint includes interfaces for configuring and managing roles, storage gateways, collections, and nodes.

Commands

globus-connect-server endpoint setup

Set up an endpoint

globus-connect-server endpoint cleanup

Delete up an endpoint.

globus-connect-server endpoint migrate53

Migrate a v5.3 endpoint and its configuration to v5.4 (new in v5.4.1)

globus-connect-server endpoint show

Show information about an endpoint

globus-connect-server endpoint update

Update an endpoint

Endpoint Document

Name

Type

Description

DATA_TYPE

string endpoint#1.0.0

Type of this document

public

boolean

Flag indicating whether this endpoint is visible to all other Globus users. If false, only users which have been granted a role on the endpoint or one of its collections, or belong to a domain allowed access to any of its storage gateways may view it.

id

string <uuid>

Unique identifier string for the endpoint.

display_name

string

Friendly name for the endpoint, not unique. Unicode string, no new lines (\r or \n). Searchable.

gcs_manager_url

string <uri>

URL of the GCS Manager API service for this endpoint.

subscription_id

string anyOf { <uuid>, DEFAULT }

The UUID of the subscription that is managing this endpoint. This may be the special value DEFAULT when using this as input to PATCH or PUT to use the caller’s default subscription id.

network_use

string normal, minimal, aggressive, custom

Allowed values for network_use are:

normal

The default setting. Uses an average level of concurrency and parallelism. The levels depend on the number of physical servers in the endpoint.

minimal

Uses a minimal level of concurrency and parallelism.

aggressive

Uses a high level of concurrency and parallelism.

custom

Uses custom values of concurrency and parallelism set by the endpoint admin. When setting this level, you must also set the max_concurrency, preferred_concurrency, max_parallelism, and preferred_parallelism options.

max_concurrency

integer

Admin-specified value when the network_use property’s value is custom; otherwise the preset value for the specified network_use.

preferred_concurrency

integer

Admin-specified value when the network_use property’s value is custom; otherwise the preset value for the specified network_use.

max_parallelism

integer

Admin-specified value when the network_use property’s value is custom; otherwise the preset value for the specified network_use.

preferred_parallelism

integer

Admin-specified value when the network_use property’s value is custom; otherwise the preset value for the specified network_use.

organization

string

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

department

string

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

keywords

array (string)

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

description

string

A description of the endpoint.

contact_email

string <email>

Email address of the support contact for the server(s) represented by the endpoint.

contact_info

string

Other non-email contact information for the endpoint, e.g. phone and mailing address.

info_link

string <uri>

Link to a web page with more information about the endpoint. The administrator is responsible for running a website at this URL and verifying that it’s accepting public connections.

allow_udt

boolean

Allow data transfer on this endpoint using the UDT protocol.

{
  "DATA_TYPE": "endpoint#1.0.0",
  "public": true,
  "id": "string",
  "display_name": "string",
  "gcs_manager_url": "https://gcs.data.globus.org/",
  "subscription_id": "2d99530d-3b20-44cb-94d3-61d8f85cd896",
  "network_use": "normal",
  "max_concurrency": 1,
  "preferred_concurrency": 1,
  "max_parallelism": 1,
  "preferred_parallelism": 1,
  "organization": "string",
  "department": "string",
  "keywords": [
    "string"
  ],
  "description": "string",
  "contact_email": "user@example.com",
  "contact_info": "string",
  "info_link": "http://example.com",
  "allow_udt": false
}

© 2010- The University of Chicago Legal