ADC NITRO APIs

nsvpxparam

August 17, 2023

Contributed by:

Configuration for “VPX” resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
masterclockcpu1	<String>	Read-write	This setting applicable in virtual appliances, to move master clock source cpu from management cpu cpu0 to cpu1 ie PE0. * There are 2 options for the behavior: 1. YES - Allow the Virtual Appliance to move clock source to cpu1. 2. NO - Virtual Appliance will use management cpu ie cpu0 for clock source default option is NO. Possible values = YES, NO
cpuyield	<String>	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. Default value: DEFAULT Possible values = DEFAULT, YES, NO
ownernode	<Double>	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
vpxenvironment	<String>	Read-only	Shows VPX Running Environmentrunning 0 VPX ON PREM, 1 AWS, 2 OPENSTACK 3 Azure, 4 GCP CLoud . Possible values = VPX, AWSCLOUD, OPENSTACKCLOUD, AZURECLOUD, GOOGLECLOUD
memorystatus	<String>	Read-only	Provides the information about memory status. Possible values = Sufficent, Insufficent
cloudproductcode	<String>	Read-only	Cloud Product Code Description . Maximum length = 127
vpxoemcode	<Double>	Read-only	OEM Distribution Code. .
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties )

UPDATE
UNSET
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 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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nsvpxparam":{
      "masterclockcpu1":<String_value>,
      "cpuyield":<String_value>,
      "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 NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsvpxparam? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nsvpxparam":{
      "masterclockcpu1":true,
      "cpuyield":true,
      "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 NetScaler-specific errors). The response payload provides details of the error

get (all)

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

Query-parameters:

attrs

http:// <netscaler-ip-address> /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:// <netscaler-ip-address> /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 NetScaler.Filtering can be done on any of the properties of the resource.

view

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

Use this query-parameter to get the summary output of nsvpxparam 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/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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "nsvpxparam": [ {
      "cpuyield":<String_value>,
      "ownernode":<Double_value>,
      "masterclockcpu1":<String_value>,
      "vpxenvironment":<String_value>,
      "memorystatus":<String_value>,
      "cloudproductcode":<String_value>,
      "vpxoemcode":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

nsvpxparam

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

nsvpxparam

Properties

Operations

update

unset

get (all)

count

In this article