## Attributes (5)

- check-for-live-server - Whether to check the cluster for another server using the same server ID when starting up.

  Type | BOOLEAN
  Default Value | true
  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 to check the cluster for another server using the same server ID when starting up.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : true,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- cluster-name - Name of the cluster used for replication. If it is undefined, the name of the first cluster connection defined in the configuration will be used.

  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 for replication. If it is undefined, the name of the first cluster connection defined in the configuration will be used.",
          "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
      }

- group-name - If set, backup servers will only pair with live servers with matching group-name.

  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" : "If set, backup servers will only pair with live servers with matching group-name.",
          "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
      }

- initial-replication-sync-timeout - How long to wait until the initiation replication is synchronized.

  Type | LONG
  Default Value | 30000
  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 to wait until the initiation replication is synchronized.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : 30000,
          "unit" : "MILLISECONDS",
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- synchronized-with-backup - The replication synchronization process with the backup server is complete.

  Type | BOOLEAN
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "The replication synchronization process with the backup server is complete.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "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
  --- | --- | --- | --- | --- | ---
  check-for-live-server | BOOLEAN | false | true | true | Whether to check the cluster for another server using the same server ID when starting up.
  cluster-name | STRING | false | true |  | Name of the cluster used for replication. If it is undefined, the name of the first cluster connection defined in the configuration will be used.
  group-name | STRING | false | true |  | If set, backup servers will only pair with live servers with matching group-name.
  initial-replication-sync-timeout | LONG | false | true | 30000 | How long to wait until the initiation replication is synchronized.

  Raw DMR model |
      {
          "operation-name" : "add",
          "description" : "Add an HA Policy to configure high availability for this ActiveMQ server.",
          "request-properties" : {
              "check-for-live-server" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Whether to check the cluster for another server using the same server ID when starting up.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : true,
                  "stability" : "default"
              },
              "cluster-name" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "Name of the cluster used for replication. If it is undefined, the name of the first cluster connection defined in the configuration will be used.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "group-name" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "If set, backup servers will only pair with live servers with matching group-name.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "initial-replication-sync-timeout" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "How long to wait until the initiation replication is synchronized.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : 30000,
                  "unit" : "MILLISECONDS",
                  "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-primary

      <feature spec="subsystem.messaging-activemq.server.ha-policy.replication-primary">
        <param name="server" value="{resource name}"/>
        <param name="check-for-live-server" value="{value}"/>
        <param name="cluster-name" value="{value}"/>
        <param name="group-name" value="{value}"/>
        <param name="initial-replication-sync-timeout" value="{value}"/>
      <feature/>