.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "PG_AUTOCTL STATUS" "1" "Nov 25, 2023" "2.1" "pg_auto_failover"
.SH NAME
pg_autoctl status \- pg_autoctl status
.sp
pg_autoctl status \- Display the current status of the pg_autoctl service
.SH SYNOPSIS
.sp
This commands outputs the current process status for the \fBpg_autoctl\fP
service running for the given \fB\-\-pgdata\fP location.
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: pg_autoctl status  [ \-\-pgdata ] [ \-\-json ]

\-\-pgdata      path to data directory
\-\-json        output data in the JSON format
.EE
.UNINDENT
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.B  \-\-pgdata
Location of the Postgres node being managed locally. Defaults to the
environment variable \fBPGDATA\fP\&.
.TP
.B  \-\-json
Output a JSON formatted data instead of a table formatted list.
.UNINDENT
.SH ENVIRONMENT
.sp
PGDATA
.INDENT 0.0
.INDENT 3.5
Postgres directory location. Can be used instead of the \fB\-\-pgdata\fP
option.
.UNINDENT
.UNINDENT
.sp
PG_AUTOCTL_MONITOR
.INDENT 0.0
.INDENT 3.5
Postgres URI to connect to the monitor node.
.UNINDENT
.UNINDENT
.sp
XDG_CONFIG_HOME
.INDENT 0.0
.INDENT 3.5
The pg_autoctl command stores its configuration files in the standard
place XDG_CONFIG_HOME. See the \fI\%XDG Base Directory Specification\fP\&.
.UNINDENT
.UNINDENT
.sp
XDG_DATA_HOME
.INDENT 0.0
.INDENT 3.5
The pg_autoctl command stores its internal states files in the standard
place XDG_DATA_HOME, which defaults to \fB~/.local/share\fP\&. See the \fI\%XDG
Base Directory Specification\fP\&.
.UNINDENT
.UNINDENT
.SH EXAMPLE
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ pg_autoctl status \-\-pgdata node1
11:26:30 27248 INFO  pg_autoctl is running with pid 26618
11:26:30 27248 INFO  Postgres is serving PGDATA \(dq/Users/dim/dev/MS/pg_auto_failover/tmux/node1\(dq on port 5501 with pid 26725

$ pg_autoctl status \-\-pgdata node1 \-\-json
11:26:37 27385 INFO  pg_autoctl is running with pid 26618
11:26:37 27385 INFO  Postgres is serving PGDATA \(dq/Users/dim/dev/MS/pg_auto_failover/tmux/node1\(dq on port 5501 with pid 26725
{
    \(dqpostgres\(dq: {
        \(dqpgdata\(dq: \(dq\e/Users\e/dim\e/dev\e/MS\e/pg_auto_failover\e/tmux\e/node1\(dq,
        \(dqpg_ctl\(dq: \(dq\e/Applications\e/Postgres.app\e/Contents\e/Versions\e/12\e/bin\e/pg_ctl\(dq,
        \(dqversion\(dq: \(dq12.3\(dq,
        \(dqhost\(dq: \(dq\e/tmp\(dq,
        \(dqport\(dq: 5501,
        \(dqproxyport\(dq: 0,
        \(dqpid\(dq: 26725,
        \(dqin_recovery\(dq: false,
        \(dqcontrol\(dq: {
            \(dqversion\(dq: 0,
            \(dqcatalog_version\(dq: 0,
            \(dqsystem_identifier\(dq: \(dq0\(dq
        },
        \(dqpostmaster\(dq: {
            \(dqstatus\(dq: \(dqready\(dq
        }
    },
    \(dqpg_autoctl\(dq: {
        \(dqpid\(dq: 26618,
        \(dqstatus\(dq: \(dqrunning\(dq,
        \(dqpgdata\(dq: \(dq\e/Users\e/dim\e/dev\e/MS\e/pg_auto_failover\e/tmux\e/node1\(dq,
        \(dqversion\(dq: \(dq1.5.0\(dq,
        \(dqsemId\(dq: 196609,
        \(dqservices\(dq: [
            {
                \(dqname\(dq: \(dqpostgres\(dq,
                \(dqpid\(dq: 26625,
                \(dqstatus\(dq: \(dqrunning\(dq,
                \(dqversion\(dq: \(dq1.5.0\(dq,
                \(dqpgautofailover\(dq: \(dq1.5.0.1\(dq
            },
            {
                \(dqname\(dq: \(dqnode\-active\(dq,
                \(dqpid\(dq: 26626,
                \(dqstatus\(dq: \(dqrunning\(dq,
                \(dqversion\(dq: \(dq1.5.0\(dq,
                \(dqpgautofailover\(dq: \(dq1.5.0.1\(dq
            }
        ]
    }
}
.EE
.UNINDENT
.UNINDENT
.SH AUTHOR
Microsoft
.SH COPYRIGHT
Copyright (c) Microsoft Corporation. All rights reserved.
.\" Generated by docutils manpage writer.
.