# Advantest FlexNet Embedded license client tools

Advantest FlexNet Embedded (FNE) license client tools are used to manage license clients, including testing license checkouts from a license server and listing all checked out licenses.

<div id="bkmrk-advantest-flexnet-em-1"><section class="section">### **Advantest FlexNet Embedded license client tools usage**

The following table lists the available Advantest FlexNet Embedded (FNE) license client tools and their usage:

<table border="1" class="frame-all" style="border-collapse: collapse; border-width: 0.2px; width: 100%; height: 1215.88px;"><caption>**Advantest FlexNet Embedded license client tools**</caption><colgroup><col style="width: 16.0906%;"></col><col style="width: 20.5006%;"></col><col style="width: 63.4088%;"></col></colgroup><thead><tr style="height: 29.7969px;"><th class="rowsep-1" id="bkmrk-option" style="border-width: 0.2px; height: 29.7969px;">**Option**</th><th class="rowsep-1" id="bkmrk-description" style="border-width: 0.2px; height: 29.7969px;">**Description**</th><th class="rowsep-1" id="bkmrk-" style="border-width: 0.2px; height: 29.7969px;"></th></tr></thead><tbody><tr class="rowsep-0" style="height: 29.7969px;"><td class="rowsep-1" headers="_344052__entry__1" rowspan="4" style="border-width: 0.2px; height: 119.188px;">**<kbd class="userinput">test\_license\_checkout</kbd>**</td><td class="rowsep-1" colspan="2" headers="_344052__entry__2 _344052__entry__3" style="border-width: 0.2px; height: 29.7969px;">Tests the license checkout from a license server.</td></tr><tr class="rowsep-0" style="height: 29.7969px;"><td class="rowsep-1" headers="_344052__entry__2" style="border-width: 0.2px; height: 29.7969px;">Location:</td><td class="rowsep-1" headers="_344052__entry__3" style="border-width: 0.2px; height: 29.7969px;"><span class="filepath">/opt/hp93000/soc64\_&lt;version&gt;/.service/bin/</span></td></tr><tr class="rowsep-1" style="height: 29.7969px;"><td class="rowsep-0" headers="_344052__entry__2" style="border-width: 0.2px; height: 29.7969px;">Examples:</td><td class="rowsep-0" headers="_344052__entry__3" style="border-width: 0.2px; height: 29.7969px;">**<span style="background-color: rgb(206, 212, 217);"><kbd class="userinput">test\_license\_checkout -t 60 -f SmarTest\_SOC</kbd></span>**</td></tr><tr class="rowsep-0" style="height: 29.7969px;"><td class="rowsep-1" headers="_344052__entry__2" style="border-width: 0.2px; height: 29.7969px;">Syntax:</td><td class="rowsep-1" headers="_344052__entry__3" style="border-width: 0.2px; height: 29.7969px;"><kbd class="userinput">test\_license\_checkout -t &lt;time in sec.&gt; -f &lt;feature name&gt;</kbd>

</td></tr><tr class="rowsep-1" style="height: 29.7969px;"><td class="rowsep-1" headers="_344052__entry__1" rowspan="4" style="border-width: 0.2px; height: 169.578px;">**<kbd class="userinput">fne-show-license-usage</kbd>**</td><td class="rowsep-0" colspan="2" headers="_344052__entry__2 _344052__entry__3" style="border-width: 0.2px; height: 29.7969px;">Iterates through the FlexNet Embedded servers defined in <span class="filepath">/etc/fne/client.conf</span> and lists all checked out licenses.

</td></tr><tr class="rowsep-0" style="height: 29.7969px;"><td class="rowsep-0" headers="_344052__entry__2" style="border-width: 0.2px; height: 29.7969px;">Location:</td><td class="rowsep-0" headers="_344052__entry__3" style="border-width: 0.2px; height: 29.7969px;"><span class="filepath">/usr/local/bin</span> (If the FNE client package is installed)</td></tr><tr class="rowsep-0" style="height: 29.7969px;"><td class="rowsep-1" headers="_344052__entry__2" style="border-width: 0.2px; height: 29.7969px;">Options:</td><td class="rowsep-1" headers="_344052__entry__3" style="border-width: 0.2px; height: 29.7969px;"><kbd class="userinput">-a\[ll\]</kbd>, <kbd class="userinput">-h\[elp\]</kbd> and <kbd class="userinput">-v\[ersion\]</kbd>

