summaryrefslogtreecommitdiff
path: root/doc/man/cloud-id.1
blob: cb500189c338712eb1f79f784c1cb98f4253d60a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
.TH CLOUD-ID 1

.SH NAME
cloud-id \- Report the canonical cloud-id for this instance

.SH SYNOPSIS
.BR "cloud-id" " [-h] [-j] [-l] [-i <INSTANCE_DATA>]"

.SH DESCRIPTION
cloud-id is the lowercase name of the cloud datasource discovered.

The cloud-id will be 'not run' when systemd generator has not run yet.
The cloud-id will be 'disabled' when cloud-init is disabled or when
ds-identify did not find a valid datasource.

See cloud-init status --long for more information.

.SH OPTIONS
.TP
.B "-h, --help"
Show help message and exit

.TP
.B "-j, --json"
Report all standardized cloud-id information as json

.TP
.B "-l, --long"
Report extended cloud-id information as tab-delimited string

.TP
.BR "-i <data>, --instance-data <data>"
Path to instance-data.json file. Default is
/run/cloud-init/instance-data.json

.SH EXIT STATUS
.TP
0
On success
.TP
1
Due to an error
.TP
2
Due to cloud-init in a disabled state. See: cloud-init status --long
.TP
3
The cloud-init generator and discovery has not yet run.

.SH COPYRIGHT
Copyright (C) 2021 Canonical Ltd. License GPL-3 or Apache-2.0

.SH SEE ALSO
Full documentation at: <https://cloudinit.readthedocs.io>