pmgcm.1-synopsis.adoc

   1 *pmgcm* `<COMMAND> [ARGS] [OPTIONS]`
   2
   3 *pmgcm create*
   4
   5 Create initial cluster config with current node as master.
   6
   7 *pmgcm delete* `<cid>`
   8
   9 Remove a node from the cluster.
  10
  11 `<cid>`: `<integer> (1 - N)` ::
  12
  13 Cluster Node ID.
  14
  15 *pmgcm help* `[OPTIONS]`
  16
  17 Get help about specified command.
  18
  19 `--extra-args` `<array>` ::
  20
  21 Shows help for a specific command
  22
  23 `--verbose` `<boolean>` ::
  24
  25 Verbose output format.
  26
  27 *pmgcm join* `<master_ip>` `[OPTIONS]`
  28
  29 Join a new node to an existing cluster.
  30
  31 `<master_ip>`: `<string>` ::
  32
  33 IP address.
  34
  35 `--fingerprint` `^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$` ::
  36
  37 SSL certificate fingerprint.
  38
  39 *pmgcm join-cmd*
  40
  41 Prints the command for joining an new node to the cluster. You need to
  42 execute the command on the new node.
  43
  44 *pmgcm join_cmd*
  45
  46 An alias for 'pmgcm join-cmd'.
  47
  48 *pmgcm promote*
  49
  50 Promote current node to become the new master.
  51
  52 *pmgcm status* `[OPTIONS]`
  53
  54 Cluster node status.
  55
  56 `--list_single_node` `<boolean>` ('default =' `0`)::
  57
  58 List local node if there is no cluster defined. Please note that RSA keys and fingerprint are not valid in that case.
  59
  60 *pmgcm sync* `[OPTIONS]`
  61
  62 Synchronize cluster configuration.
  63
  64 `--master_ip` `<string>` ::
  65
  66 Optional IP address for master node.
  67
  68 *pmgcm update-fingerprints*
  69
  70 Notify master to refresh all certificate fingerprints
  71
  72