Skip to content

vip

Configuration for vip configuration resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
protocol<String>Read-writeProtocol used by vip.
subnet_id<String>Read-writeSubnet Id of vip.
admin_state_up<String>Read-writeAdmin is up or down.
status<String>Read-writestatus of vip.
port_id<String>Read-writePort Id of requests.
subnet_gateway_ip<String>Read-writeIp of subnet gateway for vip.
network_type<String>Read-writeType of network .
tenant_id<String>Read-writeId of admin tenant..
subnet_cidr<String>Read-writesubnet_cidr for vip.
pool_id<String>Read-writeVip belongs to this pool id.
segmentation_id<String>Read-writeSegmentation_id of vip.
connection_limit<String>Read-writeMaximum number of connections allowed for the vip.
address<String>Read-writePublic Ip address of vip from subnet id.
id<String>Read-writeId is system generated key for vip.
loadbalancer_id<String>Read-writeId of loadbalancer.
session_persistence<vipsessionpersistence>Read-writeSesssion persistence state of vip.
name<String>Read-writeName of vip.
protocol_port<String>Read-writePort number of protocol.
diameter<String>Read-writeValue of diameter protocol.
description<String>Read-writeDescribes the properties of vip.
network_id<String>Read-writeNetwork_id of vip.

Operations

(click to see Properties)

GET (ALL)| GET

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

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "vip":[{
"protocol":<String_value>,
"subnet_id":<String_value>,
"admin_state_up":<String_value>,
"status":<String_value>,
"port_id":<String_value>,
"subnet_gateway_ip":<String_value>,
"network_type":<String_value>,
"tenant_id":<String_value>,
"subnet_cidr":<String_value>,
"pool_id":<String_value>,
"segmentation_id":<String_value>,
"connection_limit":<String_value>,
"address":<String_value>,
"id":<String_value>,
"loadbalancer_id":<String_value>,
"session_persistence":<vipsessionpersistence_value>,
"name":<String_value>,
"protocol_port":<String_value>,
"diameter":<String_value>,
"description":<String_value>,
"network_id":<String_value>}]}

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "vip":[{
"protocol":<String_value>,
"subnet_id":<String_value>,
"admin_state_up":<String_value>,
"status":<String_value>,
"port_id":<String_value>,
"subnet_gateway_ip":<String_value>,
"network_type":<String_value>,
"tenant_id":<String_value>,
"subnet_cidr":<String_value>,
"pool_id":<String_value>,
"segmentation_id":<String_value>,
"connection_limit":<String_value>,
"address":<String_value>,
"id":<String_value>,
"loadbalancer_id":<String_value>,
"session_persistence":<vipsessionpersistence_value>,
"name":<String_value>,
"protocol_port":<String_value>,
"diameter":<String_value>,
"description":<String_value>,
"network_id":<String_value>}]}