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
  • v5.3 Migration Guide
  • Troubleshooting Guide
  • Command-Line Reference
    • Audit
      • Load
      • Query
      • Dump
    • Endpoint
      • Setup
      • Show
      • Update
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Set Owner
      • Set Subscription ID
      • Migrate53
      • Cleanup
      • Domain
      • Role
      • Upgrade
    • OIDC
      • Create
      • Delete
      • Register
      • Show
      • Update
    • Node
      • Create
      • Setup
      • List
      • Show
      • Update
      • Cleanup
      • Delete
    • Login
    • Session
      • Consent
      • Show
      • Update
    • Whoami
    • Logout
    • Storage Gateway
      • Create
      • List
      • Show
      • Update
      • Delete
    • Collection
      • Create
      • List
      • Show
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Update
      • Delete
      • Domain
      • Role
    • Auth Policy
      • Create
      • List
      • Show
      • Update
      • Delete
    • Sharing Policy
      • Create
      • List
      • Show
      • Delete
    • User Credentials
      • Activescale Create
      • Box Create
      • Delete
      • List
      • S3 Create
    • Self Diagnostic
  • API Access for Portals
  • Application Migration Guide
  • Data Access Application Guide
  • Change Log
Skip to main content
Globus Docs
  • APIs
    Auth Flows Groups Search Transfer Python SDK Helper Pages
  • How To
  • Guides
    Globus Connect Server High Assurance Collections for Protected Data Command Line Interface Premium Storage Connectors Security Modern Research Data Portal
  • Support
    FAQs Mailing Lists Contact Us Check Support Tickets
  1. Home
  2. Globus Connect Server
  3. Installation Guide
  4. Command-Line Reference
  5. Storage Gateway

Globus Connect Server Storage Gateway List

Name

globus-connect-server storage-gateway list - List storage gateways on an endpoint

Synopsis

globus-connect-server storage-gateway list [OPTIONS]…​

Description

The globus-connect-server storage-gateway list command displays a summary of the storage gateways that exist on an endpoint.

By default, this command displays a table of data that includes the storage gateway name, id, connector, and whether it is a high assurance storage gateway or not. Alternatively, it can display a JSON document containing the list results. Use the -F json command-line option to enable this output format.

You can add the --include-private-policies flag to include private storage gateway configuration data. Some private policy fields contain complex JSON data. These are not shown in the text output format but are included in the JSON output format.

Note

In order to view private configuration data for a storage gateway, you must have an administrator role on the storage gateway assigned to one of your identities. You must have authenticated this identity within the authentication timeout of the storage gateway in order to view this data. For high assurance storage gateways you must perform the authentication within the active CLI session. If you do not meet the authentication timeout requirements, the public policies are still returned, but the private policies are omitted. Note that if there are multiple storage gateways on an endpoint with different authentication policies, the results may be a mix of those which include private policies and those that don’t.

Use the globus-connect-server session update command to update your session if you are not seeing the private policies due to the authentication timeout.

Options

-h, --help

Show help message and exit.

--version

Show the version and exit.

--include-private-policies

Flag to include the private policies. See the note above for information about requirements to view private policies.

-F, --format "text"|"json"

Output format for this command. If the format is json, then the Storage Gateway document 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.

Example

This example lists two storage gateways on an endpoint:

globus-connect-server storage-gateway list
Display Name    | ID                                   | Connector | High Assurance
--------------- | ------------------------------------ | --------- | --------------
Data Gateway    | 9753aa17-066e-46e8-b87c-6c3a34dab602 | POSIX     |              0
HA Data Gateway | 0c7a4659-2616-43bd-a680-4e716c554efa | POSIX     |              1
  • Quickstart Guide
  • Installation Guide
  • Data Access Admin Guide
  • Domain Guide
  • HTTPS Access to Collections
  • Identity Mapping Admin Guide
  • Globus OIDC Installation Guide
  • v5.3 Migration Guide
  • Troubleshooting Guide
  • Command-Line Reference
    • Audit
      • Load
      • Query
      • Dump
    • Endpoint
      • Setup
      • Show
      • Update
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Set Owner
      • Set Subscription ID
      • Migrate53
      • Cleanup
      • Domain
      • Role
      • Upgrade
    • OIDC
      • Create
      • Delete
      • Register
      • Show
      • Update
    • Node
      • Create
      • Setup
      • List
      • Show
      • Update
      • Cleanup
      • Delete
    • Login
    • Session
      • Consent
      • Show
      • Update
    • Whoami
    • Logout
    • Storage Gateway
      • Create
      • List
      • Show
      • Update
      • Delete
    • Collection
      • Create
      • List
      • Show
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Update
      • Delete
      • Domain
      • Role
    • Auth Policy
      • Create
      • List
      • Show
      • Update
      • Delete
    • Sharing Policy
      • Create
      • List
      • Show
      • Delete
    • User Credentials
      • Activescale Create
      • Box Create
      • Delete
      • List
      • S3 Create
    • Self Diagnostic
  • API Access for Portals
  • Application Migration Guide
  • Data Access Application Guide
  • Change Log
© 2010- The University of Chicago Legal Privacy Accessibility