atsd (version 1.2.0)

save_connection: Write connection parameters to configuration file.

Description

The function writes the connection parameters into configuration file.

Usage

save_connection(url = NA, user = NA, password = NA, verify = NA,
  encryption = NA)

Arguments

url

Optional string argument. The url of ATSD with the port number.

user

Optional string argument. The user name.

password

Optional string argument. The user's password.

verify

Optional string argument -- "yes" or "no". verify = "yes" ensures validation of ATSD SSL certificate and verify = "no" suppresses the validation (applicable in the case of 'https' protocol).

encryption

Optional string argument. Cryptographic protocol used by ATSD https server. Possible values are: "default", "ssl2", "ssl3", and "tls1" (In most cases, use "ssl3" or "tls1".)

Details

If you call save_connection() without arguments, then the current values of the connection parameters (including NAs) will be written to the configuration file. If you provide some arguments, they will be written into the configuration file. If configuration file is absent it will be created in the atsd package folder.

See Also

For more information about the configuration file view the package vignette: browseVignettes(package = "atsd").

Examples

# NOT RUN {
# Write the current values of the connection parameters to the configuration file
save_connection()

# Write the user name and the password to the configuration file
save_connection(user = "user001", password = "123456")

# Write all parameters nedeed for https connection to the configuration file
save_connection(url = "https://my.company.com:8443", user = "user001", password = "123456", 
                verify = "no", encryption = "ssl3")
# }