usr/src/man/man1m/ifparse.1m

   1 '\" te
   2 .\" Copyright (C) 2001, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH IFPARSE 1M "May 9, 2001"
   7 .SH NAME
   8 ifparse \- parse \fBifconfig\fR command line
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/sbin/ifparse\fR [\fB-fs\fR] \fIaddr_family\fR \fIcommands\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 Use the \fBifparse\fR command to parse the \fBifconfig\fR(1M) command line
  19 options and output substrings, one per line, as appropriate. If no options are
  20 specified, \fBifparse\fR returns the entire \fBifconfig\fR command line as a
  21 series of substrings, one per line.
  22 .SH OPTIONS
  23 .sp
  24 .LP
  25 The \fBifparse\fR command supports the following options:
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fB-f\fR\fR
  30 .ad
  31 .RS 6n
  32 Lists only substrings of the \fBifconfig\fR command line that are relevant to
  33 IP network multipath failover
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fB-s\fR\fR
  40 .ad
  41 .RS 6n
  42  Lists only substrings of the \fBifconfig\fR command line that are not relevant
  43 to IP network multipath failover
  44 .RE
  45
  46 .SH OPERANDS
  47 .sp
  48 .LP
  49 The \fBifparse\fR command \fBdoes not\fR support the \fIinterface\fR operand of
  50 the \fBifconfig\fR command.
  51 .SH EXAMPLES
  52 .LP
  53 \fBExample 1 \fRParsing Command Line Options Relevant to Failover
  54 .sp
  55 .LP
  56 The following example shows the use of the \fBifparse\fR command to parse the
  57 command line options relevant to IP network multipath failover:
  58
  59 .sp
  60 .in +2
  61 .nf
  62 example# \fBifparse -f inet 1.2.3.4 up group one addif 1.2.3.5 -failover up\fR
  63 set 1.2.3.4 up
  64 .fi
  65 .in -2
  66 .sp
  67
  68 .LP
  69 \fBExample 2 \fRParsing Command Line Options That Are Not Relevant to Failover
  70 .sp
  71 .LP
  72 The following example shows the use of the \fBifparse\fR command to parse the
  73 command line options that are not relevant to IP network multipath failover:
  74
  75 .sp
  76 .in +2
  77 .nf
  78 example# \fBifparse -s inet 1.2.3.4 up group one addif 1.2.3.5 -failover up\fR
  79 group one
  80 addif 1.2.3.5 -failover up
  81 .fi
  82 .in -2
  83 .sp
  84
  85 .LP
  86 \fBExample 3 \fRParsing the Command Line For All Options
  87 .sp
  88 .LP
  89 The following example shows the use of the \fBifparse\fR command to parse the
  90 command line for all \fBifconfig\fR options:
  91
  92 .sp
  93 .in +2
  94 .nf
  95 example# \fBifparse inet 1.2.3.4 up group one addif 1.2.3.5 -failover up\fR
  96 group one
  97 set 1.2.3.4 up
  98 addif 1.2.3.5 -failover up
  99 .fi
 100 .in -2
 101 .sp
 102
 103 .SH ATTRIBUTES
 104 .sp
 105 .LP
 106 See \fBattributes\fR(5) for descriptions of the following attributes:
 107 .sp
 108
 109 .sp
 110 .TS
 111 box;
 112 c | c
 113 l | l .
 114 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 115 _
 116 Stability Level Obsolete
 117 .TE
 118
 119 .SH SEE ALSO
 120 .sp
 121 .LP
 122 \fBifconfig\fR(1M), \fBattributes\fR(5)
 123 .SH DIAGNOSTICS
 124 .sp
 125 .LP
 126 usage: \fB-fs\fR <addr_family> <commands>
 127 .RS +4
 128 \fBDescription: \fR
 129 .sp
 130 .LP
 131 This message indicates an invalid command line.
 132 .RE
 133
 134 .sp
 135 .LP
 136 \fBifparse\fR: Not enough space
 137 .RS +4
 138 \fBDescription: \fR
 139 .sp
 140 .LP
 141 This message indicates insufficient memory.
 142 .RE
 143
 144 .sp
 145 .LP
 146 \fBifparse\fR: dhcp not supported for inet6
 147 .RS +4
 148 \fBDescription: \fR
 149 .sp
 150 .LP
 151 DHCP operations are not supported for the \fBinet6\fR address family.
 152 .RE
 153
 154 .sp
 155 .LP
 156 \fBifparse\fR: Operation <operation> not supported for <addr_family>
 157 .RS +4
 158 \fBDescription: \fR
 159 .sp
 160 .LP
 161 Most operations cannot be used with all address families. For example, the
 162 \fBbroadcast\fR operation is not supported on the \fBinet6\fR address family.
 163 .RE
 164
 165 .sp
 166 .LP
 167 \fBifparse\fR: no argument for <operation>
 168 .RS +4
 169 \fBDescription: \fR
 170 .sp
 171 .LP
 172 Some operations, for example \fBbroadcast\fR, require an argument.
 173 .RE
 174
 175 .SH NOTES
 176 .sp
 177 .LP
 178 The \fBifparse\fR command is classified as an obsolete interface. It will
 179 likely be removed in a future release. You should not develop applications that
 180 depend upon this interface.