WildFly 36 Model Reference

A named filesystem path.

Provided capabilities(1)

Name Dynamic Other provider points
org.wildfly.management.path true

none

Attributes (4)

  • name The name of the path. Cannot be one of the standard fixed paths provided by the system: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance. Note that the system provides other standard paths that can be overridden by declaring them in the configuration file. See the 'relative-to' attribute documentation for a complete list of standard paths.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-only
    Stability default
  • path The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path. If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows: If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • read-only True if added by the system, false if configured by user. If true, the path cannot be removed or modified.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type read-only
    Stability default
  • relative-to The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default

Operations (3)

  • add Add a new path.
    Request Parameter Type Required Expressions Allowed Default value Description
    path STRING true true The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path. If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows: If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.
    relative-to STRING false false The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances.
  • path-info Obtain the informations for a filesystem path.
    Request Parameter Type Required Expressions Allowed Default value Description
    unit STRING false false BYTES Disk space unit to display disk usage.

    Reply properties

    Filesystem path for which to obtain disk usage.
    type
    OBJECT
    Value Type
    {
    "used-space" => {
        "type" => DOUBLE,
        "description" => "The total size of the contents of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "unit" => "BYTES",
        "stability" => "default"
    },
    "creation-time" => {
        "type" => STRING,
        "description" => "The creation time of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L,
        "stability" => "default"
    },
    "last-modified" => {
        "type" => STRING,
        "description" => "The last modified time of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L,
        "stability" => "default"
    },
    "resolved-path" => {
        "type" => STRING,
        "description" => "The resolved filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L,
        "stability" => "default"
    },
    "available-space" => {
        "type" => DOUBLE,
        "description" => "The total size of available space for the partition containing a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "unit" => "BYTES",
        "stability" => "default"
    }
}
  • remove Remove a path