GET /serviceengine/{uuid}

/serviceengine/{uuid}

Request

URI

GET

https://api_host/api/serviceengine/{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

Returns ServiceEngine of type(s) application/json

{
    "_last_modified": "string",
    "availability_zone": "string",
    "cloud_ref": "string",
    "container_mode": false,
    "container_type": "string",
    "controller_created": false,
    "controller_ip": "string",
    "data_vnics": [
        {
            "adapter": "string",
            "aggregator_chgd": false,
            "can_se_dp_takeover": false,
            "connected": false,
            "del_pending": false,
            "delete_vnic": false,
            "dhcp_enabled": false,
            "dp_deletion_done": false,
            "enabled": false,
            "if_name": "string",
            "ip6_autocfg_enabled": false,
            "is_asm": false,
            "is_avi_internal_network": false,
            "is_hsm": false,
            "is_mgmt": false,
            "is_portchannel": false,
            "link_up": false,
            "linux_name": "string",
            "mac_address": "string",
            "members": [
                {
                    "active": false,
                    "if_name": "string",
                    "mac_address": "string"
                }
            ],
            "mtu": 0,
            "network_name": "string",
            "network_ref": "string",
            "num_rx_descriptors": 0,
            "num_tx_descriptors": 0,
            "pci_id": "string",
            "port_uuid": "string",
            "vlan_id": 0,
            "vlan_interfaces": [
                {
                    "dhcp_enabled": false,
                    "enabled": false,
                    "if_name": "string",
                    "ip6_autocfg_enabled": false,
                    "is_mgmt": false,
                    "vlan_id": 0,
                    "vnic_networks": [
                        {
                            "ctlr_alloc": false,
                            "ip": {
                                "ip_addr": {
                                    "addr": "string",
                                    "type": "string"
                                },
                                "mask": 0
                            },
                            "mode": "string"
                        }
                    ],
                    "vrf_ref": "string"
                }
            ],
            "vnic_networks": [
                {
                    "ctlr_alloc": false,
                    "ip": {
                        "ip_addr": {
                            "addr": "string",
                            "type": "string"
                        },
                        "mask": 0
                    },
                    "mode": "string"
                }
            ],
            "vrf_id": 0,
            "vrf_ref": "string"
        }
    ],
    "enable_state": "string",
    "flavor": "string",
    "host_ref": "string",
    "hypervisor": "string",
    "mgmt_vnic": {
        "adapter": "string",
        "aggregator_chgd": false,
        "can_se_dp_takeover": false,
        "connected": false,
        "del_pending": false,
        "delete_vnic": false,
        "dhcp_enabled": false,
        "dp_deletion_done": false,
        "enabled": false,
        "if_name": "string",
        "ip6_autocfg_enabled": false,
        "is_asm": false,
        "is_avi_internal_network": false,
        "is_hsm": false,
        "is_mgmt": false,
        "is_portchannel": false,
        "link_up": false,
        "linux_name": "string",
        "mac_address": "string",
        "members": [
            {
                "active": false,
                "if_name": "string",
                "mac_address": "string"
            }
        ],
        "mtu": 0,
        "network_name": "string",
        "network_ref": "string",
        "num_rx_descriptors": 0,
        "num_tx_descriptors": 0,
        "pci_id": "string",
        "port_uuid": "string",
        "vlan_id": 0,
        "vlan_interfaces": [
            {
                "dhcp_enabled": false,
                "enabled": false,
                "if_name": "string",
                "ip6_autocfg_enabled": false,
                "is_mgmt": false,
                "vlan_id": 0,
                "vnic_networks": [
                    {
                        "ctlr_alloc": false,
                        "ip": {
                            "ip_addr": {
                                "addr": "string",
                                "type": "string"
                            },
                            "mask": 0
                        },
                        "mode": "string"
                    }
                ],
                "vrf_ref": "string"
            }
        ],
        "vnic_networks": [
            {
                "ctlr_alloc": false,
                "ip": {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                },
                "mode": "string"
            }
        ],
        "vrf_id": 0,
        "vrf_ref": "string"
    },
    "name": "string",
    "nsxt_no_hotplug": false,
    "resources": {
        "cores_per_socket": 0,
        "disk": 0,
        "hyper_threading": false,
        "hypervisor_mode": false,
        "memory": 0,
        "num_datapath_processes": 0,
        "num_vcpus": 0,
        "sockets": 0
    },
    "se_group_ref": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

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

string

availability_zone

Optional

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

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.

boolean

container_mode

Optional

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

string

container_type

Optional

Enum options - CONTAINER_TYPE_BRIDGE, CONTAINER_TYPE_HOST, CONTAINER_TYPE_HOST_DPDK. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

controller_created

Optional

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

string

controller_ip

Optional

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

array of vNIC

data_vnics

Optional

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

string

enable_state

Optional

inorder to disable SE set this field appropriately. Enum options - SE_STATE_ENABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_DISABLED, SE_STATE_DISABLED_FORCE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

flavor

Optional

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

string

host_ref

Optional

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

string

hypervisor

Optional

Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

vNIC

mgmt_vnic

Optional

mgmt_vnic

string

name

Optional

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

boolean

nsxt_no_hotplug

Optional

If set to true, controller does not hotplugg the vNICs. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

SeResources

resources

Optional

resources

string

se_group_ref

Optional

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

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

Operation doesn't return any data structure

On This Page

Description