The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The following are the possible NX-API errors, error codes, and messages of an NX-API response.
Note | The standard HTTP error codes are at the Hypertext Transfer Protocol (HTTP) Status Code Registry (http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml). |
NX-API Response |
Code |
Message |
SUCCESS |
200 |
Success. |
CUST_OUTPUT_PIPED |
204 |
Output is piped elsewhere due to request. |
BASH_CMD_ERR |
400 |
Input Bash command error. |
CHUNK_ALLOW_ONE_CMD_ERR |
400 |
Chunking only allowed to one command. |
CLI_CLIENT_ERR |
400 |
CLI execution error. |
CLI_CMD_ERR |
400 |
Input CLI command error. |
IN_MSG_ERR |
400 |
Request message is invalid. |
NO_INPUT_CMD_ERR |
400 |
No input command. |
PERM_DENY_ERR |
401 |
Permission denied. |
CONF_NOT_ALLOW_SHOW_ERR |
405 |
Configuration mode does not allow show . |
SHOW_NOT_ALLOW_CONF_ERR |
405 |
Show mode does not allow configuration. |
EXCEED_MAX_SHOW_ERR |
413 |
Maximum number of consecutive show commands exceeded. The maximum is 10. |
MSG_SIZE_LARGE_ERR |
413 |
Response size too large. |
BACKEND_ERR |
500 |
Backend processing error. |
FILE_OPER_ERR |
500 |
System internal file operation error. |
LIBXML_NS_ERR |
500 |
System internal LIBXML NS error. |
LIBXML_PARSE_ERR |
500 |
System internal LIBXML parse error. |
LIBXML_PATH_CTX_ERR |
500 |
System internal LIBXML path context error. |
MEM_ALLOC_ERR |
500 |
System internal memory allocation error. |
USER_NOT_FOUND_ERR |
500 |
User not found from input or cache. |
XML_TO_JSON_CONVERT_ERR |
500 |
XML to JSON conversion error. |
BASH_CMD_NOT_SUPPORTED_ERR |
501 |
Bash command not supported. |
CHUNK_ALLOW_XML_ONLY_ERR |
501 |
Chunking allows only XML output. |
JSON_NOT_SUPPORTED_ERR |
501 |
JSON not supported due to large amount of output. |
MSG_TYPE_UNSUPPORTED_ERR |
501 |
Message type not supported. |
PIPE_OUTPUT_NOT_SUPPORTED_ERR |
501 |
Pipe operation not supported. |
PIPE_XML_NOT_ALLOWED_IN_INPUT |
501 |
Pipe XML is not allowed in input. |
RESP_BIG_JSON_NOT_ALLOWED_ERR |
501 |
Response has large amount of output. JSON not supported. |
STRUCT_NOT_SUPPORTED_ERR |
501 |
Structured output unsupported. |
ERR_UNDEFINED |
600 |
Undefined. |