|
FLEXNET OPERATIONS 2023 R1 ON PREMISES SOAP WEB SERVICES GUIDE |
FlexNet Operations 2023 R1 On Premises SOAP Web Services Guide |
Name-value pairs are used to set license model attributes through the FlexNet Operations Web services. These parameters can be set using the Entitlement Order or License services, depending when in the license lifecycle the license model attributes are required.
In an implementation that passes XML structures, the attributes are set:
<licenseModelAttributes>
<attribute>
<attributeName>SERIAL_NUMBER</attributeName>
<stringValue>test_serial_number</stringValue>
</attribute>
<attribute>
<attributeName>NOTICE</attributeName>
<stringValue>test notice</stringValue>
</attribute>
<attribute>
<attributeName>PLATFORMS</attributeName>
<arrayValue>i86_n</arrayValue>
<arrayValue>i86_l</arrayValue>
</attribute>
</licenseModelAttributes>
The following table contains a list of license model attribute names. See attributeDescriptorType in Web Service Data Types with Choices.
| attributeName | Value Type | Description |
|---|---|---|
| ALLOW_ONE_TERMINAL_SERVER |
booleanValue |
Applicable to node-locked uncounted licenses. FlexNet Licensing detects when a node-locked uncounted license is running under Windows Terminal Server. To allow your FlexEnabled application to run via a single Terminal Server Client window, node-lock the license to the Terminal Server machine and set ALLOW_ONE_TERMINAL_SERVER to true. The ONE_TS_OK keyword is added to the license. To disable access via a Terminal Server Client, set both ALLOW_ONE_TERMINAL_SERVER and ALLOW_TERMINAL_SERVER to false. |
| ALLOW_TERMINAL_SERVER |
booleanValue |
Applicable to a FlexEnabled application built with FlexNet Licensing version 8.0 or later and using a node-locked uncounted license. FlexNet Licensing detects when a node-locked uncounted license is running under Windows Terminal Server. To allow your FlexEnabled application to run via a Terminal Server Client window, node-lock the license to the Terminal Server machine and set ALLOW_TERMINAL_SERVER to true. The TS_OK keyword is added to the license. To disable access via a Terminal Server Client, set both ALLOW_ONE_TERMINAL_SERVER and ALLOW_TERMINAL_SERVER to false. |
| BORROW_HOURS |
integerValue |
Applicable to counted licenses. If borrowing is allowed, the maximum number of hours that the license can be borrowed for can be specified as the default (168 hours, or one week) or can be specified in the license model, the entitlement, or at fulfillment time. The BORROW keyword is added to the license. The maximum borrow period is limited by the maximum value of a 32-bit integer: 2 billion hours. |
| FLOAT_OK |
stringValue server_hostid |
To specify a FLOAT_OK keyword with a server_hostid. Also specify a FLEXid as a node-locked hostid. The server_hostid is the same hostid that appears on the SERVER line of the license file, or could be a different hostid that refers to the same machine. If the SERVER line hostid is ANY, the FLOAT_OK server_hostid should be specific to the license server machine. The license server can only be run on the machine with the hostid that lmhostid returns equal to the server_hostid specified with FLOAT_OK. A user can run on the license server machine, but he can use only the license being served by the license server, not the node-locked license. Otherwise an extra use for each FLOAT_OK license could occur. Note that without the server_hostid specified on the feature line, the FLOAT_OK license can be served from any computer, as long as the FLEXid is attached to it. The hostid on the FLOAT_OK feature line must be only a single hostid. For multiple FLEXids, use individual feature lines for each FLEXid. |
| HOST_BASED |
integerValue |
Applicable to counted licenses. Specify the number of host names that can be specified in INCLUDE statements in the end-user options file. |
| INCLUDE_USE_SERVER |
booleanValue |
USE_SERVER takes no arguments and has no impact on the server. When the application sees USE_SERVER, it ignores everything in the license file except preceding SERVER lines and transfers checkout validation to the vendor daemon. For uncounted features, USE_SERVER is used to force logging of usage by the daemons. |
| ISSUER |
stringValue issuer |
Issuer of the license. |
| NOTICE |
stringValue notice |
Notice string used to identify feature lines. |
| MAX_BORROW_INTERVAL |
integerValue |
For FlexNet Embeeded served licenses. Specifies the maximum borrow interval in seconds. If used, it overrides the default max borrow interval configured on the license server that is serving the license. |
| OVERDRAFT_MAX |
integerValue |
Applicable to counted licenses. The max overdraft setting allows a publisher to specify a number of additional licenses (per entitlement line item) which users are allowed to use, in addition to the licenses they have purchased. Overdraft allows your users to not be denied service when in a “temporary overdraft” state. Usage above the license limit is reported by the FlexNet Manager reporting tool. Expressed using the OVERDRAFT license keyword. |
| PLATFORMS |
arrayValue platform_key |
Specify each platform in a separate arrayValue element. See Platform Key Names table below. Usage is limited to the selected platforms. Expressed using the PLATFORMS license keyword. |
| SERIAL_NUMBER |
stringValue serial_number |
Serial number used to identify feature lines. The SN keyword is added to the license. |
| USER_BASED |
integerValue |
Applicable to counted licenses. Specify the number of users that can be specified in INCLUDE statements in the end-user options file. |
| VENDOR_STRING |
stringValue vendor_string |
Vendor string used to identify feature lines. |
| VM_PLATFORMS |
stringValue vm_platforms |
To restrict to physical machines only, set VM_PLATFORMS to PHYSICAL. To restrict to virtual machines only, set VM_PLATFORMS to VM_ONLY. |
The following table shows the key names of platform settings to pass in the PLATFORMS attribute.
| Platform Key | Platform Name |
|---|---|
| alpha_l |
Dec Alpha, Linux < version 6.2 |
| alpha_n |
Dec Alpha, Windows/NT |
| alpha_r |
Dec Alpha, Linux version 6.2 or later |
| alpha_u |
Dec UNIX for Alpha |
| alpha_v |
Dec Alpha, OpenVMS version 6.x |
| amd64_s |
AMD 64-bit, SUSE Linux Enterprise Server |
| hp700_u |
HP 9000/700, 800, HP-UX |
| hp64_u |
HP 64-bit, HP-UX |
| i86_b |
BSDI OS |
| i86_d |
DG AViiON Pentium |
| i86_f |
FreeBSD |
| i86_g |
Intel x86, Linux with GNU libc |
| i86_l |
Intel x86, Linux version 1, version 2 |
| i86_n |
Intel x86, Windows (all) |
| i86_r |
Intel x86, Red Hat Linux version 6-version 9 |
| i86_re |
Intel x86, Red Hat Enterprise Linux |
| i86_u |
Intel x86, Unixware |
| i86_w |
Intel x86, Windows 16-bit |
| i86_x |
Intel x86, Solaris |
| i86_z |
Intel x86, Netware |
| it32_hp |
Itanium 32-bit, HP-UX |
| it64_hp |
Itanium 64-bit, HP-UX |
| it64_lr |
Itanium 64-bit, Red Hat Linux version 7-version 9 |
| it64_n |
Itanium 64-bit, Windows |
| java-0 |
Java, Version |
| nec_u |
NEC EWS OS |
| ppc_mac |
Power PC, MacOS X |
| ppc_u |
Power PC, AIX |
| rm400_u |
Siemens Nixdorf RM400, Sinux |
| rs6000_u |
IBM RS/6000, AIX |
| rs64_u |
IBM RS/6000 64-bit |
| sco_u |
SCO UNIX (intel) |
| sgi32_u |
SGI 32-bit, IRIX 5, 6 |
| sgi64_u |
SGI 64-bit, IRIX 6 |
| sony_u |
Sony BSD OS V4 |
| sun4_u |
Sun Sparc 4, Solaris |
| sun64_u |
Sun 64-bit, Solaris |
| vax_v |
Dec VAX/VMS |