pool
Configuration for OpenStack Pools resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| protocol |
|
Read-write | Protocol of pool. The possible values of protocol are HTTP, HTTPS or TCP. |
| subnet_id |
|
Read-write | Subnet Id used in pool.. |
| admin_state_up |
|
Read-write | Admin State Up status of pool in OpenStack.. |
| status |
|
Read-write | Status of pool.. |
| vip_id |
|
Read-write | Id of VIP in OpenStack. |
| subnet_gateway_ip |
|
Read-write | Subnet Gateway Ip of pool.. |
| network_type |
|
Read-write | Type of network where pool is present.. |
| tenant_id |
|
Read-write | Id of tenant in openstack. |
| subnet_cidr |
|
Read-write | Subnet Cidr of pool.. |
| segmentation_id |
|
Read-write | Segmentation Id of pool.. |
| id |
|
Read-write | Id is system generated key for openstack cloud. |
| loadbalancer_id |
|
Read-write | Id of loadbalancer of which the pool is part of.. |
| lb_method |
|
Read-write | LB Method of pool. The possible values of lb_method are ‘ROUND_ROBIN’, ‘LEAST_CONNECTIONS’, ‘SOURCE_IP’. |
| name |
|
Read-write | Name of openstack.. |
| description |
|
Read-write | Description of pool.. |
| network_id |
|
Read-write | Network 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
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/pool Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/pool ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of pool 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/pool ?pagesize=#no;pageno=#no Use this query-parameter to get the pool resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/pool ?count=yes Use this query-parameter to get the count of pool 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, "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>}]}
<!--NeedCopy-->
get
URL: https://<MGMT-IP>/nitro/v2/config/pool/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, "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>}]}
<!--NeedCopy-->