Citrix

Produktdokumentation



Ganzes Dokument herunterladen

videocaching_prepopulation

Oct. 21, 2015

Configure Video Caching Prepopulation.

Properties

Name Data Type Read-Only? Description
urlinfo
<String>
No

URL information.

username
<String>
No

Username to access the specified URL. This is an optional parameter.

schedule
<String>
No

Start downloading and caching videos from the URL to the appliance immediately, or download them at a scheduled time.

Possible values = [now, later]

fetchedonce
<Boolean>
Yes

Indicates whether the video has been fetched from the specified URL.

Possible values = [true, false]

status
<String>
Yes

Status.

scheduleendtime
<String>
No

Date and time at which to stop downloading and caching the videos from the URL. ( format dd/mm/yyyy[Thh[:mm[:ss]]]

Year range = 1900-2105

schedulestarttime
<String>
No

Date and time at which start to download videos from the URL. ( format dd/mm/yyyy[Thh[:mm[:ss]]]

Year range = 1900-2105

name
<String>
No

Name of the prepopulation entry.

enable
<Boolean>
No

Enable/Disable Prepopulation entry.

Possible values = [true, false]

nextscheduletime
<String>
Yes

Date and time indicating when the video will be fetched again from the specified URL. ( format dd/mm/yyyy[Thh[:mm[:ss]]]

Year range = 1900-2105

repeat
<String>
No

Frequency of downloading and caching the videos.

Possible values = [only once, daily, weekly, monthly]

interface
<String>
No

The accelerated bridge port to download videos from the URL.

password
<String>
No

Password to access the specified URL. This is an optional parameter.

lastfetchedtime
<String>
Yes

Date and time of video last fetch from the specified URL. ( format dd/mm/yyyy[Thh[:mm[:ss]]]

Year range = 1900-2105

url
<String>
No

URL of a specific video, or of a video folder on which directory indexing is enabled, or of a video server to cache videos in advance. Must be a complete URL, such as http://example.com/.

Operations

Note:

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

ADD

Use this operation to add Video Caching Prepopulation entry.

HTTP Method: POST

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

Request Headers:

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

Request Payload: JSON

{"videocaching_prepopulation":{
"urlinfo": <string_value>,
"username": <string_value>,
"schedule": <string_value>,
"scheduleendtime": <string_value>,
"schedulestarttime": <string_value>,
"name": <string_value>,
"enable": <boolean_value>,
"repeat": <string_value>,
"interface": <string_value>,
"password": <string_value>,
"url": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"videocaching_prepopulation":{
"urlinfo": <string_value>,
"username": <string_value>,
"schedule": <string_value>,
"fetchedonce": <boolean_value>,
"status": <string_value>,
"scheduleendtime": <string_value>,
"schedulestarttime": <string_value>,
"name": <string_value>,
"enable": <boolean_value>,
"nextscheduletime": <string_value>,
"repeat": <string_value>,
"interface": <string_value>,
"password": <string_value>,
"lastfetchedtime": <string_value>,
"url": <string_value>
}}

DELETE

Use this operation to delete Video Caching Prepopulation entry.

HTTP Method: DELETE

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

Request Headers:

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

Response Payload: EMPTY

GET (ALL)

Use this operation to add Video Caching Prepopulation entries.

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"videocaching_prepopulation": [{
"urlinfo": <string_value>,
"username": <string_value>,
"schedule": <string_value>,
"fetchedonce": <boolean_value>,
"status": <string_value>,
"scheduleendtime": <string_value>,
"schedulestarttime": <string_value>,
"name": <string_value>,
"enable": <boolean_value>,
"nextscheduletime": <string_value>,
"repeat": <string_value>,
"interface": <string_value>,
"password": <string_value>,
"lastfetchedtime": <string_value>,
"url": <string_value>
}, ...]}

GET

Use this operation to add Video Caching Prepopulation entries.

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"videocaching_prepopulation":{
"urlinfo": <string_value>,
"username": <string_value>,
"schedule": <string_value>,
"fetchedonce": <boolean_value>,
"status": <string_value>,
"scheduleendtime": <string_value>,
"schedulestarttime": <string_value>,
"name": <string_value>,
"enable": <boolean_value>,
"nextscheduletime": <string_value>,
"repeat": <string_value>,
"interface": <string_value>,
"password": <string_value>,
"lastfetchedtime": <string_value>,
"url": <string_value>
}}

MODIFY

Use this operation to modify Video Caching Prepopulation entry.

HTTP Method: PUT

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

Request Headers:

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

Request Payload: JSON

{"videocaching_prepopulation":{
"urlinfo": <string_value>,
"username": <string_value>,
"schedule": <string_value>,
"scheduleendtime": <string_value>,
"schedulestarttime": <string_value>,
"name": <string_value>,
"enable": <boolean_value>,
"repeat": <string_value>,
"interface": <string_value>,
"password": <string_value>,
"url": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"videocaching_prepopulation":{
"urlinfo": <string_value>,
"username": <string_value>,
"schedule": <string_value>,
"fetchedonce": <boolean_value>,
"status": <string_value>,
"scheduleendtime": <string_value>,
"schedulestarttime": <string_value>,
"name": <string_value>,
"enable": <boolean_value>,
"nextscheduletime": <string_value>,
"repeat": <string_value>,
"interface": <string_value>,
"password": <string_value>,
"lastfetchedtime": <string_value>,
"url": <string_value>
}}

STARTNOW

Use this operation to start download for the specific Video Caching Prepopulation entry.

HTTP Method: POST

URL: https://<cb_ip_address>/cb/nitro/v1/config/videocaching_prepopulation?action=startnow

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>}

STATUSREFRESH

Use this operation to refresh status of a Video Caching Prepopulation entry.

HTTP Method: POST

URL: https://<cb_ip_address>/cb/nitro/v1/config/videocaching_prepopulation?action=statusrefresh

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>}
Back to Top