[netconf.git] / netconf.py

#!/usr/bin/env python
#
# This file and its contents are supplied under the terms of the
# Common Development and Distribution License ("CDDL"), version 1.0.
# You may only use this file in accordance with the terms of version
# 1.0 of the CDDL.
#
# A full copy of the text of the CDDL should have accompanied this
# source. A copy of the CDDL is also available via the Internet at
# http://www.illumos.org/license/CDDL.
#

#
# Copyright 2017 <Michael Rasmussen>
#

#
# The porpuse of this script is to help with basic and/or initial
# network configuration for Illumos based distribution. However,
# the script is developed specifically for OmniOS so there is no
# garaunty that it will work on other Illumos based distributions
# than Omnios.
#

import sys, subprocess, getopt

def runcmd(cmd):
    process = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
    output, error = process.communicate();
    
    return (output.rstrip(), error.rstrip())

class ParserError(Exception):
    pass

class Parser:
    """ Parse nic information """
    
    def __init__(self):
        self.__dladm1 = "dladm show-phys -p -o link,media | sed 's/:/ /g'"
        self.__dladm2 = "dladm show-phys -p -m -o link,address,inuse | sed 's/:/ /g' | sed 's/\\\[[:space:]]/:/g' | sed 's/\\\//g'"

    def __parse_nics(self, text):
        nics = {}
        for line in text.splitlines():
            parts = line.split()
            #if parts[1] in ('Ethernet', 'Infiniband'):
            if parts[1] in ('Ethernet'):
                nics[parts[0]] = [parts[0], parts[1]]
    
        return nics

    def __parse_macs(self, obj, text):
        list = []
        if obj:
            for line in text.splitlines():
                parts = line.split()
                try:
                    if parts[2] == 'yes':
                        del obj[parts[0]]
                    else:
                        obj[parts[0]].append(parts[1])
                except KeyError:
                    pass
            for k, v in obj.items():
                list.append(v)

        return list

    def parse(self):
        (nics, error) = runcmd(self.__dladm1)
        if error:
            raise ParserError(error)

        (macs, error) = runcmd(self.__dladm2)
        if error:
            raise ParserError(error)

        return self.__parse_macs(self.__parse_nics(nics), macs)

def get_terminal_width():
        try:
            if sys.version_info >= (2,7):
                width = int(subprocess.check_output(['tput', 'cols']))
            else:
                (out, err) = runcmd('tput cols')
                if err:
                    raise OSError(err);
                width = int(out)
        except OSError as e:
            print("Invalid Command 'tput cols': exit status ({1})".format(e.errno))
        except subprocess.CalledProcessError as e:
            print("Command 'tput cols' returned non-zero exit status: ({1})".format(e.returncode))
        else:
            return width

def make_menu(interfaces):
    res = None
    while not res:
        sys.stderr.write("\x1b[2J\x1b[H")
        cols = get_terminal_width()
        intro = 'The following unconfigured interfaces was discovered'
        fill = (cols / 2) - (len(intro) / 2)
        print '{0:^{cols}}'.format('Simple network interface configuration tool', cols=cols)
        print
        print '{0:<{fill}}{1}'.format('', intro, fill=fill)
        print '{0:<{fill}}{1:>2} {2:^15}  {3:^10}  {4:^17}'.format('','#','Interface','Media','MAC',fill=fill)
        print '{0:<{fill}}{1:-^2} {2:-^15}  {3:-^10}  {4:-^17}'.format('','','','','',fill=fill)

        n = 0
        for i in interfaces:
            print '{0:<{fill}}{1:>2} {2:<15}  {3:<10}  {4:>17}'.format('',n,i[0],i[1],i[2],fill=fill)
            n += 1
        print
        print '{0:<{fill}}{1:<}'.format('','select interface number to configure:',fill=fill),
        nic = int(raw_input())
        if nic >= n or nic < 0:
            print '{0:<{fill}}{1:<} {2:<}'.format('','Error: Interface: 0 <= # <',n,fill=fill),
            raw_input(' << Hit any key >>')
        else:
            res = interfaces[nic]

    return res

