Describes the response structure for session details corresponding to a specific session ID as returned by the PAN-OS API.

interface SessionIdResponse {
    response: {
        result: {
            app-insufficient: string;
            application: string;
            c2s: SessionDirection;
            c2s-octets: string;
            c2s-packets: string;
            captive-portal: string;
            cpu: string;
            egr-if: string;
            end-reason: string;
            firewall: string;
            flow-type: string;
            host-session: string;
            igr-if: string;
            l7-proc: string;
            nat-dst: string;
            nat-rule: string;
            nat-rule-vsys: string;
            nat-src: string;
            override: string;
            pansys-up: string;
            pktlog-up: string;
            prxy-started: string;
            prxy-status: string;
            prxy-wait-ssl: string;
            qos-class: string;
            qos-rule: string;
            rule: string;
            s2c: SessionDirection;
            s2c-octets: string;
            s2c-packets: string;
            sess-ager: string;
            sess-ha-sync: string;
            sess-log: string;
            slot: string;
            start-time: string;
            syncookie: string;
            time-start: string;
            timeout: string;
            timestamp: string;
            tunnel-session: string;
            tunnel-termination: string;
            url-en: string;
            vsys: string;
        };
        status: string;
    };
}

Properties

Properties

response: {
    result: {
        app-insufficient: string;
        application: string;
        c2s: SessionDirection;
        c2s-octets: string;
        c2s-packets: string;
        captive-portal: string;
        cpu: string;
        egr-if: string;
        end-reason: string;
        firewall: string;
        flow-type: string;
        host-session: string;
        igr-if: string;
        l7-proc: string;
        nat-dst: string;
        nat-rule: string;
        nat-rule-vsys: string;
        nat-src: string;
        override: string;
        pansys-up: string;
        pktlog-up: string;
        prxy-started: string;
        prxy-status: string;
        prxy-wait-ssl: string;
        qos-class: string;
        qos-rule: string;
        rule: string;
        s2c: SessionDirection;
        s2c-octets: string;
        s2c-packets: string;
        sess-ager: string;
        sess-ha-sync: string;
        sess-log: string;
        slot: string;
        start-time: string;
        syncookie: string;
        time-start: string;
        timeout: string;
        timestamp: string;
        tunnel-session: string;
        tunnel-termination: string;
        url-en: string;
        vsys: string;
    };
    status: string;
}

The response wrapper that contains the status and result details for the session ID request.

Type declaration

  • result: {
        app-insufficient: string;
        application: string;
        c2s: SessionDirection;
        c2s-octets: string;
        c2s-packets: string;
        captive-portal: string;
        cpu: string;
        egr-if: string;
        end-reason: string;
        firewall: string;
        flow-type: string;
        host-session: string;
        igr-if: string;
        l7-proc: string;
        nat-dst: string;
        nat-rule: string;
        nat-rule-vsys: string;
        nat-src: string;
        override: string;
        pansys-up: string;
        pktlog-up: string;
        prxy-started: string;
        prxy-status: string;
        prxy-wait-ssl: string;
        qos-class: string;
        qos-rule: string;
        rule: string;
        s2c: SessionDirection;
        s2c-octets: string;
        s2c-packets: string;
        sess-ager: string;
        sess-ha-sync: string;
        sess-log: string;
        slot: string;
        start-time: string;
        syncookie: string;
        time-start: string;
        timeout: string;
        timestamp: string;
        tunnel-session: string;
        tunnel-termination: string;
        url-en: string;
        vsys: string;
    }

    Contains the detailed session information for the specific session ID queried.

    • app-insufficient: string
    • application: string

      The application associated with the session.

    • c2s: SessionDirection

      Details of the client-to-server (c2s) session direction.

    • c2s-octets: string
    • c2s-packets: string
    • captive-portal: string
    • cpu: string

      The CPU identifier processing this session.

    • egr-if: string
    • end-reason: string

      The reason why the session was terminated.

    • firewall: string

      The identifier for the firewall where the session exists.

    • flow-type: string
    • host-session: string
    • igr-if: string
    • l7-proc: string
    • nat-dst: string
    • nat-rule: string
    • nat-rule-vsys: string
    • nat-src: string
    • override: string
    • pansys-up: string
    • pktlog-up: string
    • prxy-started: string
    • prxy-status: string
    • prxy-wait-ssl: string
    • qos-class: string
    • qos-rule: string
    • rule: string
    • s2c: SessionDirection

      Details of the server-to-client (s2c) session direction.

    • s2c-octets: string
    • s2c-packets: string
    • sess-ager: string
    • sess-ha-sync: string
    • sess-log: string
    • slot: string

      The slot on the firewall where this session is located.

    • start-time: string

      The start time when the session was established.

    • syncookie: string
    • time-start: string
    • timeout: string
    • timestamp: string
    • tunnel-session: string
    • tunnel-termination: string
    • url-en: string
    • vsys: string

      The virtual system (vsys) associated with the session.

  • status: string

    Indicates if the session ID request was successful ('success') or encountered an error ('error').

Generated using TypeDoc