Skip to content


Configuration for backup components resource.

(click to see Operations)


(click to see Operations)

NameData TypePermissionsDescription
component_message<String>Read-writeInformation about the componenet.
component_versions<String>Read-writeBackup component version.
component_minimum_version<String>Read-writeMinimum version supported by the NetScaler.
backup_file_name<String>Read-writeBackup file name.
Maximum length = 64
component<String>Read-writeBackup component.
component_name<String>Read-writeBackup component Name.
component_ip<String>Read-writeBackup component IPaddress.
component_version_bit<String>Read-write(32/64 bit) information for backup component version.
component_hostname<String>Read-writeBackup component VM Name.
component_error_severity<Integer>Read-writeSeverity of error for the component.


(click to see Properties)

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:


    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:



    Note: In such cases, make sure that the request header DOES not include the following:



Mandatory parameters are marked in red and placeholder content is marked in <green>.