def get_config():
    ip = mask = gw = None
    nettype = raw_input('dhcp or static [dhcp]: ').lower()
    if nettype == 'static':
        while not ip:
            ip = raw_input('Enter IP: ')
        mask = raw_input('Enter netmask [24]: ')
        if not mask:
            mask = 24
        gw = raw_input('Enter default route [0=no]: ')
        if not gw:
            gw = 0
    
    return (ip,mask,gw)    

def usage():
    print 'Usage: %s [options]' % sys.argv[0] 
    print
    print '%s' % """Options:
    -h, --help		This usage.
    -a, --address	IP for interface. 0 means use DHCP
    -g, --gateway	Default gateway. Optional.
    -i, --interface	Interface to configure.
    -m, --netmask	Netmask to use for interface. Default /24.
    -n, --nameserver	Nameserver to use. Optional.
    -r, --record	Output create commands to stdout."""

def parse_input():
    options = ()

    try:
	opts, args = getopt.gnu_getopt(sys.argv[1:],
                'ha:g:i:m:n:r', ['help', 'address=', 'gateway=',
		'interface=', 'netmask=', 'nameserver=', 'record'])
    except getopt.GetoptError as err:
	print str(err)
	usage()
	sys.exit(2)

    address = gateway = interface = netmask = nameserver = None
    record = False

    if opts:
	for o, a in opts:
	    if o in ('-h', '--help'):
		usage()
		sys.exit(0)
	    if o in ('-a', '--address'):
		address = a
	    elif o in ('-g', '--gateway'):
		gateway = a
	    elif o in ('-i', '--interface'):
		interface = a
	    elif o in ('-m', '--netmask'):
		netmask = a
	    elif o in ('-n', '--nameserver'):
		nameserver = a
	    elif o in ('-r', '--record'):
		record = True
	    else:
		assert False, 'Unhandled option'

	if (record):
	    if (bool(address) ^ bool(interface)):
                print 'Error: missing options'
		usage()
		sys.exit(2)
        else:
	    if not address or not interface or error:
		print 'Error: missing options'
		usage()
		sys.exit(2)

	if address == '0':
	    address = None
	if not netmask:
	    netmask = '24'
    
	options = (interface, address, netmask, gateway, nameserver, record)
    
    return options

def main():
    interactive = True
    record = False
    output = ''

    options = parse_input()
    if options:
        record = options[5]
        if (options[0]):
	    interactive = False

    p = Parser()
    try:
        interfaces = p.parse()
        if interfaces:
	    if interactive:
		nic = make_menu(interfaces)
	    else:
                nic = options
                found = False
                for i in interfaces:
                    if nic[0] == i[0]:
                        found = True
                        break
                if not found:
                    err = '%s: No such interface' % nic[0]
                    raise RuntimeError(err)
            if nic:
		if interactive:
		    (ip,mask,gw) = get_config()
		else:
		    ip = options[1]
		    mask = options[2]
		    gw = options[3]
                cmd = 'ipadm delete-if %s' % nic[0]
		if record:
		    output += cmd
		else:
		    runcmd(cmd)
                cmd = 'ipadm create-if %s' % nic[0]
		if record:
		    output += "\n" + cmd
		else:
		    (out, err) = runcmd(cmd)
		    if err:
			raise RuntimeError(err)
                if not ip:
                    # use DHCP
                    cmd = 'ipadm create-addr -T dhcp %s/v4' % nic[0]
		    if record:
			output += "\n" + cmd
		    else:
			(out, err) = runcmd(cmd)
			if err:
			    raise RuntimeError(err)
                else:
                    # use STATIC
                    cmd = 'ipadm create-addr -T static -a %s/%s %s/v4' % (ip, mask, nic[0])
		    if record:
			output += "\n" + cmd
		    else:
			(out, err) = runcmd(cmd)
			if err:
			    raise RuntimeError(err)
                    if gw:
                        cmd = 'route -p add default %s' % gw
			if record:
			    output += "\n" + cmd
			else:
			    (out, err) = runcmd(cmd)
			    if err:
				raise RuntimeError(err)
		if not record:
		    cmd = 'netstat -rn -finet'
		    (out, err) = runcmd(cmd)
		    if err:
			raise RuntimeError(err)
		    print 'New route table'
		    print out
		if interactive:
		    dns = raw_input('Configure DNS [n]? ').lower()
		else:
		    dns = options[4]
                if not dns or dns == 'n':
                    pass
                else:
		    if interactive:
			dns = None
			print
			while not dns:
			    dns = raw_input('Enter nameserver: ')

                    cmd = "echo 'nameserver %s' >> /etc/resolv.conf " % dns
                    cmd += '&& cp /etc/nsswitch.conf{,.bak} '
                    cmd += '&& cp /etc/nsswitch.{dns,conf}'
		    if record:
			output += "\n" + cmd
		    else:
			(out, err) = runcmd(cmd)
			if err:
			    raise RuntimeError(err)
                if record:
                    print output
        else:
            print "Found no unassigned interfaces"
    except ParserError as e:
        print 'Parse Errror: %s' % e
    except RuntimeError as e:
        print 'Runtime Error: %s' % e

