Elements: ManageDeviceService

Optional. An addOnActivationID element contains a value and search type. A value is a string to match part or all of the addOnActivationID, and a searchType is one of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Optional. An addOnActivationId contains:

• value—a string to match part or all of the add-on activation ID.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS 

Indicates created date of the addon associated with the device/server. The format of the add on created date would be <createdDate>2019-08-21T10:53:35.890Z</createdDate>.

This is an optional field.

Optional. An addOnEntitlementId contains:

• value—a string to match part or all of the add-on-entitlement ID.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS 

You can search and filter by addOnExpirationDate. This enhancement enables producers to filter out devices that have expired licenses.

Here is an example request:

&lt;urn:addOnExpirationDate&gt;
&lt;urn:value&gt;2015-10-10&lt;/urn:value&gt;
&lt;urn:searchType&gt;AFTER&lt;/urn:searchType&gt;
&lt;/urn:addOnExpirationDate&gt;

The addOnExpirationDate parameter is returned in the response, based on the response config parameter.

You can search and filter by addOnExpirationDate. This enhancement enables producers to filter out devices that have expired licenses.

Here is an example request:

<urn:addOnExpirationDate>
  <urn:value>2015-10-10</urn:value>
  <urn:searchType>AFTER</urn:searchType>
</urn:addOnExpirationDate>

The addOnExpirationDate parameter is returned in the response, based on the response config parameter.

Indicates last modified date of the addon associated with the device/server. The format of the add on last modified date would be <lastModifiedDate>2019-08-21T10:53:35.890Z</lastModifiedDate>.

This is an optional field.

Optional. An addOnPartNumber contains:

• value—a string to match part or all of the add-on part number.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS 

Optional. An addOnProductName element contains a value and search type. A value is a string to match part or all of the addOnProductName, and a searchType is one of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Optional. An addOnProductName contains:

• value—a string to match part or all of the add-on product name.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS 

Optional. An addOnProductVersion element contains a value and search type. A value is a string to match part or all of the addOnProductVersion, and a searchType is one of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Optional. An addOnProductVersion contains:

• value—a string to match part or all of the add-on product version number.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS 

Optional. An alias for the device ID.

An alias element contains a value and a search type. A value is a string to match part or all of the alias, and a searchType is one of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Optional. If true, generate a buffer response.

Note: This parameter not supported as of 2016 R1.

See channelPartnerDataListType.

Note: To set the device owner, provide a single account in the End Customer tier (bo.constants.partnertiernames.endcustomer).

See channelPartnerDataListType.

Note: This element returns an account in the End Customer channel partner tier.

See userIdentifierType.

Note: for deviceDataType and deviceQueryDataType, this parameter is not supported as of 2016 R1.

True if the account specified in accountUnit is the current owner of the device.

Note: for deviceDataType and deviceQueryDataType, this parameter not supported as of 2016 R1.

See attributeDescriptorDataType.

Note: This parameter not supported as of 2016 R1.

Optional. A dateValue element contains:

• value—a date value to compare to the version date value.

• searchType—one of the following datedSearchType values:

  • BEFORE

  • AFTER

  • ON

Optional. A description element contains a value and search type. A value is a string to match part or all of the description, and a searchType is one of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Optional. A description contains:

• value—a string to match part or all of the description.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

One of the following:

• CLIENT

• SERVER

• SERVED_CLIENT

One of the following:

• CLIENT

• SERVER

• SERVED_CLIENT

Optional. A deviceId element contains a value and search type. A value is a string to match part or all of the deviceId, and a searchType is one of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Optional. A deviceId contains:

• value—a string to match part or all of the device ID.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

Device ID type. The value for deviceIdType can be:

• UNKNOWN

• STRING

• ETHERNET

• FLEXID9

• FLEXID10

• EXTENDED

• INTERNET

• INTERNET6

• USER

• TOLERANT

• VM_UUID

TOLERANT should only be used to create a device as the result of a capability request sent from the device itself. That is, FNO honors requests with ID type of TOLERANT, but because there is no FNO code to support it, it should never be used to create or update a device.

Device ID type. The value for deviceIdType can be:

• UNKNOWN

• STRING

• ETHERNET

• FLEXID9

