Zentitle SDK and Library
nalpControl (Command line daemon control):

nalpControl is a command line tool used to perform administrative functions on the Nalpeiron LAN daemon.

Daemon Parameters

Daemon parameters are parameters passed to the daemon at startup and control daemon behavior.

Daemon Parameters Type Description
DaemonLogLevel 0-4 Amount of info in daemon log (0 min - 4 max)
DaemonMaxLog int (bytes) Max length of daemon log before rollover
DaemonLogQLen uint Length of daemon log queue (if too small log
messages will be lost)
DaemonBackLog uint Number of connections allowed to wait in queue
DaemonPort uint Port number daemon listens on for clients
IOThMax/IOThMin uint Min and max number of threads in daemon IO pool
WorkThMax/WorkThMin uint Min and max number of threads in daemon work pool
DaemonProxyIP string IP address of intervening proxy
DaemonProxyPort uint Port number of intervening proxy
DaemonProxyPass string Password for intervening proxy
DaemonProxyUser string Username for intervening proxy

Control Parameters

Control parameters are parameters used directly by the nalpControl binary.

Control Parameters Type Description
ControlLogLevel 0 - 4 Amount of info in nalpControl log (0 min - 4 max)
ControlMaxLog int (bytes) Max length of nalpControl log before rollover
ControlLogQLen uint Length of nalpControl log queue
ControlUsername string username used by nalpControl to access daemon
ControlPassword string password used by nalpControl to access daemon
ControlDaemonIP string IP used by nalpControl to access daemon

Admin Parameters

Admin parameters are used to pass information about commands to the daemon.

Action Parameters Type Description
AddUserName string Username to be added to daemon
AddUserPass string Password to be added to daemon
LTCOExpTime epoch sec Expiration date of created LTCO
LTCOCompID string ComputerID used in LTCO creation
CustomerID number CustomerID of license
ProductID number ProductID of license
LicenseCode number Product license code
HeartBeatID string heartbeat ID
Certificate string Certificate or path to file with cert
DBType string daemondata or nsa
DataFile string path to file for analytics upload to Nalpeiron
DBStart int Start date of db command in epoch sec
DBEnd int End date of db command in epoch sec

nalpControl commands

NOTE in addition to the described parameters, nalpControl calls ALWAYS require ControlUsername and ControlPassword.

Commands Type Description
ReadConfig Read the daemon's config file
WriteConfig Write the daemon's config file
AddUser Add User to daemon
GetDaemonLicenseCode Get license code used with daemon's master license
GetDaemonLicenseSource Get information about the daemon's licensing source
GetDaemonVersion Get version of daemon
DeleteUser Delete user from daemon
GetHeartBeats Get list of active heartbeats
AddLicenseToDaemon Add a product license to daemon
GetDaemonCompID Get daemon's computerID
GetLicenseInfo Return information a specific license on daemon
ListLicenses Get list of licenses known to daemon
ListFeatures Returns all features/elements present in a license
Login Attempt to Login to daemon
GetFFInfo Get information about checkouts of floating features
CreateLTCO Create a Long Term CheckOut license. This license
exists for a fixed time period and is not required
to heartbeat to the daemon
DestroyLTCO Remove a Long Term CheckOut license.
RemoveClientLicense Revoke client license
RemoveLicenseFromDaemon Deletes a product license from the daemon.
GetDaemonTimeStamp Get current time (in epoch sec) from the daemon.
ListUsers Get list of known users from daemon.
GetActCertReq Get an offline activation request from the daemon.
GetDeactCertReq Get an offline deactivation request from the daemon.
ImportCertificate Import a certificate to the daemon for offline act.
GetEPoolInfo Get information about checkouts of an element pool.
ExportDB Export analytics data from db
ClearDB Clear data from db (must first be exported)
UploadData Upload analytics data to Nalpeiron
help Usage information from nalpControl.

nalpControl Examples

The following are examples of nalpControl usage.

/etc/nalpeiron/bin/nalpControl --ControlUsername admin --ControlPassword nalpeiron --Login

admin

/etc/nalpeiron/bin/nalpControl --ControlUsername admin --ControlPassword nalpeiron --CustomerID 3653 --ProductID 102 --GetLicenseInfo

1 <?xml version="1.0" encoding="UTF-8"?>
2 <DaemonInformation>
3  <licensesCheckedOut>
4  <dLicenseEnt>
5  <customerid>3653</customerid>
6  <productid>102</productid>
7  <companyname>Shafer Daemon Account</companyname>
8  <productname>DAEMON LAN</productname>
9  <networkseats>0</networkseats>
10  <netseatsinuse>0</netseatsinuse>
11  <licenseCount>0</licenseCount>
12  </dLicenseEnt>
13  </licensesCheckedOut>
14 </DaemonInformation>