if __name__ == '__main__':
    try:
        main()
    except KeyboardInterrupt:
        sys.stderr.write("\x1b[2J\x1b[H")
Commit	Line	Data
4b6fdffe MR	1	#!/usr/bin/env python
	2	#
	3	# This file and its contents are supplied under the terms of the
	4	# Common Development and Distribution License ("CDDL"), version 1.0.
	5	# You may only use this file in accordance with the terms of version
	6	# 1.0 of the CDDL.
	7	#
	8	# A full copy of the text of the CDDL should have accompanied this
	9	# source. A copy of the CDDL is also available via the Internet at
	10	# http://www.illumos.org/license/CDDL.
	11	#
	12
	13	#
	14	# Copyright 2017 <Michael Rasmussen>
	15	#
	16
	17	#
	18	# The porpuse of this script is to help with basic and/or initial
	19	# network configuration for Illumos based distribution. However,
	20	# the script is developed specifically for OmniOS so there is no
	21	# garaunty that it will work on other Illumos based distributions
	22	# than Omnios.
	23	#
	24
	25	import sys, subprocess, getopt
	26
	27	def runcmd(cmd):
	28	process = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
	29	output, error = process.communicate();
	30
	31	return (output.rstrip(), error.rstrip())
	32
	33	class ParserError(Exception):
	34	pass
	35
	36	class Parser:
	37	""" Parse nic information """
	38
	39	def __init__(self):
	40	self.__dladm1 = "dladm show-phys -p -o link,media \| sed 's/:/ /g'"
	41	self.__dladm2 = "dladm show-phys -p -m -o link,address,inuse \| sed 's/:/ /g' \| sed 's/\\\[[:space:]]/:/g' \| sed 's/\\\//g'"
	42
	43	def __parse_nics(self, text):
	44	nics = {}
	45	for line in text.splitlines():
	46	parts = line.split()
	47	#if parts[1] in ('Ethernet', 'Infiniband'):
	48	if parts[1] in ('Ethernet'):
	49	nics[parts[0]] = [parts[0], parts[1]]
	50
	51	return nics
	52
	53	def __parse_macs(self, obj, text):
	54	list = []
	55	if obj:
	56	for line in text.splitlines():
	57	parts = line.split()
	58	try:
	59	if parts[2] == 'yes':
	60	del obj[parts[0]]
	61	else:
	62	obj[parts[0]].append(parts[1])
	63	except KeyError:
	64	pass
