Globus Connect Server Administration Guides
  • Quickstart Guide
  • Installation Guide
  • Data Access Admin Guide
  • Domain Guide
  • HTTPS Access to Collections
  • Identity Mapping Admin Guide
  • Globus OIDC Installation Guide
  • Troubleshooting Guide
  • Command-Line Reference
    • Command summary
    • Audit
      • Load
      • Query
      • Dump
    • Endpoint
      • Setup
      • Show
      • Update
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Set Owner
      • Set Subscription ID
      • Cleanup
      • Key Convert
      • Domain
      • Role
      • Upgrade
    • OIDC
      • Create
      • Delete
      • Register
      • Show
      • Update
    • Node
      • Create
      • Disable
      • Enable
      • New Secret
      • Setup
      • List
      • Show
      • Update
      • Cleanup
      • Delete
    • Login
    • Session
      • Consent
      • Show
      • Update
    • Whoami
    • Logout
    • Storage Gateway
      • Create
      • List
      • Show
      • Update
      • Delete
    • Collection
      • Create
      • List
      • Show
      • Batch Delete
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Set Owner
      • Set Subscription Admin Verified Collection Property
      • Update
      • Delete
      • Domain
      • Check
      • Role
    • Auth Policy
      • Create
      • List
      • Show
      • Update
      • Delete
    • Sharing Policy
      • Create
      • List
      • Show
      • Delete
    • User Credentials
      • Activescale Create
      • OAuth Create
      • Delete
      • List
      • S3 Create
      • S3 Keys Add
      • S3 Keys Delete
      • S3 Keys Update
    • Self Diagnostic
  • Globus Connect Server Manager API
    • Authorization
    • Versioning
    • Endpoint
    • Roles
    • Nodes
    • Storage Gateways
    • Collections
    • User Credentials
    • Domains
    • Sharing Policies
  • API Access for Portals
  • Automated Endpoint Deployment
  • Data Access Application Guide
  • Application Migration Guide
  • Change Log
Skip to main content
Globus Docs
  • APIs
    Auth Flows Groups Search Timers Transfer Globus Connect Server Compute Helper Pages
  • Applications
    Globus Connect Personal Globus Connect Server Premium Storage Connectors Compute Command Line Interface Python SDK JavaScript SDK
  • Guides
  • Support
    FAQs Mailing Lists Contact Us Check Support Tickets
  1. Home
  2. Globus Connect Server
  3. v5.4
  4. Command-Line Reference
  5. Node
  6. New Secret

Globus Connect Server Node New Secret

Name

globus-connect-server node new-secret - Rotate the node’s client secret

Synopsis

globus-connect-server node new-secret [OPTIONS]…​

Description

The globus-connect-server node new-secret command replaces the endpoint node’s client secret with a secret specific to the node. The client secret is used by GCS services on the node to authenticate to Globus services. Rotating the node’s client secret can aid in the replacement of lost or exposed client secrets.

When a node is first configured with globus-connect-server node setup, the node’s client secret is set to the secret stored in the endpoint’s deployment key. This will result in all nodes in the endpoint sharing the same client secret. Running globus-connect-server node new-secret will replace the shared secret with a node-specific secret.

Subsequent runs of globus-connect-server node new-secret on the same node will delete any previously-registered secrets for the node after allocating a new node secret.

If a node-specific secret is accidentally deleted, the GCS services on the node will not be functional. Run globus-connect-server node setup with the deployment key to recover the node.

This command must be run as root. The secret rotation only affects the local node, all other nodes will remain unchanged.

The client secret is independent of the node’s encryption key which is already specific to the node.

Note

When the node’s client secret is rotated, the GCS Manager and GCS Manager Assistant processes must be restarted for the change to take effect. If the node was previously using the deployment key’s shared client secret installed by globus-connect-server node setup, the node will be operational and continue to use the shared secret until services are restarted. If the node has a node-specific client secret prior to running globus-connect-server node new-secret, the previous node-specific client secret will be deleted leaving the node non-operational until services are restarted. Due to this, globus-connect-server node new-secret will prompt for confirmation prior to rotating a node-specific client secret in order to alert the admin to the likely forced downtime caused by the operation.

Options

-h, --help

Show help message and exit.

--version

Show the version and exit.

--agree-to-delete-previous-secret

Avoid prompting before replacing the node specific client secret. See the Note above for details.

Example

This example rotates the local node’s client secret. Since this is a subsequent secret rotation for this node and the previous node secret will be deleted resulting in the GCS services becoming non-operational until restarted, the admin is prompted for confirmation and advised to restart the GCS services.

$ sudo -E ./globus-connect-server node new-secret
This node's current secret will be deleted. The GCS services on this
node will not be operational until the GCS manager and assistant are
restarted. You can skip this prompt with the --agree-to-delete-
previous-secret option. Do you want to continue? [y/N]: y

The GCS manager and assistant must be restarted. If those services are
currently running, they will be non-functional until restarted.

HISTORY

The globus-connect-server node new-secret command was added in Globus Connect Server v5.4.80.

  • Quickstart Guide
  • Installation Guide
  • Data Access Admin Guide
  • Domain Guide
  • HTTPS Access to Collections
  • Identity Mapping Admin Guide
  • Globus OIDC Installation Guide
  • Troubleshooting Guide
  • Command-Line Reference
    • Command summary
    • Audit
      • Load
      • Query
      • Dump
    • Endpoint
      • Setup
      • Show
      • Update
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Set Owner
      • Set Subscription ID
      • Cleanup
      • Key Convert
      • Domain
      • Role
      • Upgrade
    • OIDC
      • Create
      • Delete
      • Register
      • Show
      • Update
    • Node
      • Create
      • Disable
      • Enable
      • New Secret
      • Setup
      • List
      • Show
      • Update
      • Cleanup
      • Delete
    • Login
    • Session
      • Consent
      • Show
      • Update
    • Whoami
    • Logout
    • Storage Gateway
      • Create
      • List
      • Show
      • Update
      • Delete
    • Collection
      • Create
      • List
      • Show
      • Batch Delete
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Set Owner
      • Set Subscription Admin Verified Collection Property
      • Update
      • Delete
      • Domain
      • Check
      • Role
    • Auth Policy
      • Create
      • List
      • Show
      • Update
      • Delete
    • Sharing Policy
      • Create
      • List
      • Show
      • Delete
    • User Credentials
      • Activescale Create
      • OAuth Create
      • Delete
      • List
      • S3 Create
      • S3 Keys Add
      • S3 Keys Delete
      • S3 Keys Update
    • Self Diagnostic
  • Globus Connect Server Manager API
    • Authorization
    • Versioning
    • Endpoint
    • Roles
    • Nodes
    • Storage Gateways
    • Collections
    • User Credentials
    • Domains
    • Sharing Policies
  • API Access for Portals
  • Automated Endpoint Deployment
  • Data Access Application Guide
  • Application Migration Guide
  • Change Log
© 2010- The University of Chicago Legal Privacy Accessibility