Product Documentation

license_info

Oct 21, 2015

License Information. This NITRO resource is applicable for CloudBridge SM83, SM85, SM88, VPX, 400, 800, 1000, 2000, 2000WS and 3000 platforms only.

Properties

Name Data Type Read-Only? Description
requestcryptolicense
<Boolean>
No

Request crypto license

Possible values = [true, false]

basemodel
<String>
No

Base Model.

Possible values = [100, 200, 300, 5M, 10M, 20M, 45M, 100M, 8510, 8520, 8530, 8540, 8310, 8320, 8810, 8820, V1, V2, V10, V20, V45, V50, VEXP, V100, V200, V13500, 2000-010, 2000-020, 2000-050, 3000-050, 3000-100, 3000-155, 400-002, 400-006, 800-002, 800-006, 800-010, 1000-006, 1000-010, 1000-020]

hostid
<String>
Yes

Host ID

basemodelstatus
<String>
Yes

Base Model Status

serverlocation
<String>
No

Server Location.

Possible values = [remote, local]

serverstatus
<String>
Yes

Server Status

serverport
<Integer>
No

License server port number. This value should be present when the server location is remote.

Minimum value = 1

Maximum value = 65535

islicensed
<Boolean>
Yes

is licensed or not

Possible values = [true, false]

productname
<String>
No

Product Name.

Possible values = [CBR, CWSDE, CWS, CCB]

serveraddress
<String>
No

Operations

Hinweis

Mandatory parameters are marked in red and placeholder content is marked in <green>.

GET

Use this operation to get license server configuration

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/license_info/

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.license_info+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.license_info+json

Response Payload: JSON

{"license_info":{
"requestcryptolicense": <boolean_value>,
"basemodel": <string_value>,
"hostid": <string_value>,
"basemodelstatus": <string_value>,
"serverlocation": <string_value>,
"serverstatus": <string_value>,
"serverport": <integer_value>,
"islicensed": <boolean_value>,
"productname": <string_value>,
"serveraddress": <string_value>
}}

MODIFY

Use this operation to modify license server configuration

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/license_info

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.license_info+json

Request Payload: JSON

{"license_info":{
"requestcryptolicense": <boolean_value>,
"basemodel": <string_value>,
"serverlocation": <string_value>,
"serverport": <integer_value>,
"productname": <string_value>,
"serveraddress": <string_value>
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.license_info+json

Response Payload: JSON

{"license_info":{
"requestcryptolicense": <boolean_value>,
"basemodel": <string_value>,
"hostid": <string_value>,
"basemodelstatus": <string_value>,
"serverlocation": <string_value>,
"serverstatus": <string_value>,
"serverport": <integer_value>,
"islicensed": <boolean_value>,
"productname": <string_value>,
"serveraddress": <string_value>
}}