• FLEXID10

• EXTENDED

• INTERNET

• INTERNET6

• USER

• TOLERANT

• VM_UUID

TOLERANT should only be used to create a device as the result of a capability request sent from the device itself. That is, FNO honors requests with ID type of TOLERANT, but because there is no FNO code to support it, it should never be used to create or update a device.

A deviceIdType element contains a value and search type. The value is a string to match part or all of the deviceIdType:

• UNKNOWN

• STRING

• ETHERNET

• FLEXID9

• FLEXID10

• INTERNET

• INTERNET6

• USER

• TOLERANT

• VM_UUID

NOTE: When using a deviceType of SERVER, this field is mandatory.

The searchType is one of the following enumSearchType values:

• EQUALS

• NOT_EQUALS

Device ID type. The value for deviceIdType can be:

• UNKNOWN

• STRING

• ETHERNET

• FLEXID9

• FLEXID10

• EXTENDED

• INTERNET

• INTERNET6

• USER

• TOLERANT

• VM_UUID

TOLERANT should only be used to create a device as the result of a capability request sent from the device itself. That is, FNO honors requests with ID type of TOLERANT, but because there is no FNO code to support it, it should never be used to create or update a device.

Device ID type. The value for deviceIdType can be :

• UNKNOWN

• STRING

• ETHERNET

• FLEXID9

• FLEXID10

• EXTENDED

• INTERNET

• INTERNET6

• USER

• TOLERANT

• VM_UUID

While the deviceIdType in the deviceIdentifier can be used to identify the device being updated, the deviceIdType here in updateDevDataType can be used to change the device ID type of the device being updated.

TOLERANT should only be used to create a device as the result of a capability request sent from the device itself. That is, FNO honors requests with ID type of TOLERANT, but because there is no FNO code to support it, it should never be used to create or update a device.

Specifies the configuration settings to be included in the response. Includes the following boolean elements:

• alias

• description

• status

• servedStatus

• hostTypeName

• soldTo

• channelPartners

• preBuiltLicense

• addOnActivationId

• addOnCounts

• addOnProduct

• addOnLicense

• addOnExpirationDateOverride

• publisherIdentity

• parent

• machineType

• vmDetails

• vmInfo

• vendorDictionary

• deviceUser

Note: If channelPartners is selected, the response includes only the account in the End Customer tier (bo.constants.partnertiernames.endcustomer).

The status of a served client device. One of the following:

• NORMAL

• RETURNED

• EXPIRED

• DROPPED

One of the following:

• CLIENT

• SERVER

• SERVED_CLIENT

A web service type. Valid values:

• CLIENT

• SERVER

• SERVED_CLIENT

This field is supported only for the tenants who have configured their Device User Option to On. The deviceUser string is returned only if the request's deviceResponseConfig contains deviceUser field, set to true.

• If the Device User Option is set to Off, and the request's deviceResponseConfig has deviceUser field is true, the service will ignore it, and the response will state that the deviceUser response configuration is not supported.

• If the Device User Option is set to On with no validation, the response will contain deviceUser field, set to the string value of the Device User.

• If the Device User Option is set to On with validation and the deviceUser response configuration is set to true, the response will not populate the deviceUser for existing users, populating instead deviceUserIdentifier element with user's info. In cases when the user have been deleted, the deviceUser string will be set to<User System ID> (Removed).

See userIdentifierType. This field is returned when a tenant's Device User Option is set to On with validation and the response configuration's deviceUse is set to true. The response will contain the following information:

• first name

• last name

• email address

• user name

• phone number

Required. Specify one of the following units of time:

• DAYS

• WEEKS

• MONTHS

• YEARS

New, overriding expiration date.

Affects link/increment/decrement and generateCapabilityResponse. For link/increment and generateCapabilityResponse, the expiration date is used and set at add-on line if there is no override date yet (after it is set, only the same date is accepted). After the date is set, it cannot be changed (same as on the UI). For decrement, this field is ignored and put in the warning queue.

Known issue regarding expiration date: The ALM expiration date is GMT midnight, but the back office uses midnight of the FlexNet Operations server time zone. An issue will occur if the user tries to set the override date to be the same as the entitlement expiration (on ALM).

