POST /debugserviceengine

POST /debugserviceengine

/debugserviceengine

Request
URI
POST
https://{api_host}/api/debugserviceengine
COPY
Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.


Request Body

DebugServiceEngine object creation

DebugServiceEngine of type(s) application/json
Optional
{
    "_last_modified": "string",
    "benchmark_action": "string",
    "benchmark_layer": "string",
    "benchmark_option": "string",
    "benchmark_rss_hash": "string",
    "capture": false,
    "capture_filters": {
        "capture_ip": {
            "addrs": [
                {
                    "addr": "string",
                    "type": "string"
                }
            ],
            "match_operation": "string",
            "prefixes": [
                {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            ],
            "ranges": [
                {
                    "begin": {
                        "addr": "string",
                        "type": "string"
                    },
                    "end": {
                        "addr": "string",
                        "type": "string"
                    }
                }
            ]
        },
        "capture_ipc": {
            "flow_del_probe": false,
            "flow_mirror_add": false,
            "flow_mirror_all": false,
            "flow_mirror_del": false,
            "flow_probe": false,
            "flow_probe_all": false,
            "ipc_batched": false,
            "ipc_rx_req": false,
            "ipc_rx_res": false,
            "ipc_tx_req": false,
            "ipc_tx_res": false,
            "vs_hb": false
        },
        "dst_port_end": 0,
        "dst_port_start": 0,
        "eth_proto": "string",
        "ip_proto": "string",
        "src_port": 0,
        "src_port_range_end": 0,
        "tcp_ack": false,
        "tcp_fin": false,
        "tcp_push": false,
        "tcp_syn": false
    },
    "capture_params": {
        "capture_file_size": {
            "absolute_size": 0,
            "percentage_size": 0
        },
        "duration": 0,
        "enable_ssl_session_key_capture": false,
        "file_count": 0,
        "num_pkts": 0,
        "pcap_ng": false,
        "pkt_size": 0
    },
    "capture_pkt_filter": {
        "capture_tcp_filters": [
            {
                "dst_port_range": {
                    "dst_port_end": 0,
                    "dst_port_start": 0,
                    "match_operation": "string"
                },
                "eth_proto": "string",
                "host_ip": {
                    "addrs": [
                        {
                            "addr": "string",
                            "type": "string"
                        }
                    ],
                    "match_operation": "string",
                    "prefixes": [
                        {
                            "ip_addr": {
                                "addr": "string",
                                "type": "string"
                            },
                            "mask": 0
                        }
                    ],
                    "ranges": [
                        {
                            "begin": {
                                "addr": "string",
                                "type": "string"
                            },
                            "end": {
                                "addr": "string",
                                "type": "string"
                            }
                        }
                    ]
                },
                "src_port_range": {
                    "match_operation": "string",
                    "src_port_end": 0,
                    "src_port_start": 0
                },
                "tcpflag": {
                    "filter_op": "string",
                    "match_operation": "string",
                    "tcp_ack": false,
                    "tcp_fin": false,
                    "tcp_push": false,
                    "tcp_rst": false,
                    "tcp_syn": false
                }
            }
        ]
    },
    "cpu_shares": [
        {
            "cpu": 0,
            "shares": 0
        }
    ],
    "debug_ip": {
        "addrs": [
            {
                "addr": "string",
                "type": "string"
            }
        ],
        "match_operation": "string",
        "prefixes": [
            {
                "ip_addr": {
                    "addr": "string",
                    "type": "string"
                },
                "mask": 0
            }
        ],
        "ranges": [
            {
                "begin": {
                    "addr": "string",
                    "type": "string"
                },
                "end": {
                    "addr": "string",
                    "type": "string"
                }
            }
        ]
    },
    "enable_kdump": false,
    "enable_rpc_timing_profiler": false,
    "fault": {
        "faults": [
            {
                "arg": 0,
                "fault_name": "string",
                "function_name": "string",
                "num_executions": 0,
                "num_skips": 0
            }
        ],
        "se_malloc_fail_frequency": 0,
        "se_malloc_fail_type": 0,
        "se_mbuf_cl_sanity": false,
        "se_shm_malloc_fail_frequency": 0,
        "se_shm_malloc_fail_type": 0,
        "se_waf_alloc_fail_frequency": 0,
        "se_waf_learning_alloc_fail_frequency": 0
    },
    "flags": [
        {
            "flag": "string"
        }
    ],
    "name": "string",
    "seagent_debug": [
        {
            "log_every_n": 0,
            "log_level": "string",
            "sub_module": "string",
            "trace_level": "string"
        }
    ],
    "selogagent_debug": {
        "log_every_n": 0,
        "log_level": "string",
        "sub_module": "string",
        "trace_level": "string"
    },
    "tenant_ref": "string",
    "trace_memory": {
        "trace_malloc_types": [
            {
                "malloc_type_index": 0
            }
        ],
        "trace_shm_malloc_types": [
            {
                "shm_malloc_type_index": 0
            }
        ]
    },
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns DebugServiceEngine of type(s) application/json
"DebugServiceEngine Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
benchmark_action
Optional
Constraints: default: SE_BENCHMARK_MODE_DROP

Action to be invoked at configured layer. Enum options - SE_BENCHMARK_MODE_DROP, SE_BENCHMARK_MODE_REFLECT. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
benchmark_layer
Optional
Constraints: default: SE_BENCHMARK_LAYER_NONE

Toggle and configure the layer to benchmark performance. This can be done at a specific point in the SE packet processing pipeline. Enum options - SE_BENCHMARK_LAYER_NONE, SE_BENCHMARK_LAYER_POST_VNIC_RX, SE_BENCHMARK_LAYER_POST_FT_LOOKUP, SE_BENCHMARK_LAYER_NSP_LOOKUP, SE_BENCHMARK_LAYER_PRE_PROXY_PUNT, SE_BENCHMARK_LAYER_POST_PROXY_PUNT, SE_BENCHMARK_LAYER_ETHER_INPUT, SE_BENCHMARK_LAYER_IP_INPUT, SE_BENCHMARK_LAYER_UDP_INPUT, SE_BENCHMARK_LAYER_POST_L2_PROCESSING, SE_BENCHMARK_LAYER_POST_BUILD_KEY_LITE. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
benchmark_option
Optional
Constraints: default: SE_BENCHMARK_REFLECT_SWAP_L4

Configure different reflect modes. Enum options - SE_BENCHMARK_REFLECT_SWAP_L4, SE_BENCHMARK_REFLECT_SWAP_L2, SE_BENCHMARK_REFLECT_SWAP_L3. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
benchmark_rss_hash
Optional
Constraints: default: SE_BENCHMARK_DISABLE_HASH

RSS Hash function to be used for packet reflect in TX path. Enum options - SE_BENCHMARK_DISABLE_HASH, SE_BENCHMARK_RTE_SOFT_HASH. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
capture
Optional

Enable/disable packet capture. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
capture_filters
Optional

capture_filters

object
capture_params
Optional

capture_params

object
capture_pkt_filter
Optional

capture_pkt_filter

array of object
cpu_shares
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
debug_ip
Optional

debug_ip

boolean
enable_kdump
Optional

Enables the use of kdump on SE. Requires SE Reboot. Applicable only in case of VM Based deployments. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enable_rpc_timing_profiler
Optional

Enable profiling time for certain RPC calls. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
fault
Optional

fault

array of object
flags
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Optional
Constraints: default: VM name unknown

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
seagent_debug
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
selogagent_debug
Optional

selogagent_debug

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
trace_memory
Optional

trace_memory

string
url
Optional

url

string
uuid
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/debugserviceengine