Avi DebugServiceEngine Object API

CLI ``` - debug serviceengine - show debug serviceengine ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /debugserviceengine
  2. post /debugserviceengine
  3. delete /debugserviceengine/{uuid}
  4. get /debugserviceengine/{uuid}/faultruntime/
  5. get /debugserviceengine/{uuid}
  6. patch /debugserviceengine/{uuid}
  7. put /debugserviceengine/{uuid}
Up
get /debugserviceengine
(debugserviceengineGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

DebugServiceEngineApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "capture_params" : {
      "duration" : 123,
      "file_count" : 123,
      "pcap_ng" : true,
      "enable_ssl_session_key_capture" : true,
      "pkt_size" : 123,
      "num_pkts" : 123,
      "capture_file_size" : {
        "percentage_size" : 123,
        "absolute_size" : 123
      }
    },
    "seagent_debug" : [ {
      "trace_level" : "aeiou",
      "log_level" : "aeiou",
      "sub_module" : "aeiou",
      "log_every_n" : 123
    } ],
    "selogagent_debug" : "",
    "enable_kdump" : true,
    "flags" : [ {
      "flag" : "aeiou"
    } ],
    "capture" : true,
    "fault" : {
      "se_waf_learning_alloc_fail_frequency" : 123,
      "se_malloc_fail_type" : 123,
      "se_malloc_fail_frequency" : 123,
      "se_mbuf_cl_sanity" : true,
      "se_waf_alloc_fail_frequency" : 123,
      "se_shm_malloc_fail_type" : 123,
      "se_shm_malloc_fail_frequency" : 123,
      "faults" : [ {
        "num_skips" : 123,
        "fault_name" : "aeiou",
        "arg" : 123456789,
        "function_name" : "aeiou",
        "num_executions" : 123
      } ]
    },
    "capture_filters" : {
      "src_port" : 123,
      "ip_proto" : "aeiou",
      "tcp_ack" : true,
      "tcp_syn" : true,
      "tcp_fin" : true,
      "dst_port_start" : 123,
      "tcp_push" : true,
      "capture_ip" : {
        "prefixes" : [ {
          "ip_addr" : "",
          "mask" : 123
        } ],
        "ranges" : [ {
          "end" : "",
          "begin" : ""
        } ],
        "addrs" : [ {
          "addr" : "aeiou",
          "type" : "aeiou"
        } ]
      },
      "capture_ipc" : {
        "flow_del_probe" : true,
        "flow_mirror_del" : true,
        "ipc_tx_res" : true,
        "ipc_tx_req" : true,
        "vs_hb" : true,
        "flow_probe" : true,
        "ipc_batched" : true,
        "ipc_rx_req" : true,
        "flow_mirror_add" : true,
        "flow_mirror_all" : true,
        "flow_probe_all" : true,
        "ipc_rx_res" : true
      },
      "dst_port_end" : 123,
      "eth_proto" : "aeiou"
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "debug_ip" : "",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "cpu_shares" : [ {
      "shares" : 123,
      "cpu" : 123
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DebugServiceEngineApiResponse

401

log in failed

Up
post /debugserviceengine
(debugserviceenginePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — DebugServiceEngine object creation

Return type

DebugServiceEngine

Example data

Content-Type: application/json
{
  "capture_params" : {
    "duration" : 123,
    "file_count" : 123,
    "pcap_ng" : true,
    "enable_ssl_session_key_capture" : true,
    "pkt_size" : 123,
    "num_pkts" : 123,
    "capture_file_size" : {
      "percentage_size" : 123,
      "absolute_size" : 123
    }
  },
  "seagent_debug" : [ {
    "trace_level" : "aeiou",
    "log_level" : "aeiou",
    "sub_module" : "aeiou",
    "log_every_n" : 123
  } ],
  "selogagent_debug" : "",
  "enable_kdump" : true,
  "flags" : [ {
    "flag" : "aeiou"
  } ],
  "capture" : true,
  "fault" : {
    "se_waf_learning_alloc_fail_frequency" : 123,
    "se_malloc_fail_type" : 123,
    "se_malloc_fail_frequency" : 123,
    "se_mbuf_cl_sanity" : true,
    "se_waf_alloc_fail_frequency" : 123,
    "se_shm_malloc_fail_type" : 123,
    "se_shm_malloc_fail_frequency" : 123,
    "faults" : [ {
      "num_skips" : 123,
      "fault_name" : "aeiou",
      "arg" : 123456789,
      "function_name" : "aeiou",
      "num_executions" : 123
    } ]
  },
  "capture_filters" : {
    "src_port" : 123,
    "ip_proto" : "aeiou",
    "tcp_ack" : true,
    "tcp_syn" : true,
    "tcp_fin" : true,
    "dst_port_start" : 123,
    "tcp_push" : true,
    "capture_ip" : {
      "prefixes" : [ {
        "ip_addr" : "",
        "mask" : 123
      } ],
      "ranges" : [ {
        "end" : "",
        "begin" : ""
      } ],
      "addrs" : [ {
        "addr" : "aeiou",
        "type" : "aeiou"
      } ]
    },
    "capture_ipc" : {
      "flow_del_probe" : true,
      "flow_mirror_del" : true,
      "ipc_tx_res" : true,
      "ipc_tx_req" : true,
      "vs_hb" : true,
      "flow_probe" : true,
      "ipc_batched" : true,
      "ipc_rx_req" : true,
      "flow_mirror_add" : true,
      "flow_mirror_all" : true,
      "flow_probe_all" : true,
      "ipc_rx_res" : true
    },
    "dst_port_end" : 123,
    "eth_proto" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "debug_ip" : "",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "cpu_shares" : [ {
    "shares" : 123,
    "cpu" : 123
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DebugServiceEngine

401

log in failed

Up
delete /debugserviceengine/{uuid}
(debugserviceengineUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /debugserviceengine/{uuid}/faultruntime/
(debugserviceengineUuidFaultruntimeGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
get /debugserviceengine/{uuid}
(debugserviceengineUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

DebugServiceEngine

Example data

Content-Type: application/json
{
  "capture_params" : {
    "duration" : 123,
    "file_count" : 123,
    "pcap_ng" : true,
    "enable_ssl_session_key_capture" : true,
    "pkt_size" : 123,
    "num_pkts" : 123,
    "capture_file_size" : {
      "percentage_size" : 123,
      "absolute_size" : 123
    }
  },
  "seagent_debug" : [ {
    "trace_level" : "aeiou",
    "log_level" : "aeiou",
    "sub_module" : "aeiou",
    "log_every_n" : 123
  } ],
  "selogagent_debug" : "",
  "enable_kdump" : true,
  "flags" : [ {
    "flag" : "aeiou"
  } ],
  "capture" : true,
  "fault" : {
    "se_waf_learning_alloc_fail_frequency" : 123,
    "se_malloc_fail_type" : 123,
    "se_malloc_fail_frequency" : 123,
    "se_mbuf_cl_sanity" : true,
    "se_waf_alloc_fail_frequency" : 123,
    "se_shm_malloc_fail_type" : 123,
    "se_shm_malloc_fail_frequency" : 123,
    "faults" : [ {
      "num_skips" : 123,
      "fault_name" : "aeiou",
      "arg" : 123456789,
      "function_name" : "aeiou",
      "num_executions" : 123
    } ]
  },
  "capture_filters" : {
    "src_port" : 123,
    "ip_proto" : "aeiou",
    "tcp_ack" : true,
    "tcp_syn" : true,
    "tcp_fin" : true,
    "dst_port_start" : 123,
    "tcp_push" : true,
    "capture_ip" : {
      "prefixes" : [ {
        "ip_addr" : "",
        "mask" : 123
      } ],
      "ranges" : [ {
        "end" : "",
        "begin" : ""
      } ],
      "addrs" : [ {
        "addr" : "aeiou",
        "type" : "aeiou"
      } ]
    },
    "capture_ipc" : {
      "flow_del_probe" : true,
      "flow_mirror_del" : true,
      "ipc_tx_res" : true,
      "ipc_tx_req" : true,
      "vs_hb" : true,
      "flow_probe" : true,
      "ipc_batched" : true,
      "ipc_rx_req" : true,
      "flow_mirror_add" : true,
      "flow_mirror_all" : true,
      "flow_probe_all" : true,
      "ipc_rx_res" : true
    },
    "dst_port_end" : 123,
    "eth_proto" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "debug_ip" : "",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "cpu_shares" : [ {
    "shares" : 123,
    "cpu" : 123
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DebugServiceEngine

401

log in failed

Up
patch /debugserviceengine/{uuid}
(debugserviceengineUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — DebugServiceEngine object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

DebugServiceEngine

Example data

Content-Type: application/json
{
  "capture_params" : {
    "duration" : 123,
    "file_count" : 123,
    "pcap_ng" : true,
    "enable_ssl_session_key_capture" : true,
    "pkt_size" : 123,
    "num_pkts" : 123,
    "capture_file_size" : {
      "percentage_size" : 123,
      "absolute_size" : 123
    }
  },
  "seagent_debug" : [ {
    "trace_level" : "aeiou",
    "log_level" : "aeiou",
    "sub_module" : "aeiou",
    "log_every_n" : 123
  } ],
  "selogagent_debug" : "",
  "enable_kdump" : true,
  "flags" : [ {
    "flag" : "aeiou"
  } ],
  "capture" : true,
  "fault" : {
    "se_waf_learning_alloc_fail_frequency" : 123,
    "se_malloc_fail_type" : 123,
    "se_malloc_fail_frequency" : 123,
    "se_mbuf_cl_sanity" : true,
    "se_waf_alloc_fail_frequency" : 123,
    "se_shm_malloc_fail_type" : 123,
    "se_shm_malloc_fail_frequency" : 123,
    "faults" : [ {
      "num_skips" : 123,
      "fault_name" : "aeiou",
      "arg" : 123456789,
      "function_name" : "aeiou",
      "num_executions" : 123
    } ]
  },
  "capture_filters" : {
    "src_port" : 123,
    "ip_proto" : "aeiou",
    "tcp_ack" : true,
    "tcp_syn" : true,
    "tcp_fin" : true,
    "dst_port_start" : 123,
    "tcp_push" : true,
    "capture_ip" : {
      "prefixes" : [ {
        "ip_addr" : "",
        "mask" : 123
      } ],
      "ranges" : [ {
        "end" : "",
        "begin" : ""
      } ],
      "addrs" : [ {
        "addr" : "aeiou",
        "type" : "aeiou"
      } ]
    },
    "capture_ipc" : {
      "flow_del_probe" : true,
      "flow_mirror_del" : true,
      "ipc_tx_res" : true,
      "ipc_tx_req" : true,
      "vs_hb" : true,
      "flow_probe" : true,
      "ipc_batched" : true,
      "ipc_rx_req" : true,
      "flow_mirror_add" : true,
      "flow_mirror_all" : true,
      "flow_probe_all" : true,
      "ipc_rx_res" : true
    },
    "dst_port_end" : 123,
    "eth_proto" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "debug_ip" : "",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "cpu_shares" : [ {
    "shares" : 123,
    "cpu" : 123
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DebugServiceEngine

401

log in failed

Up
put /debugserviceengine/{uuid}
(debugserviceengineUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — DebugServiceEngine object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

DebugServiceEngine

Example data

Content-Type: application/json
{
  "capture_params" : {
    "duration" : 123,
    "file_count" : 123,
    "pcap_ng" : true,
    "enable_ssl_session_key_capture" : true,
    "pkt_size" : 123,
    "num_pkts" : 123,
    "capture_file_size" : {
      "percentage_size" : 123,
      "absolute_size" : 123
    }
  },
  "seagent_debug" : [ {
    "trace_level" : "aeiou",
    "log_level" : "aeiou",
    "sub_module" : "aeiou",
    "log_every_n" : 123
  } ],
  "selogagent_debug" : "",
  "enable_kdump" : true,
  "flags" : [ {
    "flag" : "aeiou"
  } ],
  "capture" : true,
  "fault" : {
    "se_waf_learning_alloc_fail_frequency" : 123,
    "se_malloc_fail_type" : 123,
    "se_malloc_fail_frequency" : 123,
    "se_mbuf_cl_sanity" : true,
    "se_waf_alloc_fail_frequency" : 123,
    "se_shm_malloc_fail_type" : 123,
    "se_shm_malloc_fail_frequency" : 123,
    "faults" : [ {
      "num_skips" : 123,
      "fault_name" : "aeiou",
      "arg" : 123456789,
      "function_name" : "aeiou",
      "num_executions" : 123
    } ]
  },
  "capture_filters" : {
    "src_port" : 123,
    "ip_proto" : "aeiou",
    "tcp_ack" : true,
    "tcp_syn" : true,
    "tcp_fin" : true,
    "dst_port_start" : 123,
    "tcp_push" : true,
    "capture_ip" : {
      "prefixes" : [ {
        "ip_addr" : "",
        "mask" : 123
      } ],
      "ranges" : [ {
        "end" : "",
        "begin" : ""
      } ],
      "addrs" : [ {
        "addr" : "aeiou",
        "type" : "aeiou"
      } ]
    },
    "capture_ipc" : {
      "flow_del_probe" : true,
      "flow_mirror_del" : true,
      "ipc_tx_res" : true,
      "ipc_tx_req" : true,
      "vs_hb" : true,
      "flow_probe" : true,
      "ipc_batched" : true,
      "ipc_rx_req" : true,
      "flow_mirror_add" : true,
      "flow_mirror_all" : true,
      "flow_probe_all" : true,
      "ipc_rx_res" : true
    },
    "dst_port_end" : 123,
    "eth_proto" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "debug_ip" : "",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "cpu_shares" : [ {
    "shares" : 123,
    "cpu" : 123
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DebugServiceEngine

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. CaptureFileSize
  2. CaptureFilters
  3. CaptureIPC
  4. DebugIpAddr
  5. DebugSeAgent
  6. DebugSeCpuShares
  7. DebugSeDataplane
  8. DebugSeFault
  9. DebugServiceEngine
  10. DebugServiceEngineApiResponse
  11. DebugVirtualServiceCapture
  12. IpAddr
  13. IpAddrPrefix
  14. IpAddrRange
  15. SeFault

CaptureFileSize Up

absolute_size (optional)
Integer Maximum size in MB. Set 0 for avi default size. Allowed values are 100-512000. Special values are 0 - 'AVI_DEFAULT'. Field introduced in 18.2.8. Unit is MB. format: int32
percentage_size (optional)
Integer Limits capture to percentage of free disk space. Set 0 for avi default size. Allowed values are 0-75. Field introduced in 18.2.8. format: int32

CaptureFilters Up

capture_ip (optional)
DebugIpAddr Per packet IP filter. Matches with source and destination address. Curently not applicable for DebugServiceEngine. Field introduced in 18.2.5.
capture_ipc (optional)
CaptureIPC Capture filter for SE IPC. Not applicable for Debug Virtual Service. Field introduced in 18.2.5.
dst_port_end (optional)
Integer Destination Port range filter. Field introduced in 18.2.5. format: int32
dst_port_start (optional)
Integer Destination Port range filter. Field introduced in 18.2.5. format: int32
eth_proto (optional)
String Ethernet Proto filter. Enum options - ETH_TYPE_IPV4. Field introduced in 18.2.5.
ip_proto (optional)
String IP Proto filter. Support for TCP only for now. Enum options - IP_TYPE_TCP. Field introduced in 18.2.5.
src_port (optional)
Integer Source Port filter. Field introduced in 18.2.5. format: int32
tcp_ack (optional)
Boolean TCP ACK flag filter. Field introduced in 18.2.5.
tcp_fin (optional)
Boolean TCP FIN flag filter. Field introduced in 18.2.5.
tcp_push (optional)
Boolean TCP PUSH flag filter. Field introduced in 18.2.5.
tcp_syn (optional)
Boolean TCP SYN flag filter. Field introduced in 18.2.5.

CaptureIPC Up

flow_del_probe (optional)
Boolean Flow del probe filter for SE IPC. Field introduced in 18.2.5.
flow_mirror_add (optional)
Boolean Flow mirror add filter for SE IPC. Field introduced in 18.2.5.
flow_mirror_all (optional)
Boolean Filter for all flow mirror SE IPC. Field introduced in 18.2.5.
flow_mirror_del (optional)
Boolean Flow mirror del filter for SE IPC. Field introduced in 18.2.5.
flow_probe (optional)
Boolean Flow probe filter for SE IPC. Field introduced in 18.2.5.
flow_probe_all (optional)
Boolean Filter for all flow probe SE IPC. Field introduced in 18.2.5.
ipc_batched (optional)
Boolean IPC batched filter for SE IPC. Field introduced in 18.2.5.
ipc_rx_req (optional)
Boolean Filter for incoming IPC request. Field introduced in 18.2.5.
ipc_rx_res (optional)
Boolean Filter for incoming IPC response. Field introduced in 18.2.5.
ipc_tx_req (optional)
Boolean Filter for outgoing IPC request. Field introduced in 18.2.5.
ipc_tx_res (optional)
Boolean Filter for outgoing IPC response. Field introduced in 18.2.5.
vs_hb (optional)
Boolean Vs heart beat filter for SE IPC. Field introduced in 18.2.5.

DebugIpAddr Up

addrs (optional)
array[IpAddr] Placeholder for description of property addrs of obj type DebugIpAddr field type str type object
prefixes (optional)
array[IpAddrPrefix] Placeholder for description of property prefixes of obj type DebugIpAddr field type str type object
ranges (optional)
array[IpAddrRange] Placeholder for description of property ranges of obj type DebugIpAddr field type str type object

DebugSeAgent Up

log_every_n (optional)
Integer Log every nth message. Field introduced in 17.2.7. format: int32
log_level
String Enum options - LOG_LEVEL_DISABLED, LOG_LEVEL_INFO, LOG_LEVEL_WARNING, LOG_LEVEL_ERROR.
sub_module
String Enum options - TASK_QUEUE_DEBUG, RPC_INFRA_DEBUG, JOB_MGR_DEBUG, TRANSACTION_DEBUG, SE_AGENT_DEBUG, SE_AGENT_METRICS_DEBUG, VIRTUALSERVICE_DEBUG, RES_MGR_DEBUG, SE_MGR_DEBUG, VI_MGR_DEBUG, METRICS_MANAGER_DEBUG, METRICS_MGR_DEBUG, EVENT_API_DEBUG, HS_MGR_DEBUG, ALERT_MGR_DEBUG, AUTOSCALE_MGR_DEBUG, APIC_AGENT_DEBUG, REDIS_INFRA_DEBUG, CLOUD_CONNECTOR_DEBUG, MESOS_METRICS_DEBUG, STATECACHE_MGR_DEBUG, NSX_AGENT_DEBUG, SE_AGENT_CPU_UTIL_DEBUG, SE_AGENT_MEM_UTIL_DEBUG, SE_RPC_PROXY_DEBUG, SE_AGENT_GSLB_DEBUG, METRICSAPI_SRV_DEBUG, SECURITYMGR_DEBUG, RES_MGR_READ_DEBUG, LICENSE_VMWSRVR_DEBUG.
trace_level
String Enum options - TRACE_LEVEL_DISABLED, TRACE_LEVEL_ERROR, TRACE_LEVEL_DEBUG, TRACE_LEVEL_DEBUG_DETAIL.

DebugSeCpuShares Up

cpu
Integer Number of cpu. format: int32
shares
Integer Number of shares. format: int32

DebugSeDataplane Up

flag
String Enum options - DEBUG_DISPATCHER_FLOW, DEBUG_DISPATCHER_FLOW_DETAIL, DEBUG_DISPATCHER_FLOW_ALL, DEBUG_CONFIG, DEBUG_IP, DEBUG_IP_PKT_IN, DEBUG_IP_PKT_OUT, DEBUG_ARP, DEBUG_ARP_PKT_IN, DEBUG_ARP_PKT_OUT, DEBUG_ETHERNET, DEBUG_ETHERNET_PKT_IN, DEBUG_ETHERNET_PKT_OUT, DEBUG_ICMP, DEBUG_PCAP_RX, DEBUG_PCAP_TX, DEBUG_PCAP_DROP, DEBUG_PCAP_ALL, DEBUG_MISC, DEBUG_CRUD, DEBUG_POOL, DEBUG_PCAP_DOS, DEBUG_PCAP_HM, DEBUG_SE_APP, DEBUG_UDP, DEBUG_SE_VS_HB, DEBUG_ND, DEBUG_ERROR, DEBUG_NONE, DEBUG_ALL, DEBUG_STRICT, DEBUG_FLOW_MIRROR, DEBUG_NAT, DEBUG_NAT_ERROR, DEBUG_NAT_PKT, DEBUG_NAT_END2END, DEBUG_NAT_ALL, DEBUG_PCAP_SE_IPC.

DebugSeFault Up

faults (optional)
array[SeFault] Set of faults to enable/disable. Field introduced in 20.1.1.
se_malloc_fail_frequency (optional)
Integer Fail SE malloc type at this frequency. Field introduced in 18.1.2. format: int32
se_malloc_fail_type (optional)
Integer Fail this SE malloc type. Field introduced in 18.1.2. format: int32
se_mbuf_cl_sanity (optional)
Boolean Toggle assert on mbuf cluster sanity check fail. Field introduced in 17.2.13,18.1.3,18.2.1.
se_shm_malloc_fail_frequency (optional)
Integer Fail SE SHM malloc type at this frequency. Field introduced in 18.1.2. format: int32
se_shm_malloc_fail_type (optional)
Integer Fail this SE SHM malloc type. Field introduced in 18.1.2. format: int32
se_waf_alloc_fail_frequency (optional)
Integer Fail SE WAF allocation at this frequency. Field introduced in 18.1.2. format: int32
se_waf_learning_alloc_fail_frequency (optional)
Integer Fail SE WAF learning allocation at this frequency. Field introduced in 18.1.2. format: int32

DebugServiceEngine Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
capture (optional)
Boolean Enable/disable packet capture. Field introduced in 18.2.2.
capture_filters (optional)
CaptureFilters Per packet capture filters for Debug Service Engine. Not applicable for DOS pcap capture. . Field introduced in 18.2.5.
capture_params (optional)
DebugVirtualServiceCapture Params for SE pcap. Field introduced in 17.2.14,18.1.5,18.2.1.
cpu_shares (optional)
array[DebugSeCpuShares] Placeholder for description of property cpu_shares of obj type DebugServiceEngine field type str type object
debug_ip (optional)
DebugIpAddr Per packet IP filter for Service Engine PCAP. Matches with source and destination address. Field introduced in 17.2.14,18.1.5,18.2.1.
enable_kdump (optional)
Boolean 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.
fault (optional)
DebugSeFault Params for SE fault injection. Field introduced in 18.1.2.
flags (optional)
array[DebugSeDataplane] Placeholder for description of property flags of obj type DebugServiceEngine field type str type object
name (optional)
String Name of the object.
seagent_debug (optional)
array[DebugSeAgent] Placeholder for description of property seagent_debug of obj type DebugServiceEngine field type str type object
selogagent_debug (optional)
DebugSeAgent Debug knob for se_log_agent process. Field introduced in 20.1.1.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

DebugServiceEngineApiResponse Up

count
Integer format: int32
results
next (optional)

DebugVirtualServiceCapture Up

capture_file_size (optional)
CaptureFileSize Maximum allowed size of PCAP Capture File per SE. Max(absolute_size, percentage_size) will be final value. Set both to 0 for avi default size. DOS, IPC and DROP pcaps not applicaple. Field introduced in 18.2.8.
duration (optional)
Integer Number of minutes to capture packets. Use 0 to capture until manually stopped. Special values are 0 - 'infinite'. Unit is MIN. format: int32
enable_ssl_session_key_capture (optional)
Boolean Enable SSL session key capture. Field introduced in 18.2.3.
file_count (optional)
Integer Number of files to maintain for SE pcap file rotation.file count set to 1 indicates no rotate. Allowed values are 1-10. Field introduced in 20.1.1. format: int32
num_pkts (optional)
Integer Total number of packets to capture. format: int32
pcap_ng (optional)
Boolean Enable PcapNg for packet capture. Field introduced in 18.2.5.
pkt_size (optional)
Integer Number of bytes of each packet to capture. Use 0 to capture the entire packet. Allowed values are 64-1514. Special values are 0 - 'full capture'. Unit is BYTES. format: int32

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS, V6.

IpAddrPrefix Up

ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32

IpAddrRange Up

begin
IpAddr Starting IP address of the range.
end
IpAddr Ending IP address of the range.

SeFault Up

arg (optional)
Long Optional 64 bit unsigned integer that can be used within the enabled fault. Field introduced in 20.1.1. format: int64
fault_name
String The name of the target fault. Field introduced in 20.1.1.
function_name (optional)
String The name of the function that contains the target fault. Field introduced in 20.1.1.
num_executions (optional)
Integer Number of times the fault should be executed. Allowed values are 1-4294967295. Field introduced in 20.1.1. format: int32
num_skips (optional)
Integer Number of times the fault should be skipped before executing. Field introduced in 18.2.9. format: int32