List of features including feature ID and count for served client.

Note: This attribute is currently disabled.

Optional. A featureName element contains a value and search type. A value is a string to match part or all of the featureName, and a searchType is one of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Optional. A featureName contains:

• value—a string to match part or all of the Feature name (for served clients).

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS 

You can search and filter by hasLicense. This enhancement enables producers to filter out devices that have invalid licenses.

Here is an example request:

<urn:hasLicense>true</urn:hasLicense>

The hasLicense parameter is returned in the response, based on the response config parameter.

See WSDeviceType.

Device type:

• CLIENT

• SERVER

• SERVED_CLIENT

One of the following:

• false - for local server

• true - for Cloud License Service instance.

Optional. If hostTypeName is not specified, you must implement the com.flexnet.opsembedded.publicapi.DeviceHandler.decodeDeviceId() callout to set it.

See hostTypeIdentifier.

Optional. A hostTypeName element contains a value and search type. A value is a string to match part or all of the hostTypeName, and a searchType is one of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Optional. A hostTypeName contains:

• value—a string to match part or all of the host type name.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

See deviceIdTypeType.

Note: TOLERANT should only be used to create a device as the result of a capability request sent from the device itself. That is, FNO honors requests with ID type of TOLERANT, but because there is no FNO code to support it, it should never be used to create or update a device.

A incrementAddonLineItemsRequest message contains an element of linkAddonLineItemsRequestType. It increments an existing count.

NOTE: While it is possible to activate an expired entitlement line item with an activation ID using the SOAP API, there is no purpose for doing so. Activating expired line items is not allowed when using the FlexNet Operations Producer Portal.

Is license permanent?

Note: This parameter not supported as of 2016 R1.

The last date and time a response was generated for the device. It is:

• set whenever the device calls in and FlexNet Operations generates a response, and

• updated regardless of whether there was a change in the generated response or not (in which case FlexNet Operations replies with an empty license)

The last date and time a response was generated for the device. It is:

• set whenever the device calls in and FlexNet Operations generates a response, and

• updated regardless of whether there was a change in the generated response or not (in which case FlexNet Operations replies with an empty license)

Optional. The date the device was last updated in seconds since midnight, 1 January 1970 GMT. If this date is not specified, the time used will be the logical beginning of time and removal of licenses cannot be confirmed in the usual way.

Note: This parameter not supported as of 2016 R1 .

See licenseModelIdentifierType.

Note: This parameter not supported as of 2016 R1.

See attributeDescriptorDataType.

Note: This parameter not supported as of 2016 R1.

State of the license, where the value is one of the following:

• UNDEFINED

• LICENSE_NOT_GENERATED

• LICENSE_GENERATED

• MARKED_FOR_REMOVAL

• REMOVED_FROM_LICENSE

• REMOVAL_PENDING_CONFIRMATION

• COPIES_INCREASING

• COPIES_DECREASING

• WAITING_FOR_CONFIRMATION

• EXPIRED

• OBSOLETE

• INACTIVE

State of the license, where the value is one of the following:

• UNDEFINED

• LICENSE_NOT_GENERATED

• LICENSE_GENERATED

• MARKED_FOR_REMOVAL

• REMOVED_FROM_LICENSE

• REMOVAL_PENDING_CONFIRMATION

• COPIES_INCREASING

• COPIES_DECREASING

• WAITING_FOR_CONFIRMATION

• EXPIRED

• OBSOLETE

• INACTIVE

A linkAddonLineItemsRequest message contains an element of linkAddonLineItemsRequestType.

NOTE: While it is possible to activate an expired entitlement line item with an activation ID using the SOAP API, there is no purpose for doing so. Activating expired line items is not allowed when using the FlexNet Operations Producer Portal.

The value is a string to match part or all of the machineType:

• UNKNOWN

• PHYSICAL

• VIRTUAL

The value is a string to match part or all of the machineType:

• UNKNOWN

• PHYSICAL

• VIRTUAL

Optional. A name contains:

• value—a string to match part or all of the device name.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

Optional. Depending on the attribute type, set either stringValue or numberValue or booleanValue.

A numberValue element contains:

• value—an integer number to match part or all of the custom attribute value.

