Skip to content

ip_block

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

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
longitude<Double>Read-writelongitude.
region_code<String>Read-writeregion_code.
Maximum length = 16
end_ip_num<Double>Read-writeend_ip_num.
country_code<String>Read-writecountry_code.
Maximum length = 256
name<String>Read-writename.
Minimum length = 1
Maximum length = 256
description<String>Read-writeDescription about Ip Block.
Maximum length = 256
city<String>Read-writecity.
Maximum length = 256
latitude<Double>Read-writelatitude.
id<String>Read-writeId is IP block name.
Maximum length = 256
start_ip_num<Double>Read-writestart_ip_num.
custom_city<Boolean>Read-writecustom_city.
custom_country<Boolean>Read-writecustom_country.
country<String>Read-writecountry.
Maximum length = 256
end_ip<String>Read-writeend_ip.
start_ip<String>Read-writestart_ip.
custom_region<Boolean>Read-writecustom_region.
region<String>Read-writeregion.
Maximum length = 256
tenant_id<String>Read-onlyTenant 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>.

add

URL: https://<MGMT-IP>/nitro/v1/config/ip_block?onerror=<String_value>

HTTP Method: null

Request Payload:

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

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/ip_block/id_value<String>

HTTP Method: null

Response Payload:

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

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/ip_block

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/ip_block/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/ip_block/id_value<String>

HTTP Method: null

Request Payload:

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

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}