GET /serviceengine/{uuid}/nicinfo/

• Service Engine

/serviceengine/{uuid}/nicinfo/

Request

URI

GET

https://{api_host}/api/serviceengine/{uuid}/nicinfo

COPY

Path Parameters

string

uuid

Required  

UUID of the object to fetch

Header Parameters

string

X-Avi-Tenant

Optional

Avi Tenant Header

string

X-Avi-Tenant-UUID

Optional

Avi Tenant Header UUID

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.

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.

---

Authentication

This operation uses the following authentication methods.

basicAuth

Responses

200

Hide Details

OK

Returns NicInfo of type(s) application/json

{
    "active": false,
    "config_mtu": 0,
    "driver_string": "string",
    "link_state": "string",
    "mac_address": "string",
    "nic_gro_on": false,
    "nic_lro_on": false,
    "nic_name": "string",
    "nic_tso_on": false,
    "queues_per_nic": 0,
    "running_mtu": 0,
    "rx_queue_size": 0,
    "tx_queue_size": 0,
    "vrf_id": 0
}

boolean

active

Optional

Is the NIC active. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

config_mtu

Optional

MTU configured. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

driver_string

Optional

NIC driver information. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

link_state

Optional

Link state of the NIC. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

mac_address

Optional

MAC Address. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

nic_gro_on

Optional

Is GRO enabled on the NIC. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

nic_lro_on

Optional

Is LRO enabled on the NIC. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

nic_name

Optional

NIC Name. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

nic_tso_on

Optional

Is LRO enabled on the NIC. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

queues_per_nic

Optional

Number of Queues per NIC. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

running_mtu

Optional

Running MTU on the NIC. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

rx_queue_size

Optional

Receive queue size. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

tx_queue_size

Optional

Transmit queue size. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

vrf_id

Optional

VRF Information. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

401

Hide Details

log in failed

Operation doesn't return any data structure

404

Hide Details

object not found

Operation doesn't return any data structure

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/serviceengine/{uuid}/nicinfo
                

On This Page

Description

Request

Path Parameters

Header Parameters

Authentication

Response

200 Response Body

Errors

Service Engine Operations

GET

GET /serviceengine

GET

GET /serviceengine/{uuid}

PUT

PUT /serviceengine/{uuid}

PATCH

PATCH /serviceengine/{uuid}

DELETE

DELETE /serviceengine/{uuid}

POST

POST /serviceengine/{uuid}/reboot

POST

POST /serviceengine/{uuid}/forcedelete

POST

POST /serviceengine/{uuid}/switchover

POST

POST /serviceengine/clear

GET

GET /serviceengine/{uuid}/runtime/

GET

GET /serviceengine/{uuid}/runtime/detail/

GET

GET /serviceengine/{uuid}/internal/

GET

GET /serviceengine/{uuid}/ipstat/

GET

GET /serviceengine/{uuid}/arpstat/

GET

GET /serviceengine/{uuid}/icmpstat/

GET

GET /serviceengine/{uuid}/mbufstats/

GET

GET /serviceengine/{uuid}/mallocstats/

GET

GET /serviceengine/{uuid}/shmallocstats/

GET

GET /serviceengine/{uuid}/seassertstats/dp/

GET

GET /serviceengine/{uuid}/seassertstats/ag/

GET

GET /serviceengine/{uuid}/sevshbstats/

GET

GET /serviceengine/{uuid}/sevssplacement/

GET

GET /serviceengine/{uuid}/cpu/

GET

GET /serviceengine/{uuid}/cpu/detail/

GET

GET /serviceengine/{uuid}/meminfo/

GET

GET /serviceengine/{uuid}/interface/

GET

GET /serviceengine/{uuid}/systeminfo/

GET

GET /serviceengine/{uuid}/hugepageinfo/

GET

GET /serviceengine/{uuid}/bgp/

GET

GET /serviceengine/{uuid}/bgp/debug/

GET

GET /serviceengine/{uuid}/bgp/advertised_routes/

GET

GET /serviceengine/{uuid}/bgp/peer_status/

GET

GET /serviceengine/{uuid}/bgp/peer_info/

GET

GET /serviceengine/{uuid}/bgp/running_config/

GET

GET /serviceengine/{uuid}/bgp/peer_state/

GET

GET /serviceengine/{uuid}/bfd/running_config/

GET

GET /serviceengine/{uuid}/bfd/session_status/

GET

GET /serviceengine/{uuid}/interfacesummary/

GET

GET /serviceengine/{uuid}/interface/lacp/

GET

GET /serviceengine/{uuid}/lldp/

GET

GET /serviceengine/{uuid}/route/

GET

GET /serviceengine/{uuid}/ip6route/

GET

