Management API Reference for socket-binding-group

Contains a list of socket configurations.

Children (3)

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.management.socket-binding-manager	false	none

Attributes (3)

default-interface - Name of an interface that should be used as the interface for any sockets that do not explicitly declare one.

Type	STRING
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" : "Name of an interface that should be used as the interface for any sockets that do not explicitly declare one.", "expressions-allowed" : true, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.network.interface", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

name - The name of the socket binding group.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the socket binding group.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

port-offset - Increment to apply to the base port values defined in the socket bindings to derive the runtime values to use on this server.

Type	INT
Default Value	0
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	-65535
Max	65535
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Increment to apply to the base port values defined in the socket bindings to derive the runtime values to use on this server.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "min" : -65535, "max" : 65535, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - Adds a socket binding group.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
default-interface	STRING	true	true		Name of an interface that should be used as the interface for any sockets that do not explicitly declare one.
port-offset	INT	false	true	0	Increment to apply to the base port values defined in the socket bindings to derive the runtime values to use on this server.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a socket binding group.",
    "request-properties" : {
        "default-interface" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of an interface that should be used as the interface for any sockets that do not explicitly declare one.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.network.interface",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "port-offset" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Increment to apply to the base port values defined in the socket bindings to derive the runtime values to use on this server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "min" : -65535,
            "max" : 65535,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a socket binding group.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a socket binding group.",
    "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.

socket-binding-group

        
<feature spec="socket-binding-group">
  <param name="socket-binding-group" value="{resource name}"/>
  <param name="default-interface" value="{value}"/>
  <param name="port-offset" value="{value}"/>
<feature/>