Product Documentation

lacp

Sep 07, 2016

Configuration for Link aggregation control protocol resource.

Properties (click to see Operations)

Name Data Type Permissions Description
syspriority
<Double>
Read-write
Priority number that determines which peer device of an LACP LA channel can have control over the LA channel. This parameter is globally applied to all LACP channels on the NetScaler appliance. The lower the number, the higher the priority.
Default value: 32768
Minimum value = 1
Maximum value = 65535
ownernode
<Double>
Read-write
The owner node in a cluster for which we want to set the lacp priority. Owner node can vary from 0 to 31. Ownernode value of 254 is used for Cluster.
Default value: 255
devicename
<String>
Read-only
Name of the channel.
mac
<String>
Read-only
LACP system MAC.
flags
<Double>
Read-only
Flags of this channel.
lacpkey
<Double>
Read-only
LACP key of this channel.
clustersyspriority
<Double>
Read-only
LACP system (Cluster) priority.
clustermac
<String>
Read-only
LACP system (Cluster) mac.
__count
<Double>
Read-only
count parameter

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

update

URL: http://<netscaler-ip-address>/nitro/v1/config/lacp

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"lacp":{
      "syspriority":<Double_value>,
      "ownernode":<Double_value>
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/lacp

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/lacp?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/lacp?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of lacp resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/lacp?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/lacp?pagesize=#no&pageno=#no

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "lacp": [ {
      "ownernode":<Double_value>,
      "devicename":<String_value>,
      "syspriority":<Double_value>,
      "mac":<String_value>,
      "flags":<Double_value>,
      "lacpkey":<Double_value>,
      "clustersyspriority":<Double_value>,
      "clustermac":<String_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/lacp/ownernode_value<Double>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/lacp/ownernode_value<Double>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<netscaler-ip-address>/nitro/v1/config/lacp/ownernode_value<Double>?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "lacp": [ {
      "ownernode":<Double_value>,
      "devicename":<String_value>,
      "syspriority":<Double_value>,
      "mac":<String_value>,
      "flags":<Double_value>,
      "lacpkey":<Double_value>,
      "clustersyspriority":<Double_value>,
      "clustermac":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/lacp?count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "lacp": [ { "__count": "#no"} ] }