Developer Documentation
Citrix ADM NITRO API Reference

backup_component

June 20, 2023
Contributed by: 
C

Configuration for backup components resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
component_message Read-write Information about the componenet.
component_versions Read-write Backup component version.
component_minimum_version Read-write Minimum version supported by the Citrix ADC.
backup_file_name Read-write Backup file name.

Maximum length = 64
component Read-write Backup component.
component_name Read-write Backup component Name.
component_ip Read-write Backup component IPaddress.
component_version_bit Read-write (32/64 bit) information for backup component version.
component_hostname Read-write Backup component VM Name.
component_error_severity Read-write Severity of error for the component.

Operations

(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:

      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

    backup_component
    June 20, 2023
    Contributed by: 
    C
    June 20, 2023
    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.