65	for k, v in obj.items():
66	list.append(v)
67
68	return list
69
70	def parse(self):
71	(nics, error) = runcmd(self.__dladm1)
72	if error:
73	raise ParserError(error)
74
75	(macs, error) = runcmd(self.__dladm2)
76	if error:
77	raise ParserError(error)
78
79	return self.__parse_macs(self.__parse_nics(nics), macs)
80
81	def get_terminal_width():
82	try:
83	if sys.version_info >= (2,7):
84	width = int(subprocess.check_output(['tput', 'cols']))
85	else:
86	(out, err) = runcmd('tput cols')
87	if err:
88	raise OSError(err);
89	width = int(out)
90	except OSError as e:
91	print("Invalid Command 'tput cols': exit status ({1})".format(e.errno))
92	except subprocess.CalledProcessError as e:
93	print("Command 'tput cols' returned non-zero exit status: ({1})".format(e.returncode))
94	else:
95	return width
96
97	def make_menu(interfaces):
98	res = None
99	while not res:
100	sys.stderr.write("\x1b[2J\x1b[H")
101	cols = get_terminal_width()
102	intro = 'The following unconfigured interfaces was discovered'
103	fill = (cols / 2) - (len(intro) / 2)
104	print '{0:^{cols}}'.format('Simple network interface configuration tool', cols=cols)
105	print
106	print '{0:<{fill}}{1}'.format('', intro, fill=fill)
107	print '{0:<{fill}}{1:>2} {2:^15} {3:^10} {4:^17}'.format('','#','Interface','Media','MAC',fill=fill)
108	print '{0:<{fill}}{1:-^2} {2:-^15} {3:-^10} {4:-^17}'.format('','','','','',fill=fill)
109
110	n = 0
111	for i in interfaces:
112	print '{0:<{fill}}{1:>2} {2:<15} {3:<10} {4:>17}'.format('',n,i[0],i[1],i[2],fill=fill)
113	n += 1
114	print
115	print '{0:<{fill}}{1:<}'.format('','select interface number to configure:',fill=fill),
116	nic = int(raw_input())
117	if nic >= n or nic < 0:
118	print '{0:<{fill}}{1:<} {2:<}'.format('','Error: Interface: 0 <= # <',n,fill=fill),
119	raw_input(' << Hit any key >>')
120	else:
121	res = interfaces[nic]
122
123	return res
124
125	def get_config():
126	ip = mask = gw = None
127	nettype = raw_input('dhcp or static [dhcp]: ').lower()
128	if nettype == 'static':
129	while not ip:
130	ip = raw_input('Enter IP: ')
131	mask = raw_input('Enter netmask [24]: ')
132	if not mask:
133	mask = 24
134	gw = raw_input('Enter default route [0=no]: ')
135	if not gw:
136	gw = 0
137
138	return (ip,mask,gw)
139
140	def usage():
141	print 'Usage: %s [options]' % sys.argv[0]
142	print
143	print '%s' % """Options:
144	-h, --help This usage.
145	-a, --address IP for interface. 0 means use DHCP
146	-g, --gateway Default gateway. Optional.
147	-i, --interface Interface to configure.
148	-m, --netmask Netmask to use for interface. Default /24.
149	-n, --nameserver Nameserver to use. Optional.
150	-r, --record Output create commands to stdout."""
151
152	def parse_input():
153	options = ()
154
155	try:
156	opts, args = getopt.gnu_getopt(sys.argv[1:],
157	'ha:g:i:m:n:r', ['help', 'address=', 'gateway=',
158	'interface=', 'netmask=', 'nameserver=', 'record'])
159	except getopt.GetoptError as err:
160	print str(err)
161	usage()
162	sys.exit(2)
163
164	address = gateway = interface = netmask = nameserver = None
165	record = False
166
167	if opts:
168	for o, a in opts:
169	if o in ('-h', '--help'):
170	usage()
171	sys.exit(0)
172	if o in ('-a', '--address'):
173	address = a
174	elif o in ('-g', '--gateway'):
175	gateway = a
176	elif o in ('-i', '--interface'):
177	interface = a
178	elif o in ('-m', '--netmask'):
179	netmask = a
180	elif o in ('-n', '--nameserver'):
181	nameserver = a
182	elif o in ('-r', '--record'):
183	record = True
184	else:
185	assert False, 'Unhandled option'
186
187	if (record):
188	if (bool(address) ^ bool(interface)):
189	print 'Error: missing options'
190	usage()
191	sys.exit(2)
192	else:
193	if not address or not interface or error:
194	print 'Error: missing options'
195	usage()
196	sys.exit(2)
197
198	if address == '0':
199	address = None
200	if not netmask:
201	netmask = '24'
202
203	options = (interface, address, netmask, gateway, nameserver, record)
204
205	return options
206
207	def main():
208	interactive = True
209	record = False
210	output = ''
211
212	options = parse_input()
213	if options:
214	record = options[5]
215	if (options[0]):
216	interactive = False
217
218	p = Parser()
219	try:
220	interfaces = p.parse()
221	if interfaces:
222	if interactive:
223	nic = make_menu(interfaces)
224	else:
225	nic = options
226	found = False
227	for i in interfaces:
228	if nic[0] == i[0]:
229	found = True
230	break
231	if not found:
232	err = '%s: No such interface' % nic[0]
233	raise RuntimeError(err)
234	if nic:
235	if interactive:
236	(ip,mask,gw) = get_config()
237	else:
238	ip = options[1]
239	mask = options[2]
240	gw = options[3]
241	cmd = 'ipadm delete-if %s' % nic[0]
242	if record:
243	output += cmd
244	else:
245	runcmd(cmd)
246	cmd = 'ipadm create-if %s' % nic[0]
247	if record:
248	output += "\n" + cmd
249	else:
250	(out, err) = runcmd(cmd)
251	if err:
252	raise RuntimeError(err)
253	if not ip:
254	# use DHCP
255	cmd = 'ipadm create-addr -T dhcp %s/v4' % nic[0]
256	if record:
257	output += "\n" + cmd
258	else:
259	(out, err) = runcmd(cmd)
260	if err:
261	raise RuntimeError(err)
262	else:
263	# use STATIC
264	cmd = 'ipadm create-addr -T static -a %s/%s %s/v4' % (ip, mask, nic[0])
265	if record:
266	output += "\n" + cmd
267	else:
268	(out, err) = runcmd(cmd)
269	if err:
270	raise RuntimeError(err)
271	if gw:
272	cmd = 'route -p add default %s' % gw
273	if record:
274	output += "\n" + cmd
275	else:
276	(out, err) = runcmd(cmd)
277	if err:
278	raise RuntimeError(err)
279	if not record:
280	cmd = 'netstat -rn -finet'
281	(out, err) = runcmd(cmd)
282	if err:
283	raise RuntimeError(err)
284	print 'New route table'
285	print out
286	if interactive:
287	dns = raw_input('Configure DNS [n]? ').lower()
288	else:
289	dns = options[4]
290	if not dns or dns == 'n':
291	pass
292	else:
293	if interactive:
294	dns = None
295	print
296	while not dns:
297	dns = raw_input('Enter nameserver: ')
298
299	cmd = "echo 'nameserver %s' >> /etc/resolv.conf " % dns
300	cmd += '&& cp /etc/nsswitch.conf{,.bak} '
301	cmd += '&& cp /etc/nsswitch.{dns,conf}'
302	if record:
303	output += "\n" + cmd
304	else:
305	(out, err) = runcmd(cmd)
306	if err:
307	raise RuntimeError(err)
308	if record:
309	print output
310	else:
311	print "Found no unassigned interfaces"
312	except ParserError as e:
313	print 'Parse Errror: %s' % e
314	except RuntimeError as e:
315	print 'Runtime Error: %s' % e
316
317	if __name__ == '__main__':
318	try:
319	main()
320	except KeyboardInterrupt:
321	sys.stderr.write("\x1b[2J\x1b[H")
322