← Back to branch summary

~ubuntu-branches/ubuntu/natty/ntop/natty

« back to all changes in this revision

Viewing changes to python/docs/src/host.py

  • Committer: Bazaar Package Importer
  • Author(s): Ludovico Cavedon, Jordan Metzmeier, Ludovico Cavedon
  • Date: 2010-12-15 20:06:19 UTC
  • mfrom: (5.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20101215200619-0ojz3iak95ihibun
Tags: 3:4.0.3+dfsg1-1
http://bugs.debian.org/522042
http://bugs.debian.org/595450
https://launchpad.net/bugs/257466
[ Jordan Metzmeier ]
* New upstream release (Closes: #522042)
* Move data files to /usr/share/ntop (Closes: #595450).
* Package architecture independent data in a separate ntop-data package.
* Use debhelper 7.
* Update Standards-Version to 3.9.1.
* Depend on python-mako.
* Do not include ntop.txt in binary packages as it is a copy of the man
  page.
* Do not include NEWS, as it is outdated.
* Switch to package source version 3.0 (quilt).
* Add password creation to debconf
* Changed init script to fix localization problems (thanks to Alejandro
  Varas <alej0varas@gmail.com>, LP: #257466)
* Remove manual update-rc.d calls from postrm and postinst. debhelper adds
  this for us.
* Add pre-depends on adduser for postinst script.
* Fix errors in the manpages: fix-manpage-errors.patch.
* Added fixes for matching active interfaces.
* Added a watch file.

[ Ludovico Cavedon ]
* Remove direct changes to upstream tree, and move them into specific patch
  files:
  - fix-manpage-errors.patch: fix typos in ntop.8.
  - dot-path.patch: fix path of /usr/bin/dot executable
* Add patches:
  - reduce-autogen-purged-files.patch: prevent agutogen.sh from reamoving
  too many files during cleanup.
  - Add build-without-ntop-darwin.patch, to fix compilation without
  ntop_darwin.c.
* No longer add faq.html, as it is not distributed in the upstream tarball.
* Use ${source:Version} in control file. Have ntop-data recommend
  ntop.
* Rename dirs to ntop.dirs and keep only empty directories that need
  to be created.
* Remove var/lib from ntop.install file, as it is empty (keeping it in
  ntop.dirs).
* Update po files.
* Breaks and Replaces instead of Conflitcs for ntop-data.
* Use a longer package description.
* Remove useless configure options from debian/rules.
* Move private shared libraries libraries in /usr/lib/ntop.
* Add change-plugin-dir.patch for adjusting plugin directory.
* Remove development files.
* Use system library for MochiKit.js.
* Rewrite DEP5 copyright file.
* Repackage upstream tarball in order to remove non-DFSG-compliant code. Add
  get-orig-source.sh script and get-orig-source target in debian/rules.
* Add explanation to README.Debian why geolocation is no longer working.
* Add avoid-copy-maxmind-db.patch to prevent copying of Geo*.dat
  files.
* Remove old unused patches.

Show diffs side-by-side

added added

removed removed

Lines of Context:
python/docs/src/host.py
 
1
"""
 
2
Module that exposes functions to get information on the current host taken into consideration
 
3
"""
 
4
def serial(): 
 
5
    """
 
6
    Get host unique serial identifier
 
7
    @rtype: string
 
8
    @return: the unique serial identifier
 
9
    """
 
10
    pass
 
11
def ethAddress():
 
12
    """
 
13
    Get host MAC address
 
14
    @rtype: string
 
15
    @return: the host MAC address
 
16
    """
 
17
    pass
 
18
def ipAddress():
 
19
    """
 
20
    Get host IP address
 
21
    @rtype: string
 
22
    @return: the IP address
 
23
    """
 
24
    pass
 
25
def hostResolvedName():
 
26
    """
 
27
    Get host Resolved Name
 
28
    @rtype: string
 
29
    @return: the host Resolved Name
 
30
    """
 
31
    pass
 
32
def hostTrafficBucket():
 
33
    """
 
34
    Get Traffic Bucket
 
35
    @rtype: number
 
36
    @return: host traffic bucket
 
37
    """
 
38
    pass
 
39
def numHostSessions():
 
40
    """
 
41
    Get actual numHostSessions
 
42
    @rtype: int
 
43
    @return: the number of host Sessions
 
44
    """
 
45
    pass
 
46
def vlanId():
 
47
    """
 
48
    Get vlanId
 
49
    @rtype: number
 
50
    @return: the vlanId
 
51
    """
 
52
    pass
 
53
def network_mask():
 
54
    """
 
55
    Get current host network_mask
 
56
    @rtype: number
 
57
    @return: the network mask
 
58
    """
 
59
    pass
 
60
def hwModel():
 
61
    """
 
62
    Get hwModel of the current host
 
63
    @rtype: string
 
64
    @return: the hardware model or empy string if no info
 
65
    """
 
66
    pass
 
67
def isHostResolvedNameType(type):
 
68
    """
 
69
    Check if the host matches the specified type
 
70
    @type type: number
 
71
    @param type: the type of the host resolved name to check
 
72
    @rtype: boolean
 
73
    @return: true if the host resolved name is of type type, false otherwise
 
74
    """
 
75
    pass
 
76
def isFTPhost():
 
77
    """
 
78
    Check FTP Host
 
79
    @rtype: boolean
 
80
    @return: true if the current host is ftp, false otherwise
 
81
    """
 
82
    pass
 
83
def isServer():
 
84
    """
 
85
    Check isServer
 
86
    @rtype: boolean
 
87
    @return: true if the current host is a Server, false otherwise
 
88
    """
 
89
    pass
 
90
def isWorkstation():
 
91
    """
 
92
    Check isWorkstation Host
 
93
    @rtype: boolean
 
94
    @return: true if the current host is a workstation, false otherwise
 
95
    """
 
96
    pass
 
97
def isMasterBrowser():
 
98
    """
 
99
    Check isMasterBrowser Host
 
100
    @rtype: boolean
 
101
    @return: true if the current host is a Master Browser, false otherwise
 
102
    """
 
103
    pass
 
104
def isMultihomed():
 
105
    """
 
106
    Check isMultihomed Host
 
107
    @rtype: boolean
 
108
    @return: true if the current host is multihomed, false otherwise
 
109
    """
 
110
    pass
 
111
def isMultivlaned():
 
112
    """
 
113
    Check isMultivlaned Host
 
114
    @rtype: boolean
 
115
    @return: true if the current host is multilaned, false otherwise
 
116
    """
 
117
    pass
 
118
def isPrinter():
 
119
    """
 
120
    Check isPrinter Host
 
121
    @rtype: boolean
 
122
    @return: true if the current host is a printer, false otherwise
 
123
    """
 
124
    pass
 
125
def isSMTPhost():
 
126
    """
 
127
    Check isSMTPhost Host
 
128
    @rtype: boolean
 
129
    @return: true if the current host is a smtp host, false otherwise
 
130
    """
 
131
    pass
 
132
def isPOPhost():
 
133
    """
 
134
    Check isPOPhost Host
 
135
    @rtype: boolean
 
136
    @return: true if the current host is a pop host, false otherwise
 
137
    """
 
138
    pass
 
139
def isIMAPhost():
 
140
    """
 
141
    Check isIMAPhost Host
 
142
    @rtype: boolean
 
143
    @return: true if the current host is an imap host, false otherwise
 
144
    """
 
145
    pass
 
146
def isDirectoryHost():
 
147
    """
 
148
    Check isDirectoryHost Host
 
149
    @rtype: boolean
 
150
    @return: true if the current host is a directory host, false otherwise
 
151
    """
 
152
    pass
 
153
 
 
154
def isHTTPhost():
 
155
    """
 
156
    Check isHTTPhost Host
 
157
    @rtype: boolean
 
158
    @return: true if the current host is an http host, false otherwise
 
159
    """
 
160
    pass
 
161
def isWINShost():
 
162
    """
 
163
    Check isWINShost Host
 
164
    @rtype: boolean
 
165
    @return: true if the current host is a wins host, false otherwise
 
166
    """
 
167
    pass
 
168
def isBridgeHost():
 
169
    """
 
170
    Check isBridgeHost Host
 
171
    @rtype: boolean
 
172
    @return: true if the current host is a bridge, false otherwise
 
173
    """
 
174
    pass
 
175
def isVoIPClient():
 
176
    """
 
177
    Check isVoIPClient Host
 
178
    @rtype: boolean
 
179
    @return: true if the current host is a voip client host, false otherwise
 
180
    """
 
181
    pass
 
182
def isVoIPGateway():
 
183
    """
 
184
    Check isVoIPGateway Host
 
185
    @rtype: boolean
 
186
    @return: true if the current host is a voip gateway, false otherwise
 
187
    """
 
188
    pass
 
189
def isVoIPHost():
 
190
    """
 
191
    Check isVoIPHost Host
 
192
    @rtype: boolean
 
193
    @return: true if the current host is a voip host, false otherwise
 
194
    """
 
195
    pass
 
196
 
 
197
def isDHCPClient():
 
198
    """
 
199
    Check isDHCPClient Host
 
200
    @rtype: boolean
 
201
    @return: true if the current host is a dhcp client, false otherwise
 
202
    """
 
203
    pass
 
204
def isDHCPServer():
 
205
    """
 
206
    Check isDHCPServer Host
 
207
    @rtype: boolean
 
208
    @return: true if the current host is a dhcp server, false otherwise
 
209
    """
 
210
    pass
 
211
def isP2P():
 
212
    """
 
213
    Check isP2P Host
 
214
    @rtype: boolean
 
215
    @return: true if the current host is a p2p host, false otherwise
 
216
    """
 
217
    pass
 
218
def isNtpServer():
 
219
    """
 
220
    Check isNtpServer Host
 
221
    @rtype: boolean
 
222
    @return: true if the current host is a ntp server, false otherwise
 
223
    """
 
224
    pass
 
225
def totContactedSentPeers():
 
226
    """
 
227
    Check totContactedSentPeers Host
 
228
    @rtype: number
 
229
    @return: the number of the total contacted sent peers
 
230
    """
 
231
    pass
 
232
def totContactedRcvdPeers():
 
233
    """
 
234
    Check totContactedRcvdPeers Host
 
235
    @rtype: number
 
236
    @return: the number of the total contacted received peers
 
237
    """
 
238
    pass
 
239
def fingerprint():
 
240
    """
 
241
    Check fingerprint Host
 
242
    @rtype: string
 
243
    @return: the fingerprint of the current host or empty string if none
 
244
    """
 
245
    pass
 
246
def synPktsSent():
 
247
    """
 
248
    Check synPktsSent Host
 
249
    @rtype: number
 
250
    @return: the number of syn packets sent by the current host
 
251
    """
 
252
    pass
 
253
def pktSent():
 
254
    """
 
255
    Return the number of packets sent by this host
 
256
    @rtype: number
 
257
    @return: the number packets sent
 
258
    """
 
259
    pass
 
260
def pktRcvd():
 
261
    """
 
262
    Return the number of packets rcvd by this host
 
263
    @rtype: number
 
264
    @return: the number of packets received
 
265
    """
 
266
    pass
 
267
def bytesSent():
 
268
    """
 
269
    Return the number of bytes sent by this host
 
270
    @rtype: number
 
271
    @return: the number of bytes sent
 
272
    """
 
273
    pass
 
274
def bytesRcvd():
 
275
    """
 
276
    Return the number of bytes rcvd by this host
 
277
    @rtype: number
 
278
    @return: the number of bytes received
 
279
    """
 
280
    pass
 
281
def sendThpt(type):
 
282
    """
 
283
    Return the send throughput
 
284
    @type type: string
 
285
    @param type: actual average peak the type of the sent throughput to get
 
286
    @rtype: number
 
287
    @return: the number of bytes of the sent throughput of type type
 
288
    """
 
289
    pass
 
290
def receiveThpt(type):
 
291
    """
 
292
    Return the receive throughput
 
293
    @type type: string
 
294
    @param type: actual average peak the type of the received throughput to get
 
295
    @rtype: number
 
296
    @return: the number of bytes of the received throughput of type type
 
297
    """
 
298
def geoIP():
 
299
    """
 
300
    Read geoLocalization info from GeoCityLite and return them
 
301
    @rtype: dictionary
 
302
    @return: a dictionary {'country_code':string,'country_name':string, 'region':string, 'city': string, 'latitude': number float, 'longitude': number float } 
 
303
            with all the geoLocation info retrieved by GeoCityLite for the current host    
 
304
    """