Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

nsvpxparam

August 17, 2023
Contributed by: 
C

Configuration for “VPX” resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
cpuyield Read-write This setting applicable in virtual appliances, is to affect the cpu yield(relinquishing the cpu resources) in any hypervised environment.

* There are 3 options for the behavior:
1. YES - Allow the Virtual Appliance to yield its vCPUs periodically, if there is no data traffic.
2. NO - Virtual Appliance will not yield the vCPU.
3. DEFAULT - Restores the default behaviour, according to the license.

* Its behavior in different scenarios:
1. As this setting is node specific only, it will not be propagated to other nodes, when executed on Cluster(CLIP) and HA(Primary).
2. In cluster setup, use ‘-ownerNode’ to specify ID of the cluster node.
3. This setting is a system wide implementation and not granular to vCPUs.
4. No effect on the management PE.
Possible values = DEFAULT, YES, NO
ownernode Read-write ID of the cluster node for which you are setting the cpuyield. It can be configured only through the cluster IP address.
Default value: 255
Minimum value = 0
Maximum value = 31
__count Read-only count parameter

Operations

(click to see Properties)

UPDATE GET (ALL) COUNT

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>.

update

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

HTTP Method:PUT

Request Headers:

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

Request Payload: 


{"nsvpxparam":{
<b>"cpuyield":<String_value>,
</b>"ownernode":<Double_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 Citrix ADC specific errors). The response payload provides details of the error

get (all)

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

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsvpxparam?attrs=property-name1,property-name2

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

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsvpxparam?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsvpxparam?view=summary

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

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsvpxparam?pagesize=#no;pageno=#no

Use this query-parameter to get the nsvpxparam 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "nsvpxparam": [ {
"cpuyield":<String_value>,
"ownernode":<Double_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsvpxparam?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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


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

<!--NeedCopy-->
nsvpxparam
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.