Easy Mobile User License Tool - Replaces "dtps lic"

[HeikoAnkenbrand]

Introduction

In the past days I have been working on a CLI script that can display all Secure Client, SSL VPN  and Mobile Access Portal license information centrally. This script creates a new command on the management server to read the licenses. It displays all Secure Client, SSL VPN and Mobile Access Portal licenses in total (sum). Furthermore if a connection to the gateway can be established, it can read out the currently used user counters and peaks on the gateway. It replaces the old "dtps lic" tool.

This tool checks the following licenses and user counters central on the SMS:

- Secure Client

- SSL VPN

- Mobile Access Portal

Or use this one-liner to show quick and easy a  summary of all available  licensses  on the management server: One-liner for Remote Access VPN License Summary 

Description

If you execute the script via "copy and past" on the management server or start the auto install script, a new CLI command "sclic" is created. Afterwards you can use this command to display all licenses in an overview. If you give this CLI command "sclic" the IP address of the gateway, the current data of the gateway will be read. You have to use the IP address of the gateway from the topology. All available gateways from the topology can be displayed with the option -g.

Note:
- Eval licenses are not displayed.
- It doesn't currently work with VSX systems but I am working on it.
- Please note that the execution of the command may take a few seconds. This is a normal behaviour.

Syntax	Description
sclic -g	The option -g shows all possible remote gateways from the topology (for option <remote gateway ip address>)
sclic - s <remote gateway ip address>	The option -s shows the number of logged in users and the peak value of the gateway for Secure Client, SSLVPN, Mobile Access Portal. Furthermore, existing licenses on the management server are displayed for Secure Client and SSLVPN. IP address of the gateway from the topology (which is used to connect the gateway from/to the management)
sclic -r <remote gateway ip address>	The option -r shows the full license informations from a remote gateway.
sclic -m	The option -m shows the full license informations from the SMS
sclic	Shows the available Secure Client, SSL VPN  and Mobile Access Portal licenses summary on the management server.

Example

# sclic - s 192.168.1.1

# sclic -g 

# sclic -r 192.168.1.2

Install this script

Use this auto installer script on the management server as CLI command:

curl_cli -k http://www.ankenbrand24.de/inst_sclic > /tmp/inst_sclic && chmod 770 /tmp/inst_sclic && /tmp/inst_sclic

Or "copy and past" the following script block to your management server:

cat <<EOT > /usr/local/bin/sclic
#!/bin/bash
printf '%.s-' {1..78};echo;
echo '- Mobile User License Tool v1.0            - Copyright Heiko Ankenbrand 2020 -';
printf '%.s-' {1..78};echo;
SHOW_SUM="1";

