Management API Reference for management-interface=native-interface

Configuration of the server's native management interface

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.management.native-interface	false	none

Attributes (5)

sasl-authentication-factory - The SASL authentication policy to use to secure this interface.

Type	STRING
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" : "The SASL authentication policy to use to secure this interface.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.sasl-authentication-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"authentication-factory-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

sasl-protocol - The name of the protocol to be passed to the SASL mechanisms used for authentication.

Deprecated Since 5.0.0

Only for use with the legacy security realms.

Type	STRING
Default Value	remote
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" : "STRING" }, "description" : "The name of the protocol to be passed to the SASL mechanisms used for authentication.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "remote", "requires" : ["security-realm"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "5.0.0", "reason" : "Only for use with the legacy security realms." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

server-name - The name of the server used in the initial Remoting exchange and within the SASL mechanisms.

Deprecated Since 5.0.0

Only for use with the legacy security realms.

Type	STRING
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" : "STRING" }, "description" : "The name of the server used in the initial Remoting exchange and within the SASL mechanisms.", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["security-realm"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "5.0.0", "reason" : "Only for use with the legacy security realms." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

socket-binding - The name of the socket binding configuration to use for the native management interface's socket.

Type	STRING
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" : "The name of the socket binding configuration to use for the native management interface's socket.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.network.socket-binding", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"socket-config" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

ssl-context - Reference to the SSLContext to use for this management interface.

Type	STRING
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" : "Reference to the SSLContext to use for this management interface.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.ssl-context", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"ssl-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Operations (2)

add - Adds the server's native management interface

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
sasl-authentication-factory	STRING	false	false		The SASL authentication policy to use to secure this interface.
sasl-protocol	STRING	false	true	remote	The name of the protocol to be passed to the SASL mechanisms used for authentication.
server-name	STRING	false	true		The name of the server used in the initial Remoting exchange and within the SASL mechanisms.
socket-binding	STRING	true	false		The name of the socket binding configuration to use for the native management interface's socket.
ssl-context	STRING	false	false		Reference to the SSLContext to use for this management interface.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds the server's native management interface",
    "request-properties" : {
        "sasl-authentication-factory" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The SASL authentication policy to use to secure this interface.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.sasl-authentication-factory",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "sasl-protocol" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the protocol to be passed to the SASL mechanisms used for authentication.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "remote",
            "requires" : ["security-realm"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "5.0.0",
                "reason" : "Only for use with the legacy security realms."
            }
        },
        "server-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the server used in the initial Remoting exchange and within the SASL mechanisms.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "requires" : ["security-realm"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "5.0.0",
                "reason" : "Only for use with the legacy security realms."
            }
        },
        "socket-binding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the socket binding configuration to use for the native management interface's socket.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.network.socket-binding",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "ssl-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the SSLContext to use for this management interface.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.ssl-context",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes the server's native management interface

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the server's native management interface",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

Galleon Features

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

core-service.management.management-interface.native-interface

        
<feature spec="core-service.management.management-interface.native-interface">
  <param name="sasl-authentication-factory" value="{value}"/>
  <param name="sasl-protocol" value="{value}"/>
  <param name="server-name" value="{value}"/>
  <param name="socket-binding" value="{value}"/>
  <param name="ssl-context" value="{value}"/>
<feature/>