Citrix ADM NITRO API Reference

ip_block

June 20, 2023

Contributed by:

Configuration for This collection holds private ip block information. resource.

Properties

(click to see Operations )

Name	Permissions	Description
longitude	Read-write	longitude.
region_code	Read-write	region_code. Maximum length = 16
end_ip_num	Read-write	end_ip_num.
country_code	Read-write	country_code. Maximum length = 256
name	Read-write	name. Minimum length = 1 Maximum length = 256
description	Read-write	Description about Ip Block. Maximum length = 256
city	Read-write	city. Maximum length = 256
latitude	Read-write	latitude.
id	Read-write	Id is IP block name. Maximum length = 256
start_ip_num	Read-write	start_ip_num.
custom_city	Read-write	custom_city.
custom_country	Read-write	custom_country.
country	Read-write	country. Maximum length = 256
end_ip	Read-write	end_ip.
start_ip	Read-write	start_ip.
custom_region	Read-write	custom_region.
region	Read-write	region. Maximum length = 256
tenant_id	Read-only	Tenant Id.

Operations

(click to see Properties )

ADD
DELETE
GET (ALL)
GET
UPDATE

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

add

URL: https://<MGMT-IP>/nitro/v2/config/ip_block?onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ip_block": {
"end_ip":<String_value>,
"latitude":<Double_value>,
"start_ip_num":<Double_value>,
"longitude":<Double_value>,
"custom_region":<Boolean_value>,
"region_code":<String_value>,
"region":<String_value>,
"name":<String_value>,
"description":<String_value>,
"country":<String_value>,
"start_ip":<String_value>,
"custom_city":<Boolean_value>,
"country_code":<String_value>,
"id":<String_value>,
"end_ip_num":<Double_value>,
"city":<String_value>,
"custom_country":<Boolean_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ip_block":[{
"longitude":<Double_value>,
"region_code":<String_value>,
"end_ip_num":<Double_value>,
"country_code":<String_value>,
"name":<String_value>,
"description":<String_value>,
"tenant_id":<String_value>,
"city":<String_value>,
"latitude":<Double_value>,
"id":<String_value>,
"start_ip_num":<Double_value>,
"custom_city":<Boolean_value>,
"custom_country":<Boolean_value>,
"country":<String_value>,
"end_ip":<String_value>,
"start_ip":<String_value>,
"custom_region":<Boolean_value>,
"region":<String_value>}]}

<!--NeedCopy-->

delete

URL: https://<MGMT-IP>/nitro/v2/config/ip_block/id_value<String> HTTPS Method: DELETE

Request Headers: X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

<!--NeedCopy-->

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ip_block Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/ip_block ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of ip_block resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ip_block ?pagesize=#no;pageno=#no Use this query-parameter to get the ip_block resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ip_block ?count=yes Use this query-parameter to get the count of ip_block resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ip_block":[{
"longitude":<Double_value>,
"region_code":<String_value>,
"end_ip_num":<Double_value>,
"country_code":<String_value>,
"name":<String_value>,
"description":<String_value>,
"tenant_id":<String_value>,
"city":<String_value>,
"latitude":<Double_value>,
"id":<String_value>,
"start_ip_num":<Double_value>,
"custom_city":<Boolean_value>,
"custom_country":<Boolean_value>,
"country":<String_value>,
"end_ip":<String_value>,
"start_ip":<String_value>,
"custom_region":<Boolean_value>,
"region":<String_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/ip_block/id_value<String> HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ip_block":[{
"longitude":<Double_value>,
"region_code":<String_value>,
"end_ip_num":<Double_value>,
"country_code":<String_value>,
"name":<String_value>,
"description":<String_value>,
"tenant_id":<String_value>,
"city":<String_value>,
"latitude":<Double_value>,
"id":<String_value>,
"start_ip_num":<Double_value>,
"custom_city":<Boolean_value>,
"custom_country":<Boolean_value>,
"country":<String_value>,
"end_ip":<String_value>,
"start_ip":<String_value>,
"custom_region":<Boolean_value>,
"region":<String_value>}]}

<!--NeedCopy-->

update

URL: https://<MGMT-IP>/nitro/v2/config/ip_block/id_value<String> HTTPS Method: PUT

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ip_block":{
<b>"id":<String_value></b>,
"end_ip":<String_value>,
"latitude":<Double_value>,
"start_ip_num":<Double_value>,
"longitude":<Double_value>,
"custom_region":<Boolean_value>,
"region_code":<String_value>,
"region":<String_value>,
"name":<String_value>,
"description":<String_value>,
"country":<String_value>,
"start_ip":<String_value>,
"custom_city":<Boolean_value>,
"country_code":<String_value>,
"end_ip_num":<Double_value>,
"city":<String_value>,
"custom_country":<Boolean_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ip_block":[{
"longitude":<Double_value>,
"region_code":<String_value>,
"end_ip_num":<Double_value>,
"country_code":<String_value>,
"name":<String_value>,
"description":<String_value>,
"tenant_id":<String_value>,
"city":<String_value>,
"latitude":<Double_value>,
"id":<String_value>,
"start_ip_num":<Double_value>,
"custom_city":<Boolean_value>,
"custom_country":<Boolean_value>,
"country":<String_value>,
"end_ip":<String_value>,
"start_ip":<String_value>,
"custom_region":<Boolean_value>,
"region":<String_value>}]}

<!--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

ip_block

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

ip_block

Properties

Operations

add

delete

get (all)

get

update

In this article