GET /serviceengine/{uuid}/arptable/

GET

GET /serviceengine/{uuid}/httpstats/

GET

GET /serviceengine/{uuid}/seruminsertionstats/

GET

GET /serviceengine/{uuid}/selogstats/

GET

GET /serviceengine/{uuid}/seauthstats/

GET

GET /serviceengine/{uuid}/vnicdb/

GET

GET /serviceengine/{uuid}/vnicdbhistory/

GET

GET /serviceengine/{uuid}/graphdb/

GET

GET /serviceengine/{uuid}/seagent/

GET

GET /serviceengine/{uuid}/resourcemap/

GET

GET /serviceengine/{uuid}/consistenthash/

GET

GET /serviceengine/{uuid}/appmap/

GET

GET /serviceengine/{uuid}/shardclientevents/

GET

GET /serviceengine/{uuid}/qatinfo/

GET

GET /serviceengine/{uuid}/rteringstat/

GET

GET /serviceengine/{uuid}/sehmprobedisable/

GET

GET /serviceengine/{uuid}/flowtablestat/

GET

GET /serviceengine/{uuid}/flowtable/

GET

GET /serviceengine/{uuid}/vshash/

GET

GET /serviceengine/{uuid}/flowtable_remote/

GET

GET /serviceengine/{uuid}/tcp-flows/

GET

GET /serviceengine/{uuid}/sctp-flows/

GET

GET /serviceengine/{uuid}/tcp-flows/detail/

GET

GET /serviceengine/{uuid}/sctp-flows/detail/

GET

GET /serviceengine/{uuid}/metrics/

GET

GET /serviceengine/{uuid}/metrics/detail/

GET

GET /serviceengine/{uuid}/metrics/debug/

GET

GET /serviceengine/{uuid}/metrics/debug/summary/

GET

GET /serviceengine/{uuid}/dosstat/

GET

GET /serviceengine/{uuid}/memdist/

POST

POST /serviceengine/{uuid}/faultinject/exhaust_mbuf/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_mcl/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_mcl_small/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_conn/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_shm_conn/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_cfg/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_shm_cfg/clear

POST

POST /serviceengine/{uuid}/faultinject/sefault/clear

GET

GET /serviceengine/{uuid}/placement/

GET

GET /serviceengine/{uuid}/reservedvs/

GET

GET /serviceengine/{uuid}/microservice/

GET

GET /serviceengine/{uuid}/ndtable/

GET

GET /serviceengine/{uuid}/ip6stat/

GET

GET /serviceengine/{uuid}/icmp6stat/

GET

GET /serviceengine/{uuid}/natstat/

GET

GET /serviceengine/{uuid}/nat-flows/

GET

GET /serviceengine/{uuid}/network-service/

GET

GET /serviceengine/{uuid}/natpolicystats/

GET

GET /serviceengine/{uuid}/vrf-ip-info/

GET

GET /serviceengine/{uuid}/ratelimiting/rl/internal/

GET

GET /serviceengine/{uuid}/ratelimiting/msf/internal/

GET

GET /serviceengine/{uuid}/routestat/

GET

GET /serviceengine/{uuid}/route-flows/

GET

GET /serviceengine/{uuid}/objsync/

GET

GET /serviceengine/{uuid}/resolverdb/

GET

GET /serviceengine/{uuid}/resolverdbsummary/

GET

GET /serviceengine/{uuid}/seagent_sedatastore_download_fail_obj_list/

GET

GET /serviceengine/{uuid}/botuacacheruntime/

GET

GET /serviceengine/{uuid}/botuacachestatsruntime/

GET

GET /serviceengine/{uuid}/placement/summary/

GET

GET /serviceengine/{uuid}/placement/detail/

GET

GET /serviceengine/{uuid}/adaptiveevents/

GET

GET /serviceengine/{uuid}/dpmetrics/

GET

GET /serviceengine/{uuid}/objsync_stats/

GET

GET /serviceengine/{uuid}/diameter/connections/

GET

GET /serviceengine/{uuid}/dump_objsync_stats/

GET

GET /serviceengine/{uuid}/qatstats/

GET

GET /serviceengine/{uuid}/flowtablestat6/

GET

GET /serviceengine/{uuid}/selogagentstats/

GET

GET /serviceengine/{uuid}/selogagentoperstats/

GET

GET /serviceengine/{uuid}/selogagentcontrollerinterfacestats/

GET

GET /serviceengine/{uuid}/selogagentnetworkstreamstats/

GET

GET /serviceengine/{uuid}/sessionkeyforwarderstats/

GET

GET /serviceengine/{uuid}/sessionkeyforwarderstats/details/

GET

GET /serviceengine/{uuid}/nicinfo/