summaryrefslogtreecommitdiff
path: root/doc/ztscan.8
blob: e03ddba0367c0a75a74f3f2b7c62e767c99465ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
.TH ztscan 8 "2008-03-18" 
.SH NAME 
ztscan \(em Print Configuration of Zaptel Spans
.SH SYNOPSIS 
.B ztscan
.I [spans]

.SH DESCRIPTION 
.B ztscan
prints information about zaptel spans in the system. For analog spans it
also provides a list of channels.

By default it prints information about all the spans in the system.
However if parameters are provided, they will be considered to be a list
of span numbers and information will be printed for them.

Output is printed to the standard output. The format is that of an
Asterisk configuration file (similar to a "ini" configuration file),
where the name of the section is the number of the span. Note that the
specifically for analog spans some keys may appear more than once, and
hence you can not use a parser for an "ini" format and assume you have a
dictionary.

.SH EXAMPLES
Printing information for spans 1, 2 and 4:

  ztspan 1 2 4

And to print all the spans:

  ztspan

Information about a certain analog span:

  [5]
  active=yes
  alarms=OK
  description=Xorcom XPD #00/10: FXS
  name=XBUS-00/XPD-10
  manufacturer=Xorcom Inc.
  devicetype=Astribank: Unit 1 Subunit 0: FXS
  location=usb-0000:00:03.3-4
  basechan=125
  totchans=8
  irq=0
  type=analog
  port=125,FXS
  port=126,FXS
  port=127,FXS
  port=128,FXS
  port=129,FXS
  port=130,FXS
  port=131,FXS
  port=132,FXS

And an example of a digital span:

  [1]
  active=yes
  alarms=RED
  description=T2XXP (PCI) Card 0 Span 1
  name=TE2/0/1
  manufacturer=Digium
  devicetype=Wildcard TE205P (4th Gen)
  location=Board ID Switch 0
  basechan=1
  totchans=24
  irq=193
  type=digital-T1
  syncsrc=0
  lbo=0 db (CSU)/0-133 feet (DSX-1)
  coding_opts=B8ZS,AMI
  framing_opts=ESF,D4
  coding=B8ZS
  framing=ESF

The "type" field may contain: "analog", "digital-T1", "digital-E1",
"digital-J1" or "digital-BRI".

.SH FILES
Requires read access to /dev/zap/ctl .

.SH SEE ALSO 
ztcfg(8), asterisk(8). 

.SH AUTHOR 

This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> 
Permission is granted to copy, distribute and/or modify this document under 
the terms of the GNU General Public License, Version 2 any  
later version published by the Free Software Foundation. 
 
On Debian systems, the complete text of the GNU General Public 
License can be found in /usr/share/common-licenses/GPL.