epadmin-availabilityzone

< Previous		Next >

epadmin-availabilityzone

epadmin availabilityzone target — Manages StreamBase Runtime availability zones.

SYNOPSIS

epadmin [globalparameters] command availabilityzone [commandparameters]

DESCRIPTION

Use the availabilityzone target to display, rebalance, or restore an availabilityzone, which is a high availability feature of a Spotfire Streaming cluster. Configure availability zones in a node deployment configuration file; there is a default zone if not configured. See availabilityzone in the Architecture Guide.

The availabilityzone target has three commands:

The designation [sn|ad] in syntax examples is a reminder that this command requires either the global parameter ‑‑servicename or the ‑‑adminport and ‑‑hostname combination to identify the node or cluster of interest.

epadmin display availabilityzone

Displays basic information about the availabilityzone structure of a cluster. For example, for a cluster named sbuser with two nodes running:

epadmin --servicename=sbuser display availabilityzone

Returns:

[B.sbuser] Availability Zone = default-cluster-wide-availability-zone
[B.sbuser] Data Distribution Policy = default-dynamic-data-distribution-policy
[B.sbuser] Data Distribution Policy Type = Dynamic
[B.sbuser] Quorum State = Not Enabled
[B.sbuser] Re-balancing = false
[B.sbuser] Primary Nodes = A.sbuser
[B.sbuser] Backup Nodes = B.sbuser
[B.sbuser] Primary Node Pattern = [^.]+A.sbuser
[B.sbuser] Backup Node Pattern = [^.]+B.sbuser
[A.sbuser] Availability Zone = default-cluster-wide-availability-zone
[A.sbuser] Data Distribution Policy = default-dynamic-data-distribution-policy
[A.sbuser] Data Distribution Policy Type = Dynamic
[A.sbuser] Quorum State = Not Enabled
[A.sbuser] Re-balancing = false
[A.sbuser] Primary Nodes = B.sbuser
[A.sbuser] Backup Nodes = A.sbuser
[A.sbuser] Primary Node Pattern = [^.]+B.sbuser
[A.sbuser] Backup Node Pattern = [^.]+A.sbuser

Command Parameter	Description	Required
`name`	Specifies the name of a particular availabilityzone for large clusters with more than one.	No. The default is to display all availability zones.

epadmin rebalance availabilityzone

If the data distribution policy for a zone allows it, you can dynamically rebalance the distribution of data across an availabilityzone. You might need to do this if a node fails or is taken out of service, or in a multi-master situation (described in the Node Quorum section of the High Availability page of the Architecture Guide).

epadmin [sn|ad] rebalance availabilityzone
epadmin [sn|ad] rebalance availabilityzone --wait
epadmin [sn|ad] rebalance availabilityzone --name=cluster-availzone
epadmin [sn|ad] rebalance availabilityzone --threads=4 --chunksize=500

Command Parameter	Description	Required
`chunksize`	The number of objects to lock per transaction when sending data to remote nodes.	No. The default value is set in data distribution policy.
`name`	The name of an availability zone to rebalance	No. The default is to rebalance all availability zones.
`threads`	The number of threads to use when sending data to remote nodes.	No. The default value is set in data distribution policy.
`wait`	Boolean value controlling whether to wait for the rebalance to complete before returning. A value of `false` causes the command to return immediately with the rebalance completing asynchronously. A value of `true` causes the command to block until the rebalance completes.	No. The default value is `false`.

epadmin restore availabilityzone

Use this command to restore an availabilityzone after a multi-master event, as described in the Node Quorum section of the High Availability page of the Architecture Guide).

epadmin [sn|ad] restore availabilityzone
epadmin [sn|ad] restore availabilityzone --name=cluster-availzone
epadmin [sn|ad] restore availabilityzone --threads=4 --chunksize=500
epadmin [sn|ad] restore availabilityzone --action=replace --from=B.X

Command Parameter	Description	Required
`action`	One of `combine`, `replace`, or `merge`. `combine` copies all data from a remote node to the local node, and any data conflicts causes the restore to fail. `replace` removes all data on the local node and replaces it with data from the remote node. `merge` compares the data on the local and remote nodes and resolves any conflicts.	No. The default is `merge`.
`chunksize`	The number of objects to lock per transaction when sending data to remote nodes.	No. The default value is set in the data distribution policy.
`from`	Restore data from this node.	No. The default is determined using a cluster wide broadcast to locate an active node to restore from.
`name`	The name of the availability zone being restored.	No. The default is to restore all availability zones.
`threads`	The number of threads to use when sending data to remote nodes.	No. The default value is set in the data distribution policy.