]> git.proxmox.com Git - pve-docs.git/blob - pvecm.1-synopsis.adoc
backup: clarify that CLI means FS-level and highlight retention-note
[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 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
12
13 Certificate SHA 256 fingerprint.
14
15 `--force` `<boolean>` ::
16
17 Do not throw error if node already exists.
18
19 `--link[n]` `[address=]<IP> [,priority=<integer>]` ::
20
21 Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
22
23 `--nodeid` `<integer> (1 - N)` ::
24
25 Node id for this node.
26
27 `--use_ssh` `<boolean>` ::
28
29 Always use SSH to join, even if peer may do it over API.
30
31 `--votes` `<integer> (0 - N)` ::
32
33 Number of votes for this node
34
35 *pvecm addnode* `<node>` `[OPTIONS]`
36
37 Adds a node to the cluster configuration. This call is for internal use.
38
39 `<node>`: `<string>` ::
40
41 The cluster node name.
42
43 `--apiversion` `<integer>` ::
44
45 The JOIN_API_VERSION of the new node.
46
47 `--force` `<boolean>` ::
48
49 Do not throw error if node already exists.
50
51 `--link[n]` `[address=]<IP> [,priority=<integer>]` ::
52
53 Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
54
55 `--new_node_ip` `<string>` ::
56
57 IP Address of node to add. Used as fallback if no links are given.
58
59 `--nodeid` `<integer> (1 - N)` ::
60
61 Node id for this node.
62
63 `--votes` `<integer> (0 - N)` ::
64
65 Number of votes for this node
66
67 *pvecm apiver*
68
69 Return the version of the cluster join API available on this node.
70
71 *pvecm create* `<clustername>` `[OPTIONS]`
72
73 Generate new cluster configuration. If no links given, default to local IP
74 address as link0.
75
76 `<clustername>`: `<string>` ::
77
78 The name of the cluster.
79
80 `--link[n]` `[address=]<IP> [,priority=<integer>]` ::
81
82 Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
83
84 `--nodeid` `<integer> (1 - N)` ::
85
86 Node id for this node.
87
88 `--votes` `<integer> (1 - N)` ::
89
90 Number of votes for this node.
91
92 *pvecm delnode* `<node>`
93
94 Removes a node from the cluster configuration.
95
96 `<node>`: `<string>` ::
97
98 The cluster node name.
99
100 *pvecm expected* `<expected>`
101
102 Tells corosync a new value of expected votes.
103
104 `<expected>`: `<integer> (1 - N)` ::
105
106 Expected votes
107
108 *pvecm help* `[OPTIONS]`
109
110 Get help about specified command.
111
112 `--extra-args` `<array>` ::
113
114 Shows help for a specific command
115
116 `--verbose` `<boolean>` ::
117
118 Verbose output format.
119
120 *pvecm keygen* `<filename>`
121
122 Generate new cryptographic key for corosync.
123
124 `<filename>`: `<string>` ::
125
126 Output file name
127
128 *pvecm mtunnel* `[<extra-args>]` `[OPTIONS]`
129
130 Used by VM/CT migration - do not use manually.
131
132 `<extra-args>`: `<array>` ::
133
134 Extra arguments as array
135
136 `--get_migration_ip` `<boolean>` ('default =' `0`)::
137
138 return the migration IP, if configured
139
140 `--migration_network` `<string>` ::
141
142 the migration network used to detect the local migration IP
143
144 `--run-command` `<boolean>` ::
145
146 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.
147
148 *pvecm nodes*
149
150 Displays the local view of the cluster nodes.
151
152 *pvecm qdevice remove*
153
154 Remove a configured QDevice
155
156 *pvecm qdevice setup* `<address>` `[OPTIONS]`
157
158 Setup the use of a QDevice
159
160 `<address>`: `<string>` ::
161
162 Specifies the network address of an external corosync QDevice
163
164 `--force` `<boolean>` ::
165
166 Do not throw error on possible dangerous operations.
167
168 `--network` `<string>` ::
169
170 The network which should be used to connect to the external qdevice
171
172 *pvecm status*
173
174 Displays the local view of the cluster status.
175
176 *pvecm updatecerts* `[OPTIONS]`
177
178 Update node certificates (and generate all needed files/directories).
179
180 `--force` `<boolean>` ::
181
182 Force generation of new SSL certificate.
183
184 `--silent` `<boolean>` ::
185
186 Ignore errors (i.e. when cluster has no quorum).
187
188