3.10. internallicense

Description

This method is used to instruct SoftNAS to use the default built-in license.

POST

internallicense

Request

Response

The following parameters are returned, in addition to the Standard Response Structure

Property	Description	Note/Data Type
actual-storage-GB	Actual storage in use, measured in gigabytes.	string
actual-expiration	Expiration date of license including grace period.	Date string
capabilities	Internal use only.	string
capacityGB	Licensed maximum capacity in gigabytes.	string
currentkey	License key.	string
Msg	Message appropriate to the method in the request, based on success or failure.	string
expiration	Expiration date of the license.	Date string
gracedays	Number of grace days following license expiration that product continues to operate.	Integer string
graceperiod	In the event you are running SoftNAS In a production environment and your license expires, it will enter the grace period. “1” means grace period is in effect.	Boolean string
graceremaining	Amount of days remaining in the grace period, before the grace period expires and SoftNAS functionality is impacted.
hardware_id	The hardware ID used for license activation. On AWS, the instance ID; otherwise, IP address of admin interface.	string
ipmode	IP address mode, how the default IP address used for licensing was assigned “STATIC” or “DHCP”	string
is_activated	Reports if the license is active or not. True or False.	Boolean string
is_perpetual	Reports if the license is a perpetual license or not. True or false.	Boolean string
is_subscription	Reports of the license type is subscription-based (monthly or annual).	Boolean string
istrial	Reports if the product is currently running in trial mode.	Boolean string
license-version	Licensed software version of SoftNAS.	string
licensetype	Reports the license type: monthly, annual, subscription, trial etc.	string
maint_expiration	Reports the date at which the maintenance package expires.	Date string
maint_expired	Reports if the status of the maintenance package is expired. True or False.	Boolean string
model	The license model: “key” (licensed by key) or “utility”. (Licensed by the hour).	string
platform	Platform on which SoftNAS is running. Eg. Amazon, VMWare, Microsoft HyperV	string
product-id	SoftNAS product id	string
producttype	SoftNAS product type.	string
regname	Registered name – customer name associated with an activated license key.	string
sig	internal use only.
status	Reports of the current license is valid. Possible values: valid license or an error message	string
storage-capacity-GB	Reports total storage capacity applicable to the current license in gigabytes.	string
today	Reports today's date.	Date string
totalstorageGB	Total storage consumed currently by storage pools.	string
valid	True if the license is valid.	Boolean string

Example

{

"success": true,

"msg": "",

"records": {

"valid": true,

"errMsg": "Valid License",

"status": "Valid License",

"capabilities": "2:1:100:00/00/0000:2:0",

"model": "key",

"sig": "556B7E03",

"today": "12/17/2013",

"hardware_id": "i-0b06fe44",

"product-id": "2",

"license-version": "1",

"storage-capacity-GB": "100",

"actual_expiration": "License does not expire",

"expiration": "License does not expire",

"gracedays": "2",

"istrial": "0",

"graceperiod": "0",

"graceremaining": "2",

"is_perpetual": false,

"is_subscription": true,

"maint_expired": false,

"maint_expiration": "No maintenance expiration",

"actual-storage-GB": 0,

"regname": "Unregistered, Built-in License",

"licensetype": "Subscription",

"capacityGB": "100 GB",

"totalStorageGB": "0 GB",

"is_activated": false,

"currentkey": "Built-in License",

"producttype": "SoftNAS™ Essentials",

"ipmode": "DHCP",

"platform": "amazon"

},

"total": 31

}

3.10. internallicense

Made with help of Dr.Explain