Skip to content

lsngroup_binding

Binding object which returns the resources bound to lsngroup.

Properties

(click to see Operations)

NameData TypePermissionsDescription
groupname<String>Read-writeName for the LSN group. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the LSN group is created. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "lsn group1" or 'lsn group1').
Minimum length = 1
Maximum length = 127
lsngroup_lsnsipalgprofile_binding<lsngroup_lsnsipalgprofile_binding[]>Read-onlylsnsipalgprofile that can be bound to lsngroup.
lsngroup_ipsecalgprofile_binding<lsngroup_ipsecalgprofile_binding[]>Read-onlyipsecalgprofile that can be bound to lsngroup.
lsngroup_pcpserver_binding<lsngroup_pcpserver_binding[]>Read-onlypcpserver that can be bound to lsngroup.
lsngroup_lsnhttphdrlogprofile_binding<lsngroup_lsnhttphdrlogprofile_binding[]>Read-onlylsnhttphdrlogprofile that can be bound to lsngroup.
lsngroup_lsnpool_binding<lsngroup_lsnpool_binding[]>Read-onlylsnpool that can be bound to lsngroup.
lsngroup_lsntransportprofile_binding<lsngroup_lsntransportprofile_binding[]>Read-onlylsntransportprofile that can be bound to lsngroup.
lsngroup_lsnlogprofile_binding<lsngroup_lsnlogprofile_binding[]>Read-onlylsnlogprofile that can be bound to lsngroup.
lsngroup_lsnrtspalgprofile_binding<lsngroup_lsnrtspalgprofile_binding[]>Read-onlylsnrtspalgprofile that can be bound to lsngroup.
lsngroup_lsnappsprofile_binding<lsngroup_lsnappsprofile_binding[]>Read-onlylsnappsprofile that can be bound to lsngroup.

Operations

(click to see Properties)

GET| GET (ALL)

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lsngroup_binding/groupname_value<String>

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "lsngroup_binding": [ {
"groupname":<String_value>,
"lsngroup_lsnhttphdrlogprofile_binding":<lsngroup_lsnhttphdrlogprofile_binding[]_value>,
"lsngroup_lsnappsprofile_binding":<lsngroup_lsnappsprofile_binding[]_value>,
"lsngroup_lsnrtspalgprofile_binding":<lsngroup_lsnrtspalgprofile_binding[]_value>,
"lsngroup_lsnsipalgprofile_binding":<lsngroup_lsnsipalgprofile_binding[]_value>,
"lsngroup_lsnpool_binding":<lsngroup_lsnpool_binding[]_value>,
"lsngroup_lsntransportprofile_binding":<lsngroup_lsntransportprofile_binding[]_value>,
"lsngroup_pcpserver_binding":<lsngroup_pcpserver_binding[]_value>,
"lsngroup_ipsecalgprofile_binding":<lsngroup_ipsecalgprofile_binding[]_value>,
"lsngroup_lsnlogprofile_binding":<lsngroup_lsnlogprofile_binding[]_value>
}]}

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lsngroup_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lsngroup_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "lsngroup_binding": [ {
"groupname":<String_value>,
"lsngroup_lsnhttphdrlogprofile_binding":<lsngroup_lsnhttphdrlogprofile_binding[]_value>,
"lsngroup_lsnappsprofile_binding":<lsngroup_lsnappsprofile_binding[]_value>,
"lsngroup_lsnrtspalgprofile_binding":<lsngroup_lsnrtspalgprofile_binding[]_value>,
"lsngroup_lsnsipalgprofile_binding":<lsngroup_lsnsipalgprofile_binding[]_value>,
"lsngroup_lsnpool_binding":<lsngroup_lsnpool_binding[]_value>,
"lsngroup_lsntransportprofile_binding":<lsngroup_lsntransportprofile_binding[]_value>,
"lsngroup_pcpserver_binding":<lsngroup_pcpserver_binding[]_value>,
"lsngroup_ipsecalgprofile_binding":<lsngroup_ipsecalgprofile_binding[]_value>,
"lsngroup_lsnlogprofile_binding":<lsngroup_lsnlogprofile_binding[]_value>
}]}