ADC NITRO APIs

policypatsetfile

May 23, 2024

Contributed by:

Configuration for patset file resource.

Properties

(click to see Operations )

Name	Permissions	Description
src	Read-write	URL in protocol, host, path, and file name format from where the patset file will be imported. If file is already present, then it can be imported using local keyword (import patsetfile local:filename patsetfile1) NOTE: The import fails if the object to be imported is on an HTTPS server that requires client certificate authentication for access. Minimum length = 1 Maximum length = 2047
name	Read-write	Name to assign to the imported patset file. Unique name of the pattern set. Not case sensitive. Must begin with an ASCII letter or underscore (_) character and must contain only alphanumeric and underscore characters. Minimum length = 1 Maximum length = 31
overwrite	Read-write	Overwrites the existing file.
delimiter	Read-write	patset file patterns delimiter. Default value: 10
charset	Read-write	Character set associated with the characters in the string. Possible values = ASCII, UTF_8
comment	Read-write	Any comments to preserve information about this patsetfile.
imported	Read-write	When set, display only shows all imported patsetfiles. Default value: 0
totalpatterns	Read-only	Total number of patterns in the patset file.
boundpatterns	Read-only	Total number of patterns bound to a patset.
patsetname	Read-only	The patset with which the patsetfile is associated.
bindstatuscode	Read-only	The status code of pattern bindings to patset.
bindstatus	Read-only	The status of pattern bindings to patset.
__count	Read-only	count parameter

Operations

(click to see Properties )

IMPORT
ADD
DELETE
CHANGE
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

Import

URL: http:// <netscaler-ip-address> /nitro/v1/config/policypatsetfile? action=Import HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"policypatsetfile":{
<b>"src":<String_value>,
</b><b>"name":<String_value>,
</b>"overwrite":<Boolean_value>,
"delimiter":<String_value>,
"charset":<String_value>
}}

<!--NeedCopy-->

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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/policypatsetfile HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"policypatsetfile":{
<b>"name":<String_value>,
</b>"comment":<String_value>
}}

<!--NeedCopy-->

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/policypatsetfile/ name_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

change

URL: http:// <netscaler-ip-address> /nitro/v1/config/policypatsetfile? action=update HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"policypatsetfile":{
<b>"name":<String_value>
</b>}}

<!--NeedCopy-->

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/policypatsetfile Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/policypatsetfile? args=name: <String_value> ,imported: <Boolean_value>

Use this query-parameter to get policypatsetfile resources based on additional properties.

attrs http:// <netscaler-ip-address> /nitro/v1/config/policypatsetfile? 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/policypatsetfile? filter=property-name1:property-val1,property-name2:property-val2

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

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

Use this query-parameter to get the summary output of policypatsetfile 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/policypatsetfile? pagesize=#no;pageno=#no

Use this query-parameter to get the policypatsetfile 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:

{ "policypatsetfile": [ {
name:<String_value>,imported:<Boolean_value>"src":<String_value>,
"delimiter":<String_value>,
"charset":<String_value>,
"totalpatterns":<Double_value>,
"boundpatterns":<Double_value>,
"patsetname":<String_value>,
"comment":<String_value>,
"bindstatuscode":<Double_value>,
"bindstatus":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/policypatsetfile/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/policypatsetfile/ name_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/policypatsetfile/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of policypatsetfile 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:

{  "policypatsetfile": [ {
name:<String_value>,imported:<Boolean_value>"src":<String_value>,
"delimiter":<String_value>,
"charset":<String_value>,
"totalpatterns":<Double_value>,
"boundpatterns":<Double_value>,
"patsetname":<String_value>,
"comment":<String_value>,
"bindstatuscode":<Double_value>,
"bindstatus":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/policypatsetfile? 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:

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

policypatsetfile

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

policypatsetfile

Properties

Operations

Import

add

delete

change

get (all)

get

count

In this article