Module : system
Module overview
This module contains functions to retrieve information about the system and the current users of the system.
- It provides information such as environment variables, username, user home directory path, and the current working directory.
Samples
The sample given below uses the functions in the module to get the system-level information.
import ballerina/io;
import ballerina/system;
public function main() {
// Get environment variables.
io:println("Envirionment variable: " + system:getEnv("HTTP_PORT")); // E.g. “80”
// Get the user account name.
io:println("Username: " + system:getUsername()); // E.g. “john”
// Get the user home path.
io:println("User home: " + system:getUserHome()); // E.g. “/home/john”
// Execute an OS command as a subprocess
system:Process|system:Error proc = check system:exec("ls", {}, "/", "-la");
}
Process | This object contains information on a process being created from Ballerina.
This is returned from the |
exec | Executes an operating system command as a subprocess of the current process. |
getEnv | Returns the environment variable value associated with the provided name. |
getUserHome | Returns the current user's home directory path. |
getUsername | Returns the current user's name. |
uuid | Returns a random UUID string. |
INVALID_OPERATION_ERROR | |
PERMISSION_ERROR | |
FILE_SYSTEM_ERROR | |
FILE_NOT_FOUND_ERROR |
Error |
FileNotFoundError | |
FileSystemError | |
InvalidOperationError | |
PermissionError |