Actions
Classes
ActionAlarm
| ActionAlarm(alarm, message: str)
|
HookAction
Issues an alarm. See .alarms options group.
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionCall
| ActionCall(
target: str,
honour_exit_status: bool = False,
arg_int: bool = False
)
|
HookAction
Call functions in the current process address space.
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionDirChange
| ActionDirChange(target_dir: str)
|
HookAction
Changes a directory.
Convenience action, same as call:chdir <directory>.
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionDirCreate
| ActionDirCreate(target_dir: str)
|
HookAction
Creates a directory with 0777.
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionExecute
| ActionExecute(command: str)
|
HookAction
Run the shell command.
Command run under /bin/sh.
If for some reason you do not want to use /bin/sh,
use binsh option,
Examples:
* cat /proc/self/mounts
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionExit
| ActionExit(status_code: int | None = None)
|
HookAction
Exits.
Convenience action, same as callint:exit [num].
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionFifoWrite
| ActionFifoWrite(target: str, text: str, wait: bool = False)
|
HookAction
Writes a string to the specified FIFO (see fifo_file from master_process params).
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionFileCreate
| ActionFileCreate(fpath: Strpath)
|
HookAction
Creates a directory with 0666.
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionFileWrite
| ActionFileWrite(
target: str,
text: str,
append: bool = False,
newline: bool = False
)
|
HookAction
Writes a string to the specified file.
If file doesn't exist it will be created.
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionMount
| ActionMount(
mountpoint: str,
fs: str | None = None,
src: str | None = None,
flags: Strlist = None
)
|
HookAction
Mount or unmount filesystems.
Examples:
* Mount: proc none /proc
* Unmount: /proc
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionPrintout
| ActionPrintout(text: str | None = None)
|
HookAction
Prints.
Convenience action, same as calling the uwsgi_log symbol.
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionSetHostName
| ActionSetHostName(name: str)
|
HookAction
Sets a host name.
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.
ActionUnlink
| ActionUnlink(target: str)
|
HookAction
Unlink the specified file.
alias
Alias to address this value.
args_joiner
Symbol to join arguments with.
name_separator
| .name_separator: str = ':'
|
Separator to add after name portion.
name_separator_strip
| .name_separator_strip: bool = False
|
Strip leading and trailing name separator from the result.
opt_key
| .opt_key: str | None = None
|
Allows swapping default option key with custom value.
plugin
| .plugin: bool | str = False
|
Indication this option group belongs to a plugin.