GLOBUS ENDPOINT ACTIVATE

NAME

globus endpoint activate - Activate an endpoint

SYNOPSIS

globus endpoint activate [OPTIONS] ENDPOINT_ID

DESCRIPTION

Activate an endpoint using Autoactivation, Myproxy, Delegate Proxy, or Web activation. Note that --web, --delegate-proxy, and --myproxy activation are mutually exclusive options.

Autoactivation will always be attempted unless the --no-autoactivate option is given. If autoactivation succeeds any other activation options will be ignored as the endpoint has already been successfully activated.

To use Web activation use the --web option. The CLI will try to open your default browser to the endpoint’s activation page, but if a remote CLI session is detected, or the --no-browser option is given, a url will be printed for you to manually follow and activate the endpoint.

To use Myproxy activation give the --myproxy option. Myproxy activation requires your username and password for the myproxy server the endpoint is using for authentication. e.g. for default Globus Connect Server endpoints this will be your login credentials for the server the endpoint is hosted on. You can enter your username when prompted or give your username with the --myproxy-username option. For security it is recommended that you only enter your password when prompted to hide your inputs and keep your password out of your command history, but you may pass your password with the hidden --myproxy-password or -P options.

To use Delegate Proxy activation use the --delegate-proxy option with a file containing an X.509 certificate as an argument (e.g. an X.509 gotten from the myproxy-logon command). This certificate must be a valid credential or proxy credential for the user from an identity provider accepted by the endpoint being activated, and the endpoint must be configured with a gridmap that will match the globus user using this command with the local user the certificate was made to. Note if the X.509 is valid, but the endpoint does not recognize the identity provider or the user the error will not be detected until the user attempts to perform an operation on the endpoint.

OPTIONS

--web

Use web activation. Mutually exclusive with --myproxy and --delegate-proxy.

--no-browser

If using --web, Give a url to manually follow instead of opening your default web browser. Implied if the CLI detects this is a remote session.

--myproxy

Use myproxy activation. Mutually exclusive with --web and --delegate-proxy.

-U, --myproxy-username TEXT

Give a username to use with --myproxy

--myproxy-lifetime INTEGER

The lifetime for the credential to request from the server under --myproxy activation, in hours. The myproxy server may be configured with a maximum lifetime which it will use if this value is too high

--delegate-proxy X.509_PEM_FILE

Use delegate proxy activation, takes an X.509 certificate in pem format as an argument. Mutually exclusive with --web and --myproxy.

--proxy-lifetime INTEGER

Set a lifetime in hours for the proxy generated with --delegate-proxy. [default: 12]

--no-autoactivate

Don’t attempt to autoactivate endpoint before using another activation method.

--force

Force activation even if endpoint is already activated.

-v, --verbose

Control level of output

-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

Activate an endpoint using just Automatic activation:

$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ globus endpoint activate $ep_id

Activate an endpoint using Web activation

$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ globus endpoint activate $ep_id --web

Activate an endpoint using Myproxy activation, skipping the username prompt.

$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ globus endpoint activate $ep_id --myproxy -U username

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.