mirror of
https://github.com/clearlinux/telemetrics-client.git
synced 2026-06-16 02:35:52 +00:00
Alex Jaramillo
5cbd31cbf2
telemetrics-client installation starts when the package is installed, this change makes sure that to start telemetry the first time two steps are needed: 1- telemctl opt-in and 2- telemctl start Signed-off-by: Alex Jaramillo <alex.jch@gmail.com>
80 lines
2.1 KiB
Groff
80 lines
2.1 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH TELEMCTL 1 "" "" ""
|
|
.SH NAME
|
|
telemctl \- Telemetry service administration tool
|
|
.
|
|
.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
|
|
..
|
|
.SH SYNOPSIS
|
|
.sp
|
|
\fBtelemctl\fP
|
|
.sp
|
|
\fB/etc/telemetrics/opt\-in\fP
|
|
.SH DESCRIPTION
|
|
.sp
|
|
Control actions for telemetry services. The command can be used to start,
|
|
restart, or stop \fBtelemprobd\fP(1) and \fBtelempostd\fP(1), or to opt\-in or opt\-out of telemetry delivery of records to a central telemetry service.
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fBstart\(ga\(ga|\(ga\(gastop\(ga\(ga|\(ga\(garestart\fP:
|
|
Starts, stops or restarts all running telemetry services.
|
|
.IP \(bu 2
|
|
\fBopt\-in\fP:
|
|
Opts in to telemetry and the opt\-in file \fB/etc/telemetrics/opt\-in\fP
|
|
is created. Note: this is a one time required operation before
|
|
telemetry can be used the first time.
|
|
.IP \(bu 2
|
|
\fBopt\-out\fP:
|
|
Opts out of telemetry, and stops telemetry services. The opt\-in file
|
|
\fB/etc/telemetrics/opt\-in\fP is deleted.
|
|
.IP \(bu 2
|
|
\fBis\-active\fP:
|
|
Checks if telemetry client daemons are active (telemprobd and telempostd).
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH RETURN VALUES
|
|
.sp
|
|
0 on success. A non\-zero exit code indicates a failure occurred.
|
|
.SH SEE ALSO
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fBtelemprobd\fP(1)
|
|
.IP \(bu 2
|
|
\fI\%https://github.com/clearlinux/telemetrics\-client\fP
|
|
.IP \(bu 2
|
|
\fI\%https://clearlinux.org/documentation/\fP
|
|
.UNINDENT
|
|
.SH COPYRIGHT
|
|
(C) 2017 Intel Corporation, CC-BY-SA-3.0
|
|
.\" Generated by docutils manpage writer.
|
|
.
|