GET /serviceengine/{uuid}/systeminfo/

/serviceengine/{uuid}/systeminfo/

Request

URI

GET

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

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

Returns SeSystemInfoRuntime of type(s) application/json

{
    "cloud": "string",
    "disk_size": 0,
    "disk_type": "string",
    "dispatcher_info": {
        "active_cores": 0,
        "dedicated_dispatcher_on": false,
        "dispatcher_cores": 0,
        "dp_isolated_cores": 0,
        "num_queues": 0,
        "num_queues_per_dispatcher": 0,
        "proxy_cores": 0
    },
    "fips_info": {
        "fips_compliance_standard": "string",
        "fips_mode_enabled": false,
        "fips_provider_version": "string",
        "openssl_base_version": "string"
    },
    "hypervisor": "string",
    "iommu_mode": "string",
    "memdist_info": {
        "app_cache_mb": 0,
        "app_learning_memory_mb": 0,
        "clusters": 0,
        "config_memory_mb": 0,
        "conn_memory_mb": 0,
        "conn_memory_mb_per_core": 0,
        "huge_pages": 0,
        "os_reserved_memory_mb": 0,
        "qat_hpage_mem_mb": 0,
        "shm_config_memory_mb": 0,
        "shm_conn_memory_mb": 0,
        "shm_memory_mb": 0
    },
    "memory": 0,
    "network_info": {
        "active_ofed_version": "string",
        "datapath_nic_drivers": "string",
        "dpdk_mode": false,
        "dpdk_version": "string",
        "inband_mgmt": false,
        "is_mgmt_port_channel": false,
        "loaded_mlx_modules": "string",
        "mgmt_intf_name": "string",
        "mgmt_nic_driver_family": "string",
        "num_active_nics": 0,
        "num_datapath_interfaces": 0,
        "num_passive_nics": 0,
        "num_port_channels": 0,
        "num_vlan_interfaces": 0
    },
    "num_cores": 0,
    "num_qat_devices": 0,
    "num_sockets": 0,
    "proc_id": "string",
    "se_uuid": "string",
    "use_hyper_threading": 0,
    "version_info": {
        "active_root_partition": "string",
        "boot_mode": "string",
        "host_os_version": "string",
        "kernel_version": "string",
        "lsc_deployment_mode": "string",
        "openssl_base_version": "string",
        "openssl_providers": "string",
        "os_version": "string",
        "se_image_version": "string",
        "se_patch_version": "string"
    }
}

string

cloud

Optional

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

integer As int32 As int32

disk_size

Optional

SE Disk Size. Field introduced in 31.2.1. Unit is MB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

disk_type

Optional

SE Disk Type HDD/SSD. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

object

dispatcher_info

Optional

dispatcher_info

object

fips_info

Optional

fips_info

string

hypervisor

Optional

SE Hypervisor Type. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

iommu_mode

Optional

SE IOMMU Mode. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

object

memdist_info

Optional

memdist_info

integer As int32 As int32

memory

Optional

SE System Memory. Field introduced in 31.2.1. Unit is MB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

object

network_info

Optional

network_info

integer As int32 As int32

num_cores

Optional

Total Num of Cores of SE. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32

num_qat_devices

Optional

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

integer As int32 As int32

num_sockets

Optional

Num Sockets of SE. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

proc_id

Required

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

string

se_uuid

Required

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

integer As int32 As int32

use_hyper_threading

Optional

Hyperthreading on SE. Field introduced in 31.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

object

version_info

Optional

version_info

401

Operation doesn't return any data structure

404

object not found

Operation doesn't return any data structure

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Header Parameters

Authentication

Response

200 Response Body

Errors

Service Engine Operations