3 namespace "urn:opendaylight:params:xml:ns:yang:controller:md:sal:cluster:admin";
4 prefix "cluster-admin";
7 "This module contains YANG RPC definitions for administering a cluster.";
9 revision "2015-10-13" {
10 description "Initial revision.";
13 rpc add-shard-replica {
17 description "The name of the shard for which to create a replica.";
21 description "Adds a replica of a shard to this node and joins it to an existing cluster. The shard must
22 already have a module configuration defined for it and there must already be a shard existing on
23 another node with a leader. This RPC first contacts peer member seed nodes searching for a shard.
24 When found, an AddServer message is sent to the shard leader and applied as described in the Raft
28 rpc remove-shard-replica {
32 description "The name of the shard for which to remove the replica.";
36 description "Removes an existing replica of a shard from this node via the RemoveServer mechanism as
37 described in the Raft paper.";
40 rpc add-replicas-for-all-shards {
41 description "Adds replicas on this node for all currently defined shards. This is equivalent to issuing
42 an add-shard-replica RPC for all shards.";
45 rpc remove-all-shard-replicas {
46 description "Removes replicas for all shards on this node. This is equivalent to issuing
47 a remove-shard-replica for all shards and essentially removes this node from a cluster.";
50 rpc convert-members-to-nonvoting-for-all-shards {
52 leaf-list member-names {
54 description "The names of the cluster members to convert.";
58 description "Converts the given cluster members to non-voting for all shards. The members will no
59 longer participate in leader elections and consensus but will be replicated. This is useful for
60 having a set of members serve as a backup cluster in case the primary voting cluster suffers
61 catastrophic failure. This RPC can be issued to any cluster member and will be forwarded
65 rpc convert-members-to-voting-for-all-shards {
67 leaf-list member-names {
69 description "The names of the cluster members to convert.";
73 description "Converts the given cluster members to voting for all shards. The members will
74 participate in leader elections and consensus.";
77 rpc backup-datastore {
81 description "The path and name of the file in which to store the backup.";
85 description "Creates a backup file of the datastore state";