f5-conx-core/dist/bigip/as3Client.d.ts

F5 SDK for JavaScript with Typescript type definitions

import { AxiosResponseWithTimings } from "../utils/httpModels";
import { AtcInfo } from "./bigipModels";
import { MgmtClient } from "./mgmtClient";
import { atcMetaData } from '../constants';
import { AdcDeclaration, As3Declaration } from "./as3Models";
/**
 * AS3 client class that handles AS3 calls
 */
export declare class As3Client {
    readonly mgmtClient: MgmtClient;
    metaData: typeof atcMetaData.as3;
    /**
     * AS3 service version information
     */
    readonly version: AtcInfo;
    /**
     * declarations of targets (typically from bigiq)
     */
    targets: {
        label: string;
        declaration: unknown;
        target: string;
        id: string;
        schemaVersion: string;
        updateMode: string;
    }[];
    /**
     * list of tenants/declarations
     */
    tenants: {
        class: string;
        schemaVersion: string;
        updateMode: string;
        [key: string]: unknown;
    }[];
    constructor(versions: AtcInfo, as3MetaData: typeof atcMetaData.as3, mgmtClient: MgmtClient);
    /**
     * get as3 tasks
     * @param task ID to get
     * if no task, returns all
     */
    getTasks(id?: string): Promise<AxiosResponseWithTimings>;
    /**
     * get AS3 declaration(s)
     *
     * ** extended/full are pretty much the same **
     *
     * @param options.expanded get extended/full declartion (includes default tmos settings)
     */
    getDecs(options?: {
        expanded?: boolean;
        tenant?: string;
    }): Promise<AxiosResponseWithTimings>;
    /**
     * Post AS3 delcaration
     * ** async by default **
     * @param data delaration to post
     */
    postDec(data: As3Declaration | AdcDeclaration): Promise<AxiosResponseWithTimings>;
    /**
     * Remove AS3 tenant - works with both bigip and bigiq
     *
     * ** target parameter required for bigiq **
     *
     * ```json
     * {
     *      "class": "AS3",
     *      "declaration": {
     *          "class": "ADC",
     *          "schemaVersion": "3.0.0",
     *          "target": "192.168.200.13",
     *          "tenant1": {
     *              "class": "Tenant"
     *          }
     *      }
     * }
     * ```
     *
     * @param tenant tenant to delete
     * @param dec empty declaration to remove from multi-target system
     */
    deleteTenant(dec: As3Declaration | AdcDeclaration): Promise<AxiosResponseWithTimings>;
    /**
     * parse as3 declare responses into target/tenant/declaration lists.
     * This data can be used to repost declarations from multi-target/tenant responses.
     * This was inspired by what is needed for the extension to list and repost decs in the view
     * - todo: provide better typing for this entire function 'any'=bad
     * @param x delcare endpoint response
     */
    parseDecs(x: AdcDeclaration[] | AdcDeclaration): Promise<any[]>;
}