external

external Structure: Description for executing an external process.

external structure
arguments array of string: optional
user string: length 1..1024
group string: optional, length 1..1024
root directory string: optional, length 1..1024
working directory string: optional, length 1..1024
additional environment array of environment variables: optional
redirect standard out string: optional, length 1..1024
redirect standard error string: optional, length 1..1024
process scheduling priority integer: optional
throttle disk reads boolean: optional
file creation mode mask integer: optional

Description

external describes all the detail needed to execute an external process. The structure provides fine grain control over how an external process should be configured.

Fields

type

Type of external being described.

arguments

Arguments to pass to the executable.

user

User to execute process as.

Short user name.

group

Group to execute process as.

Short group name. If no group is provided, the primary group of the user is used.

root directory

Set the executable's root directory (chroot).

working directory

Set the executable's working directory (chdir).

Relative paths are resolved with respect to any root directory.

additional environment

Set additional environment variables for the executable.

redirect standard out

Redirect the executable's standard output (stdout) to a file.

An absolute path to which the executable's output to appended. The file is created as needed. Removing the file while the executable is running will cause undefined behaviour.

redirect standard error

Redirect the executable's standard error (stderr) to a file.

An absolute path to which the executable's error to appended. The file is created as needed. Removing the file while the executable is running will cause undefined behaviour.

process scheduling priority

Set the executable's scheduling priority (nice).

throttle disk reads

Throttle the executable's disk reads.

file creation mode mask

Set the executable's file creation mode mask (umask).

Related

external executable external inline

Back to external.