mwctl deprecated
OX App Suite Middleware configuration utility
Synopsis
mwclt is a command-line utility for configuring and administering the OX App Suite Middleware.
It offers various subcommands for specific tasks.
Options:
--config string config file (default is $HOME/.mwctl.yaml)
-h, --help help for mwctl
-v, --verbose Verbose output
Sub Commands
debug
A pallet of debugging utilities for the App Suite Middleware.
Synopsis
mwctl debug [flags]
Options
-h, --help help for debug
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
-v, --verbose Verbose output
See Also
- mwctl - OX App Suite Middleware configuration utility
- debug heapdump - Creates a heap dump of the App Suite Middleware Java process.
- debug shell - Creates an interactive shell.
- debug threaddump - Creates a thread dump of the App Suite Middleware java process.
debug heapdump
Creates a heap dump of the App Suite Middleware Java process.
Synopsis
mwctl debug heapdump <POD> [flags]
This command creates a heap dump of an OX App Suite Middleware Java process.
"heapdump" targets the container where the Middleware Java process is running, and creates an ephemeral debug container in the same pod. This debug container is used to create the heap dump by running "jmap" before it is terminated afterwards.
By default, the heapdump is written to the "/tmp" directory on the Middleware container's filesystem.
In addition, "heapdump" also provides the option to download the heap dump to the machine where the command was invoked from.
Options
-c, --container string Name to use for the new ephemeral container. (default debug-n)
-d, --download Download the created heapdump from the pod.
-h, --help help for heapdump
--image string Defines the container image to use for the debug container.
Omit for using the default image. (default "registry.open-xchange.com/appsuite-core-internal/middleware-debug:main")
--imagePullPolicy string Defines the imagePullPolicy to use for the debug container's image. ("Always","Never" or "IfNotPresent") (default "Always" if ":latest" tag is specified, or "IfNotPresent" otherwise)
--kubeconfig string Path to the kubeconfig file
--kubecontext string The kubernetes context to use
-n, --namespace string The kubernetes namespace.
--no-compression Do not compress the heapdump.
-o, --outputpath string Specify the output path for the heapdump on the pod. (default "/tmp")
-p, --pid int The PID to take the heapdump for. (default -1)
--retries kubectl cp Set number of retries to complete a download operation of a heapdump; analogous to kubectl cp. (default 20)
-t, --target string Target container to get the heapdump from. (default "core-mw")
--timeout duration The timeout to wait for the debug container (default 1m0s)
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
-v, --verbose Verbose output
See Also
- debug - A pallet of debugging utilities for the App Suite Middleware.
debug shell
Creates an interactive shell.
Synopsis
mwctl debug shell <POD> [flags]
This command creates an interactive shell.
"shell" creates an ephemeral debug container in a pod while sharing the "process namespace" with a given container. This is essentially useful for acting as a "debug shell", having access to the target container's processes and filesystem (via procfs).
Options
-c, --container string Name to use for the new ephemeral container. (default debug-n)
-h, --help help for shell
--image string Defines the container image to use for the debug container.
Omit for using the default image. (default "registry.open-xchange.com/appsuite-core-internal/middleware-debug:main")
--imagePullPolicy string Defines the imagePullPolicy to use for the debug container's image. ("Always","Never" or "IfNotPresent") (default "Always" if ":latest" tag is specified, or "IfNotPresent" otherwise)
--kubeconfig string Path to the kubeconfig file
--kubecontext string The Kubernetes context to use
-n, --namespace string The Kubernetes namespace
-t, --target string Defines the target container to debug (default "core-mw")
--timeout duration The timeout to wait for the debug container (default 1m0s)
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
-v, --verbose Verbose output
See Also
- debug - A pallet of debugging utilities for the App Suite Middleware.
debug threaddump
Creates a thread dump of the App Suite Middleware java process.
Synopsis
mwctl debug threaddump <POD> [flags]
This command creates a thread dump of an OX App Suite Middleware Java process.
"threaddump" targets the container where the Middleware Java process in running in, and creates an, ephemeral, debug container in the same pod. This debug container is used to create the thread dump by running "jstack" before it is terminated afterwards.
By default, "threaddump" creates a "comprehensive" thread dump, consisting of multiple single dumps and top(1) outputs, which will be downloaded to the machine where the command was invoked from.
In addition, "threaddump" provides a "single" mode (--single), in which only one single thread dump is created from the given java process and written to STDOUT afterwards.
Options
-c, --container string Name to use for the new ephemeral container. (default debug-n)
-h, --help help for threaddump
--image string Defines the container image to use for the debug container.
Omit for using the default image. (default "registry.open-xchange.com/appsuite-core-internal/middleware-debug:main")
--imagePullPolicy string Defines the imagePullPolicy to use for the debug container's image. ("Always","Never" or "IfNotPresent") (default "Always" if ":latest" tag is specified, or "IfNotPresent" otherwise)
--kubeconfig string Path to the kubeconfig file
--kubecontext string The kubernetes context to use
-n, --namespace string The kubernetes namespace.
-p, --pid int The PID to take the thread dump for. (default -1)
-s, --single Creates just a single thread dump and prints it to STDOUT.
-t, --target string Target container to get the threaddump from. (default "core-mw")
--timeout duration The timeout to wait for the debug container (default 1m0s)
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
-v, --verbose Verbose output
See Also
- debug - A pallet of debugging utilities for the App Suite Middleware.
logconf
A pallet of logging configuration commands for the App Suite Middleware.
Synopsis
mwctl logconf [flags]
Options
-h, --help help for logconf
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
-v, --verbose Verbose output
See Also
- mwctl - OX App Suite Middleware configuration utility
- logconf category - Manage exception categories.
- logconf logger - Manage logger(s).
- logconf stacktrace - Manage stacktrace behaviour.
logconf category
Manage exception categories.
Synopsis
mwctl logconf category [flags]
Manage exception categories.
Exceptions which can occur on the server are classified in the following categories:
CAPACITY: The category for a 3rd party system when reporting capacity restrictions, e.g. quota. CONFIGURATION: The category for a configuration issue (e.g. missing required property). CONFLICT: The category for conflicting data. CONNECTIVITY: The category for a connectivity issue, e.g. broken/lost TCP connection. ERROR: The category for an error. PERMISSION_DENIED: The category for a permission-denied issue. SERVICE_DOWN: The category for a missing service or system, e.g. database. TRUNCATED: The category for truncated data. TRY_AGAIN: The category for a try-again issue. USER_INPUT: The category for an invalid user input. WARNING: The category for a warning displayed to the user.
Options
-h, --help help for category
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf - A pallet of logging configuration commands for the App Suite Middleware.
- logconf category suppressed - Manage suppressed exception categories.
logconf category suppressed
Manage suppressed exception categories.
Synopsis
mwctl logconf category suppressed [flags]
Manage suppressed exception categories.
This command allows configure suppress exception categories and prevent the server to log exceptions for errors belonging to a certain category.
Options
-h, --help help for suppressed
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf category - Manage exception categories.
- logconf category suppressed delete - Deletes all suppressed exception categories.
- logconf category suppressed get - Gets a list of suppressed exception categories.
- logconf category suppressed set - Sets a list of suppressed exception categories.
logconf category suppressed delete
Deletes all suppressed exception categories.
Synopsis
mwctl logconf category suppressed delete [flags]
Options
-h, --help help for delete
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf category suppressed - Manage suppressed exception categories.
logconf category suppressed get
Gets a list of suppressed exception categories.
Synopsis
mwctl logconf category suppressed get [flags]
Options
-h, --help help for get
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf category suppressed - Manage suppressed exception categories.
logconf category suppressed set
Sets a list of suppressed exception categories.
Synopsis
mwctl logconf category suppressed set CATEGORY [..CATEGORY] [flags]
Sets a list of suppressed exception categories.
Valid categories are: "CAPACITY" "CONFIGURATION" "CONFLICT" "CONNECTIVITY" "ERROR" "PERMISSION_DENIED" "SERVICE_DOWN" "TRUNCATED" "TRY_AGAIN" "USER_INPUT" "WARNING"
Options
-h, --help help for set
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf category suppressed - Manage suppressed exception categories.
logconf logger
Manage logger(s).
Synopsis
mwctl logconf logger [flags]
Options
-h, --help help for logger
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf - A pallet of logging configuration commands for the App Suite Middleware.
- logconf logger delete - Set the log level of a system logger to
null
, or deletes a session-, context-, or user-based logger. - logconf logger get - Gets logger(s).
- logconf logger set - Sets the level of specified logger(s).
logconf logger delete
Set the log level of a system logger to null
, or deletes a session-, context-, or user-based logger.
Synopsis
mwctl logconf logger delete [NAME [...NAME]] [flags]
Options
-c, --contextid uint The context ID
-h, --help help for delete
-s, --session string The session ID
-i, --userid uint The user ID
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf logger - Manage logger(s).
logconf logger get
Gets logger(s).
Synopsis
mwctl logconf logger get NAME [flags]
Options
-c, --contextid uint The context ID
-h, --help help for get
-s, --session string The session ID
-i, --userid uint The user ID
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf logger - Manage logger(s).
logconf logger set
Sets the level of specified logger(s).
Synopsis
mwctl logconf logger set NAME=VALUE [...NAME=VALUE] [flags]
Options
-c, --contextid uint The context ID
-h, --help help for set
-s, --session string The session ID
-i, --userid uint The user ID
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf logger - Manage logger(s).
logconf stacktrace
Manage stacktrace behaviour.
Synopsis
mwctl logconf stacktrace [flags]
Manage stacktrace behaviour.
This command allows to get and change the "includeStackTraceOnError" behaviour for a user.
If "enabled" for a particular user, HTTP API JSON error responses for this user will include a complete Java stack trace in case an exceptional error occurred on the server.
If "disabled" for a particular user, HTTP API error responses for this user will not include the stack trace.
However, the stack trace can still be included if configured on the server (see the "com.openexchange.ajax.response.includeStackTraceOnError" configuration property), or if explicitly requested by a client by sending the "includeStackTraceOnError" within a request.
Options
-h, --help help for stacktrace
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf - A pallet of logging configuration commands for the App Suite Middleware.
- logconf stacktrace disable - Disables stack trace responses for a certain user.
- logconf stacktrace enable - Enables stack trace responses for a certain user.
- logconf stacktrace get - Gets the current setting for a certain user.
logconf stacktrace disable
Disables stack trace responses for a certain user.
Synopsis
mwctl logconf stacktrace disable [flags]
Options
-c, --contextid uint The context ID
-h, --help help for disable
-i, --userid uint The user ID
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf stacktrace - Manage stacktrace behaviour.
logconf stacktrace enable
Enables stack trace responses for a certain user.
Synopsis
mwctl logconf stacktrace enable [flags]
Options
-c, --contextid uint The context ID
-h, --help help for enable
-i, --userid uint The user ID
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf stacktrace - Manage stacktrace behaviour.
logconf stacktrace get
Gets the current setting for a certain user.
Synopsis
mwctl logconf stacktrace get [flags]
Options
-c, --contextid uint The context ID
-h, --help help for get
-i, --userid uint The user ID
Options inherited from parent commands
--config string config file (default is $HOME/.mwctl.yaml)
--password string The password for authentication
-l, --selector string The label selector (default "app=core-mw")
-u, --urls string A comma separated list of URLs to connect to
--username string The username for authentication
-v, --verbose Verbose output
See Also
- logconf stacktrace - Manage stacktrace behaviour.
autogenerated with builddoc - 2-Sep-2024