diff --git a/bin/ngcp-api_ping b/bin/ngcp-api_ping index 6091e1b..acb0c23 100755 --- a/bin/ngcp-api_ping +++ b/bin/ngcp-api_ping @@ -31,7 +31,6 @@ sub usage { my $missing = shift; pod2usage(-exitval => $missing ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $missing ? "Missing parameters: $missing" : '', ); return; @@ -66,53 +65,36 @@ __END__ ngcp-api_ping - check NGCP API status +=head1 SYNOPSIS + +B [I] + +=head1 DESCRIPTION + +B checks whether NGCP API is running. + =head1 OPTIONS =over 8 -=item B<-help> +=item B<--help> Print a brief help message. -=item B<-verbose> +=item B<--verbose> Show additional debug information. Default false. =back -=head1 USAGE - -ngcp-api_ping [options] - -=head1 DESCRIPTION - -B checks if NGCP API is running. - -=head1 REQUIRED ARGUMENTS - -None - =head1 EXIT STATUS Exit code 0 means everything is fine otherwise 1. -=head1 CONFIGURATION - -=head1 DIAGNOSTICS - =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-api_ping relies on a bunch of Perl modules, all of them specified as -dependencies through the ngcp-panel Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -122,7 +104,7 @@ Development Team . Victor Seva -=head1 LICENSE AND COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria diff --git a/bin/ngcp-create_customer b/bin/ngcp-create_customer index d7e4821..d915f5c 100755 --- a/bin/ngcp-create_customer +++ b/bin/ngcp-create_customer @@ -36,7 +36,6 @@ sub usage { my $missing = shift; pod2usage(-exitval => $missing ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $missing ? "Missing parameters: $missing" : '', ); return; @@ -68,50 +67,44 @@ __END__ ngcp-create_customer - create a customer -=head1 OPTIONS - -=over 8 +=head1 SYNOPSIS -=item B<-help> - -Print a brief help message. +B [I...] I... -=item B<-billing_profile_id> +=head1 DESCRIPTION -Billing profile id. +B creates a customer on the NGCP platform. -=item B<-contact_id> +=head1 REQUIRED ARGUMENTS -Contact id. +=over 8 -=item B<-type> +=item B<--billing_profile_id> -Customer can be one of the "sipaccount" or "pbxaccount" type. Defaults to -"sipaccount". +Billing profile id. -=item B<-verbose> +=item B<--contact_id> -Show additional debug information. Default false. +Contact id. =back -=head1 USAGE - -ngcp-create_customer [options] +=head1 OPTIONS -ngcp-create_customer --billing_profile_id 1 --contact_id 4 --type sipaccount +=over 8 -=head1 DESCRIPTION +=item B<--type> -B creates a customer on the NGCP platform. +Customer can be one of the "sipaccount" or "pbxaccount" type. Defaults to +"sipaccount". -=head1 REQUIRED ARGUMENTS +=item B<--verbose> -=over 8 +Show additional debug information. Default false. -=item B<-billing_profile_id> +=item B<--help> -=item B<-contact_id> +Print a brief help message. =back @@ -119,23 +112,10 @@ B creates a customer on the NGCP platform. Exit code 0 means everything is ok otherwise 1. -=head1 CONFIGURATION - -=head1 DIAGNOSTICS - =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-create_customer relies on a bunch of Perl modules, all of them specified as -dependencies through the Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -145,7 +125,7 @@ Development Team . Victor Seva -=head1 LICENSE AND COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria diff --git a/bin/ngcp-create_domain b/bin/ngcp-create_domain index 8209f73..18b54a1 100755 --- a/bin/ngcp-create_domain +++ b/bin/ngcp-create_domain @@ -44,7 +44,6 @@ sub usage { my $missing = shift; pod2usage(-exitval => $missing ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $missing ? "Missing parameters: $missing" : '', ); return; @@ -75,49 +74,49 @@ __END__ ngcp-create_domain - create an NGCP domain -=head1 OPTIONS +=head1 SYNOPSIS -=over 8 +B [I...] I... -=item B<-help> +=head1 DESCRIPTION -Print a brief help message. +B creates a domain on the NGCP platform. -=item B<-reseller_id> +=head1 REQUIRED ARGUMENTS -Reseller id. Default 1. +=over 8 -=item B<-skip_sip> +=item B<--domain> I -Skip reloading SIP services. If true, changes will not be effective immedeately -until the respective service is restarted or properly notified. Default false. +The domain to create. -=item B<-skip_xmpp> +=back -Skip reloading XMPP services. If true, changes will not be effective immedeately -until the respective service is restarted or properly notified. Default false. +=head1 OPTIONS -=item B<-verbose> +=over 8 -Show additional debug information. Default false. +=item B<--reseller_id> I -=back +Reseller id. Default 1. -=head1 USAGE +=item B<--skip_sip> -ngcp-create_domain [options] +Skip reloading SIP services. If true, changes will not be effective immedeately +until the respective service is restarted or properly notified. Default false. -ngcp-create_domain --domain example.org +=item B<--skip_xmpp> -=head1 DESCRIPTION +Skip reloading XMPP services. If true, changes will not be effective immedeately +until the respective service is restarted or properly notified. Default false. -B creates a domain on the NGCP platform. +=item B<--verbose> -=head1 REQUIRED ARGUMENTS +Show additional debug information. Default false. -=over 8 +=item B<--help> -=item B<-domain> +Print a brief help message. =back @@ -125,23 +124,10 @@ B creates a domain on the NGCP platform. Exit code 0 means everything is ok otherwise 1. -=head1 CONFIGURATION - -=head1 DIAGNOSTICS - =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-create_domain relies on a bunch of Perl modules, all of them specified as -dependencies through the Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -151,7 +137,7 @@ Development Team . Victor Seva -=head1 LICENSE AND COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria diff --git a/bin/ngcp-create_subscriber b/bin/ngcp-create_subscriber index 4071cb8..b5962c1 100755 --- a/bin/ngcp-create_subscriber +++ b/bin/ngcp-create_subscriber @@ -41,7 +41,6 @@ sub usage { my $msg = shift; pod2usage(-exitval => $msg ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $msg ? $msg =~ /not found/i ? $msg @@ -90,84 +89,74 @@ __END__ ngcp-create_subscriber - create a subscriber -=head1 OPTIONS +=head1 SYNOPSIS -=over 8 +B [I...] I... -=item B<-help> +=head1 DESCRIPTION -Print a brief help message. +B creates a subscriber on the NGCP platform. -=item B<-customer_id> +=head1 REQUIRED ARGUMENTS + +=over 8 + +=item B<--customer_id> I An existing customer id to assign this subscriber to. -=item B<-username|u> +=item B<-u>, B<--username> I A SIP username. -=item B<-domain|d> +=item B<-d>, B<--domain> I An existing domain for the new subscriber. -=item B<-password|p> +=item B<-p>, B<--password> I An unencrypted SIP password for the new subscriber. -=item B<-webpassword|w> +B using this option is a security hole, as it will be visible to +other users at least from the /proc filesystem. + +=item B<-w>, B<--webpassword> I An unencrypted web password for the new subscriber. -=item B<-cc|c> +B using this option is a security hole, as it will be visible to +other users at least from the /proc filesystem. + +=item B<-c>, B<--cc> I A country code part of the subscriber's number. -=item B<-ac|a> +=item B<-a>, B<--ac> I An area code part of the subscriber's number. -=item B<-number|n> +=item B<-n>, B<--sn> I A local number part of the subscriber's number. -=item B<-admin|s> - -Set the administrative flag for the new subscriber. -Defaults to 0 (no). - -=item B<-verbose> - -Show additional debug information. Default false. - =back -=head1 USAGE - -ngcp-create_subscriber [options] - -ngcp-create_subscriber --customer_id 1 --username 4311101 --domain sipwise.com --password SecurePassword1 --cc 43 --ac 111 --sn 01 - -=head1 DESCRIPTION - -B creates a subscriber on the NGCP platform. - -=head1 REQUIRED ARGUMENTS +=head1 OPTIONS =over 8 -=item B<-customer_id> +=item B<-s>, B<--admin> -=item B<-username> - -=item B<-domain> +Set the administrative flag for the new subscriber. +Defaults to 0 (no). -=item B<-password> +=item B<--verbose> -=item B<-cc> +Show additional debug information. Default false. -=item B<-ac> +=item B<--help> -=item B<-sn> +Print a brief help message. =back @@ -175,23 +164,10 @@ B creates a subscriber on the NGCP platform. Exit code 0 means everything is ok otherwise 1. -=head1 CONFIGURATION - -=head1 DIAGNOSTICS - =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-create_customer relies on a bunch of Perl modules, all of them specified as -dependencies through the Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -201,7 +177,7 @@ Development Team . Victor Seva -=head1 LICENSE AND COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria diff --git a/bin/ngcp-credit-warning b/bin/ngcp-credit-warning index 30137ff..57274d1 100755 --- a/bin/ngcp-credit-warning +++ b/bin/ngcp-credit-warning @@ -40,7 +40,6 @@ sub usage { my $msg = shift; pod2usage(-exitval => $msg ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $msg ? $msg =~ /not found/i ? $msg @@ -159,53 +158,37 @@ __END__ ngcp-credit-warning - checks for contract balances above credit warning thresholds -=head1 OPTIONS - -=over 8 +=head1 SYNOPSIS -=item B<-help> - -Print a brief help message. +B [I...] -=item B<-verbose> +=head1 DESCRIPTION -Show additional debug information. Default false. +B checks for contract balances above credit warning thresholds +and sends email notifications about the incidents. -=back +=head1 OPTIONS -=head1 USAGE +=over 8 -ngcp-credit-warning [options] +=item B<--verbose> -=head1 DESCRIPTION +Show additional debug information. Default false. -B checks for contract balances above credit warning thresholds and sends email notifications about the incidents +=item B<--help> -=head1 REQUIRED ARGUMENTS +Print a brief help message. -None +=back =head1 EXIT STATUS Exit code 0 means everything is ok otherwise 1. -=head1 CONFIGURATION - -=head1 DIAGNOSTICS - =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-credit-warning relies on a bunch of Perl modules, all of them specified as -dependencies through the Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -215,7 +198,7 @@ Development Team . Kirill Solomko -=head1 LICENSE AND COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria diff --git a/bin/ngcp-delete_domain b/bin/ngcp-delete_domain index 7c92bd3..c3b0825 100755 --- a/bin/ngcp-delete_domain +++ b/bin/ngcp-delete_domain @@ -37,7 +37,6 @@ sub usage { my $msg = shift; pod2usage(-exitval => $msg ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $msg ? $msg =~ /not found/i ? $msg @@ -86,45 +85,45 @@ __END__ ngcp-delete_domain - delete an NGCP domain -=head1 OPTIONS +=head1 SYNOPSIS -=over 8 +B [I...] I... -=item B<-help> +=head1 DESCRIPTION -Print a brief help message. +B deletes a domain on the NGCP platform. -=item B<-skip_sip> +=head1 REQUIRED ARGUMENTS -Skip reloading SIP services. If true, changes will not be effective immedeately -until the respective service is restarted or properly notified. Default false. +=over 8 -=item B<-skip_xmpp> +=item B<--domain> I -Skip reloading XMPP services. If true, changes will not be effective immedeately -until the respective service is restarted or properly notified. Default false. +The domain name to delete. -=item B<-verbose> +=back -Show additional debug information. Default false. +=head1 OPTIONS -=back +=over 8 -=head1 USAGE +=item B<--skip_sip> -ngcp-delete_domain [options] +Skip reloading SIP services. If true, changes will not be effective immedeately +until the respective service is restarted or properly notified. Default false. -ngcp-delete_domain --domain example.org +=item B<--skip_xmpp> -=head1 DESCRIPTION +Skip reloading XMPP services. If true, changes will not be effective immedeately +until the respective service is restarted or properly notified. Default false. -B deletes a domain on the NGCP platform. +=item B<--verbose> -=head1 REQUIRED ARGUMENTS +Show additional debug information. Default false. -=over 8 +=item B<--help> -=item B<-domain> +Print a brief help message. =back @@ -132,23 +131,10 @@ B deletes a domain on the NGCP platform. Exit code 0 means everything is ok otherwise 1. -=head1 CONFIGURATION - -=head1 DIAGNOSTICS - =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-delete_domain relies on a bunch of Perl modules, all of them specified as -dependencies through the Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -158,7 +144,7 @@ Development Team . Victor Seva -=head1 LICENSE AND COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria diff --git a/bin/ngcp-fraud-auto-lock b/bin/ngcp-fraud-auto-lock index b13270a..3f86824 100755 --- a/bin/ngcp-fraud-auto-lock +++ b/bin/ngcp-fraud-auto-lock @@ -41,7 +41,6 @@ sub usage { my $msg = shift; pod2usage(-exitval => $msg ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $msg ? $msg =~ /not found/i ? $msg @@ -205,55 +204,36 @@ ngcp-fraud-auto-lock - checks for contract balances above fraud limit thresholds =head1 SYNOPSIS -ngcp-fraud-daily-lock +B [I...] -=head1 OPTIONS +=head1 DESCRIPTION -=over 8 +B checks for contract balances above fraud limit warning +thresholds and sends email notifications about the incidents as applying +actions on such contracts (e.g. lock). Interval: 'month'. -=item B<-help> +=head1 OPTIONS -Print a brief help message. +=over 8 -=item B<-verbose> +=item B<--verbose> Show additional debug information. Default false. -=back - -=head1 USAGE - -ngcp-fraud-auto-lock [options] - -=head1 DESCRIPTION - -B checks for contract balances above fraud limit warning thresholds and sends email notifications about the incidents as applying actions on such contracts (e.g. lock). Interval: 'month' +=item B<--help> -=head1 REQUIRED ARGUMENTS +Print a brief help message. -None +=back =head1 EXIT STATUS Exit code 0 means everything is ok otherwise 1. -=head1 CONFIGURATION - -=head1 DIAGNOSTICS - =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-fraud-auto-lock relies on a bunch of Perl modules, all of them specified as -dependencies through the Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -263,12 +243,10 @@ Development Team . Kirill Solomko -=head1 COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria -=head1 LICENSE - 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 diff --git a/bin/ngcp-fraud-daily-lock b/bin/ngcp-fraud-daily-lock index 2d73f2d..30071c8 100755 --- a/bin/ngcp-fraud-daily-lock +++ b/bin/ngcp-fraud-daily-lock @@ -41,7 +41,6 @@ sub usage { my $msg = shift; pod2usage(-exitval => $msg ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $msg ? $msg =~ /not found/i ? $msg @@ -205,55 +204,36 @@ ngcp-fraud-daily-lock - checks for contract balances above fraud limit threshold =head1 SYNOPSIS -ngcp-fraud-daily-lock +B [I...] -=head1 OPTIONS +=head1 DESCRIPTION -=over 8 +B checks for contract balances above fraud limit warning +thresholds and sends email notifications about the incidents as applying +actions on such contracts (e.g. lock). Interval: 'day'. -=item B<-help> +=head1 OPTIONS -Print a brief help message. +=over 8 -=item B<-verbose> +=item B<--verbose> Show additional debug information. Default false. -=back - -=head1 USAGE - -ngcp-fraud-daily-lock [options] - -=head1 DESCRIPTION - -B checks for contract balances above fraud limit warning thresholds and sends email notifications about the incidents as applying actions on such contracts (e.g. lock). Interval: 'day' +=item B<--help> -=head1 REQUIRED ARGUMENTS +Print a brief help message. -None +=back =head1 EXIT STATUS Exit code 0 means everything is ok otherwise 1. -=head1 CONFIGURATION - -=head1 DIAGNOSTICS - =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-fraud-daily-lock relies on a bunch of Perl modules, all of them specified as -dependencies through the Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -263,12 +243,10 @@ Development Team . Kirill Solomko -=head1 COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria -=head1 LICENSE - 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 diff --git a/bin/ngcp-get_customer b/bin/ngcp-get_customer index 6b78128..d5b203e 100755 --- a/bin/ngcp-get_customer +++ b/bin/ngcp-get_customer @@ -32,7 +32,6 @@ sub usage { my $missing = shift; pod2usage(-exitval => $missing ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $missing ? "Missing parameters: $missing" : '', ); return; @@ -63,63 +62,46 @@ __END__ ngcp-get_customer - retreives an NGCP Customer -=head1 OPTIONS +=head1 SYNOPSIS -=over 8 +B [I...] I... -=item B<-help> +=head1 DESCRIPTION -Print a brief help message. +B retreives a customer from the NGCP platform. -=item B<-customer_id> +=head1 REQUIRED ARGUMENTS -Customer id +=over 8 -=item B<-verbose> +=item B<--customer_id> I -Show additional debug information. Default false. +Customer id. =back -=head1 USAGE - -ngcp-get_customer [options] - -ngcp-get_customer --customer_id 11 +=head1 OPTIONS -=head1 DESCRIPTION +=over 8 -B retreives a customer from the NGCP platform. +=item B<--verbose> -=head1 REQUIRED ARGUMENTS +Show additional debug information. Default false. -=over 8 +=item B<--help> -=item B<-customer_id> +Print a brief help message. =back =head1 EXIT STATUS -Exit code 0 means everything is ok otherwise 1. - -=head1 CONFIGURATION - -=head1 DIAGNOSTICS +Exit code 0 means everything is ok, otherwise 1. =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-get_customer relies on a bunch of Perl modules, all of them specified as -dependencies through the Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -129,7 +111,7 @@ Development Team . Victor Seva -=head1 LICENSE AND COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria diff --git a/bin/ngcp-sound_set b/bin/ngcp-sound_set index 1eb2fc4..9479659 100755 --- a/bin/ngcp-sound_set +++ b/bin/ngcp-sound_set @@ -32,7 +32,6 @@ sub usage { my $missing = shift; pod2usage(-exitval => $missing ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $missing ? "Missing parameters: $missing" : '', ); return; @@ -63,39 +62,35 @@ __END__ ngcp-sound_set - retreives an NGCP Sound Set -=head1 OPTIONS +=head1 SYNOPSIS -=over 8 +B [I...] I... -=item B<-help> +=head1 DESCRIPTION -Print a brief help message. +B retreives a sound set from the NGCP platform. -=item B<-id> +=head1 REQUIRED ARGUMENTS -Sound set id +=over 8 -=item B<-verbose> +=item B<--id> I -Show additional debug information. Default false. +Sound set ID. =back -=head1 USAGE - -ngcp-sound_set [options] - -ngcp-sound_set --id 11 +=head1 OPTIONS -=head1 DESCRIPTION +=over 8 -B retreives a sound set from the NGCP platform. +=item B<--verbose> -=head1 REQUIRED ARGUMENTS +Show additional debug information. Default false. -=over 8 +=item B<--help> -=item B<-id> +Print a brief help message. =back @@ -103,23 +98,10 @@ B retreives a sound set from the NGCP platform. Exit code 0 means everything is ok otherwise 1. -=head1 CONFIGURATION - -=head1 DIAGNOSTICS - =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-sound_set relies on a bunch of Perl modules, all of them specified as -dependencies through the Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -129,7 +111,7 @@ Development Team . Victor Seva -=head1 LICENSE AND COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria diff --git a/bin/ngcp-terminate_customer b/bin/ngcp-terminate_customer index 66ddc76..556608e 100755 --- a/bin/ngcp-terminate_customer +++ b/bin/ngcp-terminate_customer @@ -32,7 +32,6 @@ sub usage { my $missing = shift; pod2usage(-exitval => $missing ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $missing ? "Missing parameters: $missing" : '', ); return; @@ -64,39 +63,35 @@ __END__ ngcp-terminate_customer - terminate an NGCP Customer -=head1 OPTIONS +=head1 SYNOPSIS -=over 8 +B [I...] I... -=item B<-help> +=head1 DESCRIPTION -Print a brief help message. +B terminates a customer on the NGCP platform. -=item B<-customer_id> +=head1 REQUIRED ARGUMENTS -Customer id +=over 8 -=item B<-verbose> +=item B<--customer_id> I -Show additional debug information. Default false. +Customer ID. =back -=head1 USAGE - -ngcp-terminate_customer [options] - -ngcp-terminate_customer --customer_id 11 +=head1 OPTIONS -=head1 DESCRIPTION +=over 8 -B terminates a customer on the NGCP platform. +=item B<--verbose> -=head1 REQUIRED ARGUMENTS +Show additional debug information. Default false. -=over 8 +=item B<--help> -=item B<-customer_id> +Print a brief help message. =back @@ -104,23 +99,10 @@ B terminates a customer on the NGCP platform. Exit code 0 means everything is ok otherwise 1. -=head1 CONFIGURATION - -=head1 DIAGNOSTICS - =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-terminate_customer relies on a bunch of Perl modules, all of them specified as -dependencies through the Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -130,7 +112,7 @@ Development Team . Victor Seva -=head1 LICENSE AND COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria diff --git a/bin/ngcp-terminate_subscriber b/bin/ngcp-terminate_subscriber index fcb59d3..efe10e5 100755 --- a/bin/ngcp-terminate_subscriber +++ b/bin/ngcp-terminate_subscriber @@ -33,7 +33,6 @@ sub usage { my $msg = shift; pod2usage(-exitval => $msg ? 1 : 0, -verbose => 99, - -sections => [ qw(NAME OPTIONS USAGE) ], -message => $msg ? $msg =~ /not found/i ? $msg @@ -84,45 +83,39 @@ __END__ ngcp-terminate_subscriber - terminate an NGCP Subscriber -=head1 OPTIONS +=head1 SYNOPSIS -=over 8 +B [I...] I... -=item B<-help> +=head1 DESCRIPTION -Print a brief help message +B terminates a subscriber on the NGCP platform. -=item B<-username> +=head1 REQUIRED ARGUMENTS -Subscriber username +=over 8 -=item B<-domain> +=item B<--username> I -Subscriber domain +Subscriber username. -=item B<-verbose> +=item B<--domain> I -Show additional debug information. Default false. +Subscriber domain. =back -=head1 USAGE - -ngcp-terminate_subscriber [options] - -ngcp-terminate_subscriber --username 431110001 --domain example.org - -=head1 DESCRIPTION +=head1 OPTIONS -B terminates a subscriber on the NGCP platform. +=over 8 -=head1 REQUIRED ARGUMENTS +=item B<--verbose> -=over 8 +Show additional debug information. Default false. -=item B<-username> +=item B<--help> -=item B<-domain> +Print a brief help message =back @@ -130,23 +123,10 @@ B terminates a subscriber on the NGCP platform. Exit code 0 means everything is ok otherwise 1. -=head1 CONFIGURATION - -=head1 DIAGNOSTICS - =head1 SEE ALSO NGCP::API::Client -=head1 DEPENDENCIES - -ngcp-terminate_subscriber relies on a bunch of Perl modules, all of them specified as -dependencies through the Debian package. - -=head1 INCOMPATIBILITIES - -No known at this time. - =head1 BUGS AND LIMITATIONS Please report problems you notice to the Sipwise @@ -156,7 +136,7 @@ Development Team . Victor Seva -=head1 LICENSE AND COPYRIGHT +=head1 LICENSE Copyright (C) 2016 Sipwise GmbH, Austria