ADC NITRO APIs

systemextramgmtcpu

Configuration for 0 resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
nodeid Read-write Unique number that identifies the cluster node.

Minimum value = 0

Maximum value = 31
configuredstate Read-only Get the configured state of extra manahement cpu.

Default value: DISABLED

Possible values = ENABLED, DISABLED
effectivestate Read-only Get the current running state of extra management cpu.

Default value: DISABLED

Possible values = ENABLED, DISABLED

Operations

(click to see Properties )

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

enable

URL: http:// <netscaler-ip-address> /nitro/v1/config/systemextramgmtcpu? action=enable HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"systemextramgmtcpu":{
}}

<!--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/systemextramgmtcpu? action=disable HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"systemextramgmtcpu":{
}}

<!--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/systemextramgmtcpu Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/systemextramgmtcpu? args=nodeid: <Double_value>

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

Response Header:

Content-Type:application/json

Response Payload:

{ "systemextramgmtcpu": [ {
nodeid:<Double_value>"configuredstate":<String_value>,
"effectivestate":<String_value>
}]}

<!--NeedCopy-->
systemextramgmtcpu