]>
Commit | Line | Data |
---|---|---|
d8742b0c DM |
1 | *pvecm* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
3 | *pvecm add* `<hostname>` `[OPTIONS]` | |
4 | ||
5 | Adds the current node to an existing cluster. | |
6 | ||
013dc89f | 7 | `<hostname>`: `<string>` :: |
d8742b0c | 8 | |
9b3e4991 | 9 | Hostname (or IP) of an existing cluster member. |
d8742b0c | 10 | |
27a7acb2 DM |
11 | `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: |
12 | ||
13 | Certificate SHA 256 fingerprint. | |
14 | ||
2489d6df | 15 | `--force` `<boolean>` :: |
d8742b0c | 16 | |
9b3e4991 | 17 | Do not throw error if node already exists. |
d8742b0c | 18 | |
2489d6df | 19 | `--nodeid` `<integer> (1 - N)` :: |
d8742b0c | 20 | |
9b3e4991 | 21 | Node id for this node. |
d8742b0c | 22 | |
27a7acb2 | 23 | `--ring0_addr` `<string>` ('default =' `Hostname of the node`):: |
d8742b0c | 24 | |
27a7acb2 | 25 | Hostname (or IP) of the corosync ring0 address of this node. |
d8742b0c | 26 | |
2489d6df | 27 | `--ring1_addr` `<string>` :: |
d8742b0c | 28 | |
27a7acb2 DM |
29 | Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster. |
30 | ||
31 | `--use_ssh` `<boolean>` :: | |
32 | ||
33 | Always use SSH to join, even if peer may do it over API. | |
d8742b0c | 34 | |
2489d6df | 35 | `--votes` `<integer> (0 - N)` :: |
d8742b0c | 36 | |
9b3e4991 | 37 | Number of votes for this node |
d8742b0c | 38 | |
d8742b0c DM |
39 | *pvecm addnode* `<node>` `[OPTIONS]` |
40 | ||
e2d681b3 | 41 | Adds a node to the cluster configuration. This call is for internal use. |
d8742b0c | 42 | |
013dc89f | 43 | `<node>`: `<string>` :: |
d8742b0c | 44 | |
9b3e4991 | 45 | The cluster node name. |
d8742b0c | 46 | |
2489d6df | 47 | `--force` `<boolean>` :: |
d8742b0c | 48 | |
9b3e4991 | 49 | Do not throw error if node already exists. |
d8742b0c | 50 | |
2489d6df | 51 | `--nodeid` `<integer> (1 - N)` :: |
d8742b0c | 52 | |
9b3e4991 | 53 | Node id for this node. |
d8742b0c | 54 | |
27a7acb2 | 55 | `--ring0_addr` `<string>` ('default =' `Hostname of the node`):: |
d8742b0c | 56 | |
27a7acb2 | 57 | Hostname (or IP) of the corosync ring0 address of this node. |
d8742b0c | 58 | |
2489d6df | 59 | `--ring1_addr` `<string>` :: |
d8742b0c | 60 | |
27a7acb2 | 61 | Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster. |
d8742b0c | 62 | |
2489d6df | 63 | `--votes` `<integer> (0 - N)` :: |
d8742b0c | 64 | |
9b3e4991 | 65 | Number of votes for this node |
d8742b0c | 66 | |
d8742b0c DM |
67 | *pvecm create* `<clustername>` `[OPTIONS]` |
68 | ||
69 | Generate new cluster configuration. | |
70 | ||
013dc89f | 71 | `<clustername>`: `<string>` :: |
d8742b0c | 72 | |
9b3e4991 | 73 | The name of the cluster. |
d8742b0c | 74 | |
2489d6df | 75 | `--bindnet0_addr` `<string>` :: |
d8742b0c | 76 | |
c2993fe5 | 77 | This specifies the network address the corosync ring 0 executive should bind to and defaults to the local IP address of the node. |
d8742b0c | 78 | |
2489d6df | 79 | `--bindnet1_addr` `<string>` :: |
d8742b0c | 80 | |
c2993fe5 | 81 | This specifies the network address the corosync ring 1 executive should bind to and is optional. |
d8742b0c | 82 | |
2489d6df | 83 | `--nodeid` `<integer> (1 - N)` :: |
d8742b0c | 84 | |
9b3e4991 | 85 | Node id for this node. |
d8742b0c | 86 | |
27a7acb2 | 87 | `--ring0_addr` `<string>` ('default =' `Hostname of the node`):: |
d8742b0c | 88 | |
27a7acb2 | 89 | Hostname (or IP) of the corosync ring0 address of this node. |
d8742b0c | 90 | |
2489d6df | 91 | `--ring1_addr` `<string>` :: |
d8742b0c | 92 | |
27a7acb2 | 93 | Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster. |
d8742b0c | 94 | |
2489d6df | 95 | `--votes` `<integer> (1 - N)` :: |
d8742b0c | 96 | |
9b3e4991 | 97 | Number of votes for this node. |
d8742b0c | 98 | |
d8742b0c DM |
99 | *pvecm delnode* `<node>` |
100 | ||
27a7acb2 | 101 | Removes a node from the cluster configuration. |
d8742b0c | 102 | |
013dc89f | 103 | `<node>`: `<string>` :: |
d8742b0c | 104 | |
27a7acb2 | 105 | The cluster node name. |
d8742b0c | 106 | |
d8742b0c DM |
107 | *pvecm expected* `<expected>` |
108 | ||
109 | Tells corosync a new value of expected votes. | |
110 | ||
013dc89f | 111 | `<expected>`: `<integer> (1 - N)` :: |
d8742b0c | 112 | |
9b3e4991 | 113 | Expected votes |
d8742b0c | 114 | |
35a75dd3 | 115 | *pvecm help* `[OPTIONS]` |
d8742b0c DM |
116 | |
117 | Get help about specified command. | |
118 | ||
35a75dd3 | 119 | `--extra-args` `<array>` :: |
d8742b0c | 120 | |
35a75dd3 | 121 | Shows help for a specific command |
d8742b0c | 122 | |
2489d6df | 123 | `--verbose` `<boolean>` :: |
d8742b0c | 124 | |
9b3e4991 | 125 | Verbose output format. |
d8742b0c | 126 | |
d8742b0c DM |
127 | *pvecm keygen* `<filename>` |
128 | ||
129 | Generate new cryptographic key for corosync. | |
130 | ||
013dc89f | 131 | `<filename>`: `<string>` :: |
d8742b0c | 132 | |
9b3e4991 | 133 | Output file name |
d8742b0c | 134 | |
5d9c884c | 135 | *pvecm mtunnel* `[<extra-args>]` `[OPTIONS]` |
de0983cb DM |
136 | |
137 | Used by VM/CT migration - do not use manually. | |
138 | ||
5d9c884c DM |
139 | `<extra-args>`: `<array>` :: |
140 | ||
141 | Extra arguments as array | |
142 | ||
2489d6df | 143 | `--get_migration_ip` `<boolean>` ('default =' `0`):: |
de0983cb DM |
144 | |
145 | return the migration IP, if configured | |
146 | ||
2489d6df | 147 | `--migration_network` `<string>` :: |
de0983cb DM |
148 | |
149 | the migration network used to detect the local migration IP | |
150 | ||
2489d6df | 151 | `--run-command` `<boolean>` :: |
5d9c884c DM |
152 | |
153 | Run a command with a tcp socket as standard input. The IP address and port are printed via this command's stdandard output first, each on a separate line. | |
154 | ||
d8742b0c DM |
155 | *pvecm nodes* |
156 | ||
157 | Displays the local view of the cluster nodes. | |
158 | ||
d8742b0c DM |
159 | *pvecm status* |
160 | ||
161 | Displays the local view of the cluster status. | |
162 | ||
d8742b0c DM |
163 | *pvecm updatecerts* `[OPTIONS]` |
164 | ||
165 | Update node certificates (and generate all needed files/directories). | |
166 | ||
2489d6df | 167 | `--force` `<boolean>` :: |
d8742b0c | 168 | |
9b3e4991 | 169 | Force generation of new SSL certifate. |
d8742b0c | 170 | |
2489d6df | 171 | `--silent` `<boolean>` :: |
d8742b0c | 172 | |
9b3e4991 | 173 | Ignore errors (i.e. when cluster has no quorum). |
d8742b0c DM |
174 | |
175 |