mSITIONAL=()
while [[ \$# -gt 0 ]]
do
key="\$1"
case \$key in
    -g|--gateways)
       shift # past argument
       echo;echo 'Gateways from topology:';echo;
       mgmt_cli -r true show gateways-and-servers details-level full --format json | \$CPDIR/jq/jq -r '.objects[] | select(.type | contains("Member","simple-gateway")) | ."ipv4-address",."name"  ' |xargs -n 2 | grep -v 0.0.0. | awk '{print \$1 "\t\t" \$2}' ;
       echo;printf '%.s-' {1..78};echo;
       SHOW_SUM="0";
    ;;

    -m|--management)
       shift # past argument
       echo;echo "Licenses on management server:";echo;
       cplic print;
       printf '%.s-' {1..78};echo;
       SHOW_SUM="0";
    ;;


    -r|--remote)
       REMOTEIP="\$2"
       shift # past argument
       shift # past value
       $CPDIR/bin/cprid_util -server \$REMOTEIP -verbose rexec -rcmd bash -c 'cplic print' > /tmp/cplic_print_lic.txt ;
       if [ ! -s /tmp/cplic_print_lic.txt ]
       then
       echo;echo 'This IP is not from a gateway. Use the option "sclic -g" to show all gateways.';echo;
       else
       echo; echo -n "Licenses on gateway "; echo -n \$REMOTEIP;echo ":";echo;
       more /tmp/cplic_print_lic.txt
       echo;
       fi
       printf '%.s-' {1..78};echo;
       SHOW_SUM="0";
    ;;

    -s|--summary)
       REMOTEIP="\$2"
       shift # past argument
       shift # past value       
       $CPDIR/bin/cprid_util -server \$REMOTEIP -verbose rexec -rcmd bash -c 'fw tab -t userc_users -s' |grep localhost > /tmp/sclic.txt ;
       if [ ! -s /tmp/sclic.txt ]
       then
       echo;echo 'This IP is not from a gateway. Use the option "sclic -g" to show all gateways.';
       else
       $CPDIR/bin/cprid_util -server \$REMOTEIP -verbose rexec -rcmd bash -c 'fw tab -t sslt_om_ip_params -s' |grep localhost > /tmp/snxlic.txt ;
       $CPDIR/bin/cprid_util -server \$REMOTEIP -verbose rexec -rcmd bash -c 'fw tab -t cvpn_session -s' |grep localhost > /tmp/moblic.txt ;
       echo;
       echo; echo -n "User counters on gateway "; echo -n \$REMOTEIP;echo ":";echo;
       echo -n '  Endpoint Security VPN (SecureClient) now on the gateway    : ';
       more /tmp/sclic.txt | awk {'print \$4'};
       echo -n '  Endpoint Security VPN users on the gateway (peak)          : ';
       more /tmp/sclic.txt | awk {'print \$5'};
       fi
       if [ ! -s /tmp/snxlic.txt ]
       then
       echo -n '';
       else
       echo -n '  SNX (SSL VPN not MOB) users now on the gateway             : ';
       more /tmp/snxlic.txt | awk {'print \$4'};
       echo -n '  SNX (SSLVPN not MOB) users on the gateway (peak)           : ';
       more /tmp/snxlic.txt | awk {'print \$5'};
       fi
       if [ ! -s /tmp/moblic.txt ]
       then
       echo -n '';
       else
       echo -n '  Mobile Access Portal users now on the gateway              : ';
       more /tmp/moblic.txt | awk {'print \$4'};
       echo -n '  Mobile Access Portal users on the gateway (peak)           : ';
       more /tmp/moblic.txt | awk {'print \$5'};
       fi
       echo;
       printf '%.s-' {1..78};echo;
       SHOW_SUM="1";
    ;;


    *)    # unknown option
    #echo "Unbekannt"
    POSITIONAL+=("\$1") # save it in an array for later
    shift # past argument
    SHOW_SUM="1";
    ;;

esac
done


if [ \$SHOW_SUM == "1" ] 
then
    echo;echo  'Remote Access Licenses on SMS:';echo;
    echo -n '  Endpoint Security VPN (SecureClient)  (CPVP-VSC-5-NGX-XXX) : ';
    cplic print |grep never | grep -o -E 'CPVP-VSC-5-NGX\+.*' |sed 's/CPVP-VSC-5-NGX+//g' |awk '{ total = total + \$1 } END { print total }';
    echo -n '  Endpoint Security VPN (SecureClient)  (CPVP-VSC-XXX-NGX)   : ';
    cplic print |grep never |grep -v 'CPVP-VSC-5-NGX\+' |grep -o -E 'CPVP-VSC-.*NGX' | sed 's/CPVP-VSC-//g' | sed 's/-NGX//g' | awk '{ total = total+ \$1 } END { print total }'
    echo -n '  SNX (not MOB)                         (CPVP-SNX-XXX-NGX)   : ';
    cplic print |grep never | grep SNX | sed 's/.*\sCPVP\-SNX\-//' | sed 's/\-NGX.*//' |awk '{ total2 = total2 + \$1 } END { print total2 }'
    echo -n '  Mobile Access Blade                   (CPSB-SSLVPN-XXX)    : ';
    cplic print |grep never | grep SSLVPN | sed 's/.*\sCPSB\-SSLVPN\-//' | awk '{ total3 = total3 + \$1 } END { print total3 }'
    # printf '%.s-' {1..78};echo;
    echo;echo 'User Center keys: ';echo;
    echo '  Endpoint Security VPN (SecureClient): ';
    cplic print |grep never | grep 'CPVP-VSC-' | grep -o -E 'SWB CK-............'| awk '{print \$2}' |sed 's/CK-//g' | awk '{print "    " \$1}'; 
    echo '  SNX: '; 
    cplic print |grep never | grep 'CPVP-SNX-' | sed 's/.*\sCK-//' | awk '{print "    " \$1}'; 
    echo '  MOB: ';
    cplic print |grep never | grep 'CPSB-SSLVPN-' | sed 's/.*\sCK-//' | awk '{print "    " \$1}'; 
    echo;printf '%.s-' {1..78};echo;
