1 DHCPINFO(1) User Commands DHCPINFO(1)
2
3
4
5 NAME
6 dhcpinfo - display values of parameters received through DHCP
7
8 SYNOPSIS
9 dhcpinfo [-c] [-i interface] [-n limit] [-v 4|6] code
10
11
12 dhcpinfo [-c] [-i interface] [-n limit] [-v 4|6] identifier
13
14
15 DESCRIPTION
16 The dhcpinfo utility prints the DHCP-supplied value(s) of the parameter
17 requested on the command line. The parameter can be identified either
18 by its numeric code in the DHCP specification, or by its mnemonic
19 identifier, as listed in dhcp_inittab(4). This command is intended to
20 be used in command substitutions in the shell scripts invoked by
21 init(1M) at system boot. It first contacts the DHCP client daemon at
22 system boot or in event scripts as described in dhcpagent(1M). It first
23 contacts the DHCP client daemon dhcpagent(1M) to verify that DHCP has
24 successfully completed on the requested interface. If DHCP has
25 successfully completed on the requested interface, dhcpinfo retrieves
26 the values for the requested parameter. Parameter values echoed by
27 dhcpinfo should not be used without checking its exit status. See
28 exit(1).
29
30
31 See dhcp_inittab(4) for the list of mnemonic identifier codes for all
32 DHCP parameters. See RFC 2132, DHCP Options and BOOTP Vendor Extensions
33 for more details on DHCPv4 parameters, and RFC 3315, Dynamic Host
34 Configuration Protocol for IPv6 (DHCPv6), for more details on DHCPv6
35 parameters.
36
37 Output Format
38 The output from dhcpinfo consists of one or more lines of ASCII text;
39 the format of the output depends upon the requested parameter. The
40 number of values returned per line and the total number of lines output
41 for a given parameter are determined by the parameter's granularity and
42 maximum values, respectively, as defined by dhcp_inittab(4).
84 system automatically selects an interface to consider
85 as primary for the current command invocation. The
86 selection chooses the interface whose name sorts
87 lexically first, and that has DHCP parameters attached.
88 This selection does not affect system state. Use
89 ifconfig(1M) to set a primary interface.
90
91 The recommended practice in the dhcpagent(1M) eventhook
92 scripts is to specify the desired interface with -i,
93 rather than relying on primary selection.
94
95 For DHCPv6, the interface name used should be the name
96 of the physical interface, not one of the logical
97 interfaces created by dhcpagent.
98
99
100 -n limit
101 Limits the list of values displayed to limit lines.
102
103
104 -v4 | 6
105 Specifies the DHCP version to query. Use -v4for DHCPv4
106 and -v6 for DHCPv6.
107
108
109 OPERANDS
110 The following operands are supported:
111
112 code
113 Numeric code for the requested DHCP parameter, as defined
114 by the DHCP specification. Vendor options are specified
115 by adding 256 to the actual vendor code for DHCPv4, and
116 65536 for DHCPv6.
117
118
119 identifier
120 Mnemonic symbol for the requested DHCP parameter, as
121 listed in dhcp_inittab(4).
122
123
124 EXIT STATUS
125 The following exit values are returned:
126
142 The operation timed out.
143
144
145 6
146 System error (should never occur).
147
148
149 ATTRIBUTES
150 See attributes(5) for descriptions of the following attributes:
151
152
153
154
155 +--------------------+-----------------+
156 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
157 +--------------------+-----------------+
158 |Interface Stability | Committed |
159 +--------------------+-----------------+
160
161 SEE ALSO
162 dhcpagent(1M), ifconfig(1M), init(1M), dhcp_inittab(4), attributes(5)
163
164
165 Alexander, S., and R. Droms, RFC 2132, DHCP Options and BOOTP Vendor
166 Extensions, Silicon Graphics, Inc., Bucknell University, March 1997.
167
168
169 Droms, R. , RFC 3315, Dynamic Host Configuration Protocol for IPv6
170 (DHCPv6), Cisco Systems, July 2003.
171
172
173 Mockapetris, P.V. , RFC 1035, Domain names - implementation and
174 specification, ISI, November 1987.
175
176
177
178 May 15, 2009 DHCPINFO(1)
|
1 DHCPINFO(1) User Commands DHCPINFO(1)
2
3
4
5 NAME
6 dhcpinfo - display values of parameters received through DHCP
7
8 SYNOPSIS
9 dhcpinfo [-c] [-i interface] [-n limit] [-v 4|6] code
10
11
12 dhcpinfo [-c] [-i interface] [-n limit] [-v 4|6] identifier
13
14
15 DESCRIPTION
16 The dhcpinfo utility prints the DHCP-supplied value(s) of the parameter
17 requested on the command line. The parameter can be identified either
18 by its numeric code in the DHCP specification, or by its mnemonic
19 identifier, as listed in dhcp_inittab(4). This command is intended to
20 be used in command substitutions in the shell scripts invoked at system
21 boot or in event scripts as described in dhcpagent(1M). It first
22 contacts the DHCP client daemon dhcpagent(1M) to verify that DHCP has
23 successfully completed on the requested interface. If DHCP has
24 successfully completed on the requested interface, dhcpinfo retrieves
25 the values for the requested parameter. Parameter values echoed by
26 dhcpinfo should not be used without checking its exit status. See
27 exit(1).
28
29
30 See dhcp_inittab(4) for the list of mnemonic identifier codes for all
31 DHCP parameters. See RFC 2132, DHCP Options and BOOTP Vendor Extensions
32 for more details on DHCPv4 parameters, and RFC 3315, Dynamic Host
33 Configuration Protocol for IPv6 (DHCPv6), for more details on DHCPv6
34 parameters.
35
36 Output Format
37 The output from dhcpinfo consists of one or more lines of ASCII text;
38 the format of the output depends upon the requested parameter. The
39 number of values returned per line and the total number of lines output
40 for a given parameter are determined by the parameter's granularity and
41 maximum values, respectively, as defined by dhcp_inittab(4).
83 system automatically selects an interface to consider
84 as primary for the current command invocation. The
85 selection chooses the interface whose name sorts
86 lexically first, and that has DHCP parameters attached.
87 This selection does not affect system state. Use
88 ifconfig(1M) to set a primary interface.
89
90 The recommended practice in the dhcpagent(1M) eventhook
91 scripts is to specify the desired interface with -i,
92 rather than relying on primary selection.
93
94 For DHCPv6, the interface name used should be the name
95 of the physical interface, not one of the logical
96 interfaces created by dhcpagent.
97
98
99 -n limit
100 Limits the list of values displayed to limit lines.
101
102
103 -v 4|6
104 Specifies the DHCP version to query. Use -v 4 for
105 DHCPv4 and -v 6 for DHCPv6.
106
107
108 OPERANDS
109 The following operands are supported:
110
111 code
112 Numeric code for the requested DHCP parameter, as defined
113 by the DHCP specification. Vendor options are specified
114 by adding 256 to the actual vendor code for DHCPv4, and
115 65536 for DHCPv6.
116
117
118 identifier
119 Mnemonic symbol for the requested DHCP parameter, as
120 listed in dhcp_inittab(4).
121
122
123 EXIT STATUS
124 The following exit values are returned:
125
141 The operation timed out.
142
143
144 6
145 System error (should never occur).
146
147
148 ATTRIBUTES
149 See attributes(5) for descriptions of the following attributes:
150
151
152
153
154 +--------------------+-----------------+
155 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
156 +--------------------+-----------------+
157 |Interface Stability | Committed |
158 +--------------------+-----------------+
159
160 SEE ALSO
161 dhcpagent(1M), ifconfig(1M), dhcp_inittab(4), attributes(5)
162
163
164 Alexander, S., and R. Droms, RFC 2132, DHCP Options and BOOTP Vendor
165 Extensions, Silicon Graphics, Inc., Bucknell University, March 1997.
166
167
168 Droms, R. , RFC 3315, Dynamic Host Configuration Protocol for IPv6
169 (DHCPv6), Cisco Systems, July 2003.
170
171
172 Mockapetris, P.V. , RFC 1035, Domain names - implementation and
173 specification, ISI, November 1987.
174
175
176
177 February 13, 2020 DHCPINFO(1)
|