mirror of
https://git.proxmox.com/git/systemd
synced 2025-06-04 13:31:52 +00:00
81 lines
2.8 KiB
Groff
81 lines
2.8 KiB
Groff
'\" t
|
|
.TH "SD_ID128_GET_MACHINE" "3" "" "systemd 219" "sd_id128_get_machine"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
sd_id128_get_machine, sd_id128_get_boot \- Retrieve 128\-bit IDs
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.ft B
|
|
.nf
|
|
#include <systemd/sd\-id128\&.h>
|
|
.fi
|
|
.ft
|
|
.HP \w'int\ sd_id128_get_machine('u
|
|
.BI "int sd_id128_get_machine(sd_id128_t\ *" "ret" ");"
|
|
.HP \w'int\ sd_id128_get_boot('u
|
|
.BI "int sd_id128_get_boot(sd_id128_t\ *" "ret" ");"
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\fBsd_id128_get_machine()\fR
|
|
returns the machine ID of the executing host\&. This reads and parses the
|
|
\fBmachine-id\fR(5)
|
|
file\&. This function caches the machine ID internally to make retrieving the machine ID a cheap operation\&.
|
|
.PP
|
|
\fBsd_id128_get_boot()\fR
|
|
returns the boot ID of the executing kernel\&. This reads and parses the
|
|
/proc/sys/kernel/random/boot_id
|
|
file exposed by the kernel\&. It is randomly generated early at boot and is unique for every running kernel instance\&. See
|
|
\fBrandom\fR(4)
|
|
for more information\&. This function also internally caches the returned ID to make this call a cheap operation\&.
|
|
.PP
|
|
Note that
|
|
\fBsd_id128_get_boot()\fR
|
|
always returns a UUID v4 compatible ID\&.
|
|
\fBsd_id128_get_machine()\fR
|
|
will also return a UUID v4\-compatible ID on new installations but might not on older\&. It is possible to convert the machine ID into a UUID v4\-compatible one\&. For more information, see
|
|
\fBmachine-id\fR(5)\&.
|
|
.PP
|
|
For more information about the
|
|
"sd_id128_t"
|
|
type see
|
|
\fBsd-id128\fR(3)\&.
|
|
.SH "RETURN VALUE"
|
|
.PP
|
|
The two calls return 0 on success (in which case
|
|
\fIret\fR
|
|
is filled in), or a negative errno\-style error code\&.
|
|
.SH "NOTES"
|
|
.PP
|
|
The
|
|
\fBsd_id128_get_machine()\fR
|
|
and
|
|
\fBsd_id128_get_boot()\fR
|
|
interfaces are available as a shared library, which can be compiled and linked to with the
|
|
"libsystemd"\ \&\fBpkg-config\fR(1)
|
|
file\&.
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
\fBsystemd\fR(1),
|
|
\fBsd-id128\fR(3),
|
|
\fBmachine-id\fR(5),
|
|
\fBrandom\fR(4),
|
|
\fBsd_id128_randomize\fR(3)
|