Citrix

Produktdokumentation



Ganzes Dokument herunterladen

local_licenses

Oct. 21, 2015

Local licenses configuration. 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
content
<String>
No

Content of license file. The content of license file must be converted to string programatically loading into string data type and then pass to JSON payload. Directly copy paste from license file to JSON objent may not work. Response of get operation will also be in same format. Refer following C++ implementation for example: std::ifstream t(licenseFilePath); std::stringstream buffer; buffer << t.rdbuf(); std::string str = buffer.str(); This str can now be sent as value of content.

name
<String>
No

Name of license

Operations

Note:

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

ADD

Use this operation to add and install a license

HTTP Method: POST

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

Request Headers:

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

Request Payload: JSON

{"local_licenses":{
"content": <string_value>,
"name": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"local_licenses":{
"content": <string_value>,
"name": <string_value>
}}

DELETE

Use this operation to delete a license

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/local_licenses/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>

Response Payload: EMPTY

GET (ALL)

Use this operation to get all licenses intalled

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"local_licenses": [{
"content": <string_value>,
"name": <string_value>
}, ...]}

GET

Use this operation to get all licenses intalled

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/local_licenses/<name>

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"local_licenses":{
"content": <string_value>,
"name": <string_value>
}}
Back to Top