Skip to content
Was this article helpful?

vip

Configuration for vip configuration resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
protocol <String> Read-write Protocol used by vip.
subnet_id <String> Read-write Subnet Id of vip.
admin_state_up <String> Read-write Admin is up or down.
status <String> Read-write status of vip.
port_id <String> Read-write Port Id of requests.
subnet_gateway_ip <String> Read-write Ip of subnet gateway for vip.
network_type <String> Read-write Type of network .
tenant_id <String> Read-write Id of admin tenant..
subnet_cidr <String> Read-write subnet_cidr for vip.
pool_id <String> Read-write Vip belongs to this pool id.
segmentation_id <String> Read-write Segmentation_id of vip.
connection_limit <String> Read-write Maximum number of connections allowed for the vip.
address <String> Read-write Public Ip address of vip from subnet id.
id <String> Read-write Id is system generated key for vip.
loadbalancer_id <String> Read-write Id of loadbalancer.
session_persistence <vipsessionpersistence> Read-write Sesssion persistence state of vip.
name <String> Read-write Name of vip.
protocol_port <String> Read-write Port number of protocol.
diameter <String> Read-write Value of diameter protocol.
description <String> Read-write Describes the properties of vip.
network_id <String> Read-write Network_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

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

get (all)

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

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/vip ?filter=property-name1:property-value1,property-name2:property-value2

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

Use this query-parameter to get the vip resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/vip ?count=yes

Use this query-parameter to get the count of vip resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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 Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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/v2/config/vip/id_value<String>

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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 Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>}]}
Was this article helpful?