-
-
-
-
-
-
-
servicegroup
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
videooptimizationdetectionpolicylabel_videooptimizationdetectionpolicy_binding
-
videooptimizationdetectionpolicy_videooptimizationglobaldetection_binding
-
videooptimizationglobaldetection_videooptimizationdetectionpolicy_binding
-
videooptimizationglobalpacing_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicylabel_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicy_videooptimizationglobalpacing_binding
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
servicegroup
Configuration for service group resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| servicegroupname | <String> | Read-write | Name of the service group. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Can be changed after the name is created.
Minimum length = 1 |
| servicetype | <String> | Read-write | Protocol used to exchange data with the service.
Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, RPCSVR, DNS, ADNS, SNMP, RTSP, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, ADNS_TCP, MYSQL, MSSQL, ORACLE, MONGO, MONGO_TLS, RADIUS, RADIUSListener, RDP, DIAMETER, SSL_DIAMETER, TFTP, SMPP, PPTP, GRE, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, USER_TCP, USER_SSL_TCP, QUIC, IPFIX, LOGSTREAM, LOGSTREAM_SSL |
| cachetype | <String> | Read-write | Cache type supported by the cache server.
Possible values = TRANSPARENT, REVERSE, FORWARD |
| td | <Double> | Read-write | Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.
Minimum value = 0 Maximum value = 4094 |
| maxclient | <Double> | Read-write | Maximum number of simultaneous open connections for the service group.
Minimum value = 0 Maximum value = 4294967294 |
| maxreq | <Double> | Read-write | Maximum number of requests that can be sent on a persistent connection to the service group.
Note: Connection requests beyond this value are rejected. Minimum value = 0 Maximum value = 65535 |
| cacheable | <String> | Read-write | Use the transparent cache redirection virtual server to forward the request to the cache server.
Note: Do not set this parameter if you set the Cache Type. Default value: NO Possible values = YES, NO |
| cip | <String> | Read-write | Insert the Client IP header in requests forwarded to the service.
Possible values = ENABLED, DISABLED |
| cipheader | <String> | Read-write | Name of the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If client IP insertion is enabled, and the client IP header is not specified, the value of Client IP Header parameter or the value set by the set ns config command is used as client's IP header name.
Minimum length = 1 |
| usip | <String> | Read-write | Use client's IP address as the source IP address when initiating connection to the server. With the NO setting, which is the default, a mapped IP (MIP) address or subnet IP (SNIP) address is used as the source IP address to initiate server side connections.
Possible values = YES, NO |
| pathmonitor | <String> | Read-write | Path monitoring for clustering.
Possible values = YES, NO |
| pathmonitorindv | <String> | Read-write | Individual Path monitoring decisions.
Possible values = YES, NO |
| useproxyport | <String> | Read-write | Use the proxy port as the source port when initiating connections with the server. With the NO setting, the client-side connection port is used as the source port for the server-side connection.
Note: This parameter is available only when the Use Source IP (USIP) parameter is set to YES. Possible values = YES, NO |
| healthmonitor | <String> | Read-write | Monitor the health of this service. Available settings function as follows:
YES - Send probes to check the health of the service. NO - Do not send probes to check the health of the service. With the NO option, the appliance shows the service as UP at all times. Default value: YES Possible values = YES, NO |
| sc | <String> | Read-write | State of the SureConnect feature for the service group.
Default value: OFF Possible values = ON, OFF |
| sp | <String> | Read-write | Enable surge protection for the service group.
Default value: OFF Possible values = ON, OFF |
| rtspsessionidremap | <String> | Read-write | Enable RTSP session ID mapping for the service group.
Default value: OFF Possible values = ON, OFF |
| clttimeout | <Double> | Read-write | Time, in seconds, after which to terminate an idle client connection.
Minimum value = 0 Maximum value = 31536000 |
| svrtimeout | <Double> | Read-write | Time, in seconds, after which to terminate an idle server connection.
Minimum value = 0 Maximum value = 31536000 |
| cka | <String> | Read-write | Enable client keep-alive for the service group.
Possible values = YES, NO |
| tcpb | <String> | Read-write | Enable TCP buffering for the service group.
Possible values = YES, NO |
| cmp | <String> | Read-write | Enable compression for the specified service.
Possible values = YES, NO |
| maxbandwidth | <Double> | Read-write | Maximum bandwidth, in Kbps, allocated for all the services in the service group.
Minimum value = 0 Maximum value = 4294967287 |
| monthreshold | <Double> | Read-write | Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to mark a service as UP or DOWN.
Minimum value = 0 Maximum value = 65535 |
| state | <String> | Read-write | Initial state of the service group.
Default value: ENABLED Possible values = ENABLED, DISABLED |
| downstateflush | <String> | Read-write | Flush all active transactions associated with all the services in the service group whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.
Default value: ENABLED Possible values = ENABLED, DISABLED |
| tcpprofilename | <String> | Read-write | Name of the TCP profile that contains TCP configuration settings for the service group.
Minimum length = 1 Maximum length = 127 |
| httpprofilename | <String> | Read-write | Name of the HTTP profile that contains HTTP configuration settings for the service group.
Minimum length = 1 Maximum length = 127 |
| comment | <String> | Read-write | Any information about the service group. |
| appflowlog | <String> | Read-write | Enable logging of AppFlow information for the specified service group.
Default value: ENABLED Possible values = ENABLED, DISABLED |
| netprofile | <String> | Read-write | Network profile for the service group.
Minimum length = 1 Maximum length = 127 |
| autoscale | <String> | Read-write | Auto scale option for a servicegroup.
Default value: DISABLED Possible values = DISABLED, DNS, POLICY, CLOUD, API |
| memberport | <Integer> | Read-write | member port. |
| autodisablegraceful | <String> | Read-write | Indicates graceful shutdown of the service. System will wait for all outstanding connections to this service to be closed before disabling the service.
Default value: NO Possible values = YES, NO |
| autodisabledelay | <Double> | Read-write | The time allowed (in seconds) for a graceful shutdown. During this period, new connections or requests will continue to be sent to this service for clients who already have a persistent session on the system. Connections or requests from fresh or new clients who do not yet have a persistence sessions on the system will not be sent to the service. Instead, they will be load balanced among other available services. After the delay time expires, no new requests or connections will be sent to the service. |
| monconnectionclose | <String> | Read-write | Close monitoring connections by sending the service a connection termination message with the specified bit set.
Default value: NONE Possible values = RESET, FIN |
| servername | <String> | Read-write | Name of the server to which to bind the service group.
Minimum length = 1 |
| port | <Integer> | Read-write | Server port number.
Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
| weight | <Double> | Read-write | Weight to assign to the servers in the service group. Specifies the capacity of the servers relative to the other servers in the load balancing configuration. The higher the weight, the higher the percentage of requests sent to the service.
Minimum value = 1 Maximum value = 100 |
| customserverid | <String> | Read-write | The identifier for this IP:Port pair. Used when the persistency type is set to Custom Server ID.
Default value: "None" |
| serverid | <Double> | Read-write | The identifier for the service. This is used when the persistency type is set to Custom Server ID. |
| hashid | <Double> | Read-write | The hash identifier for the service. This must be unique for each service. This parameter is used by hash based load balancing methods.
Minimum value = 1 |
| nameserver | <String> | Read-write | Specify the nameserver to which the query for bound domain needs to be sent. If not specified, use the global nameserver. |
| dbsttl | <Double> | Read-write | Specify the TTL for DNS record for domain based service.The default value of ttl is 0 which indicates to use the TTL received in DNS response for monitors.
Default value: 0 |
| monitor_name_svc | <String> | Read-write | Name of the monitor bound to the service group. Used to assign a weight to the monitor.
Minimum length = 1 |
| dup_weight | <Double> | Read-write | weight of the monitor that is bound to servicegroup.
Minimum value = 1 |
| delay | <Double> | Read-write | Time, in seconds, allocated for a shutdown of the services in the service group. During this period, new requests are sent to the service only for clients who already have persistent sessions on the appliance. Requests from new clients are load balanced among other available services. After the delay time expires, no requests are sent to the service, and the service is marked as unavailable (OUT OF SERVICE). |
| graceful | <String> | Read-write | Wait for all existing connections to the service to terminate before shutting down the service.
Default value: NO Possible values = YES, NO |
| includemembers | <Boolean> | Read-write | Display the members of the listed service groups in addition to their settings. Can be specified when no service group name is provided in the command. In that case, the details displayed for each service group are identical to the details displayed when a service group name is provided, except that bound monitors are not displayed. |
| newname | <String> | Read-write | New name for the service group.
Minimum length = 1 |
| numofconnections | <Integer> | Read-only | This will tell the number of client side connections are still open. |
| serviceconftype | <Boolean> | Read-only | The configuration type of the service group. |
| value | <String> | Read-only | SSL Status.
Possible values = Certkey not bound, SSL feature disabled |
| svrstate | <String> | Read-only | The state of the service.
Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED |
| ip | <String> | Read-only | IP Address. |
| monstatcode | <Integer> | Read-only | The code indicating the monitor response. |
| monstatparam1 | <Integer> | Read-only | First parameter for use with message code. |
| monstatparam2 | <Integer> | Read-only | Second parameter for use with message code. |
| monstatparam3 | <Integer> | Read-only | Third parameter for use with message code. |
| statechangetimemsec | <Double> | Read-only | Time when last state change occurred. Milliseconds part. |
| stateupdatereason | <Double> | Read-only | Checks state update reason on the secondary node. |
| clmonowner | <Double> | Read-only | Tells the mon owner of the service. |
| clmonview | <Double> | Read-only | Tells the view id of the monitoring owner. |
| groupcount | <Double> | Read-only | Servicegroup Count. |
| serviceipstr | <String> | Read-only | This field has been intorduced to show the dbs services ip. |
| servicegroupeffectivestate | <String> | Read-only | Indicates the effective servicegroup state based on the state of the bound service items.If all services are UP the effective state is UP, if all are DOWN its DOWN,if all are OFS its OFS.If atleast one serviceis UP and rest are either DOWN or OFS, the effective state is PARTIAL-UP.If atleast one bound service is DOWN and rest are OFS the effective state is PARTIAL DOWN.
Possible values = UP, DOWN, OUT OF SERVICE, PARTIAL-UP, PARTIAL-DOWN |
| nodefaultbindings | <String> | Read-only | to determine if the configuration is from stylebooks.
Default value: NO Possible values = YES, NO |
| svcitmactsvcs | <Double> | Read-only | This gives the total active service items for an FQDN for SRV type server binding. |
| svcitmboundsvcs | <Double> | Read-only | This gives the total bound items for an FQDN for SRV type server binding. |
| monuserstatusmesg | <String> | Read-only | This field has been introduced to show user monitor failure reasons. |
| __count | <Double> | Read-only | count parameter |
Operations
(click to see Properties )
- ADD
- DELETE
- UPDATE
- UNSET
- ENABLE
- DISABLE
- GET (ALL)
- GET
- COUNT
- RENAME
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
add
URL: http:// <netscaler-ip-address> /nitro/v1/config/servicegroup
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"servicegroup":{
<b> "servicegroupname":<String_value>,
</b><b> "servicetype":<String_value>,
</b> "cachetype":<String_value>,
"td":<Double_value>,
"maxclient":<Double_value>,
"maxreq":<Double_value>,
"cacheable":<String_value>,
"cip":<String_value>,
"cipheader":<String_value>,
"usip":<String_value>,
"pathmonitor":<String_value>,
"pathmonitorindv":<String_value>,
"useproxyport":<String_value>,
"healthmonitor":<String_value>,
"sc":<String_value>,
"sp":<String_value>,
"rtspsessionidremap":<String_value>,
"clttimeout":<Double_value>,
"svrtimeout":<Double_value>,
"cka":<String_value>,
"tcpb":<String_value>,
"cmp":<String_value>,
"maxbandwidth":<Double_value>,
"monthreshold":<Double_value>,
"state":<String_value>,
"downstateflush":<String_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"comment":<String_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"autoscale":<String_value>,
"memberport":<Integer_value>,
"autodisablegraceful":<String_value>,
"autodisabledelay":<Double_value>,
"monconnectionclose":<String_value>
}}
<!--NeedCopy-->
Response:
HTTP Status Code on Success: 201 Created
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
delete
URL: http:// <netscaler-ip-address> /nitro/v1/config/servicegroup/ servicegroupname_value<String>
HTTP Method: DELETE
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
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
update
URL: http:// <netscaler-ip-address> /nitro/v1/config/servicegroup
HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"servicegroup":{
<b> "servicegroupname":<String_value>,
</b> "servername":<String_value>,
"port":<Integer_value>,
"weight":<Double_value>,
"customserverid":<String_value>,
"serverid":<Double_value>,
"hashid":<Double_value>,
"nameserver":<String_value>,
"dbsttl":<Double_value>,
"monitor_name_svc":<String_value>,
"dup_weight":<Double_value>,
"maxclient":<Double_value>,
"maxreq":<Double_value>,
"healthmonitor":<String_value>,
"cacheable":<String_value>,
"cip":<String_value>,
"cipheader":<String_value>,
"usip":<String_value>,
"pathmonitor":<String_value>,
"pathmonitorindv":<String_value>,
"useproxyport":<String_value>,
"sc":<String_value>,
"sp":<String_value>,
"rtspsessionidremap":<String_value>,
"clttimeout":<Double_value>,
"svrtimeout":<Double_value>,
"cka":<String_value>,
"tcpb":<String_value>,
"cmp":<String_value>,
"maxbandwidth":<Double_value>,
"monthreshold":<Double_value>,
"downstateflush":<String_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"comment":<String_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"autodisablegraceful":<String_value>,
"autodisabledelay":<Double_value>,
"monconnectionclose":<String_value>,
"autoscale":<String_value>
}}
<!--NeedCopy-->
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
unset
URL: http:// <netscaler-ip-address> /nitro/v1/config/servicegroup? action=unset
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"servicegroup":{
<b> "servicegroupname":<String_value>,
</b> "servername":true,
"port":true,
"weight":true,
"customserverid":true,
"serverid":true,
"hashid":true,
"nameserver":true,
"dbsttl":true,
"maxclient":true,
"maxreq":true,
"cacheable":true,
"cip":true,
"usip":true,
"useproxyport":true,
"sc":true,
"sp":true,
"rtspsessionidremap":true,
"clttimeout":true,
"svrtimeout":true,
"cka":true,
"tcpb":true,
"cmp":true,
"maxbandwidth":true,
"monthreshold":true,
"tcpprofilename":true,
"httpprofilename":true,
"appflowlog":true,
"netprofile":true,
"autodisablegraceful":true,
"autodisabledelay":true,
"monitor_name_svc":true,
"dup_weight":true,
"healthmonitor":true,
"cipheader":true,
"pathmonitor":true,
"pathmonitorindv":true,
"downstateflush":true,
"comment":true,
"monconnectionclose":true
}}
<!--NeedCopy-->
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
enable
URL: http:// <netscaler-ip-address> /nitro/v1/config/servicegroup? action=enable
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"servicegroup":{
<b> "servicegroupname":<String_value>,
</b> "servername":<String_value>,
"port":<Integer_value>
}}
<!--NeedCopy-->
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
disable
URL: http:// <netscaler-ip-address> /nitro/v1/config/servicegroup? action=disable
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"servicegroup":{
<b> "servicegroupname":<String_value>,
</b> "servername":<String_value>,
"port":<Integer_value>,
"delay":<Double_value>,
"graceful":<String_value>
}}
<!--NeedCopy-->
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
rename
URL: http:// <netscaler-ip-address> /nitro/v1/config/servicegroup? action=rename
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"servicegroup":{
<b> "servicegroupname":<String_value>,
</b><b> "newname":<String_value>
</b>}}
<!--NeedCopy-->
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/servicegroup
Query-parameters:
args
http:// <netscaler-ip-address> /nitro/v1/config/servicegroup? args=servicegroupname: <String_value> ,includemembers: <Boolean_value>
Use this query-parameter to get servicegroup resources based on additional properties.
attrs
http:// <netscaler-ip-address> /nitro/v1/config/servicegroup? 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/servicegroup? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of servicegroup resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http:// <netscaler-ip-address> /nitro/v1/config/servicegroup? view=summary
Use this query-parameter to get the summary output of servicegroup resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination
http:// <netscaler-ip-address> /nitro/v1/config/servicegroup? pagesize=#no;pageno=#no
Use this query-parameter to get the servicegroup 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 Header:
Content-Type:application/json
Response Payload:
{ "servicegroup": [ {
servicegroupname:<String_value>,includemembers:<Boolean_value> "numofconnections":<Integer_value>,
"servicetype":<String_value>,
"port":<Integer_value>,
"td":<Double_value>,
"serviceconftpye":<Boolean_value>,
"serviceconftype":<Boolean_value>,
"value":<String_value>,
"cachetype":<String_value>,
"maxclient":<Double_value>,
"maxreq":<Double_value>,
"cacheable":<String_value>,
"cip":<String_value>,
"cipheader":<String_value>,
"usip":<String_value>,
"pathmonitor":<String_value>,
"pathmonitorindv":<String_value>,
"useproxyport":<String_value>,
"sc":<String_value>,
"sp":<String_value>,
"rtspsessionidremap":<String_value>,
"clttimeout":<Double_value>,
"svrtimeout":<Double_value>,
"cka":<String_value>,
"tcpb":<String_value>,
"cmp":<String_value>,
"maxbandwidth":<Double_value>,
"state":<String_value>,
"svrstate":<String_value>,
"delay":<Double_value>,
"ip":<String_value>,
"servername":<String_value>,
"monthreshold":<Double_value>,
"weight":<Double_value>,
"customserverid":<String_value>,
"serverid":<Double_value>,
"monstatcode":<Integer_value>,
"monstatparam1":<Integer_value>,
"monstatparam2":<Integer_value>,
"monstatparam3":<Integer_value>,
"downstateflush":<String_value>,
"statechangetimemsec":<Double_value>,
"timesincelaststatechange":<Double_value>,
"stateupdatereason":<Double_value>,
"clmonowner":<Double_value>,
"clmonview":<Double_value>,
"groupcount":<Double_value>,
"comment":<String_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"hashid":<Double_value>,
"graceful":<String_value>,
"healthmonitor":<String_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"autoscale":<String_value>,
"memberport":<Integer_value>,
"autodisablegraceful":<String_value>,
"autodisabledelay":<Double_value>,
"serviceipstr":<String_value>,
"servicegroupeffectivestate":<String_value>,
"monconnectionclose":<String_value>,
"nodefaultbindings":<String_value>,
"nameserver":<String_value>,
"dbsttl":<Double_value>,
"svcitmactsvcs":<Double_value>,
"svcitmboundsvcs":<Double_value>,
"monuserstatusmesg":<String_value>
}]}
<!--NeedCopy-->
get
URL: http:// <netscaler-ip-address> /nitro/v1/config/servicegroup/ servicegroupname_value<String>
Query-parameters:
attrs
http:// <netscaler-ip-address> /nitro/v1/config/servicegroup/ servicegroupname_value<String> ? 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/servicegroup/ servicegroupname_value<String> ? view=summary
Use this query-parameter to get the summary output of servicegroup resources configured on NetScaler.
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 Header:
Content-Type:application/json
Response Payload:
{ "servicegroup": [ {
servicegroupname:<String_value>,includemembers:<Boolean_value> "numofconnections":<Integer_value>,
"servicetype":<String_value>,
"port":<Integer_value>,
"td":<Double_value>,
"serviceconftpye":<Boolean_value>,
"serviceconftype":<Boolean_value>,
"value":<String_value>,
"cachetype":<String_value>,
"maxclient":<Double_value>,
"maxreq":<Double_value>,
"cacheable":<String_value>,
"cip":<String_value>,
"cipheader":<String_value>,
"usip":<String_value>,
"pathmonitor":<String_value>,
"pathmonitorindv":<String_value>,
"useproxyport":<String_value>,
"sc":<String_value>,
"sp":<String_value>,
"rtspsessionidremap":<String_value>,
"clttimeout":<Double_value>,
"svrtimeout":<Double_value>,
"cka":<String_value>,
"tcpb":<String_value>,
"cmp":<String_value>,
"maxbandwidth":<Double_value>,
"state":<String_value>,
"svrstate":<String_value>,
"delay":<Double_value>,
"ip":<String_value>,
"servername":<String_value>,
"monthreshold":<Double_value>,
"weight":<Double_value>,
"customserverid":<String_value>,
"serverid":<Double_value>,
"monstatcode":<Integer_value>,
"monstatparam1":<Integer_value>,
"monstatparam2":<Integer_value>,
"monstatparam3":<Integer_value>,
"downstateflush":<String_value>,
"statechangetimemsec":<Double_value>,
"timesincelaststatechange":<Double_value>,
"stateupdatereason":<Double_value>,
"clmonowner":<Double_value>,
"clmonview":<Double_value>,
"groupcount":<Double_value>,
"comment":<String_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"hashid":<Double_value>,
"graceful":<String_value>,
"healthmonitor":<String_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"autoscale":<String_value>,
"memberport":<Integer_value>,
"autodisablegraceful":<String_value>,
"autodisabledelay":<Double_value>,
"serviceipstr":<String_value>,
"servicegroupeffectivestate":<String_value>,
"monconnectionclose":<String_value>,
"nodefaultbindings":<String_value>,
"nameserver":<String_value>,
"dbsttl":<Double_value>,
"svcitmactsvcs":<Double_value>,
"svcitmboundsvcs":<Double_value>,
"monuserstatusmesg":<String_value>
}]}
<!--NeedCopy-->
count
URL: http:// <netscaler-ip-address> /nitro/v1/config/servicegroup? 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 Header:
Content-Type:application/json
Response Payload:
{ "servicegroup": [ { "__count": "#no"} ] }
<!--NeedCopy-->
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select Do Not Agree to exit.