X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvecm.1-synopsis.adoc;h=3b58a9d87bfccf98a68ad20bbdd9b3fd1cc918f7;hp=46659749e212ead1a7569934316375559f3ae4da;hb=856993e4166495537f42e0b9c3a51c966227feab;hpb=2c0dde619dc203c365be8b15284530099d159682 diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc index 4665974..3b58a9d 100644 --- a/pvecm.1-synopsis.adoc +++ b/pvecm.1-synopsis.adoc @@ -4,170 +4,192 @@ Adds the current node to an existing cluster. -`` `string` :: +``: `` :: Hostname (or IP) of an existing cluster member. -`-force` `boolean` :: +`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: + +Certificate SHA 256 fingerprint. + +`--force` `` :: Do not throw error if node already exists. -`-nodeid` `integer (1 - N)` :: +`--nodeid` ` (1 - N)` :: Node id for this node. -`-ring0_addr` `string` :: +`--ring0_addr` `` ('default =' `Hostname of the node`):: -Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname. +Hostname (or IP) of the corosync ring0 address of this node. -`-ring1_addr` `string` :: +`--ring1_addr` `` :: -Hostname (or IP) of the corosync ring1 address, this needs an valid configured ring 1 interface in the cluster. +Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster. -`-votes` `integer (0 - N)` :: +`--use_ssh` `` :: -Number of votes for this node +Always use SSH to join, even if peer may do it over API. +`--votes` ` (0 - N)` :: +Number of votes for this node *pvecm addnode* `` `[OPTIONS]` -Adds a node to the cluster configuration. +Adds a node to the cluster configuration. This call is for internal use. -`` `string` :: +``: `` :: The cluster node name. -`-force` `boolean` :: +`--force` `` :: Do not throw error if node already exists. -`-nodeid` `integer (1 - N)` :: +`--nodeid` ` (1 - N)` :: Node id for this node. -`-ring0_addr` `string` :: +`--ring0_addr` `` ('default =' `Hostname of the node`):: -Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname. +Hostname (or IP) of the corosync ring0 address of this node. -`-ring1_addr` `string` :: +`--ring1_addr` `` :: -Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr. +Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster. -`-votes` `integer (0 - N)` :: +`--votes` ` (0 - N)` :: Number of votes for this node - - *pvecm create* `` `[OPTIONS]` Generate new cluster configuration. -`` `string` :: +``: `` :: The name of the cluster. -`-bindnet0_addr` `string` :: +`--bindnet0_addr` `` :: This specifies the network address the corosync ring 0 executive should bind to and defaults to the local IP address of the node. -`-bindnet1_addr` `string` :: +`--bindnet1_addr` `` :: This specifies the network address the corosync ring 1 executive should bind to and is optional. -`-nodeid` `integer (1 - N)` :: +`--nodeid` ` (1 - N)` :: Node id for this node. -`-ring0_addr` `string` :: - -Hostname (or IP) of the corosync ring0 address of this node. Defaults to the hostname of the node. - -`-ring1_addr` `string` :: +`--ring0_addr` `` ('default =' `Hostname of the node`):: -Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr. +Hostname (or IP) of the corosync ring0 address of this node. -`-rrp_mode` `(active | none | passive)` (default=`none`):: +`--ring1_addr` `` :: -This specifies the mode of redundant ring, which may be none, active or passive. Using multiple interfaces only allows 'active' or 'passive'. +Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster. -`-votes` `integer (1 - N)` :: +`--votes` ` (1 - N)` :: Number of votes for this node. - - *pvecm delnode* `` -Removes a node to the cluster configuration. - -`` `string` :: - -Hostname or IP of the corosync ring0 address of this node. +Removes a node from the cluster configuration. +``: `` :: +The cluster node name. *pvecm expected* `` Tells corosync a new value of expected votes. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: Expected votes +*pvecm help* `[OPTIONS]` +Get help about specified command. +`--extra-args` `` :: -*pvecm help* `[]` `[OPTIONS]` +Shows help for a specific command -Get help about specified command. +`--verbose` `` :: -`` `string` :: +Verbose output format. -Command name +*pvecm keygen* `` -`-verbose` `boolean` :: +Generate new cryptographic key for corosync. -Verbose output format. +``: `` :: +Output file name +*pvecm mtunnel* `[]` `[OPTIONS]` +Used by VM/CT migration - do not use manually. -*pvecm keygen* `` +``: `` :: -Generate new cryptographic key for corosync. +Extra arguments as array -`` `string` :: +`--get_migration_ip` `` ('default =' `0`):: -Output file name +return the migration IP, if configured + +`--migration_network` `` :: +the migration network used to detect the local migration IP +`--run-command` `` :: + +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. *pvecm nodes* Displays the local view of the cluster nodes. +*pvecm qdevice remove* +Remove a configured QDevice -*pvecm status* +*pvecm qdevice setup* `
` `[OPTIONS]` -Displays the local view of the cluster status. +Setup the use of a QDevice + +`
`: `` :: +Specifies the network address of an external corosync QDevice +`--force` `` :: + +Do not throw error on possible dangerous operations. + +`--network` `` :: + +The network which should be used to connect to the external qdevice + +*pvecm status* + +Displays the local view of the cluster status. *pvecm updatecerts* `[OPTIONS]` Update node certificates (and generate all needed files/directories). -`-force` `boolean` :: +`--force` `` :: Force generation of new SSL certifate. -`-silent` `boolean` :: +`--silent` `` :: Ignore errors (i.e. when cluster has no quorum). - -