nodes/generated

Interface NetscalerAdcNodeParameters

Source
interface NetscalerAdcNodeParameters {
    additionalFields?: {
        days?: string;
        pempassphrase?: string;
        subjectaltname?: string;
    };
    binaryProperty?: string;
    caCertificateFileFormat?: "PEM"
    | "DER";
    caCertificateFileName?: string;
    caPrivateKeyFileFormat?: "PEM" | "DER";
    caPrivateKeyFileName?: string;
    caSerialFileNumber?: string;
    certificateBundle?: boolean;
    certificateFileName?: string;
    certificateFormat?: "PEM" | "DER";
    certificateKeyPairName?: string;
    certificateRequestFileName?: string;
    certificateType?:
        | "ROOT_CERT"
        | "INTM_CERT"
        | "SRVR_CERT"
        | "CLNT_CERT";
    fileLocation?: string;
    fileName?: string;
    notificationPeriod?: number;
    notifyExpiration?: boolean;
    operation?: | "create"
    | "delete"
    | "upload"
    | "download"
    | "install";
    options?: { fileName?: string };
    password?: string;
    privateKeyFileName?: string;
    privateKeyFormat?: "PEM" | "DER";
    resource?: "file" | "certificate";
}

Properties§

Source§

readonly additionalFields?: {
    days?: string;
    pempassphrase?: string;
    subjectaltname?: string;
}

Default: {}

Source§

readonly binaryProperty?: string

The name of the incoming field containing the binary file data to be processed Default: "data"

Source§

readonly caCertificateFileFormat?: "PEM" | "DER"

Format of the CA certificate Default: "PEM"

Source§

readonly caCertificateFileName?: string

Name of the CA certificate file that issues and signs the Intermediate-CA certificate or the end-user client and server certificates

Source§

readonly caPrivateKeyFileFormat?: "PEM" | "DER"

Format of the CA certificate Default: "PEM"

Source§

readonly caPrivateKeyFileName?: string

Private key, associated with the CA certificate that is used to sign the Intermediate-CA certificate or the end-user client and server certificate. If the CA key file is password protected, the user is prompted to enter the pass phrase that was used to encrypt the key.

Source§

readonly caSerialFileNumber?: string

Serial number file maintained for the CA certificate. This file contains the serial number of the next certificate to be issued or signed by the CA.

Source§

readonly certificateBundle?: boolean

Whether to parse the certificate chain as a single file after linking the server certificate to its issuer's certificate within the file

Source§

readonly certificateFileName?: string

Name for and, optionally, path to the generated certificate file. /nsconfig/ssl/ is the default path.

Source§

readonly certificateFormat?: "PEM" | "DER"

Format in which the certificate is stored on the appliance Default: "PEM"

Source§

readonly certificateKeyPairName?: string

Name for the certificate and private-key pair

Source§

readonly certificateRequestFileName?: string

Name for and, optionally, path to the certificate-signing request (CSR). /nsconfig/ssl/ is the default path.

Source§

readonly certificateType?: "ROOT_CERT" | "INTM_CERT" | "SRVR_CERT" | "CLNT_CERT"

Default: "ROOT_CERT"

Source§

readonly fileLocation?: string

Default: "/nsconfig/ssl/"

Source§

readonly fileName?: string

Name of the file. It should not include filepath.

Source§

readonly notificationPeriod?: number

Time, in number of days, before certificate expiration, at which to generate an alert that the certificate is about to expire Default: 10 Type options: {"minValue":10,"maxValue":100}

Source§

readonly notifyExpiration?: boolean

Whether to alert when the certificate is about to expire

Source§

readonly operation?: "create" | "delete" | "upload" | "download" | "install"

Default: "create"

Source§

readonly options?: { fileName?: string }

Default: {}

Source§

readonly password?: string

Input format of the certificate and the private-key files. The three formats supported by the appliance are: PEM - Privacy Enhanced Mail DER - Distinguished Encoding Rule PFX - Personal Information Exchange. Type options: {"password":true}

Source§

readonly privateKeyFileName?: string

Name for and, optionally, path to the private key. You can either use an existing RSA or DSA key that you own or create a new private key on the Netscaler ADC. This file is required only when creating a self-signed Root-CA certificate. The key file is stored in the /nsconfig/ssl directory by default.

Source§

readonly privateKeyFormat?: "PEM" | "DER"

Format in which the key is stored on the appliance Default: "PEM"

Source§

readonly resource?: "file" | "certificate"

Default: "file"