</td></tr><tr class="rowsep-0" style="height: 80.1875px;"><td class="rowsep-1" headers="_344052__entry__2" style="border-width: 0.2px; height: 80.1875px;">Usage:</td><td class="rowsep-1" headers="_344052__entry__3" style="border-width: 0.2px; height: 80.1875px;"><kbd class="userinput">-a</kbd> - Shows all clients managed by the servers (default: Only clients on the local machine).

<kbd class="userinput">-h</kbd> - Shows the help information.

<kbd class="userinput">-v</kbd> - Displays the version of the <kbd class="userinput">fne-show-license-usage</kbd> tool.

</td></tr><tr class="rowsep-0" id="bkmrk-fne-list-licenses-it" style="height: 137.219px;"><td class="rowsep-1" headers="_344052__entry__1" rowspan="5" style="border-width: 0.2px; height: 748.329px;">**<kbd class="userinput">fne-list-licenses</kbd>**</td><td class="rowsep-1" colspan="2" headers="_344052__entry__2 _344052__entry__3" style="border-width: 0.2px; height: 137.219px;">Iterates through the FlexNet Embedded servers defined in <span class="filepath">/etc/fne/client.conf</span> and lists all licenses (used and available). Provides detailed information about the available licenses including:

<div class="p">- Content of the AssetScale tokens
- Locking of licenses
- Expiry information

</div></td></tr><tr class="rowsep-0" style="height: 29.7969px;"><td class="rowsep-1" headers="_344052__entry__2" style="border-width: 0.2px; height: 29.7969px;">Location:</td><td class="rowsep-1" headers="_344052__entry__3" style="border-width: 0.2px; height: 29.7969px;"><span class="filepath">/usr/local/bin</span> (If the FNE client package is installed)</td></tr><tr class="rowsep-1" style="height: 29.7969px;"><td class="rowsep-0" headers="_344052__entry__2" style="border-width: 0.2px; height: 29.7969px;">Options:</td><td class="rowsep-0" headers="_344052__entry__3" style="border-width: 0.2px; height: 29.7969px;"><kbd class="userinput">&lt;no option&gt;</kbd>, <kbd class="userinput">--feature</kbd>, <kbd class="userinput">--expires</kbd>, <kbd class="userinput">--assetScale</kbd>, and <kbd class="userinput">-h\[elp\]</kbd>

</td></tr><tr class="rowsep-0" style="height: 164.172px;"><td class="rowsep-0" headers="_344052__entry__2" style="border-width: 0.2px; height: 164.172px;">Usage for general options:</td><td class="rowsep-0" headers="_344052__entry__3" style="border-width: 0.2px; height: 164.172px;"><span style="text-decoration: underline;">No option:</span> Lists licenses provided by all servers.

<kbd class="userinput">--feature=&lt;xyz&gt;</kbd> - Lists only licenses of the specified feature.

<kbd class="userinput">--expires\[=&lt;n&gt;\]</kbd> - Lists only licenses expiring in the next n days. Default for n: 30.

<kbd class="userinput">--assetScale</kbd> - Lists the AssetScale tokens and shows their content.

<kbd class="userinput">--v\[ersion\]</kbd> - Displays the tool version information.

</td></tr><tr style="height: 387.344px;"><td class="rowsep-1" headers="_344052__entry__2" style="border-width: 0.2px; height: 387.344px;">Usage for tabular output options:</td><td class="rowsep-1" headers="_344052__entry__3" style="border-width: 0.2px; height: 387.344px;"><div class="note">  
</div><p class="callout info"><span class="title">Note: </span>**Options are processed in the order that they are stated.** Use <kbd class="userinput">--sep</kbd> and <kbd class="userinput">--notitle</kbd> before <kbd class="userinput">--csv</kbd>.</p>

<div class="note">  
</div><div class="p"><kbd class="userinput">--sep\[arator\]=&lt;d&gt;</kbd> - Defines column separator for csv output: Defaults to ",".  
  
</div><kbd class="userinput">--notitle</kbd> - Omits title line in csv output (for scripting).

<kbd class="userinput">--listtokens</kbd> - Shows all currently available tokens for csv output.

<p class="callout info"><span class="title">Note: </span>At least one license must be borrowed to show complete list.</p>

<div class="p">  
</div><kbd class="userinput">--match=&lt;list of filters&gt;</kbd> - Filter shown borrow records.

<kbd class="userinput">--csv=&lt;list of tokens&gt;</kbd> - Show licenses borrowed in csv format.

<p class="callout info"><span class="title">Note:</span> There is always one line per feature.</p>

</td></tr><tr><td rowspan="4" style="border-width: 0.2px;">**fne-clear-SmarTest-licenses.sh**  
  
  
  
