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