Management API Reference for remote-destination-outbound-socket-binding

Provided Capabilities (1)

Attributes (5)

• fixed-source-port - Whether the port value should remain fixed even if numeric offsets are applied to the other outbound sockets in the socket group.

  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" : "Whether the port value should remain fixed even if numeric offsets are applied to the other outbound sockets in the socket group.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• host - The host name or the IP address of the remote destination to which this outbound socket will connect.

  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" : "The host name or the IP address of the remote destination to which this outbound socket will connect.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• port - The port number of the remote destination to which the outbound socket should connect.

  Type	INT
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Min	0
  Max	65535
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The port number of the remote destination to which the outbound socket should connect.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 0, "max" : 65535, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• source-interface - The name of the interface which will be used for the source address of the outbound socket.

  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 interface which will be used for the source address of the outbound socket.", "expressions-allowed" : true, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.network.interface", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

• source-port - The port number which will be used as the source port of the outbound socket.

  Type	INT
  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	0
  Max	65535
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The port number which will be used as the source port of the outbound socket.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min" : 0, "max" : 65535, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

• add - Adds a remote destination outbound socket binding to a socket binding group

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  fixed-source-port	BOOLEAN	false	true	false	Whether the port value should remain fixed even if numeric offsets are applied to the other outbound sockets in the socket group.
  host	STRING	true	true		The host name or the IP address of the remote destination to which this outbound socket will connect.
  port	INT	true	true		The port number of the remote destination to which the outbound socket should connect.
  source-interface	STRING	false	true		The name of the interface which will be used for the source address of the outbound socket.
  source-port	INT	false	true		The port number which will be used as the source port of the outbound socket.

  Raw DMR model

  { "operation-name" : "add", "description" : "Adds a remote destination outbound socket binding to a socket binding group", "request-properties" : { "fixed-source-port" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether the port value should remain fixed even if numeric offsets are applied to the other outbound sockets in the socket group.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "host" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The host name or the IP address of the remote destination to which this outbound socket will connect.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "port" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The port number of the remote destination to which the outbound socket should connect.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 0, "max" : 65535, "stability" : "default" }, "source-interface" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the interface which will be used for the source address of the outbound socket.", "expressions-allowed" : true, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.network.interface", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "source-port" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The port number which will be used as the source port of the outbound socket.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min" : 0, "max" : 65535, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Removes a remote destination outbound socket binding from a socket binding group

  Raw DMR model

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

          
  <feature spec="socket-binding-group.remote-destination-outbound-socket-binding">
    <param name="remote-destination-outbound-socket-binding" value="{resource name}"/>
    <param name="socket-binding-group" value="{resource name}"/>
    <param name="fixed-source-port" value="{value}"/>
    <param name="host" value="{value}"/>
    <param name="port" value="{value}"/>
    <param name="source-interface" value="{value}"/>
    <param name="source-port" value="{value}"/>
  <feature/>
          
        

  📋