Methods: ManageDeviceService

The decrementAddonLineItems operation takes one or many devices and decrements entitlement line items to the devices.

To decrement a line item on a simple entitlement to a device, the entitlement must belong to the same soldTo and the product must use the same host type as the device. When a web register key is decremented, it will be redeemed and the soldTo of the device will be assigned to the simple entitlement line item that is created.

If decrementing for a device fails, then the failed devices are displayed in the response data.

The decrementAddonLineItems operation can also be used to remove metered licenses. In this case, as a prerequisite, the configuration Allow Removing or Reducing Metered Features From a License Server must be selected (under System > Configure > Embedded Devices > Host Options) in the Producer Portal.

The deleteAddonLineItems operation takes one or many devices and deletes entitlement line items from the devices.

If deleting for a device fails, then the failed devices are displayed in the response data.

The deleteAddonLineItems operation can also be used to remove metered licenses. In this case, as a prerequisite, the configuration Allow Removing or Reducing Metered Features From a License Server must be selected (under System > Configure > Embedded Devices > Host Options) in the Producer Portal.

The generateCapabilityResponse operation generates capability responses for one or more devices, either from a submitted capability request or from input data that comprises a capability request. This operation optionally maps activation IDs and generates a buffer response for client devices; in the absence of optional input parameters, a capability response is generated. The generateCapabilityResponse operation returns an error for requests to:

• generate a buffer response for a server device

• generate a buffer response for a client device that previously received a capability response

• generate a capability response for a client device that previously received a buffer response

• remove or decrease copies of client device buffer licenses

Note: This operation is only for client and server devices, not served clients.

The generateCapabilityResponse operation can also be used to remove metered licenses. In this case, as a prerequisite, the configuration Allow Removing or Reducing Metered Features From a License Server must be selected (under System > Configure > Embedded Devices > Host Options) in the Producer Portal.

Generating from Capability Requests

This mode allows a collection of base-64 encoded binary capability requests to be uploaded in one web service operation, licenses (capability and buffer responses) generated or re-generated, as appropriate, and returned to the caller. In this mode, the behavior is identical to the devices being directly connected and receiving responses (or as if requests were uploaded for offline activation), including the ability to register unknown devices if FlexNet Operations is configured to allow adding unknown devices. Confirmation of license removal is possible, and empty responses are returned if nothing changes on the client. In the case of a buffer response, a license cannot be returned (in other words, the count cannot be decreased). The binary responses are returned with base-64 encoding, and wrapped in XML elements that identify the device for which they are intended.

Generating from Web Service Parameters

This mode bypasses the need for the caller to get or create binary capability requests. The caller specifies the hostid of each device to be processed, and optionally supplies the force generation flag, the last update time, and vendor dictionary entries.

Note: If the last update time information is not supplied, the time used is the logical beginning of time. In this case, it is not possible to confirm removal of licenses in the usual way. To support return operations without the last update time, either set the configuration parameter to skip confirmation (which applies to all devices) or define the DeviceRequestHandler.handleResponse call-out to skip confirmation for devices that require special treatment. For example, the handleResponse call-out could be used to skip confirmation only for node-locked licenses (requests coming from clients) but not for served licenses.

The getDevice operation takes a unique device identifier and returns that device's data.

NOTE: The getDevice SOAP service returns only the activation ID details for any device of deviceClass CLIENT, SERVER. The features are returned in the response for deviceClass SERVED_CLIENT only.

The getDevicesQuery operation takes one or more query parameters to return the matching devices. If no specific query parameters are provided in the <queryParams> element, all devices are returned.

Note: Starting with FlexNet Operations 2018 Release 2, the getDevicesQuery operation is obsolete. Use searchDevices instead.

The incrementAddonLineItems operation takes one or many devices and increments entitlement line items to the devices.

To increment a line item on a simple entitlement to a device, the entitlement must belong to the same soldTo and the product must use the same host type as the device. When a web register key is incremented, it will be redeemed and the soldTo of the device will be assigned to the simple entitlement line item that is created.

If incrementing for a device fails, then the failed devices are displayed in the response data.

The linkAddonLineItems operation takes one or many devices and links entitlement line items to the devices.

To link a line item on a simple entitlement to a device, the entitlement must belong to the same soldTo and the product must use the same host type as the device. When a web register key is linked, it will be redeemed and the soldTo of the device will be assigned to the simple entitlement line item that is created.

If linking for a device fails, then the failed devices are displayed in the response data.

The linkAddonLineItems operation can also be used to remove metered licenses. In this case, as a prerequisite, the configuration Allow Removing or Reducing Metered Features From a License Server must be selected (under System > Configure > Embedded Devices > Host Options) in the Producer Portal.

The moveDevice operation moves a device from one account to a related account. A device that has not yet been assigned as sold-to a customer can be moved. For example, the parent account can move the device from one of its child accounts (a regional division, for instance) to another child account.

When a device is moved, any entitlements that belong to that device are moved as well. The result of such a move is to either create new entitlements for the receiving account or to increment the count of that account's exising, matching entitlements by the count on the device that was moved.

The searchDevices operation takes one or more query parameters and returns the matching devices. If no specific query parameters are provided in the <queryParams> element, all active CLIENT and SERVER devices are returned. You can use <responseConfig> to limit which fields are returned; however, searchDevices returns host identifier and last modified information only if no response configuration is specified. There are certain details that the searchDevices operation does not return; if more details are required for any of the devices found, use getDevice to retrieve them.

The optional SortBys element enables sorting of the devices returned by searchDevices.

Note: Although the WSDL allows the use of multiple sortBy elements, searchDevices currently only supports sorting by a single key.

Note: By default, a search for devices by device owner (account ID or account name) also returns devices that are not owned by the account specified in the search, if the device has add-on license entitlements mapped from the account specified in the search. If you want to limit the results to devices owned by the account specified in the search, select the configuration option Limit device search by device owner (available in the Producer Portal under System > Configure > FlexNet Operations > Embedded Device Settings).

Enables producers to explicitly set an activation ID with a zero allocation mapping on a Cloud License Server (CLS) instance. Using this method, customers can clearly distinguish between activation IDs that are fully entitled for allocation (full count) and those that are restricted for allocation on the CLS.

By explicitly creating a zero allocation mapping, producers can track and manage entitlement behavior accurately, improving license compliance and allocation control across their deployments.

This method is behind the Allow mapping zero counts to FlexNet Embedded devices setting in the FlexNet Operations Producer Portal, which is located under System > Configure > FlexNet Operations > Embedded Device Settings.