• searchType—one of the following simpleSearchType values:

  • GREATER_THAN

  • GREATER_THAN_EQUALS

  • LESS_THAN

  • LESS_THAN_EQUALS

  • EQUALS

  • NOT_EQUALS

This is an optional parameter. Choose one of the following operation types:

• ADD: Performs the REPLACE operation and displays the warning message "ADD or DELETE are not supported values for the opType element. The method always uses the REPLACE operation.".

• REPLACE: The specified updateChannelPartners set replaces the entire existing channel partner set. Individual tiers cannot be updated separately. If an account with a specified contact is replaced by an account without a specified contact, the contact is cleared.

• DELETE: Performs the REPLACE operation and displays the warning message "ADD or DELETE are not supported values for the opType element. The method always uses the REPLACE operation.".

Optional. A parentId corresponds to the Served By value for a served client in the admin console UI; it identifies the served client’s parent FlexNet Embedded server device.

A parentId element contains a value and a search type. A value is a string to match part or all of the parentId, and a searchType is one of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Optional. A parentId contains:

• value—a string to match part or all of the parent server ID.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

True, if existing, matching line items at the target account are to be pooled. False, to always create new line items at the target account.

Note: This parameter not supported as of 2016 R1.

See productIdentifierType.

Note: This parameter not supported as of 2016 R1.

One of the following datedSearchType values:

• BEFORE

• AFTER

• ON

One of the following dateSearchType values:

• BEFORE

• AFTER

• ON

One of the following:

• EQUALS

• NOT_EQUALS

One of the following enumSearchType values:

• EQUALS

• NOT_EQUALS

One of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

One of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

One of the following enumSearchType values:

• EQUALS

• NOT_EQUALS

One of the following simpleSearchType values:

• GREATER_THAN

• GREATER_THAN_EQUALS

• LESS_THAN

• LESS_THAN_EQUALS

• EQUALS, NOT_EQUALS

One of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Served client status. Valid values:

• NORMAL

• RETURNED

• EXPIRED

• DROPPED

One of the following:

• NORMAL

• RETURNED

• EXPIRED

• DROPPED 

Optional. A soldTo element contains a value and search type. A value is a string, in the form of the account name, to match part or all of the soldTo, and a searchType is one of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Optional. A soldTo account name contains:

• value—a string to match part or all of the sold to account name.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

Optional. A soldToAcctId element contains a value and search type. A value is a string, in the form of the account ID, to match part or all of the soldToAcctId, and a searchType is one of the following simpleSearchType values:

• STARTS_WITH

• CONTAINS

• ENDS_WITH

• EQUALS

Optional. A soldToAcctId contains:

• value—a string to match part or all of the sold to account ID. 

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS 

The name of the account to which the device currently belongs.

Specify either soldToUniqueId or soldToName, not both.

Unique database identifier of the account to which the device currently belongs.

Specify either soldToUniqueId or soldToName, not both.

See deviceSortBy.

Note: Currently, only sorting by one key is supported.

Start date of the prebuilt license.

Note: This parameter not supported as of 2016 R1.

One of the following values:

• SUCCESS

• FAILURE

• PARTIAL_FAILURE

One of the following:

• ACTIVE

• OBSOLETE

• TEST

• RETURNED 

A stringValue element contains:

• value—a string to match part or all of the custom attribute value.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

Allows users to request devices with matching Device User. Results for this request depend on how the tenant has configured Device User Option.

• If the Device User Option is set to Off, the userString field is ignored, and the response states that this criteria is not supported

• If the Device User Option is set to On with no validation, the userString is matched with string value of the Device User.

• If the Device User Option is set to On with validation, the userString is matched with the email of the Device User.

Optional. A userString contains:

• value—a string to match part or all of the device user.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS 

The value is a string to match part or all of the machineType:

• UNKNOWN

• PHYSICAL

• VIRTUAL

One of the following:

• NORMAL

• RETURNED

• EXPIRED

• DROPPED

This element can be set to:

• ACTIVE

• OBSOLETE

• RETURNED

This element can be set to:

• ACTIVE

• OBSOLETE

• RETURNED

Optional. See generateCapabilityResponseDictionary.

Note: This parameter not supported as of 2016 R1.