/etc/nalpeiron/bin/nalpControl --ControlUsername admin --ControlPassword nalpeiron --CustomerID 3183 --ProductID 113 --ListLicenses

1 <?xml version="1.0" encoding="UTF-8"?>
2 <DaemonInformation>
3  <dInfoLicense>
4  <dLicenseEnt>
5  <customerid>3653</customerid>
6  <productid>102</productid>
7  <companyname>Shafer Daemon Account</companyname>
8  <productname>DAEMON LAN</productname>
9  <computerid>RXbew8g59J//1nTZkCDi</computerid>
10  <licensecode>365300069047952510</licensecode>
11  <productstatus>1</productstatus>
12  <networkseats>0</networkseats>
13  <netseatsinuse>0</netseatsinuse>
14  <longtermcheckoutseats>0</longtermcheckoutseats>
15  <oemlseats>0</oemlseats>
16  <oemlseatsinuse>0</oemlseatsinuse>
17  <maxconcurrentproc>0</maxconcurrentproc>
18  <leaseperiodend>2114380800</leaseperiodend>
19  <trialperiodend>-6003</trialperiodend>
20  </dLicenseEnt>
21  <dLicenseEnt>
22  <customerid>3183</customerid>
23  <productid>113</productid>
24  <companyname>Nalpeiron</companyname>
25  <productname>NightlyBuilds</productname>
26  <computerid>RXbew8g59J//1nTZkCDi</computerid>
27  <licensecode>318300000042124268</licensecode>
28  <productstatus>-1</productstatus>
29  <networkseats>1000</networkseats>
30  <netseatsinuse>0</netseatsinuse>
31  <longtermcheckoutseats>0</longtermcheckoutseats>
32  <oemlseats>0</oemlseats>
33  <oemlseatsinuse>0</oemlseatsinuse>
34  <maxconcurrentproc>0</maxconcurrentproc>
35  <leaseperiodend>1567213580</leaseperiodend>
36  <trialperiodend>-6003</trialperiodend>
37  </dLicenseEnt>
38  </dInfoLicense>
39 </DaemonInformation>

1 <?xml version="1.0" encoding="UTF-8"?>
2 <DaemonInformation>
3  <features>
4  <feature name="CONS1" description="Nightlybuilds CONS1" outcount="0" type="FEATTYPE_TOKEN" status="FEATSTATE_ACTIVATED" pool="1000" used="0"/>
5  <feature name="FEAT1" description="Nightlybuilds FEAT1" type="FEATTYPE_FEAT" status="FEATSTATE_ACTIVATED">ON</feature>
6  <feature name="FEAT3" description="Nightlybuilds FEAT3" type="FEATTYPE_FEAT" status="FEATSTATE_ACTIVATED">ON</feature>
7  <feature name="FEAT4" description="Nightlybuilds FEAT4" type="FEATTYPE_FEAT" status="FEATSTATE_ACTIVATED">ON</feature>
8  <feature name="FEAT5" description="Nightlybuilds FEAT5" type="FEATTYPE_FEAT" status="FEATSTATE_ACTIVATED">ON</feature>
9  <feature name="FEAT6" description="Nightlybuilds FEAT6" type="FEATTYPE_FLOAT" pool="250" outcount="0" status="FEATSTATE_DEACTIVATED">ON</feature>
10  <feature name="FEAT7" description="Nightlybuilds FEAT7" outcount="53" type="FEATTYPE_ELEMPOOL" status="FEATSTATE_ACTIVATED" pool="1999">0</feature>
11  <feature name="TEST1" type="FEATTYPE_UDF" status="FEATSTATE_ACTIVATED" description="TEST1">This is a test1 string</feature>
12  <feature name="$CurrentActivations" type="FEATTYPE_UDF" status="FEATSTATE_ACTIVATED" description="CurrentActivations">1</feature>
13  <feature name="$ActivationsAllowed" type="FEATTYPE_UDF" status="FEATSTATE_ACTIVATED" description="ActivationsAllowed">1</feature>
14  </features>
15 </DaemonInformation>

/etc/nalpeiron/bin/nalpControl --ControlUsername admin --ControlPassword nalpeiron --CustomerID 3653 --ProductID 102 --GetDaemonLicenseCode

365300069047952510

