1PG_AUTOCTL(1) pg_auto_failover PG_AUTOCTL(1)
2
6 pg_autoctl - pg_autoctl
7 pg_autoctl - control a pg_auto_failover node
9
11 pg_autoctl provides the following commands:
12 + create Create a pg_auto_failover node, or formation
14 + drop Drop a pg_auto_failover node, or formation
15 + config Manages the pg_autoctl configuration
16 + show Show pg_auto_failover information
17 + enable Enable a feature on a formation
18 + disable Disable a feature on a formation
19 + get Get a pg_auto_failover node, or formation setting
20 + set Set a pg_auto_failover node, or formation setting
21 + perform Perform an action orchestrated by the monitor
22 run Run the pg_autoctl service (monitor or keeper)
23 watch Display a dashboard to watch monitor's events and state
24 stop signal the pg_autoctl service for it to stop
25 reload signal the pg_autoctl for it to reload its configuration
26 status Display the current status of the pg_autoctl service
27 help print help message
28 version print pg_autoctl version
29 pg_autoctl create
31 monitor Initialize a pg_auto_failover monitor node
32 postgres Initialize a pg_auto_failover standalone postgres node
33 formation Create a new formation on the pg_auto_failover monitor
34 pg_autoctl drop
36 monitor Drop the pg_auto_failover monitor
37 node Drop a node from the pg_auto_failover monitor
38 formation Drop a formation on the pg_auto_failover monitor
39 pg_autoctl config
41 check Check pg_autoctl configuration
42 get Get the value of a given pg_autoctl configuration variable
43 set Set the value of a given pg_autoctl configuration variable
44 pg_autoctl show
46 uri Show the postgres uri to use to connect to pg_auto_failover nodes
47 events Prints monitor's state of nodes in a given formation and group
48 state Prints monitor's state of nodes in a given formation and group
49 settings Print replication settings for a formation from the monitor
50 standby-names Prints synchronous_standby_names for a given group
51 file List pg_autoctl internal files (config, state, pid)
52 systemd Print systemd service file for this node
53 pg_autoctl enable
55 secondary Enable secondary nodes on a formation
56 maintenance Enable Postgres maintenance mode on this node
57 ssl Enable SSL configuration on this node
58 pg_autoctl disable
60 secondary Disable secondary nodes on a formation
61 maintenance Disable Postgres maintenance mode on this node
62 ssl Disable SSL configuration on this node
63 pg_autoctl get
65 + node get a node property from the pg_auto_failover monitor
66 + formation get a formation property from the pg_auto_failover monitor
67 pg_autoctl get node
69 replication-quorum get replication-quorum property from the monitor
70 candidate-priority get candidate property from the monitor
71 pg_autoctl get formation
73 settings get replication settings for a formation from the monitor
74 number-sync-standbys get number_sync_standbys for a formation from the monitor
75 pg_autoctl set
77 + node set a node property on the monitor
78 + formation set a formation property on the monitor
79 pg_autoctl set node
81 metadata set metadata on the monitor
82 replication-quorum set replication-quorum property on the monitor
83 candidate-priority set candidate property on the monitor
84 pg_autoctl set formation
86 number-sync-standbys set number-sync-standbys for a formation on the monitor
87 pg_autoctl perform
89 failover Perform a failover for given formation and group
90 switchover Perform a switchover for given formation and group
91 promotion Perform a failover that promotes a target node
92
94 The pg_autoctl tool is the client tool provided by pg_auto_failover to
95 create and manage Postgres nodes and the pg_auto_failover monitor node.
96 The command is built with many sub-commands that each have their own
97 manual page.
98
100 To get the full recursive list of supported commands, use:
101 pg_autoctl help
103
105 To grab the version of pg_autoctl that you're using, use:
106 pg_autoctl --version
108 pg_autoctl version
109 A typical output would be:
111 pg_autoctl version 1.4.2
113 pg_autoctl extension version 1.4
114 compiled with PostgreSQL 12.3 on x86_64-apple-darwin16.7.0, compiled by Apple LLVM version 8.1.0 (clang-802.0.42), 64-bit
115 compatible with Postgres 10, 11, 12, and 13
116 The version is also available as a JSON document when using the --json
118 option:
119 pg_autoctl --version --json
121 pg_autoctl version --json
122 A typical JSON output would be:
124 {
126 "pg_autoctl": "1.4.2",
127 "pgautofailover": "1.4",
128 "pg_major": "12",
129 "pg_version": "12.3",
130 "pg_version_str": "PostgreSQL 12.3 on x86_64-apple-darwin16.7.0, compiled by Apple LLVM version 8.1.0 (clang-802.0.42), 64-bit",
131 "pg_version_num": 120003
132 }
133 This is for version 1.4.2 of pg_auto_failover. This particular version
135 of the pg_autoctl client tool has been compiled using libpq for Post‐
136 greSQL 12.3 and is compatible with Postgres 10, 11, 12, and 13.
137
139 Microsoft
140
142 Copyright (c) Microsoft Corporation. All rights reserved.
1431.6 Jan 21, 2022 PG_AUTOCTL(1)