Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This command line allows user to perform action which requires admin privileges and requires the admin password. The most common use cases are installation of catalog, database and indexes, create users, query the audit etc. As oppose to "opencga.sh", "opencga-admin.sh" does not use RESTful web services and must have direct access to the server to execute commands. 


Code Block
languagebash
themeRDark
titleopencga-admin.sh
./opencga-admin.sh 
...
Usage:       opencga-admin.sh [-h|--help] [--version] <command> [options]

Commands:
       catalog  Implements different tools interact with Catalog database
         users  Implements different tools for working with users
         audit  Implements different tools for working with audit
         tools  Implements different tools for working with tools
        server  Manage REST and gRPC servers
          meta  Manage Meta data

Common Use Cases

Examples


Code Block
languagebash
themeRDark
titleCreate User
opencga-admin.sh users create --name John --u john --email john@mail.com --user-password


Code Block
languagebash
themeRDark
titleImport Users From LDAP
opencga-admin.sh users import --auth-origin {originId} --user {userId}


Code Block
languagebash
themeRDark
titleImport Groups Of Users
# Import groups of users
opencga-admin.sh users import --auth-origin {originId} --group {ldapGroupName}

# Import a group (ldapGroupName) of users, create a group (newCatalogGroup) within a study (study) containing the users imported
opencga-admin.sh users import --auth-origin {originId} --group {ldapGroupName} --study-group {newCatalogGroup} --study {study}


Code Block
languagebash
themeRDark
titleGroup Synchronisation
opencga-admin.sh users sync --auth-origin {originId} --from {ldapGroupName} --to {catalogGroupName} --study {study}



Table of Contents