GET /debugvirtualservice/{uuid}

GET /debugvirtualservice/{uuid}

/debugvirtualservice/{uuid}

Request
URI
GET
https://{api_host}/api/debugvirtualservice/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

string
fields
Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean
include_name
Optional

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.

boolean
skip_default
Optional

Default values are not set.

string
join_subresources
Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

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.


Responses
200

OK

Returns DebugVirtualService of type(s) application/json
{
    "_last_modified": "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
                }
            }
        ]
    },
    "cloud_ref": "string",
    "debug_hm": "string",
    "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"
                }
            }
        ]
    },
    "dns_options": {
        "domain_name": [
            "string"
        ],
        "gslb_service_name": [
            "string"
        ]
    },
    "flags": [
        {
            "flag": "string"
        }
    ],
    "latency_audit_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
    },
    "name": "string",
    "objsync": {
        "trigger_initial_sync": false
    },
    "resync_flows": false,
    "se_params": {
        "se_refs": [
            "string"
        ]
    },
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

boolean
capture
Optional

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

string
cloud_ref
Optional

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

string
debug_hm
Optional
Constraints: default: DEBUG_VS_HM_NONE

This option controls the capture of Health Monitor flows. Enum options - DEBUG_VS_HM_NONE, DEBUG_VS_HM_ONLY, DEBUG_VS_HM_INCLUDE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
debug_ip
Optional

debug_ip

object
dns_options
Optional

dns_options

array of object
flags
Optional

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

object
latency_audit_filters
Optional

latency_audit_filters

string
name
Required

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

object
objsync
Optional

objsync

boolean
resync_flows
Optional

This option re-synchronizes flows between Active-Standby service engines for all the virtual services placed on them. It should be used with caution because as it can cause a flood between Active-Standby. Field introduced in 18.1.3,18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
se_params
Optional

se_params

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.

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 -H 'Authorization: <value>' https://{api_host}/api/debugvirtualservice/{uuid}