You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ngcp-api-tools/bin/ngcp-terminate-subscriber

174 lines
3.3 KiB

#!/usr/bin/perl
use strict;
use warnings;
use English;
use Getopt::Long;
use Pod::Usage;
use NGCP::API::Client;
use Readonly;
Readonly my @required => qw(username domain);
my $opts = {
verbose => 0,
};
GetOptions($opts,
'help|h' => sub { usage() },
'username=s',
'domain=s',
'verbose',
) or usage();
sub check_params {
my @missing;
foreach my $param (@required) {
push @missing, $param unless $opts->{$param};
}
usage(join(' ', @missing)) if scalar @missing;
return;
}
sub usage {
my $missing = shift;
pod2usage(
-exitval => $missing ? 1 : 0,
-verbose => 99,
-sections => 'SYNOPSIS|REQUIRED ARGUMENTS|OPTIONS',
-message => $missing ? "Missing parameters: $missing" : '',
);
return;
}
sub main {
check_params();
my $client = NGCP::API::Client->new(verbose => $opts->{verbose});
my $uri = sprintf '/api/subscribers/?username=%s&domain=%s',
@{$opts}{qw(username domain)};
my $sub = $client->request('GET', $uri);
my $sub_id;
if ($sub->as_hash->{total_count} == 1) {
my $tmp = $sub->as_hash->{_embedded}->{'ngcp:subscribers'};
if (ref $tmp eq 'ARRAY') {
$sub_id = @{$tmp}[0]->{id};
} else {
$sub_id = $tmp->{id};
}
die "Wrong subscriber id $sub_id found\n" unless $sub_id =~ /^\d$/;
} else {
die "Subscriber $opts->{username}\@$opts->{domain} not found\n";
}
$uri = '/api/subscribers/' . $sub_id;
my $data = [
{
op => 'replace',
path => '/status',
value => 'terminated',
},
];
my $res = $client->request('PATCH', $uri, $data);
print $res->result . "\n";
return !$res->is_success;
}
exit main();
__END__
=head1 NAME
ngcp-terminate-subscriber - terminate an NGCP Subscriber
=head1 SYNOPSIS
B<ngcp-terminate-subscriber> [I<options>...] I<required-arguments>...
=head1 DESCRIPTION
B<This program> terminates a subscriber on the NGCP platform.
=head1 REQUIRED ARGUMENTS
=over 8
=item B<--username> I<name>
Subscriber username.
=item B<--domain> I<domain>
Subscriber domain.
=back
=head1 OPTIONS
=over 8
=item B<--verbose>
Show additional debug information. Default false.
=item B<--help>
Print a brief help message
=back
=head1 EXIT STATUS
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO
NGCP::API::Client
=head1 BUGS AND LIMITATIONS
Please report problems you notice to the Sipwise
Development Team <support@sipwise.com>.
=head1 AUTHOR
Victor Seva <vseva@sipwise.com>
=head1 LICENSE
Copyright (C) 2016 Sipwise GmbH, Austria
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
=cut