Management API Reference for host

An Undertow host

Stability Level: default

Children (3)

Provided Capabilities (3)

Name	Dynamic	Other provider points
org.wildfly.undertow.host	true	none
org.wildfly.web.common.host	true	none
org.wildfly.undertow.default-server-host	true	none

Attributes (5)

alias - Aliases for the host

Type	LIST
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Aliases for the host", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

default-response-code - If set, this will be response code sent back in case requested context does not exist on server.

Type	INT
Default Value	404
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	400
Max	599
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "If set, this will be response code sent back in case requested context does not exist on server.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 404, "min" : 400, "max" : 599, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

default-web-module - Default web module

Type	STRING
Default Value	ROOT.war
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Default web module", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "ROOT.war", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

disable-console-redirect - if set to true, /console redirect wont be enabled for this host, default is false

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "if set to true, /console redirect wont be enabled for this host, default is false", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

queue-requests-on-start - If requests should be queued on start for this host. If this is set to false the default response code will be returned instead.

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If requests should be queued on start for this host. If this is set to false the default response code will be returned instead.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - Adds a new host

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
alias	LIST	false	true		Aliases for the host
default-response-code	INT	false	true	404	If set, this will be response code sent back in case requested context does not exist on server.
default-web-module	STRING	false	false	ROOT.war	Default web module
disable-console-redirect	BOOLEAN	false	true	false	if set to true, /console redirect wont be enabled for this host, default is false
queue-requests-on-start	BOOLEAN	false	true		If requests should be queued on start for this host. If this is set to false the default response code will be returned instead.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a new host",
    "request-properties" : {
        "alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "Aliases for the host",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "default-response-code" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "If set, this will be response code sent back in case requested context does not exist on server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 404,
            "min" : 400,
            "max" : 599,
            "stability" : "default"
        },
        "default-web-module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Default web module",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "ROOT.war",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "disable-console-redirect" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "if set to true, /console redirect wont be enabled for this host, default is false",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "queue-requests-on-start" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If requests should be queued on start for this host. If this is set to false the default response code will be returned instead.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a host

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a host",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.undertow.server.host

        
<feature spec="subsystem.undertow.server.host">
  <param name="host" value="{resource name}"/>
  <param name="server" value="{resource name}"/>
  <param name="alias" value="{value}"/>
  <param name="default-response-code" value="{value}"/>
  <param name="default-web-module" value="{value}"/>
  <param name="disable-console-redirect" value="{value}"/>
  <param name="queue-requests-on-start" value="{value}"/>
<feature/>