nodes/generated

Interface SplunkV1NodeParameters

Source
interface SplunkV1NodeParameters {
    additionalFields?:
        | {
            adhoc_search_level?: "fast"
            | "smart"
            | "verbose";
            auto_cancel?: number;
            auto_finalize_ec?: number;
            auto_pause?: number;
            earliest_time?: string;
            exec_mode?: "normal" | "blocking" | "oneshot";
            index_earliest?: string;
            index_latest?: string;
            indexedRealtimeOffset?: number;
            latest_time?: string;
            max_time?: number;
            namespace?: string;
            reduce_freq?: number;
            remote_server_list?: string;
            reuse_max_seconds_ago?: number;
            rf?: string;
            search_mode?: "normal" | "realtime";
            status_buckets?: number;
            timeout?: number;
            workload_pool?: string;
        }
        | { email?: string; realname?: string };
    filters?: {
        keyValueMatch?: {
            keyValuePair: { key?: string; value?: string };
        };
    };
    limit?: number;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "getReport";
    options?: | {
        add_orphan_field?: boolean;
        listDefaultActionArgs?: boolean;
    }
    | {
        sort_dir?: "asc"
        | "desc";
        sort_key?: string;
        sort_mode?: "auto" | "alpha" | "alpha_case" | "num";
    }
    | { add_summary_to_metadata?: boolean };
    password?: string;
    resource?:
        | "user"
        | "firedAlert"
        | "searchConfiguration"
        | "searchJob"
        | "searchResult";
    returnAll?: boolean;
    roles?: unknown[];
    search?: string;
    searchConfigurationId?: string;
    searchJobId?: string;
    updateFields?: {
        email?: string;
        password?: string;
        realname?: string;
        roles?: unknown[];
    };
    userId?: string;
}

Properties§

Source§

readonly additionalFields?:
    | {
        adhoc_search_level?: "fast"
        | "smart"
        | "verbose";
        auto_cancel?: number;
        auto_finalize_ec?: number;
        auto_pause?: number;
        earliest_time?: string;
        exec_mode?: "normal" | "blocking" | "oneshot";
        index_earliest?: string;
        index_latest?: string;
        indexedRealtimeOffset?: number;
        latest_time?: string;
        max_time?: number;
        namespace?: string;
        reduce_freq?: number;
        remote_server_list?: string;
        reuse_max_seconds_ago?: number;
        rf?: string;
        search_mode?: "normal" | "realtime";
        status_buckets?: number;
        timeout?: number;
        workload_pool?: string;
    }
    | { email?: string; realname?: string }

Default: {}

Source§

readonly filters?: {
    keyValueMatch?: {
        keyValuePair: { key?: string; value?: string };
    };
}

Default: {}

Source§

readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

Source§

readonly name?: string

Login name of the user

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "getReport"

Default: "getReport"

Source§

readonly options?:
    | {
        add_orphan_field?: boolean;
        listDefaultActionArgs?: boolean;
    }
    | {
        sort_dir?: "asc"
        | "desc";
        sort_key?: string;
        sort_mode?: "auto" | "alpha" | "alpha_case" | "num";
    }
    | { add_summary_to_metadata?: boolean }

Default: {}

Source§

readonly password?: string

Type options: {"password":true}

Source§

readonly resource?:
    | "user"
    | "firedAlert"
    | "searchConfiguration"
    | "searchJob"
    | "searchResult"

Default: "searchJob"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly roles?: unknown[]

Comma-separated list of roles to assign to the user. Choose from the list, or specify IDs using an expression. Default: [] Type options: {"loadOptionsMethod":"getRoles"}

Source§

readonly search?: string

Search language string to execute, in Splunk's Search Processing Language

Source§

readonly searchConfigurationId?: string

ID of the search configuration to delete

Source§

readonly searchJobId?: string

ID of the search job to delete

Source§

readonly updateFields?: {
    email?: string;
    password?: string;
    realname?: string;
    roles?: unknown[];
}

Default: {}

Source§

readonly userId?: string

ID of the user to delete