Developer Documentation
NetScaler SDX 13.1 NITRO API Reference

platform_specs

March 20, 2024
Contributed by: 
C

Configuration for Platform Specification resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
cpu_cores_per_vm_list <Integer[]> Read-only List of CPU cores which can be allocated to VM.
contains_fortville_nics Read-only check if Fortville nic card is present.
max_channels Read-only Maximum number of channels available.
contains_cavium Read-only check if Cavium chips are present.
no_of_mgmt_interfaces Read-only total number of management interfaces available.
contains_raid Read-only Enable RAID for the platform.
cavium_vf_to_acu_x Read-only Maximum number of CPU cores which can be allocated to VM.
contains_swraid Read-only Enable SW RAID for the platform.
is_fips_present Read-only To check if FIPS is present.
is_nextgen Read-only If NextGen Platform.
max_cores_per_vm Read-only Maximum number of CPU cores which can be allocated to VM.
cavium_vf_to_scu_x Read-only Maximum number of CPU cores which can be allocated to VM.
contains_mnx_nics Read-only check if mellanox nics card are present.
contains_coleto Read-only check if Coleto chips are present.

Operations

(click to see Properties )

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/platform_specs Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/platform_specs ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of platform_specs resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/platform_specs ?pagesize=#no;pageno=#no Use this query-parameter to get the platform_specs resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/platform_specs ?count=yes Use this query-parameter to get the count of platform_specs resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "platform_specs":[{
"cpu_cores_per_vm_list":<Integer_value>,
"contains_fortville_nics":<Boolean_value>,
"max_channels":<Integer_value>,
"contains_cavium":<Boolean_value>,
"no_of_mgmt_interfaces":<Integer_value>,
"contains_raid":<Boolean_value>,
"cavium_vf_to_acu_x":<Integer_value>,
"contains_swraid":<Boolean_value>,
"is_fips_present":<Boolean_value>,
"is_nextgen":<Boolean_value>,
"max_cores_per_vm":<Integer_value>,
"cavium_vf_to_scu_x":<Integer_value>,
"contains_mnx_nics":<Boolean_value>,
"contains_coleto":<Boolean_value>}]}

<!--NeedCopy-->
platform_specs
March 20, 2024
Contributed by: 
C
March 20, 2024
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.