appfwprofile_xmlwsiurl_binding¶
Binding object showing the xmlwsiurl that can be bound to appfwprofile.
Properties¶
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
xmlwsichecks | <String> | Read-write | Specify a comma separated list of relevant WS-I rule IDs. (R1140, R1141). |
name | <String> | Read-write | Name of the profile to which to bind an exemption or rule.
Minimum length = 1 |
xmlwsiurl | <String> | Read-write | XML WS-I URL regular expression length. |
state | <String> | Read-write | Enabled.
Possible values = ENABLED, DISABLED |
isautodeployed | <String> | Read-write | Is the rule auto deployed by dynamic profile ?.
Possible values = AUTODEPLOYED, NOTAUTODEPLOYED |
comment | <String> | Read-write | Any comments about the purpose of profile, or other useful information about the profile. |
alertonly | <String> | Read-write | Send SNMP alert?.
Possible values = ON, OFF |
__count | <Double> | Read-write | count parameter |
Operations¶
(click to see Properties )
- ADD
- DELETE
- GET
- GET (ALL)
- 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/appfwprofile_xmlwsiurl_binding
HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{
"appfwprofile_xmlwsiurl_binding":{
<b> "name":<String_value>,
</b> "comment":<String_value>,
"state":<String_value>,
"xmlwsiurl":<String_value>,
"xmlwsichecks":<String_value>,
"isautodeployed":<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/appfwprofile_xmlwsiurl_binding/ name_value<String>
Query-parameters:
args
http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_xmlwsiurl_binding/ name_value<String> ? args=xmlwsiurl: <String_value>
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
get¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_xmlwsiurl_binding/ name_value<String>
Query-parameters:
filter
http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_xmlwsiurl_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2
Use this query-parameter to get the filtered set of appfwprofile_xmlwsiurl_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
pagination
http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_xmlwsiurl_binding/ name_value<String> ? pagesize=#no;pageno=#no
Use this query-parameter to get the appfwprofile_xmlwsiurl_binding 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:
{ "appfwprofile_xmlwsiurl_binding": [ {
"xmlwsichecks":<String_value>,
"name":<String_value>,
"xmlwsiurl":<String_value>,
"state":<String_value>,
"isautodeployed":<String_value>,
"comment":<String_value>,
"alertonly":<String_value>
}]}
get (all)¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_xmlwsiurl_binding
HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Query-parameters:
bulkbindings
http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_xmlwsiurl_binding? bulkbindings=yes
NITRO allows you to fetch bindings in bulk.
Note: get (all) method can be used only in conjuction with bulkbindings query parameter.
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:
{ "appfwprofile_xmlwsiurl_binding": [ {
"xmlwsichecks":<String_value>,
"name":<String_value>,
"xmlwsiurl":<String_value>,
"state":<String_value>,
"isautodeployed":<String_value>,
"comment":<String_value>,
"alertonly":<String_value>
}]}
count¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_xmlwsiurl_binding/ name_value<String> ? 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:
{"appfwprofile_xmlwsiurl_binding": [ { "__count": "#no"} ] }