Options for tibemsadmin
Type
tibemsadmin -help
to display information about
tibemsadmin
startup parameters. All
tibemsadmin
parameters are optional.
Option | Description |
---|---|
-help or -h
|
Print the help screen. |
-script
script-file
|
Execute the specified text file containing
tibemsadmin commands then quit. Any valid
tibemsadmin command described in this chapter can be executed.
Line breaks within the file delimit each command. That is, every command must be contained on a single line (no line breaks within the command), and each command is separated by a line break. |
-server
server-url
|
Connect to specified server. |
-user
user-name
|
Use this user name to connect to the server. If the server is configured for OAuth 2.0 authentication, use this user name to obtain an OAuth 2.0 access token as part of the Authentication Using OAuth 2.0. |
-password
password |
Use this password to connect to the server. If the server is configured for OAuth 2.0 authentication, use this password to obtain an OAuth 2.0 access token as part of the Authentication Using OAuth 2.0. |
-pwdfile
password-file
|
Use the clear-text password in the specified file to connect to the server. If both
-pwdfile
and
-password options are given, the password specified through the
-password option takes precedence.
|
-oauth2_access_token
|
The OAuth 2.0 access token to use to authenticate with the EMS server.
If an access token is directly provided via this option, none of the other |
-oauth2_server_url
|
The HTTP(S) URL of the OAuth 2.0 authorization server that will issue the access tokens to be used to authenticate with the EMS server. |
-oauth2_client_id
|
The OAuth 2.0 client ID to use when connecting to the OAuth 2.0 authorization server. This parameter is required regardless of the grant type to be used for requesting access tokens. |
-oauth2_client_secret
|
The OAuth 2.0 client secret to use when connecting to the OAuth 2.0 authorization server. This parameter is required regardless of the grant type to be used for requesting access tokens. |
-oauth2_server_trust_file
|
A file containing one or more PEM-encoded public certificates that can be used to validate the OAuth 2.0 authorization server's identity. This parameter is only required if establishing an HTTPS connection to the authorization server. |
-oauth2_disable_verify_hostname
|
If set, the name in the CN field of the OAuth 2.0 authorization server’s certificate will not be verified. This parameter is optional. Hostname verification is performed by default. |
-oauth2_expected_hostname
|
The name that is expected in the CN field of the OAuth 2.0 authorization server's certificate. This parameter is optional and only relevant when |
-ignore
|
Ignore errors when executing script file. This parameter only ignores errors in command execution but not syntax errors in the script. |
-mangle [password ]
|
Mangle the password and quit. Mangled string in the output can be set as a value of one of these passwords from the configuration files:
|
-ssl_trusted
filename
|
File containing trusted certificate(s). This parameter may be entered more than once if required. |
-ssl_identity
filename
|
File containing client certificate and (optionally) extra issuer certificate(s), and the private key. |
-ssl_issuer
filename
|
File containing extra issuer certificate(s) for client-side identity. |
-ssl_key
filename
|
File containing the private key. |
-ssl_password
password
|
Private key or PKCS#12 password. If the password is required, but has not been specified, it will be prompted for. |
-ssl_pwdfile
password-file |
Use the private key or PKCS12 password in the specified file to connect to the server. If both
-ssl_pwdfile and -ssl_password options are given, the password specified through the
-ssl_password option takes precedence.
|
-ssl_noverifyhost
|
Do not verify the server's certificate. Server certificate verification is enabled by default. |
-ssl_noverifyhostname
|
Do not verify hostname against the name on the certificate. |
-ssl_hostname
name
|
Name expected in the certificate sent by the host. |
-ssl_trace
|
Show loaded certificates and certificates sent by the host. |
-ssl_debug_trace
|
Show additional tracing, which is useful for debugging. |
-user
and
-password
, that information is not stored for later use. It is only used to connect to the server specified in the same command line. The user name and password entered on one command line are not reused with subsequent connect commands entered in the script file or interactively.
Examples
tibemsadmin -server "tcp://host:7222" tibemsadmin -server "tcp://host:7222" -user admin -password secret
Some options are needed when you choose to make a TLS connection. For more information on TLS connections, refer to TLS Protocol.