Skip to content

pool

Configuration for OpenStack Pools resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
protocol<String>Read-writeProtocol of pool. The possible values of protocol are HTTP, HTTPS or TCP.
subnet_id<String>Read-writeSubnet Id used in pool..
admin_state_up<String>Read-writeAdmin State Up status of pool in OpenStack..
status<String>Read-writeStatus of pool..
vip_id<String>Read-writeId of VIP in OpenStack.
subnet_gateway_ip<String>Read-writeSubnet Gateway Ip of pool..
network_type<String>Read-writeType of network where pool is present..
tenant_id<String>Read-writeId of tenant in openstack.
subnet_cidr<String>Read-writeSubnet Cidr of pool..
segmentation_id<String>Read-writeSegmentation Id of pool..
id<String>Read-writeId is system generated key for openstack cloud.
loadbalancer_id<String>Read-writeId of loadbalancer of which the pool is part of..
lb_method<String>Read-writeLB Method of pool. The possible values of lb_method are 'ROUND_ROBIN', 'LEAST_CONNECTIONS', 'SOURCE_IP'.
name<String>Read-writeName of openstack..
description<String>Read-writeDescription of pool..
network_id<String>Read-writeNetwork Id of the pool..

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/pool

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "pool":[{
"protocol":<String_value>,
"subnet_id":<String_value>,
"admin_state_up":<String_value>,
"status":<String_value>,
"vip_id":<String_value>,
"subnet_gateway_ip":<String_value>,
"network_type":<String_value>,
"tenant_id":<String_value>,
"subnet_cidr":<String_value>,
"segmentation_id":<String_value>,
"id":<String_value>,
"loadbalancer_id":<String_value>,
"lb_method":<String_value>,
"name":<String_value>,
"description":<String_value>,
"network_id":<String_value>}]}

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "pool":[{
"protocol":<String_value>,
"subnet_id":<String_value>,
"admin_state_up":<String_value>,
"status":<String_value>,
"vip_id":<String_value>,
"subnet_gateway_ip":<String_value>,
"network_type":<String_value>,
"tenant_id":<String_value>,
"subnet_cidr":<String_value>,
"segmentation_id":<String_value>,
"id":<String_value>,
"loadbalancer_id":<String_value>,
"lb_method":<String_value>,
"name":<String_value>,
"description":<String_value>,
"network_id":<String_value>}]}