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