Management API Reference for ha-policy=replication-colocated

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).

Children (1)

configuration
- primary
- secondary

Attributes (6)

backup-port-offset - The offset to use for the Connectors and Acceptors when creating a new backup server.

Type	INT
Default Value	100
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 offset to use for the Connectors and Acceptors when creating a new backup server.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 100, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

backup-request-retries - How many times the live server will try to request a backup, -1 means for ever.

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" : "How many times the live server will try to request a backup, -1 means for ever.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : -1, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

backup-request-retry-interval - How long (in ms) to wait for retries between attempts to request a backup server.

Type	LONG
Default Value	5000
Unit	MILLISECONDS
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" : "LONG" }, "description" : "How long (in ms) to wait for retries between attempts to request a backup server.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 5000, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

excluded-connectors - The connectors that must not have their port offset.

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" : "The connectors that must not have their port offset.", "expressions-allowed" : false, "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 }`

max-backups - Whether or not this live server will accept backup requests from other live servers.

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" : "Whether or not this live server will accept backup requests from other live servers.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

request-backup - If true then the server will request a backup on another node.

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 true then the server will request a backup on another node.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "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
backup-port-offset	INT	false	true	100	The offset to use for the Connectors and Acceptors when creating a new backup server.
backup-request-retries	INT	false	true	-1	How many times the live server will try to request a backup, -1 means for ever.
backup-request-retry-interval	LONG	false	true	5000	How long (in ms) to wait for retries between attempts to request a backup server.
excluded-connectors	LIST	false	false		The connectors that must not have their port offset.
max-backups	INT	false	true	1	Whether or not this live server will accept backup requests from other live servers.
request-backup	BOOLEAN	false	true	false	If true then the server will request a backup on another node.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add an HA Policy to configure high availability for this ActiveMQ server.",
    "request-properties" : {
        "backup-port-offset" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The offset to use for the Connectors and Acceptors when creating a new backup server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 100,
            "stability" : "default"
        },
        "backup-request-retries" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "How many times the live server will try to request a backup, -1 means for ever.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "stability" : "default"
        },
        "backup-request-retry-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "How long (in ms) to wait for retries between attempts to request a backup server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 5000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "excluded-connectors" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The connectors that must not have their port offset.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "max-backups" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Whether or not this live server will accept backup requests from other live servers.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1,
            "stability" : "default"
        },
        "request-backup" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If true then the server will request a backup on another node.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "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.replication-colocated

        
<feature spec="subsystem.messaging-activemq.server.ha-policy.replication-colocated">
  <param name="server" value="{resource name}"/>
  <param name="backup-port-offset" value="{value}"/>
  <param name="backup-request-retries" value="{value}"/>
  <param name="backup-request-retry-interval" value="{value}"/>
  <param name="excluded-connectors" value="{value}"/>
  <param name="max-backups" value="{value}"/>
  <param name="request-backup" value="{value}"/>
<feature/>