Package: cyral
The Cyral CLI ToolUse this tool to obtain credentials for accessing a data repo via the Cyral sidecar.NotesThis tool does not work with Cyral versions before 3.0. If you are using an
older version of Cyral, please use thegimme-db-tokentool instead.Use version 1.x of this tool for Cyral version 3.X and version 2.x for Cyral version 4.X and greater.Commandtokenworks only with Cyral version 4.12 and greater.Usagecyral [OPTIONS] COMMAND [ARGS]...The Cyral CLIOptionsNameDescription--cp-address TEXTCyral Control Plane Address--no-browserDisable automatic browser launch for authentication--idp TEXTIdentity Provider to use to authenticate to Cyral--local-port INTEGERLocal port number for receiving OAuth2 redirects  [default: 8005]--stored-creds / --no-stored-credsUse and/or store refresh token in ~/.cyral  [default: stored-creds]--offline-access / --no-offline-accessObtain a (long lived) offline refresh token  [default: no-offline-access]--realm TEXTAuthentication realm (usually not needed)  [default: default]--versionShow the version and exit.--helpShow this message and exit.CommandsNameDescriptionaccessAccess a data repo.helpPrints detailed usage information including commands,...sidecarSidecar related commandstokenManage access tokens.Usagecyral help [OPTIONS]Prints detailed usage information including commands, subcommands, and
options.OptionsNameDescription-f, --output-format [plain | md]Output format  [default: plain]--helpShow this message and exit.Usagecyral token [OPTIONS] COMMAND [ARGS]...Manage access tokens. By default, tokens are cached in a file. Use option
--no-use-token-cache if you wish to disable token caching.OptionsNameDescription--use-token-cache / --no-use-token-cacheWhether to use local token cache.  [default: use-token-cache]--helpShow this message and exit.CommandsNameDescriptioncreateCreate a new access token.deleteDelete an access token.listLists information about all currently valid access tokens.showShow the value of a cached access token.Usagecyral token create [OPTIONS]Create a new access token.OptionsNameDescription--validity INTEGERToken validity in seconds (system default if not specified)--name TEXTName of the access token, autogenerated if not specified-h, --helpShow help message and exit.Usagecyral token list [OPTIONS]Lists information about all currently valid access tokens. Actual token
values are not shown.OptionsNameDescription-f, --output-format [plain | json]Output format  [default: plain]-h, --helpShow help message and exit.Usagecyral token delete [OPTIONS]Delete an access token.OptionsNameDescription-h, --helpShow help message and exit.--token-id TEXTID of the token on which the action will be performedUsagecyral token show [OPTIONS]Show the value of a cached access token.OptionsNameDescription-h, --helpShow help message and exit.--token-id TEXTID of the token on which the action will be performedUsagecyral access [OPTIONS] COMMAND [ARGS]...Access a data repo.OptionsNameDescription--token TEXTAccess token value to use (optional)--auto-generate-token / --no-auto-generate-tokenGenerate a token automatically if needed  [default: auto-generate-token]--use-token-cache / --no-use-token-cacheWhether to use local token cache.  [default: use-token-cache]--helpShow this message and exit.CommandsNameDescriptionpgConfigure access to postgres databases via Cyral in .pgpass file.repoObtain information to access a data repos3Configure AWS profile for accessing S3 via Cyral sidecar.tokenObtain access token for accessing a data repo.Usagecyral access token [OPTIONS]Obtain access token for accessing a data repo. DEPRECATED: If your Cyral
control plane has version v4.12.0 or later, use thecyral token createandcyral token showcommands.OptionsNameDescription-h, --helpShow help message and exit.Usagecyral access repo [OPTIONS]Obtain information to access a data repoOptionsNameDescription-n, --name TEXTRepo name in Cyral (substring match)--tag TEXTRepo tag (substring match)-t, --type [auroramysql | aurorapostgres | denodo | dremio | galera | mariadb | mongodb | mysql | oracle | postgresql | redshift | s3 | sqlserver]Repo type--repos-per-page INTEGERNumber of repos shown per page  [default: 10]-f, --output-format [plain | json]Output format  [default: plain]-h, --helpShow help message and exit.Usagecyral access s3 [OPTIONS]Configure AWS profile for accessing S3 via Cyral sidecar.OptionsNameDescription--aws-profile TEXTName of the AWS profile to configure  [default: cyral]--autoconfigure / --no-autoconfigureAutoconfigure (without confirmation) S3 proxy settings  [default: no-autoconfigure]--account-name TEXTPreferred account name to use for accessing the s3 repo--silent / --no-silentDo not print confirmation messages  [default: no-silent]-h, --helpShow help message and exit.Usagecyral access pg [OPTIONS]Configure access to postgres databases via Cyral in .pgpass file.OptionsNameDescription--silent / --no-silentDo not print confirmation messages  [default: no-silent]-h, --helpShow help message and exit.Usagecyral sidecar [OPTIONS] COMMAND [ARGS]...Sidecar related commandsOptionsNameDescription--id TEXTthe id of the sidecar--name TEXTthe name of the sidecar--helpShow this message and exit.CommandsNameDescriptiongetGet information about sidecars in the control plane.setSet different sidecar options.Usagecyral sidecar get [OPTIONS]Get information about sidecars in the control plane.OptionsNameDescription-f, --output-format [yaml | json | table]Output format  [default: table]-h, --helpShow help message and exit.Usagecyral sidecar set [OPTIONS] COMMAND [ARGS]...Set different sidecar options.OptionsNameDescription--helpShow this message and exit.CommandsNameDescriptionlog-levelSet the log level for a sidecar service.Usagecyral sidecar set log-level [OPTIONS]Set the log level for a sidecar service. The argument can be of the form
 (log level applicable to all services) or : (log
level for a specific service).  can be one of fatal, error, warn,
info, debug, or trace. The list of services may vary depending on the
sidecar version and configuration. This option can be specified multiple
times, the last log level specified for a service is the one that is set.Examplesset the level for all servicescyral sidecar set log-level --level debugset the level for a single servicecyral sidecar set log-level --level dispatcher:warnset the level for multiple servicescyral sidecar set log-level --level dispatcher:warn --level pg-wire:debugOptionsNameDescription--level TEXTrequested log level-h, --helpShow help message and exit.Release Notes2.5.5(Bug fix) Fix the bug where attempting to set log level for a service may give error "service does not exist".2.5.4(Bug fix) Remove dependency on awscli 1.x package and use awscli-plugin-proxy instead of
awscli-plugin-s3-proxy to avoid clobbering of awscli installation.2.5.3(Bug fix) Fix possible unexpected exception inaccess s3command.2.5.2(Bug fix) Fix bug inaccess tokencommand for older (< v4.12) control planes.2.5.1(Enhancement) Add --no-browser flag to disable automatic browser launch for authentication.(Enhancement) Add --auto-token-generation option.2.5.0(Enhancement) Add access token management commands and token cache.(Refactor) Update access commands to use new token interactions.2.4.0(Enhancement) Addhelpcommand for comprehensive command help.(Bug Fix) Disable option validity checking when--helpis specified.2.3.0(Enhancement) Allow users to choose account name for S3 access.2.2.4(Chore) Update dependency versions.2.2.3(Enhancement) Support new certificate download endpoint on Cyral Control Plane.2.2.2(Bug Fix) Supportaws s3apicommand.2.2.1(Bug Fix) Make changes compatible with Python version 3.9.2.2.0(Enhancement) Addsidecarcommand.2.1.1(Enhancement) Add--realmoption to support some older control planes.2.0.1(Bug Fix) Choose non-proxy mode port for S3 repo.2.0.0(Enhancement) Add support for Cyral Control Plane v4.x.