The globus-connect-server endpoint update command updates information about the Globus Connect Server Endpoint. This can be used to update properties of the endpoint that may enable different functionality, tune performance, or make the endpoint easier to search for.
In order to use this command, one of your Globus identities must have an
owner role on the endpoint (except for the --subscription-id parameter).
The --subscription-id parameter can be used by a subscription manager
who does not have an
owner role on an endpoint if the
following are true:
The endpoint is public
The endpoint is currently not managed
It can be used by an
owner if the argument to that parameter
is null and the endpoint is managed to alter the endpoint to be unmanaged.
The command line options --public and --private control whether the endpoint is visible to globus users who do not have a role on the endpoint. If the endpoint is set to private, then it is not visible in the Globus Transfer API unless the caller has a role on that endpoint.
The command line option --network-use can be used to alter the network
performance and scalability of your endpoint. The network use value may
only be modified from the normal value on a managed endpoint. If the
network use is set to
custom, the all of the --preferred-parallelism,
--max-parallelism, --preferred-concurrency, and --max-concurrency
options must also be set. See the
network use section of the installation
guide for a description of what these values mean.
- -h, --help
Show help message and exit.
Show the version and exit.
- -F, --format "text"|"json"
Output format for this command. If the format is json, then the full response from the GCS Manager is displayed.
- --use-explicit-host IP_ADDRESS (new in 5.4.23)
IP address of the GCS node to use for this request. If not specified, any available GCS node in the endpoint will be used.
- --public / --private
Set the Endpoint to be public or private
- --preferred-parallelism INTEGER
Set the Endpoint’s preferred parallelism; requires
- --max-parallelism INTEGER
Set the Endpoint’s max parallelism; requires
- --preferred-concurrency INTEGER
Set the Endpoint’s preferred concurrency; requires
- --max-concurrency INTEGER
Set the Endpoint’s max concurrency; requires
--network-use=custom--network-use "normal"|"minimal"|"aggressive"|"custom" Set the Endpoint’s network use level. If using custom, the Endpoint’s max and preferred concurrency and parallelism must be set
- --subscription-id UUID|"DEFAULT"|"null"
Set the Endpoint as a managed Endpoint with the given subscription ID or DEFAULT. Pass
--subscription-id DEFAULTif are subscription manager for only one subscription, or pass '--subscription-id null' to set an endpoint’s subscription ID to null.
- --keywords KEYWORD,…
Comma-separated list of keywords to help searches for this endpoint.
- --department DEPARTMENT
Department within the organization that runs the Data Transfer Nodes.
- --contact-email ADDRESS
Email address of the support contact for the Data Transfer Nodes serving this endpoint.
- --contact-info INFO
Other non-email contact information for the endpoint, e.g. phone and mailing address.
- --info-link URL
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.
- --description DESCRIPTION
Description of this endpoint.
- --display-name NAME
Name of this endpoint.