fi

EOT
chmod 770 /usr/local/bin/sclic

More "Easy Tools"

- Easy Backup Tool - (migrate export + all GAIA configs)                   -> Easy backup of all gateway GAIA configs + migrate export with one CLI command.
- Easy execute CLI commands on all gateways simultaneously        ->  Now you can use the new command to execute bash or clish commands on all gateway simultaneously.
- Easy execute CLI commands from management on gateways        -> Easy execute CLI commands from management on gateways
- Mobile User License Tool - replaced "dtps lic"                                   -> It displays all Secure Client, SSL VPN and Mobile Access Portal licenses in total (sum) on the SMS.
- Easy View Tool - (system infos from all gateways simultaneously) -> This toll shows you quickly an overview of status information of all your gateways with only one CLI command.

Version

0.1    03-15-2020    -      oneliner to show Secure Client licenses
0.2    03-17-2020    -      create "sclic" tool as script
0.3    03-19-2020    -      add remote user check on the gateway
0.4    03-20-2020    -      add SNX licenses and MOB licenses,   renamed to "Mobile User License Tool"
0.5    03-21-2020    -      option -g shows all gateways from topology
         03-22-2020    -      add auto installer one-liner
0.6    03-23-2020    -      add parameters -m, -s, -r, -g;
                                         option -r show full remote gateway licenses
                                         option -m show  full SMS licenses
                                         option -g shows remote IP and gateway name from topology

1.0    03-29-2020    -     bug fixed

[Harry_Morgan]

Hi @HeikoAnkenbrand,

This is a very nice solution and it works great.

[Jan_Elbers]

Hi @HeikoAnkenbrand 

I have another Suggestion. You could also include the used office mode IP addresses:-)

fw tab -t om_assigned_ips -s

Regards

Jan

[MattElkington]

I'm not sure this will always work.

I have encountered Endpoint licenses with the key format "CPVP-VSC-25-NGX" instead of "CPVP-VSC-5-NGX+30", and your one line specifically search for "CPVP-VSC-5-NGX+"

For instance (anonymised, but from an actual manager):

1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-5-NGX+100 CPEP-SUBSCR CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-5-NGX+30 CPEP-SUBSCR CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-25-NGX CPEP-PERP CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-25-NGX CPEP-PERP CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-5-NGX+10 CPEP-PERP CPSB-SWB CK-1ABCD123A123 

Notice the two CPVP-VSC-25-NGX licenses.  They're weird static Endpoint container licenses from days of yore. It's a 25 endpoint container with a 25 user count that is welded into the container.

Your one liner will report 140 licenses, buts it's actually 190. 

See my other post for some interesting musings on endpoint licenses and how they are actually enforced.

[HeikoAnkenbrand]

I will extend the script.

[HeikoAnkenbrand]

Hi @MattElkington,

THX for the information. I have modified the scripts accordingly. Can you test it again.

Regards

Heiko

[MattElkington]

Hi @HeikoAnkenbrand , thanks, I gave it a test and it didn't show any up.

Secure Client licenses (CPVP-VSC-5-NGX): 140
Secure Client licenses (CPVP-VSC-25-NGX):

I think you're not checking the string correctly.

With CPVP-VSC-25-NGX it's the 25 which changes to reflect the number of seats, so you can't check for CPVP-VSC-25-NGX, as there probably exist CPVP-VSC-50-NGX and CPVP-VSC-100-NGX out there.

My regex skills aren't good enough to work out how to extract just the 25/50/100 out of the string.  I would assume something like "CPVP-VSC-[0-9]+-NGX \b".

