wfsite¶

Configuration for WF site resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
sitename	<String>	Read-write	Name of the WebFront site being created on the Citrix ADC. Minimum length = 1 Maximum length = 255
storefronturl	<String>	Read-write	FQDN or IP of Windows StoreFront server where the store is configured. Minimum length = 1 Maximum length = 255
storename	<String>	Read-write	Name of the store present in StoreFront. Minimum length = 1 Maximum length = 255
html5receiver	<String>	Read-write	Specifies whether or not to use HTML5 receiver for launching apps for the WF site. Default value: FALLBACK Possible values = ALWAYS, FALLBACK, OFF
workspacecontrol	<String>	Read-write	Specifies whether of not to use workspace control for the WF site. Default value: ON Possible values = ON, OFF
displayroamingaccounts	<String>	Read-write	Specifies whether or not to display the accounts selection screen during First Time Use of Receiver . Default value: ON Possible values = ON, OFF
xframeoptions	<String>	Read-write	The value to be sent in the X-Frame-Options header. WARNING: Setting this option to ALLOW could leave the end user vulnerable to Click Jacking attacks. Default value: DENY Possible values = ALLOW, DENY
state	<String>	Read-only	State of wf site. Default value: UP Possible values = UP, INITIALIZING, DOWN-HostUnknown, DOWN-ReqTimeout, DOWN-Wrong Store, DOWN-SF Error, DOWN-SSL Error, DOWN-Conn Reset, DOWN
__count	<Double>	Read-only	count parameter

Operations¶

(click to see Properties )

ADD
DELETE
UPDATE
GET (ALL)
GET
COUNT

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER: <username>
X-NITRO-PASS: <password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in green

add¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/wfsite

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"wfsite":{
<b>      "sitename":<String_value>,
</b><b>      "storefronturl":<String_value>,
</b><b>      "storename":<String_value>,
</b>      "html5receiver":<String_value>,
      "workspacecontrol":<String_value>,
      "displayroamingaccounts":<String_value>,
      "xframeoptions":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/wfsite/ sitename_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/wfsite

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"wfsite":{
<b>      "sitename":<String_value>,
</b>      "storefronturl":<String_value>,
      "storename":<String_value>,
      "html5receiver":<String_value>,
      "workspacecontrol":<String_value>,
      "displayroamingaccounts":<String_value>,
      "xframeoptions":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/wfsite

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/wfsite? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/wfsite? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of wfsite resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/wfsite? view=summary

Use this query-parameter to get the summary output of wfsite resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/wfsite? pagesize=#no;pageno=#no

Use this query-parameter to get the wfsite resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "wfsite": [ {
      "sitename":<String_value>,
      "storefronturl":<String_value>,
      "storename":<String_value>,
      "html5receiver":<String_value>,
      "workspacecontrol":<String_value>,
      "displayroamingaccounts":<String_value>,
      "xframeoptions":<String_value>,
      "state":<String_value>
}]}

get¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/wfsite/ sitename_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/wfsite/ sitename_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/wfsite/ sitename_value<String> ? view=summary

Use this query-parameter to get the summary output of wfsite resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "wfsite": [ {
      "sitename":<String_value>,
      "storefronturl":<String_value>,
      "storename":<String_value>,
      "html5receiver":<String_value>,
      "workspacecontrol":<String_value>,
      "displayroamingaccounts":<String_value>,
      "xframeoptions":<String_value>,
      "state":<String_value>
}]}

count¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/wfsite? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "wfsite": [ { "__count": "#no"} ] }