Command «credentials»
- Former user (Deleted)
- Nancy Cohn (Deactivated)
Command «credentials» is used to make manipulations with credential files. This is:
Printing credentials from credential file. Password is hidden;
Adding, editing and deleting credentials;
Changing credential type;
Converting from eagle encrypted file to aes encrypted.
Different actions have different parameters.
General Syntax
Here is basic syntax of credential command:
cmdmgr.exe credentials --type=<eagle|aes> --action=<list|add|delete|edit|convert|change_credtype> [optional parameters]Parameter «type» is required for selecting encoding type. Therefore, it cannot be empty.
If action is changing content of file, it automatically converts from old format file (with another encryption format and 3-parameter credential format) to new file format (more flexible encryption format and 4-parameter credential format).
Below will be described each action in details.
1. action=list
This is action, which prints credentials from specified file.
Syntax
Here is command syntax with this action:
cmdmgr.exe credentials --type=aes --action=list [--file=<path_to_file>|--section=<some_section>]Parameters
Command has two optional parameters:
file – path to credential file. If this parameter not specified, then default file location will be from «db_connection.ini» primary section;
section – server custom settings section, by default primary.
Examples
List Example 1
cmdmgr.exe credentials --type=aes --action=list
List Example 2
cmdmgr.exe credentials --type=aes --action=list --file=../cfg/test
List Example 3
cmdmgr.exe credentials --type=aes --action=list --section=secondary
2. action=add
This action allows adding new credential to specified file, or file from section.
Syntax
Here is command syntax with this action:
cmdmgr.exe credentials --type=<eagle|aes> --action=add --name=<DB_Name> --user=<UserName> --pass=<Password> [--credtype=<oracle|mssql|service>] [--file=<path_to_file>|--section=<some_section>]Parameters
Action has such parameters:
name – database name;
user – user name or login for database connection;
pass – user password for database connection. It will be encrypted using encryption type from parameter «type»;
credtype – Credential database type. It can be mssql, oracle, service or unknown. By default, it is unknown. This is optional parameter;
file – path to credential file. If this parameter not specified, then default file location will be from «db_connection.ini» primary section. This is optional parameter;
section – server custom settings section, by default primary. This is optional parameter.
Examples
Add Example 1
cmdmgr.exe credentials --type=aes --action=add --name=DB --user=root --pass=root
Add Example 2
cmdmgr.exe credentials --type=aes --action=add --name=DB --user=root --pass=root --credtype=Oracle
Add Example 3
cmdmgr.exe credentials --type=aes --action=add --name=DB --user=root --pass=root --credtype=Oracle --file=../cfg/test
Add Example 4
cmdmgr.exe credentials --type=aes --action=add --name=DB --user=root --pass=root --credtype=Oracle --section=secondary
If credential file does not exist, action «add» will create new file based on file or section parameter, or will use default file location from database configuration file.
3. action=delete
This is action which delete credential from specified file or file from section.
Syntax
Here is command syntax with this action:
cmdmgr.exe credentials --type=<eagle|aes> --action=delete --name=<DB_Name> --user=<UserName> [--credtype=<oracle|mssql|service>] [--file=<path_to_file>|--section=<some_section>]Parameters
Action has such parameters:
name – database name;
user – user name or login for database connection;
credtype – Credential database type. It can be mssql, oracle, service or unknown. By default, it is unknown. This is optional parameter;
file – path to credential file. If this parameter not specified, then default file location will be from «db_connection.ini» primary section. This is optional parameter;
section – server custom settings section, by default primary. This is optional parameter.
Examples
Delete Example 1
cmdmgr.exe credentials --type=aes --action=delete --name=DB --user=root
Delete Example 2
cmdmgr.exe credentials --type=aes --action=delete --name=DB --user=root -–credtype=Oracle
Delete Example 3
cmdmgr.exe credentials --type=aes --action=delete --name=DB --user=root -–credtype=Oracle --file=../cfg/test
Delete Example 4
cmdmgr.exe credentials --type=aes --action=delete --name=DB --user=root -–credtype=Oracle –-section=secondary
4. action=edit
This is action, which allows editing existing credential password in specified file, or file from section.
Syntax
Here is command syntax with this action:
cmdmgr.exe credentials --type=<eagle|aes> --action=edit --name=<DB_Name> --user=<UserName> --pass=<NewPassword> [--credtype=<oracle|mssql|service>] [--file=<path_to_file>|--section=<some_section>]Parameters
Parameter list:
name – database name;
user – user name or login for database connection;
pass – new user password. It will be encrypted using encryption type from parameter «type»;
credtype – Credential database type. It can be mssql, oracle, service or unknown. By default, it is unknown. This is optional parameter;
file – path to credential file. If this parameter not specified, then default file location will be from «db_connection.ini» primary section. This is optional parameter;
section – server custom settings section, by default primary. This is optional parameter.
Examples
cmdmgr.exe credentials --type=aes --action=edit --name=DB --user=root --pass=newroot
cmdmgr.exe credentials --type=aes --action=edit --name=DB --user=root --pass= newroot --credtype=Oracle
cmdmgr.exe credentials --type=aes --action=edit --name=DB --user=root --pass= newroot --credtype=Oracle --file=../cfg/test
cmdmgr.exe credentials --type=aes --action=edit --name=DB --user=root --pass= newroot --credtype=Oracle --section=secondary5. action=convert
This is action, which allows converting credential files from eagle encoding to new format aes encoding. This means that credentials from eagle encoding will have 4th parameter (database type) set to unknown, because, old format does not support this parameter.
Syntax
Here is command syntax with this action:
cmdmgr.exe credentials --type=eagle --action=convert --from=<path_to_eagle> --to=<path_to_aes>Parameters
Action has such parameters:
from – path to credential file in eagle format;
to – path with file name for converted file.
Example
cmdmgr.exe credentials --type=eagle --action=convert --from=../cfg/eagle_pass --to=../cfg/aes_pass6. action=change_credtype
This is action, which allow to change credential database type in specified file, or file from section.
Syntax
Here is command syntax with this action:
cmdmgr.exe credentials --type=aes --action=change_credtype --name=<database name> --user=<user name> --from=<oldType> --to=<newType>Parameters
Action has such parameters:
from – database type that currently credential has.
to – new database type.
Example
cmdmgr.exe credentials --type=aes --action=change_credtype --name=DB --user=root --from=Oracle --to=MSSql