If you put the following into a text file and replace the "cplic print" with "cat textfile" you can test it out yourself:

1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-5-NGX+100 CPEP-SUBSCR CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-5-NGX+30 CPEP-SUBSCR CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-25-NGX CPEP-PERP CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-25-NGX CPEP-PERP CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-5-NGX+10 CPEP-PERP CPSB-SWB CK-1ABCD123A123

[HeikoAnkenbrand]

It works fine with your textfile:-)

[Expert]# cat test.txt |grep never | grep -o -E "CPVP-VSC-25-NGX|CPVP-VSC-50-NGX|CPVP-VSC-100-NGX" | sed 's/CPVP-VSC-//g' | sed 's/-NGX//g' | awk '{ total1 = total1 + $1 } END { print total1 }'

50

I can see the 50 CPVP-VSC-25-NGX licenses.

[MattElkington]

echo -n "Secure Client licenses (CPVP-VSC-5-NGX+xx): "; cplic print |grep never | grep -v -E "CPVP-VSC-[0-9]+-NGX " |grep -o -E "CPVP-VSC-5-NGX+........" |sed 's/CPVP-VSC-5-NGX+//g' |awk '{ total = total + $1 } END { print total }'; echo -n "Secure Client licenses (CPVP-VSC-xx-NGX): "; cplic print |grep never | grep -o -E "CPVP-VSC-[0-9]+-NGX " | sed 's/CPVP-VSC-//g' | sed 's/-NGX//g' | awk '{ total1 = total1 + $1 } END { print total1 }' ; echo "User Center Key:"; cplic print |grep never | grep "CPVP-VSC-" | grep -o -E "SWB CK-............"| awk '{print $2}' |sed 's/CK-//g'

I modified your's slight so it can deal with arbitrary license values:

cat test.txt |grep never | grep -o -E "CPVP-VSC-[0-9]+-NGX " | sed 's/CPVP-VSC-//g' | sed 's/-NGX//g' | awk '{ total1 = total1 + $1 } END { print total1 }'
175

the [0-9]+ matches one or more numbers, plus the space after NGX means that it won't accidentally count CPVP-VSC-5-NGX+yy ones.

I updated the cplic test file to the below to validate

1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-5-NGX+100 CPEP-SUBSCR CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-5-NGX+30 CPEP-SUBSCR CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-25-NGX CPEP-PERP CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-25-NGX CPEP-PERP CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-5-NGX+10 CPEP-PERP CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-50-NGX CPEP-PERP CPSB-SWB CK-1ABCD123A123
1.2.3.4        never       CPVP-VPS-1-NGX CPVP-VSC-75-NGX CPEP-PERP CPSB-SWB CK-1ABCD123A123

[Expert@FWMGMT01:0]# cat licensetest.txt |grep never | grep -o -E "CPVP-VSC-[0-9]+-NGX " | sed 's/CPVP-VSC-//g' | sed 's/-NGX//g' | awk '{ total1 = total1 + $1 } END { print total1 }'

175

Now we just need to get it shoved back into the one liner... 🙂

edit:

@HeikoAnkenbrand 

I modified your full one liner above to deal with brbitrary valuse for the "other" style.

echo -n "Secure Client licenses (CPVP-VSC-5-NGX+xx): "; cplic print |grep never | grep -v -E "CPVP-VSC-[0-9]+-NGX " |grep -o -E "CPVP-VSC-5-NGX+........" |sed 's/CPVP-VSC-5-NGX+//g' |awk '{ total = total + $1 } END { print total }'; echo -n "Secure Client licenses (CPVP-VSC-xx-NGX): "; cplic print |grep never | grep -o -E "CPVP-VSC-[0-9]+-NGX " | sed 's/CPVP-VSC-//g' | sed 's/-NGX//g' | awk '{ total1 = total1 + $1 } END { print total1 }' ; echo "User Center Key:"; cplic print |grep never | grep "CPVP-VSC-" | grep -o -E "SWB CK-............"| awk '{print $2}' |sed 's/CK-//g'

The output when I pass it across the license file as above is:

