package mirage
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=1155b5e9a585d3b44dfdd72777d94a7222b0f88a1737593bfb1f09954b6fb914
sha512=c59a0051f1037d7dd5bb81dfc8a265117b533383d0b285e0c2101b44d2ca8bcab40c432ce696a5b44397216e78ac59863f1ab6c5fb33bb338ca18d7ef359500f
doc/mirage.devices/Devices/Runtime_arg/index.html
Module Devices.Runtime_arg
Source
Command-line arguments for Mirage applications.
include module type of Functoria.Runtime_arg
The type command-line arguments where the type of the value is abstract.
Set
implements sets over t
elements.
Code Serialization
serialize ctx ppf k
outputs the Cmdliner
runes to parse command-line arguments represented by k
at runtime.
The type for command-line arguments that reads a value of type 'a
.
val create :
pos:(string * int * int * int) ->
?packages:Functoria.DSL.package list ->
string ->
'a arg
v k
is the k
with its type hidden.
Network Arguments
A network interface.
An option for dual stack to only use IPv4.
An option for dual stack to only use IPv6.
val resolver :
?group:string ->
?docs:string ->
?default:string list ->
unit ->
string list option Functoria.DSL.runtime_arg
The address of the DNS resolver to use. See $REFERENCE for format.
val dns_servers :
?group:string ->
?docs:string ->
string list option ->
string list option Functoria.DSL.runtime_arg
The addresses of the DNS servers to use.
val dns_timeout :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_arg
The timeout (in nanoseconds) for DNS resolution.
val dns_cache_size :
?group:string ->
?docs:string ->
int option ->
int option Functoria.DSL.runtime_arg
The cache size of the LRU cache used for DNS resolution.
val he_aaaa_timeout :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_arg
The timeout (in nanoseconds) for IPv6 resolution.
val he_connect_delay :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_arg
The delay (in nanoseconds) for establishing connections.
val he_connect_timeout :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_arg
The timeout (in nanoseconds) for establishing connections.
val he_resolve_timeout :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_arg
The timeout (in nanoseconds) for resolving hostnames.
val he_resolve_retries :
?group:string ->
?docs:string ->
int option ->
int option Functoria.DSL.runtime_arg
The number of resolution attempts before an error is returned.
val he_timer_interval :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_arg
The interval (in nanoseconds) when the timer is executed.
val ssh_key :
?group:string ->
?docs:string ->
string option ->
string option Functoria.DSL.runtime_arg
A SSH private key.
val ssh_password :
?group:string ->
?docs:string ->
string option ->
string option Functoria.DSL.runtime_arg
A SSH password.
val ssh_authenticator :
?group:string ->
?docs:string ->
string option ->
string option Functoria.DSL.runtime_arg
A SSH authenticator.
val tls_authenticator :
?group:string ->
?docs:string ->
string option ->
string option Functoria.DSL.runtime_arg
A TLS authenticator.
val http_headers :
?group:string ->
?docs:string ->
(string * string) list option ->
(string * string) list option Functoria.DSL.runtime_arg
HTTP headers.
val syslog :
?group:string ->
?docs:string ->
Ipaddr.t option ->
Ipaddr.t option Functoria.DSL.runtime_arg
The address to send syslog frames to.
val syslog_port :
?group:string ->
?docs:string ->
int option ->
int Functoria.DSL.runtime_arg
The port to send syslog frames to.
val syslog_truncate :
?group:string ->
?docs:string ->
int option ->
int option Functoria.DSL.runtime_arg
Truncate syslog frames to a specific byte count, docs
defaults to Mirage_runtime.s_log
.
val syslog_keyname :
?group:string ->
?docs:string ->
string option ->
string option Functoria.DSL.runtime_arg
TLS key used for syslog, docs
defaults to Mirage_runtime.s_log
.
val monitor :
?group:string ->
?docs:string ->
Ipaddr.t option ->
Ipaddr.t option Functoria.DSL.runtime_arg
The address to send monitor statistics to.
Logs
The type for log threshold. A log level of None
disables logging.
Startup delay
The initial delay, specified in seconds, before a unikernel starting up. Defaults to 0. Useful for tenders and environments that take some time to bring devices up.