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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
package FS::part_export::broadband_snmp;
use strict;
use vars qw(%info $DEBUG);
use base 'FS::part_export';
use Net::SNMP qw(:asn1 :snmp);
use Tie::IxHash;
$DEBUG = 0;
my $me = '['.__PACKAGE__.']';
tie my %snmp_version, 'Tie::IxHash',
v1 => 'snmpv1',
v2c => 'snmpv2c',
# 3 => 'v3' not implemented
;
tie my %snmp_type, 'Tie::IxHash',
i => INTEGER,
u => UNSIGNED32,
s => OCTET_STRING,
n => NULL,
o => OBJECT_IDENTIFIER,
t => TIMETICKS,
a => IPADDRESS,
# others not implemented yet
;
tie my %options, 'Tie::IxHash',
'version' => { label=>'SNMP version',
type => 'select',
options => [ keys %snmp_version ],
},
'community' => { label=>'Community', default=>'public' },
(
map { $_.'_command',
{ label => ucfirst($_) . ' commands',
type => 'textarea',
default => '',
}
} qw( insert delete replace suspend unsuspend )
),
'ip_addr_change_to_new' => {
label=>'Send IP address changes to new address',
type=>'checkbox'
},
'timeout' => { label=>'Timeout (seconds)' },
;
%info = (
'svc' => 'svc_broadband',
'desc' => 'Send SNMP requests to the service IP address',
'options' => \%options,
'weight' => 10,
'notes' => <<'END'
Send one or more SNMP SET requests to the IP address registered to the service.
Enter one command per line. Each command is a target OID, data type flag,
and value, separated by spaces.
The data type flag is one of the following:
<font size="-1"><ul>
<li><i>i</i> = INTEGER</li>
<li><i>u</i> = UNSIGNED32</li>
<li><i>s</i> = OCTET-STRING (as ASCII)</li>
<li><i>a</i> = IPADDRESS</li>
<li><i>n</i> = NULL</li></ul>
The value may interpolate fields from svc_broadband by prefixing the field
name with <b>$</b>, or <b>$new_</b> and <b>$old_</b> for replace operations.
The value may contain whitespace; quotes are not necessary.<br>
<br>
For example, to set the SNMPv2-MIB "sysName.0" object to the string
"svc_broadband" followed by the service number, use the following
command:<br>
<pre>1.3.6.1.2.1.1.5.0 s svc_broadband$svcnum</pre><br>
END
);
sub export_insert {
my $self = shift;
$self->export_command('insert', @_);
}
sub export_delete {
my $self = shift;
$self->export_command('delete', @_);
}
sub export_replace {
my $self = shift;
$self->export_command('replace', @_);
}
sub export_suspend {
my $self = shift;
$self->export_command('suspend', @_);
}
sub export_unsuspend {
my $self = shift;
$self->export_command('unsuspend', @_);
}
sub export_command {
my $self = shift;
my ($action, $svc_new, $svc_old) = @_;
my $command_text = $self->option($action.'_command');
return if !length($command_text);
warn "$me parsing ${action}_command:\n" if $DEBUG;
my @commands;
foreach (split /\n/, $command_text) {
my ($oid, $type, $value) = split /\s/, $_, 3;
$oid =~ /^(\d+\.)*\d+$/ or die "invalid OID '$oid'\n";
my $typenum = $snmp_type{$type} or die "unknown data type '$type'\n";
$value = '' if !defined($value); # allow sending an empty string
$value = $self->substitute($value, $svc_new, $svc_old);
warn "$me $oid $type $value\n" if $DEBUG;
push @commands, $oid, $typenum, $value;
}
my $ip_addr = $svc_new->ip_addr;
# ip address change: send to old address unless told otherwise
if ( defined $svc_old and ! $self->option('ip_addr_change_to_new') ) {
$ip_addr = $svc_old->ip_addr;
}
warn "$me opening session to $ip_addr\n" if $DEBUG;
my %opt = (
-hostname => $ip_addr,
-community => $self->option('community'),
-timeout => $self->option('timeout') || 20,
);
my $version = $self->option('version');
$opt{-version} = $snmp_version{$version} or die 'invalid version';
$opt{-varbindlist} = \@commands; # just for now
$self->snmp_queue( $svc_new->svcnum, %opt );
}
sub snmp_queue {
my $self = shift;
my $svcnum = shift;
my $queue = new FS::queue {
'svcnum' => $svcnum,
'job' => 'FS::part_export::broadband_snmp::snmp_request',
};
$queue->insert(@_);
}
sub snmp_request {
my %opt = @_;
my $varbindlist = delete $opt{-varbindlist};
my ($session, $error) = Net::SNMP->session(%opt);
die "Couldn't create SNMP session: $error" if !$session;
warn "$me sending SET request\n" if $DEBUG;
my $result = $session->set_request( -varbindlist => $varbindlist );
$error = $session->error();
$session->close();
if (!defined $result) {
die "SNMP request failed: $error\n";
}
}
sub substitute {
# double-quote-ish interpolation of service fields
# accepts old_ and new_ for replace actions, like shellcommands
my $self = shift;
my ($value, $svc_new, $svc_old) = @_;
foreach my $field ( $svc_new->fields ) {
my $new_val = $svc_new->$field;
$value =~ s/\$(new_)?$field/$new_val/g;
if ( $svc_old ) { # replace only
my $old_val = $svc_old->$field;
$value =~ s/\$old_$field/$old_val/g;
}
}
$value;
}
1;
|