Secure Client licenses (CPVP-VSC-5-NGX): 140
Secure Client licenses (CPVP-VSC-25-NGX): 175
User Center Key:
1ABCD123A123
1ABCD123A123
1ABCD123A123
1ABCD123A123
1ABCD123A123
1ABCD123A123
1ABCD123A123

Which looks absolutely perfect to me.

Thanks so much for this, as I spent most of Monday this week counting bloody licenses in cplic prints.

[HeikoAnkenbrand]

Hi @MattElkington,

FYI:

I made a CLI command from the onliner.
You can now also check the used licenses on the gateway 🙂

Regards

Heiko

[HeikoAnkenbrand]

I found this on a license:

CPVP-VPS-1-NGX CPVP-VSC-25-NGX CPVP-VSC-5-NGX+25 CPEP-SUBSCR CPSB-SWB CK-XXXXXXXXXX

Hmmm

[mike123]

Hi @HeikoAnkenbrand,

nice tool!

Maybe you can also add SNX and MOB licenses.

Best Regards

Mike

[HeikoAnkenbrand]

Now for following:
- Secure Client licenses
- Mobile Access Portal licenses
- SSLVPN licenses

[sabil]

Hi @HeikoAnkenbrand, 

great job!

Best greetings
Sabil

[Fernando_Lopez]

Great Work!

Does it work for VSX?

Regards!

[HeikoAnkenbrand]

Hi @Fernando_Lopez 

I still have some ideas!

- Support for VSX will follow.
- Automatic detection of all gateways with a selection list

Regards
Heiko

[Arne_Boettger]

Hi,

is there any way to help you make it work with VSX?

I am asking because this would be very helpful for us.

Kind regards,

Arne

[Oliver_Fink]

Any progress regarding VSX?

[uror]

Hi @HeikoAnkenbrand,

The automatic installation is great, but you may need a firewall rule from SMS to internet.

[HeikoAnkenbrand]

New in v0.5:

- shows gateways from the topology (IP, gateway name) as list ( option -g)

- read endpoint VPN user statistics from gateway -> centralized from management server 

- now for Endpoint VPN User (old Secure Client), SSL VPN user and MOB user statistics

- now for Endpoint VPN- , SSL VPN- and MOB licenses

[Wolfgang]

@HeikoAnkenbrand 

how about including the VPN licenses coming with every SandBlast Agent license?

Wolfgang

[HeikoAnkenbrand]

Hi @Wolfgang.

THX - Is included in v0.5

[HeikoAnkenbrand · Accepted solution]

Now in v0.6 with new parameter and features:

Syntax	Description
sclic -g	The option -g shows all possible remote gateways from the topology (for option <remote gateway ip address>)
sclic - s <remote gateway ip address>	The option -s shows the number of logged in users and the peak value of the gateway for Secure Client, SSLVPN, Mobile Access Portal. Furthermore, existing licenses on the management server are displayed for Secure Client and SSLVPN. IP address of the gateway from the topology (which is used to connect the gateway from/to the management)
sclic -r <remote gateway ip address>	The option -r shows the full license informations from a remote gateway.
sclic -m	The option -m shows the full license informations from the SMS
sclic	Shows the available Secure Client, SSL VPN  and Mobile Access Portal licenses summary on the management server.

[Kleber_Castella]

great script, is it possible to include the percentage of CPU utilization of the gateway?

[libin]

Does this script is compatible in the MDS environment? 

[Martin_Raska]

Heiko, you are TOP as always :-), thanks for the script.

[marcinw]

Hi,

It doesn't work for me I run it from "curl_cli", at the end when I try run command "sclic" I get notification "command not found", admin has UID 0  if it is relevant. thank you for help 

Marcin

[_Val_]

First command downloads the script. Of course, if you cannot download it, you cannot then execute it either. 
To help you, @HeikoAnkenbrand added the script itself in the post, after these words:

Or "copy and past" the following script block to your management server...

[mmunford_5701]

Hi Heiko, 

In my environment, it does not count the VPN license units in the attached screenshot...

[Christian_Koehl]

Hello Heiko,

When running your one-liner to download and install the script, it is copied to /usr/local/bin. This location is not in $PATH.

It may be better located in /usr/bin as this location is in $PATH.

Best regards,

Christian