Skip to content

scpolicy

Statistics for SureConnect policy resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName of the policy about which to display statistics. To display statistics about all SureConnect policies, do not set this parameter.
Minimum length = 1
Maximum length = 31
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
avgservertransactiontime<Double>Read-onlyAverage server transaction time in seconds for this SureConnect Policy.
avgservertransactiontimerate<Double>Read-onlyRate (/s) counter for avgservertransactiontime
scaverageclientttlb<Double>Read-onlyAverage value of the client Time-To-Last-Byte in seconds for this SureConnect policy.
scaverageclientttlbrate<Double>Read-onlyRate (/s) counter for scaverageclientttlb
scphysicalserviceip<String>Read-onlyIP address of the service in dotted notation for which these statistics are maintained.
scphysicalserviceport<Integer>Read-onlyPort of the service for which these statistics are maintained.
sccurrentclientconnections<Double>Read-onlyNumber of clients currently allowed a server connection by this SureConnect policy.
sccurrentclientconnectionsrate<Double>Read-onlyRate (/s) counter for sccurrentclientconnections
sccurrentwaitingclients<Double>Read-onlyCurrent number of SureConnect priority clients that are waiting for a server connection.
sccurrentwaitingclientsrate<Double>Read-onlyRate (/s) counter for sccurrentwaitingclients
totopenconn<Double>Read-onlyCurrent number of open connections to the servers matching this policy.
openconnrate<Double>Read-onlyRate (/s) counter for totopenconn
sccurrentwaitingtime<Double>Read-onlyValue of the currently estimated waiting time in seconds for the configured URL.
sccurrentwaitingtimerate<Double>Read-onlyRate (/s) counter for sccurrentwaitingtime
sctotalclientconnections<Double>Read-onlyTotal number of clients that were allowed a server connection by this SureConnect policy.
scclientconnectionsrate<Double>Read-onlyRate (/s) counter for sctotalclientconnections
sctotalserverconnections<Double>Read-onlyTotal number of server connections that were established through this SureConnect policy.
scserverconnectionsrate<Double>Read-onlyRate (/s) counter for sctotalserverconnections
totclienttransaction<Double>Read-onlyTotal number of client transactions processed by this SureConnect policy.
clienttransactionrate<Double>Read-onlyRate (/s) counter for totclienttransaction
sctotalservertransactions<Double>Read-onlyNumber of 200 OK responses received from the web server by this SureConnect policy.
scservertransactionsrate<Double>Read-onlyRate (/s) counter for sctotalservertransactions
sctotalrequestsreceived<Double>Read-onlyTotal number of requests received by this SureConnect policy.
screquestsreceivedrate<Double>Read-onlyRate (/s) counter for sctotalrequestsreceived
sctotalrequestbytes<Double>Read-onlyTotal number of request bytes received by this SureConnect policy.
screquestbytesrate<Double>Read-onlyRate (/s) counter for sctotalrequestbytes
sctotalresponsesreceived<Double>Read-onlyTotal number of server responses received by this SureConnect policy.
scresponsesreceivedrate<Double>Read-onlyRate (/s) counter for sctotalresponsesreceived
sctotalresponsebytes<Double>Read-onlyTotal number of response bytes received by this SureConnect policy.
scresponsebytesrate<Double>Read-onlyRate (/s) counter for sctotalresponsebytes

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 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 (all)

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

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/scpolicy?args=name:<String_value>,detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get scpolicy resources based on additional properties.

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:

{ "scpolicy": [ {
"name":<String_value>,
"sctotalresponsesreceived":<Double_value>,
"sccurrentwaitingtime":<Double_value>,
"clienttransactionrate":<Double_value>,
"sccurrentwaitingtimerate":<Double_value>,
"sccurrentwaitingclients":<Double_value>,
"sctotalrequestsreceived":<Double_value>,
"screquestsreceivedrate":<Double_value>,
"scresponsebytesrate":<Double_value>,
"screquestbytesrate":<Double_value>,
"sctotalresponsebytes":<Double_value>,
"scserverconnectionsrate":<Double_value>,
"sctotalservertransactions":<Double_value>,
"sccurrentwaitingclientsrate":<Double_value>,
"scaverageclientttlb":<Double_value>,
"avgservertransactiontime":<Double_value>,
"scphysicalserviceip":<String_value>,
"sccurrentclientconnectionsrate":<Double_value>,
"sccurrentclientconnections":<Double_value>,
"openconnrate":<Double_value>,
"scclientconnectionsrate":<Double_value>,
"scaverageclientttlbrate":<Double_value>,
"totclienttransaction":<Double_value>,
"scservertransactionsrate":<Double_value>,
"sctotalclientconnections":<Double_value>,
"scphysicalserviceport":<Integer_value>,
"totopenconn":<Double_value>,
"avgservertransactiontimerate":<Double_value>,
"scresponsesreceivedrate":<Double_value>,
"sctotalrequestbytes":<Double_value>,
"sctotalserverconnections":<Double_value>
}]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/scpolicy/name_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:

{ "scpolicy": [ {
"name":<String_value>,
"sctotalresponsesreceived":<Double_value>,
"sccurrentwaitingtime":<Double_value>,
"clienttransactionrate":<Double_value>,
"sccurrentwaitingtimerate":<Double_value>,
"sccurrentwaitingclients":<Double_value>,
"sctotalrequestsreceived":<Double_value>,
"screquestsreceivedrate":<Double_value>,
"scresponsebytesrate":<Double_value>,
"screquestbytesrate":<Double_value>,
"sctotalresponsebytes":<Double_value>,
"scserverconnectionsrate":<Double_value>,
"sctotalservertransactions":<Double_value>,
"sccurrentwaitingclientsrate":<Double_value>,
"scaverageclientttlb":<Double_value>,
"avgservertransactiontime":<Double_value>,
"scphysicalserviceip":<String_value>,
"sccurrentclientconnectionsrate":<Double_value>,
"sccurrentclientconnections":<Double_value>,
"openconnrate":<Double_value>,
"scclientconnectionsrate":<Double_value>,
"scaverageclientttlbrate":<Double_value>,
"totclienttransaction":<Double_value>,
"scservertransactionsrate":<Double_value>,
"sctotalclientconnections":<Double_value>,
"scphysicalserviceport":<Integer_value>,
"totopenconn":<Double_value>,
"avgservertransactiontimerate":<Double_value>,
"scresponsesreceivedrate":<Double_value>,
"sctotalrequestbytes":<Double_value>,
"sctotalserverconnections":<Double_value>
}]}