/etc/nalpeiron/bin/nalpControl --ControlUsername admin --ControlPassword nalpeiron --CustomerID 3653 --ProductID 102 --LicenseCode 365300069047952510 --GetDaemonLicenseSource

10.200.2.227

/etc/nalpeiron/bin/nalpControl --ControlUsername admin --ControlPassword nalpeiron --CustomerID 3653 --ProductID 102 --LicenseCode 365300069047952510 --GetDaemonCompID

ChHjqThbSwQ27tPE30+W:RXbew8g59J//1nTZkCDi

/etc/nalpeiron/bin/nalpControl --ControlUsername admin --ControlPassword nalpeiron --CustomerID 3653 --ProductID 102 --LicenseCode 365300069047952510 --GetDaemonLicenseStatus

1

/etc/nalpeiron/bin/nalpControl --ControlUsername admin --ControlPassword nalpeiron --CustomerID 3653 --ProductID 102 --LicenseCode 365300069047952510 --GetDaemonVersion

1.4.139.0

/etc/nalpeiron/bin/nalpControl --ControlUsername admin --ControlPassword nalpeiron --CustomerID 3653 --ProductID 102 --LicenseCode 365300069047952510 --AddLicenseToDaemon

1 <?xml version="1.0" encoding="UTF-8"?>
2 <DaemonInformation>
3  <dInfoHBeats>
4  <heartbeat>
5  <licenseRevoked>0</licenseRevoked>
6  <heartbeatID>543603903</heartbeatID>
7  <customerid>3183</customerid>
8  <productid>113</productid>
9  <heartbeatperiod>300</heartbeatperiod>
10  <hbmissed>0</hbmissed>
11  <username>admin</username>
12  <ClientHostname>clientTestName</ClientHostname>
13  <computerid>Sibew8g59J221nTZkCDi</computerid>
14  </heartbeat>
15  <heartbeat>
16  <licenseRevoked>0</licenseRevoked>
17  <heartbeatID>764361903</heartbeatID>
18  <customerid>3183</customerid>
19  <productid>113</productid>
20  <heartbeatperiod>300</heartbeatperiod>
21  <hbmissed>0</hbmissed>
22  <username>admin</username>
23  <ClientHostname>clientTestName</ClientHostname>
24  <computerid>RXbew8g59J//1nTZkCDi</computerid>
25  </heartbeat>
26  <heartbeat>
27  <licenseRevoked>0</licenseRevoked>
28  <heartbeatID>574098903</heartbeatID>
29  <customerid>3183</customerid>
30  <productid>113</productid>
31  <heartbeatperiod>300</heartbeatperiod>
32  <hbmissed>0</hbmissed>
33  <username>admin</username>
34  <ClientHostname>clientTestName</ClientHostname>
35  <computerid>43Aew8g59J13nTZkCDi</computerid>
36  </heartbeat>
37  </dInfoHBeats>
38 </DaemonInformation>

1 <?xml version="1.0" encoding="UTF-8"?>
2 <DaemonInformation>
3  <elementPools>
4  <clientInfo computerid="Sibew8g59J221nTZkCDi" ClientHostname="clientTestName" username="admin">
5  <ePoolInfo poolid="FEAT7" description="Nightlybuilds FEAT7">83</ePoolInfo>
6  </clientInfo>
7  <clientInfo computerid="RXbew8g59J//1nTZkCDi" ClientHostname="clientTestName" username="admin">
8  <ePoolInfo poolid="FEAT7" description="Nightlybuilds FEAT7">133</ePoolInfo>
9  </clientInfo>
10  <clientInfo computerid="43Aew8g59J13nTZkCDi" ClientHostname="clientTestName" username="admin">
11  <ePoolInfo poolid="FEAT7" description="Nightlybuilds FEAT7">81</ePoolInfo>
12  </clientInfo>
13  </elementPools>
14 </DaemonInformation>

Added newuser

Deleted newuser

1 Daemon running
2 +<?xml version="1.0" encoding="UTF-8"?>
3 <nalpConfig>
4  <backlog>2000</backlog>
5  <logLevel>4</logLevel>
6  <logMax>0</logMax>
7  <logQLen>300</logQLen>
8  <ioMin>2</ioMin>
9  <ioMax>30</ioMax>
10  <workMin>2</workMin>
11  <workMax>30</workMax>
12  <workDir>/etc/nalpeiron/</workDir>
13  <daemonPort>16700</daemonPort>
14  <proxyIP>NALPNA</proxyIP>
15  <proxyPort>NALPNA</proxyPort>
16  <proxyUser>NALPNA</proxyUser>
17 </nalpConfig>

Generated by   doxygen 1.8.9.1