Management API Reference for ha-policy=live-only

A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, replication-colocated, shared-store-master, shared-store-slave, or shared-store-colocated).

Attributes (6)

scale-down - Configure whether this server send its messages to another live server in the scale-down cluster when it is shutdown cleanly.

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" : "Configure whether this server send its messages to another live server in the scale-down cluster when it is shutdown cleanly.", "attribute-group" : "scale-down", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

scale-down-cluster-name - Name of the cluster used to scale down.

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" : "Name of the cluster used to scale down.", "attribute-group" : "scale-down", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

scale-down-commit-interval - The batch size for committing the messages being moved on scale down.

Type	INT
Default Value	-1
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" : "INT" }, "description" : "The batch size for committing the messages being moved on scale down.", "attribute-group" : "scale-down", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : -1, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

scale-down-connectors - List of connectors used to form the scale-down cluster.

Type	LIST
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" : "LIST" }, "description" : "List of connectors used to form the scale-down cluster.", "attribute-group" : "scale-down", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["scale-down-discovery-group"], "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 }

scale-down-discovery-group - Name of the discovery group used to build the scale-down cluster

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" : "Name of the discovery group used to build the scale-down cluster", "attribute-group" : "scale-down", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["scale-down-connectors"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

scale-down-group-name - Name of the group used to scale down.

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" : "Name of the group used to scale down.", "attribute-group" : "scale-down", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - Add an HA Policy to configure high availability for this ActiveMQ server.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
scale-down	BOOLEAN	false	true		Configure whether this server send its messages to another live server in the scale-down cluster when it is shutdown cleanly.
scale-down-cluster-name	STRING	false	true		Name of the cluster used to scale down.
scale-down-commit-interval	INT	false	true	-1	The batch size for committing the messages being moved on scale down.
scale-down-connectors	LIST	false	false		List of connectors used to form the scale-down cluster.
scale-down-discovery-group	STRING	false	false		Name of the discovery group used to build the scale-down cluster
scale-down-group-name	STRING	false	true		Name of the group used to scale down.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add an HA Policy to configure high availability for this ActiveMQ server.",
    "request-properties" : {
        "scale-down" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Configure whether this server send its messages to another live server in the scale-down cluster when it is shutdown cleanly.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "scale-down-cluster-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the cluster used to scale down.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "scale-down-commit-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The batch size for committing the messages being moved on scale down.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "stability" : "default"
        },
        "scale-down-connectors" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "List of connectors used to form the scale-down cluster.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["scale-down-discovery-group"],
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "scale-down-discovery-group" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the discovery group used to build the scale-down cluster",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["scale-down-connectors"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "scale-down-group-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the group used to scale down.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove the HA Policy.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the HA Policy.",
    "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.

subsystem.messaging-activemq.server.ha-policy.live-only

        
<feature spec="subsystem.messaging-activemq.server.ha-policy.live-only">
  <param name="server" value="{resource name}"/>
  <param name="scale-down" value="{value}"/>
  <param name="scale-down-cluster-name" value="{value}"/>
  <param name="scale-down-commit-interval" value="{value}"/>
  <param name="scale-down-connectors" value="{value}"/>
  <param name="scale-down-discovery-group" value="{value}"/>
  <param name="scale-down-group-name" value="{value}"/>
<feature/>