</td><td colspan="2" style="border-width: 0.2px;">Clears orphaned licenses from crashed SmarTest sessions on FNE servers. (Available from FNE **2024.10**).

Installed as part of the FNE client package.

Executed on the system controller (FNE license client workstation).

</td></tr><tr><td style="border-width: 0.2px;">Location:

</td><td style="border-width: 0.2px;"><span class="filepath">/usr/local/</span> (If the FNE client package is installed)

</td></tr><tr><td class="rowsep-0" headers="_344052__entry__2">Options:</td><td class="rowsep-0" headers="_344052__entry__3"><kbd class="userinput">&lt;no option&gt;</kbd>, <kbd class="userinput">--v\[ersion\],</kbd><kbd class="userinput">--h\[elp\]</kbd>

</td></tr><tr><td class="rowsep-0" headers="_344052__entry__2">Usage:</td><td class="rowsep-0" headers="_344052__entry__3">No option: Clears licenses.

<kbd class="userinput">--v\[ersion\]</kbd> - Displays the tool version information.

<kbd class="userinput">--h\[elp\]</kbd> - Prints the help information.

</td></tr></tbody></table>

</section></div>### **Example**

#### Usage examples for the fne-list-licenses tool

List licenses **provided by all servers:**

```
$ fne-list-licenses
Server: Feature Server (redundant)
\-URL: http://fne1.domain.com:7070/fne/bin/capability
-SEL: DEVICEOWNER:UPSTREAM
100000 x Digital_E803x_E8070_16_32MB/1.0
100000 x Digital_E803x_E8070_32_64MB/1.0
100000 x Digital_E803x_E8070_64_112MB/1.0
...
```

<div id="bkmrk--1"></div>List all licenses **expiring in the next 28 days** (request date 30.04.2018).

```
$ fne-list-licenses --expires=28
Server: Feature Server (redundant)
\-URL: http://fne1.domain.com:7070/fne/bin/capability
-SEL: DEVICEOWNER:UPSTREAM
100000 x Digital_E803x_E8070_16_32MB/1.0 expires 2018-05-28
...
```

List licenses of **all features including the string** <kbd class="userinput">**Company**</kbd>:

```
$ fne-list-licenses --feature=Company_
Server: Feature Server (redundant)
\-URL: http://fneserver.domain.com:7070/fne/bin/capability
1000 x Company_Details/1.0
Company=COMPANY_NAME
```

List **AssetScale tokens** and show their content:

```
$ fne-list-licenses --assetScale
Server: Feature Server (redundant)
\-URL: http://fneserver.domain.com:7070/fne/bin/capability
123 x Token_OWNER_BRAND_PremiumTier/1.0
Locked to DeviceOwner=OWNER_BRAND
Content of AssetScale bundle:
1 x ANALOG_E9723B_MEAS_4_8/1.0
...
```

**Show usage** of a specific **feature**:

```
$ fne-list-licenses ---notitle -m featureName=Digital_E803x_E8070_16_32MB -csv featureCount,used,featureName
100000,10,Digital_E803x_E8070_16_32MB
```

Show **all licenses** locked to a **DeviceOwner**:

```
$ fne-list-licenses --match selectorsDictionary.DeviceOwner=UPSTREAM -csv server.name,featureName server.name,featureName
Feature Server (redundant),Token_UPSTREAM_PremiumTier
```

**Clear the licenses currently in use** on the client:

```
$ fne-clear-SmarTest-licenses.sh
Clearing borrowed licenses for device id 6451063D7784.starter_2tplf
```

Returns a **message describing the devices** for which the licenses are being cleared:

```
<button class="-copy" title="Copy to clipboard"><svg height="20" viewbox="0 0 1000 1000" width="20"><path d="M704 896H64V320h640v192h64V192c0-35-29-64-64-64H512C512 57 455 0 384 0S256 57 256 128H64c-35 0-64 29-64 64v704c0 35 29 64 64 64h640c35 0 64-29 64-64V768h-64v128zM192 192h64s64-29 64-64 29-64 64-64 64 29 64 64 32 64 64 64h64s64 29 64 64H128c0-39 28-64 64-64zm-64 512h128v-64H128v64zm448-128V448L320 640l256 192V704h320V576H576zM128 832h192v-64H128v64zm320-448H128v64h320v-64zM256 512H128v64h128v-64z" fill="currentColor"></path></svg></button>Clearing borrowed licenses for device id 6451063D7784.starter_2tplf
```