Globus Connect Server Setup Node

Name

globus-connect-server node setup - Set up a data transfer node

Synopsis

globus-connect-server node setup -c CLIENT-ID [OPTIONS]…

Description

The globus-connect-server node setup command provides a command-line interface to deploying and starting Globus services on a data transfer node. Before running this command, you must have previously used the globus-connect-server endpoint setup command to initialize the endpoint data and keychain. You will need to provide the client id you used when invoking that command along with the deployment-key.json file output from that command to run this command.

Important

This command must be run as root in order to correctly install the system configuration files and register the Globus services with the operating system. Also, the deployment-key.json file must be the same one created by globus-connect-server endpoint setup. Failure to disable a node with globus-connect-server node update or clean it up with globus-connect-server node cleanup before shutting down a Data Transfer Node can make your endpoint unreliable until you do so.

When you invoke this command with its required arguments, it will register this Data Transfer Node with the Globus service and associate it with the endpoint. This process may take several minutes to complete. After successful completion, the current machine acts as a Data Transfer Node to process data transfer and service management requests for your endpoint.

After running this command, you’ll probably want to log in to the endpoint and then use the endpoint manager command-line tools to update the endpoint.

This command logs the operations it performs in /var/log/globus-connect-server/gcs-manager/setup.log.

Note

Globus Connect Server prior to version 5.4.61 required manual registration with Globus Auth via the Developers web interface, and specifying client credentials to the GCS CLI required the --client-id option. If you are running a GCS version prior to 5.4.61 or your GCS deployment key was created prior to version 5.4.61, you must use the --client-id option to this command. As of version 5.4.67, the --client-id option has been removed. See the subcommand

endpoint
key convert

to update any existing deployment keys to include the client ID and secret.

Note

If your endpoint is in a NATed environment, then be sure to read our statement regarding NAT support.

Options

-h, --help: Show help message and exit.
--version: Show the version and exit.
-c, --client-id CLIENT_ID (required prior to 5.4.61, removed in 5.4.67): Auth Client ID for the Globus Connect Server endpoint. See the note above for when to use this option.
--deployment-key DEPLOYMENT_KEY_FILE: Path to deployment key created when setting up the endpoint. By default the path deployment-key.json is used.
--incoming-port-range LOW_PORT HIGH_PORT: Range of TCP ports to allow the GridFTP server to listen for data channel connections on. By default, Globus Connect Server uses the range [50000, 51000].
--outgoing-port-range LOW_PORT HIGH_PORT: Range of TCP ports to allow the GridFTP server to use as source ports for data channel connections to other GridFTP servers. By default, this is unconstrained.
-i, --ip-address ADDRESS: IP Address of this Data Transfer Node. By default this program will attempt to discover the public IP address that is used by the node. If it is unable to do so, you may be required to provide it on the command line using this option. Use this option multiple times to set multiple IPs.
--data-interface ADDRESS: The IP Address of the network interface to use for GridFTP data transfers. By default, this is set to the value of --ip-address if only one address is given. This option is required if multiple instances of --ip-address are given.
--export-node NODE_INFO_JSON: File to write node configuration to in order to restore the node by rerunning this command at a later time. This is intended for use in situations where the node is transient and needs to be redeployed on a different IP address than it previously was running on. Contact Globus Support if you think you need this.
--import-node NODE_INFO_JSON: File to read node configuration from in order to restore the node from a previous run of this command with a different IP address. This is intended for use in situations where the node is transient and needs to be redeployed on a different IP address than it previously was running on. Contact Globus Support if you think you need this.
-v, --verbose: Write verbose logging information to the setup log.

Example

This example sets up a node using the client id stored in the $CLIENT_ID environment variable, using sudo to become the root user to execute the command.

sudo globus-connect-server node setup