1HOST(3) host 1.7 HOST(3)
2
6 nfstest.host - Host module
7
9 Provides a set of tools for running commands on the local host or a re‐
10 mote host, including a mechanism for running commands in the back‐
11 ground. It provides methods for mounting and unmounting from an NFS
12 server and a mechanism to simulate a network partition via the use of
13 'iptables'. Currently, there is no mechanism to restore the iptables
14 rules to their original state.
15
17 class Host(baseobj.BaseObj)
18 Host object
19 Host() -> New Host object
21 Usage:
23 from nfstest.host import Host
24 # Create host object for local host
26 x = Host()
27 # Create host object for remote host
28 y = Host(host='192.168.0.11')
29 # Run command to the local host
31 x.run_cmd("ls -l")
32 # Send command to the remote host and run it as root
34 y.run_cmd("ls -l", sudo=True)
35 # Run command in the background
37 x.run_cmd("tcpdump", sudo=True, wait=False)
38 ....
39 ....
40 # Stop command running in the background
41 x.stop_cmd()
42 # Mount volume using default options
44 x.mount()
45 # Unmount volume
47 x.umount()
48 # Start packet trace
50 x.trace_start()
51 # Stop packet trace
53 x.trace_stop()
54 # Open packet trace
56 x.trace_open()
57 # Enable NFS kernel debug
59 x.nfs_debug_enable(nfsdebug='all'):
60 # Stop NFS kernel debug
62 x.nfs_debug_reset()
63 Methods defined here:
66 ---------------------
67 __del__(self)
69 Destructor
70 __init__(self, **kwargs)
72 Constructor
73 Initialize object's private data.
75 host: Hostname or IP address [default: localhost]
78 user: User to log in to host [default: '']
80 server:
82 NFS server name or IP address [default: None]
83 nfsversion:
85 NFS version [default: 4.1]
86 proto: NFS protocol name [default: 'tcp']
88 port: NFS server port [default: 2049]
90 sec: Security flavor [default: 'sys']
92 nconnect:
94 Multiple TCP connections option [default: 1]
95 export:
97 Exported file system to mount [default: '/']
98 mtpoint:
100 Mount point [default: '/mnt/t']
101 datadir:
103 Data directory where files are created [default: '']
104 mtopts:
106 Mount options [default: 'hard,rsize=4096,wsize=4096']
107 interface:
109 Network device interface [default: 'eth0']
110 nomount:
112 Debug option so the server is not actually mounted [default: False]
113 tracename:
115 Base name for trace files to create [default: 'tracefile']
116 trcdelay:
118 Seconds to delay before stopping packet trace [default: 0.0]
119 tcpdump:
121 Tcpdump command [default: '/usr/sbin/tcpdump']
122 tbsize:
124 Capture buffer size in kB [default: 150000]
125 notrace:
127 Debug option so a trace is not actually started [default: False]
128 rpcdebug:
130 Set RPC kernel debug flags and save log messages [default: '']
131 nfsdebug:
133 Set NFS kernel debug flags and save log messages [default: '']
134 tracepoints:
136 List of trace points modules to enable [default: '']
137 nfsstats:
139 Get NFS stats [default: False]
140 dbgname:
142 Base name for log messages files to create [default: 'dbgfile']
143 trcpname:
145 Base name for trace point files to create [default: 'trcpfile']
146 nfsstatname:
148 Base name for NFS stats files to create [default: 'nfsstatfile']
149 messages:
151 Location of file for system messages [default: '/var/log/messages']
152 trcevents:
154 Tracing events directory [default: '/sys/kernel/debug/tracing/events']
155 trcpipe:
157 Trace pipe file [default: '/sys/kernel/debug/tracing/trace_pipe']
158 tmpdir:
160 Temporary directory where trace/debug files are created
161 [default: '/tmp']
162 iptables:
164 Iptables command [default: '/usr/sbin/iptables']
165 kill: kill command [default: '/usr/bin/kill']
167 nfsstat:
169 nfsstat command [default: '/usr/bin/nfsstat']
170 sudo: Sudo command [default: '/usr/bin/sudo']
172 abspath(self, filename, dir=None)
174 Return the absolute path for the given file name.
175 cleanup(self)
177 Gracefully unmount volume and reset network
178 get_pids(self, pid)
180 Get all descendant PIDs for the given PID
181 get_route(self, ipaddr)
183 Get routing information for destination IP address
184 Returns a tuple: (gateway, device name, src IP address)
185 mount(self, **kwargs)
187 Mount the file system on the given mount point.
188 server:
191 NFS server name or IP address [default: self.server]
192 nfsversion:
194 NFS version [default: self.nfsversion]
195 proto: NFS protocol name [default: self.proto]
197 port: NFS server port [default: self.port]
199 sec: Security flavor [default: self.sec]
201 nconnect:
203 Multiple TCP connections option [default: self.nconnect]
204 export:
206 Exported file system to mount [default: self.export]
207 mtpoint:
209 Mount point [default: self.mtpoint]
210 datadir:
212 Data directory where files are created [default: self.datadir]
213 mtopts:
215 Mount options [default: self.mtopts]
216 Return the mount point.
218 network_drop(self, ipaddr, port)
220 Simulate a network drop by dropping all tcp packets going to the
221 given ipaddr and port using the iptables commands.
222 network_reset(self)
224 Reset the network by flushing all the chains in the table using
225 the iptables command.
226 nfs_debug_enable(self, **kwargs)
228 Enable NFS debug messages.
229 rpcdebug:
232 Set RPC kernel debug flags and save log messages [default: self.rpcdebug]
233 nfsdebug:
235 Set NFS kernel debug flags and save log messages [default: self.nfsdebug]
236 dbgfile:
238 Name of log messages file to create, default is a unique name
239 created in the temporary directory using self.dbgname as the
240 base name.
241 nfs_debug_reset(self)
243 Reset NFS debug messages.
244 nfsstat_get(self)
246 Get NFS stats.
247 nfsstat_init(self)
249 Initialize NFS stats.
250 nfsstr(self, version=None, prefix='NFSv')
252 Return the NFS string for the given NFS version
253 version:
256 NFS version, default is the object attribute nfsversion
257 nfsvers(self, version=None)
259 Return major and minor version for the given NFS version
260 version:
263 NFS version, default is the object attribute nfsversion
264 run_cmd(self, cmd, sudo=False, dlevel='DBG1', msg='', wait=True)
266 Run the command to the remote machine using ssh.
267 There is no user authentication, so remote host must allow
268 ssh connection without any passwords for the user.
269 For a localhost the command is just executed and ssh is not used.
270 The object for the process of the command is stored in object
272 attribute 'self.process' to be used by methods wait_cmd() and
273 stop_cmd(). The standard output of the command is also stored
274 in the object attribute 'self.pstdout' while the standard error
275 output of the command is stored in 'self.pstderr'.
276 cmd: Command to execute
279 sudo: Run command using sudo if option is True
281 dlevel:
283 Debug level for displaying the command to the user
284 msg: Prefix this message to the debug message to be displayed
286 wait: Wait for command to complete before returning
288 Return the standard output of the command and the return code or
290 exit status is stored in the object attribute 'self.returncode'.
291 stop_cmd(self, process=None, dlevel=None, msg='')
293 Terminate command started by run_cmd() by calling wait_cmd()
294 with the 'terminate' option set to True.
295 process:
298 The object for the process of the command to terminate,
299 or terminate all commands started by run_cmd() if this
300 option is not given
301 dlevel:
303 Debug level for displaying the command to the user, default
304 is the level given by run_cmd()
305 msg: Prefix this message to the debug message to be displayed
307 Return the exit status of the last command
309 sudo_cmd(self, cmd)
311 Prefix the SUDO command if effective user is not root.
312 trace_open(self, tracefile=None, **kwargs)
314 Open the trace file given or the trace file started by trace_start().
315 All extra options are passed directly to the packet trace object.
317 Return the packet trace object created, the packet trace object
319 is also stored in the object attribute pktt.
320 trace_points_enable(self)
322 Enable trace points.
323 trace_points_reset(self)
325 Reset trace points.
326 trace_start(self, tracefile=None, interface=None, capsize=None, clients=None)
328 Start trace on interface given
329 tracefile:
332 Name of trace file to create, default is a unique name
333 created in the temporary directory using self.tracename as the
334 base name.
335 capsize:
337 Use the -C option of tcpdump to split the trace files every
338 1000000*capsize bytes. See documentation for tcpdump for more
339 information
340 clients:
342 List of Host() objects to monitor
343 Return the name of the trace file created.
345 trace_stop(self)
347 Stop the trace started by trace_start().
348 umount(self)
350 Unmount the file system.
351 wait_cmd(self, process=None, terminate=False, dlevel=None, msg='')
353 Wait for command started by run_cmd() to finish.
354 process:
357 The object for the process of the command to wait for,
358 or wait for all commands started by run_cmd() if this
359 option is not given
360 terminate:
362 If True, send a signal to terminate the command or commands
363 and then wait for all commands to finish
364 dlevel:
366 Debug level for displaying the command to the user, default
367 is the level given by run_cmd()
368 msg: Prefix this message to the debug message to be displayed
370 Return the exit status of the last command
372 Static methods defined here:
374 ----------------------------
375 get_ip_address(host='', ipv6=False)
377 Get IP address associated with the given host name.
378 This could be run as an instance or class method.
379
381 baseobj(3), packet.pktt(3)
382
385 No known bugs.
386
388 Jorge Mora (mora@netapp.com)
389NFStest 3.2 21 March 2023 HOST(3)