Management API Reference for backup

A backup site to which to replicate this cache.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.clustering.infinispan.cache-configuration.backup	true	/subsystem=infinispan/cache-container=/distributed-cache=/component=backups/backup=* /subsystem=infinispan/cache-container=/replicated-cache=/component=backups/backup=*

Attributes (6)

after-failures - Indicates the number of failures after which this backup site should go offline.

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?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Indicates the number of failures after which this backup site should go offline.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

enabled - Indicates whether or not this backup site is enabled.

Deprecated Since 16.0.0

Deprecated. Ignored if specified.

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?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether or not this backup site is enabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "deprecated" : { "since" : "16.0.0", "reason" : "Deprecated. Ignored if specified." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

failure-policy - The policy to follow when connectivity to the backup site fails.

Type	STRING
Default Value	WARN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Allowed Values	CUSTOM IGNORE WARN FAIL
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The policy to follow when connectivity to the backup site fails.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "WARN", "allowed" : [ "IGNORE", "WARN", "FAIL", "CUSTOM" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

min-wait - Indicates the minimum time (in milliseconds) to wait after the max number of failures is reached, after which this backup site should go offline.

Type	LONG
Default Value	0
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?	resource-services
Min	0
Max	9223372036854775807
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Indicates the minimum time (in milliseconds) to wait after the max number of failures is reached, after which this backup site should go offline.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

strategy - The backup strategy for this cache

Type	STRING
Default Value	ASYNC
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Allowed Values	ASYNC SYNC
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The backup strategy for this cache", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "ASYNC", "allowed" : [ "SYNC", "ASYNC" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

timeout - The timeout for replicating to the backup site.

Type	LONG
Default Value	10000
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?	resource-services
Min	0
Max	9223372036854775807
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The timeout for replicating to the backup site.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10000, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

Operations (5)

add - Adds a backup site to this cache.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
after-failures	INT	false	true	1	Indicates the number of failures after which this backup site should go offline.
enabled	BOOLEAN	false	true	true	Indicates whether or not this backup site is enabled.
failure-policy	STRING	false	true	WARN	The policy to follow when connectivity to the backup site fails.
min-wait	LONG	false	true	0	Indicates the minimum time (in milliseconds) to wait after the max number of failures is reached, after which this backup site should go offline.
strategy	STRING	false	true	ASYNC	The backup strategy for this cache
timeout	LONG	false	true	10000	The timeout for replicating to the backup site.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a backup site to this cache.",
    "request-properties" : {
        "after-failures" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Indicates the number of failures after which this backup site should go offline.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1,
            "stability" : "default"
        },
        "enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether or not this backup site is enabled.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default",
            "deprecated" : {
                "since" : "16.0.0",
                "reason" : "Deprecated. Ignored if specified."
            }
        },
        "failure-policy" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The policy to follow when connectivity to the backup site fails.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "WARN",
            "allowed" : [
                "IGNORE",
                "WARN",
                "FAIL",
                "CUSTOM"
            ],
            "stability" : "default"
        },
        "min-wait" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Indicates the minimum time (in milliseconds) to wait after the max number of failures is reached, after which this backup site should go offline.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        },
        "strategy" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The backup strategy for this cache",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "ASYNC",
            "allowed" : [
                "SYNC",
                "ASYNC"
            ],
            "stability" : "default"
        },
        "timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The timeout for replicating to the backup site.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10000,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

bring-site-online - Re-enables a previously disabled backup site.

Reply properties

Type: STRING

Raw DMR model


{
    "operation-name" : "bring-site-online",
    "description" : "Re-enables a previously disabled backup site.",
    "request-properties" : {},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "STRING"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

remove - Removes a backup site from this cache.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a backup site from this cache.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

site-status - Displays the current status of the backup site.

Reply properties

Type: STRING

Raw DMR model


{
    "operation-name" : "site-status",
    "description" : "Displays the current status of the backup site.",
    "request-properties" : {},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "STRING"
    }},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

take-site-offline - Disables backup to a remote site.

Reply properties

Type: STRING

Raw DMR model


{
    "operation-name" : "take-site-offline",
    "description" : "Disables backup to a remote site.",
    "request-properties" : {},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "STRING"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.infinispan.cache-container.scattered-cache.component.backups.backup

        
<feature spec="subsystem.infinispan.cache-container.scattered-cache.component.backups.backup">
  <param name="backup" value="{resource name}"/>
  <param name="cache-container" value="{resource name}"/>
  <param name="scattered-cache" value="{resource name}"/>
  <param name="after-failures" value="{value}"/>
  <param name="enabled" value="{value}"/>
  <param name="failure-policy" value="{value}"/>
  <param name="min-wait" value="{value}"/>
  <param name="strategy" value="{value}"/>
  <param name="timeout" value="{value}"/>
<feature/>