Pluribus Networks REST API (5.2.0-5020015650)

Pluribus Networks REST API.
More information: support@pluribusnetworks.com
Contact Info: support@pluribusnetworks.com
Version: 1.0.0
BasePath:/vRest
Apache 2.0 License
http://www.apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

AaaTacacs

AccessLists

AclIps

AclMacs

AdminIpmi

AdminServices

AdminSessionTimeout

AdminSftp

AdminSyslogs

Alerts

ApiInstalls

BezelPortmaps

Bootenvs

BridgeDomains

CertExpirationAlert

CertRequests

Certs

ClientServerStats

ClusterBringdown

ClusterBringup

ClusterMemberships

Clusters

ConnectionLatencies

ConnectionStats

ConnectionStatsSettings

Connections

ControlStats

ControlStatsSettings

ControlTraffics

DhcpFilters

DhcpLeases

Dhcps

DiskLibraries

Dns

DscpMaps

ErrDisable

Eula

FabricAnycastMac

FabricCommPorts

FabricCommVrouterBgps

FabricInBandNetworks

FabricLocal

FabricNodes

FabricStats

FabricUpgradeStatuses

FabricUpgrades

FabricVnics

Fabrics

FlowTables

HogViolatorStats

HogViolators

IdLed

IgmpQuerierIps

IgmpRouters

IgmpSnooping

IgmpStaticGroups

IgmpStaticSources

IgmpStats

IgmpSwitches

Igmps

InlineServices

InterfaceStats

IpPools

IpfixCollectors

IpfixService

Ipv6securityRaguards

IsoLibraries

L2Checks

L2Histories

L2Setting

L2StaticMulticastGroups

L2Tables

L3Checks

L3Histories

L3Setting

L3Tables

Lacp

LacpPortStatsSettings

Lldps

LogAdminAudit

LogAlerts

LogArchivalSchedule

LogAuditExceptions

LogAudits

LogDatetimeFmtMode

LogEventSettings

LogEvents

LogSystemCounters

LogSystems

MacLimits

Mcasts

MgmtSessions

Mirrors

MldRouters

MldSnooping

MldStaticGroups

MldStaticSources

MldStats

MldSwitches

Mlds

MstConfigs

Nodes

NvQueueStats

NvQueueStatsSettings

ObjectLocations

Openvswitches

PnScripts

PortAssociationPaths

PortAssociations

PortBufferSettings

PortBuffers

PortConfigs

PortCosBws

PortCosRateSettings

PortCosStats

PortCosStatsSettings

PortCosWeight

PortEgresses

PortForceLinkup

PortGroups

PortLacpStats

PortLacps

PortLldps

PortPfcStats

PortPfcStatsSettings

PortPfcs

PortPhys

PortStats

PortStatsSettings

PortStatsSnmps

PortStormControls

PortVlans

PortXcvrMemories

PortXcvrs

Ports

PrefixLists

Ptp

Roles

ServiceHeartbeats

ServiceStats

SflowCollectors

Sflows

SnmpCommunities

SnmpEngineid

SnmpSystem

SnmpTrapEnable

SnmpTrapSinks

SnmpUsers

SnmpV3TrapSinks

SnmpVacms

Snmps

Software

SoftwareLicenses

SoftwareUpgradeStatuses

StaticArps

StaticEcmpGroups

StorageDevices

StoragePools

StorageStats

Stp

StpPortEvents

StpPortStates

StpPorts

StpStates

Subnets

SwitchBoot

SwitchConfigs

SwitchGroups

SwitchInfo

SwitchMode

SwitchNicInfos

SwitchNicStats

SwitchRoutes

SwitchSetup

SwitchStatusSettings

SwitchStatuses

SwitchVnics

SyslogTlsCertInfos

SyslogTlsCertRequests

SyslogTlsCerts

System

SystemDiagnosticsHwLimits

SystemSettings

SystemStats

SystemStatsSettings

Topologies

TransactionNodes

TransactionSettings

Transactions

TrunkStats

Trunks

TunnelHistories

TunnelHistorySettings

TunnelStats

TunnelStatsSettings

Tunnels

Udfs

Users

VcenterConnections

VflowClasses

VflowMgmtStats

VflowSettings

VflowStats

VflowStatsSettings

VflowTableProfiles

VflowTables

Vflows

VlagStats

Vlags

VlanStats

VlanStatsSettings

Vlans

Vles

VnetManagers

VnetPublicVlans

Vnets

VportHistories

VportSettings

VportStats

VportSystemStats

Vports

VrfMroutes

VrfMulticast

VrfMulticastFlood

VrfMulticastIgmp

Vrfs

VrouterCachedRoutes

VrouterEcmpCachedRoutes

VrouterEcmpGroups

VrouterFibArps

VrouterFibRoutes

VrouterLogs

VrouterMfibRoutes

VrouterMribRoutes

VrouterRibHistories

VrouterRibHistorySettings

VrouterRibRoutes

VrouterRoutesStats

Vrouters

VtepAutoVxlan

Vteps

VxlanDestPort

VxlanStats

VxlanStatsSettings

WebCertInfos

WebCertRequests

WebCertSelfSigneds

WebCerts

AaaTacacs

Up
post /aaa-tacacs
(createTacacs)

Consumes

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

Request body

body aaa-tacacs-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /aaa-tacacs/{name}
(deleteTacacsByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /aaa-tacacs
(showTacacs)

Consumes

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

Return type

aaa-tacacs-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "server" : "server",
    "cmd-acct" : true,
    "sess-author" : true,
    "service-vtysh" : "service-vtysh",
    "sess-acct" : true,
    "errors-logged" : true,
    "author-local" : true,
    "priority" : 1,
    "api.switch-name" : "api.switch-name",
    "timed-out" : true,
    "timeout" : 6,
    "acct-local" : true,
    "num-errors" : 5,
    "authen-method" : "pap",
    "authen-local" : true,
    "port" : 0,
    "service" : "service",
    "service-shell" : "service-shell",
    "scope" : "local",
    "name" : "name",
    "error-start" : "error-start",
    "cmd-author" : true,
    "authen" : true,
    "status" : "status"
  }, {
    "server" : "server",
    "cmd-acct" : true,
    "sess-author" : true,
    "service-vtysh" : "service-vtysh",
    "sess-acct" : true,
    "errors-logged" : true,
    "author-local" : true,
    "priority" : 1,
    "api.switch-name" : "api.switch-name",
    "timed-out" : true,
    "timeout" : 6,
    "acct-local" : true,
    "num-errors" : 5,
    "authen-method" : "pap",
    "authen-local" : true,
    "port" : 0,
    "service" : "service",
    "service-shell" : "service-shell",
    "scope" : "local",
    "name" : "name",
    "error-start" : "error-start",
    "cmd-author" : true,
    "authen" : true,
    "status" : "status"
  } ]
}

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

default

success aaa-tacacs-show-response

Up
get /aaa-tacacs/{name}
(showTacacsByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

aaa-tacacs-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "server" : "server",
    "cmd-acct" : true,
    "sess-author" : true,
    "service-vtysh" : "service-vtysh",
    "sess-acct" : true,
    "errors-logged" : true,
    "author-local" : true,
    "priority" : 1,
    "api.switch-name" : "api.switch-name",
    "timed-out" : true,
    "timeout" : 6,
    "acct-local" : true,
    "num-errors" : 5,
    "authen-method" : "pap",
    "authen-local" : true,
    "port" : 0,
    "service" : "service",
    "service-shell" : "service-shell",
    "scope" : "local",
    "name" : "name",
    "error-start" : "error-start",
    "cmd-author" : true,
    "authen" : true,
    "status" : "status"
  }, {
    "server" : "server",
    "cmd-acct" : true,
    "sess-author" : true,
    "service-vtysh" : "service-vtysh",
    "sess-acct" : true,
    "errors-logged" : true,
    "author-local" : true,
    "priority" : 1,
    "api.switch-name" : "api.switch-name",
    "timed-out" : true,
    "timeout" : 6,
    "acct-local" : true,
    "num-errors" : 5,
    "authen-method" : "pap",
    "authen-local" : true,
    "port" : 0,
    "service" : "service",
    "service-shell" : "service-shell",
    "scope" : "local",
    "name" : "name",
    "error-start" : "error-start",
    "cmd-author" : true,
    "authen" : true,
    "status" : "status"
  } ]
}

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

default

success aaa-tacacs-show-response

Up
get /aaa-tacacs/status/{name}
(statusTacacs)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

aaa-tacacs-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "server" : "server",
    "cmd-acct" : true,
    "sess-author" : true,
    "service-vtysh" : "service-vtysh",
    "sess-acct" : true,
    "errors-logged" : true,
    "author-local" : true,
    "priority" : 1,
    "api.switch-name" : "api.switch-name",
    "timed-out" : true,
    "timeout" : 6,
    "acct-local" : true,
    "num-errors" : 5,
    "authen-method" : "pap",
    "authen-local" : true,
    "port" : 0,
    "service" : "service",
    "service-shell" : "service-shell",
    "scope" : "local",
    "name" : "name",
    "error-start" : "error-start",
    "cmd-author" : true,
    "authen" : true,
    "status" : "status"
  }, {
    "server" : "server",
    "cmd-acct" : true,
    "sess-author" : true,
    "service-vtysh" : "service-vtysh",
    "sess-acct" : true,
    "errors-logged" : true,
    "author-local" : true,
    "priority" : 1,
    "api.switch-name" : "api.switch-name",
    "timed-out" : true,
    "timeout" : 6,
    "acct-local" : true,
    "num-errors" : 5,
    "authen-method" : "pap",
    "authen-local" : true,
    "port" : 0,
    "service" : "service",
    "service-shell" : "service-shell",
    "scope" : "local",
    "name" : "name",
    "error-start" : "error-start",
    "cmd-author" : true,
    "authen" : true,
    "status" : "status"
  } ]
}

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

default

success aaa-tacacs-show-response

Up
get /aaa-tacacs/status
(statusTacacs_1)

Consumes

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

Return type

aaa-tacacs-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "server" : "server",
    "cmd-acct" : true,
    "sess-author" : true,
    "service-vtysh" : "service-vtysh",
    "sess-acct" : true,
    "errors-logged" : true,
    "author-local" : true,
    "priority" : 1,
    "api.switch-name" : "api.switch-name",
    "timed-out" : true,
    "timeout" : 6,
    "acct-local" : true,
    "num-errors" : 5,
    "authen-method" : "pap",
    "authen-local" : true,
    "port" : 0,
    "service" : "service",
    "service-shell" : "service-shell",
    "scope" : "local",
    "name" : "name",
    "error-start" : "error-start",
    "cmd-author" : true,
    "authen" : true,
    "status" : "status"
  }, {
    "server" : "server",
    "cmd-acct" : true,
    "sess-author" : true,
    "service-vtysh" : "service-vtysh",
    "sess-acct" : true,
    "errors-logged" : true,
    "author-local" : true,
    "priority" : 1,
    "api.switch-name" : "api.switch-name",
    "timed-out" : true,
    "timeout" : 6,
    "acct-local" : true,
    "num-errors" : 5,
    "authen-method" : "pap",
    "authen-local" : true,
    "port" : 0,
    "service" : "service",
    "service-shell" : "service-shell",
    "scope" : "local",
    "name" : "name",
    "error-start" : "error-start",
    "cmd-author" : true,
    "authen" : true,
    "status" : "status"
  } ]
}

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

default

success aaa-tacacs-show-response

Up
put /aaa-tacacs/{name}
(updateTacacsByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body aaa-tacacs-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

AccessLists

Up
post /access-lists/{name}/ips
(addNvOSAccessListIpByNvOSAccessListName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body access-list-ip-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /access-lists
(createNvOSAccessList)

Consumes

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

Request body

body access-list-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /access-lists/{name}
(deleteNvOSAccessListByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /access-lists/{name}/ips/{ip}
(removeNvOSAccessListIpByNameByIp)

Path parameters

name (required)
Path Parameter
ip (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /access-lists/{name}
(showNvOSAccessListByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

access-list-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  }, {
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success access-list-show-response

Up
get /access-lists/{name}/ips/{ip}
(showNvOSAccessListIpByNameByIp)

Path parameters

name (required)
Path Parameter
ip (required)
Path Parameter

Consumes

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

Return type

access-list-ip-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ip" : "ip",
    "api.switch-name" : "api.switch-name"
  }, {
    "ip" : "ip",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success access-list-ip-show-response

Up
get /access-lists/{name}/ips
(showNvOSAccessListIpsByNvOSAccessListName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

access-list-ip-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ip" : "ip",
    "api.switch-name" : "api.switch-name"
  }, {
    "ip" : "ip",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success access-list-ip-show-response

Up
get /access-lists
(showNvOSAccessLists)

Consumes

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

Return type

access-list-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  }, {
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success access-list-show-response

AclIps

Up
post /acl-ips
(createIpAcl)

Consumes

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

Request body

body acl-ip-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /acl-ips/id/{id}
(deleteIpAclByIdent)

Path parameters

id (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /acl-ips/name/{name}
(deleteIpAclByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /acl-ips/id/{id}
(showIpAclByIdent)

Path parameters

id (required)
Path Parameter

Consumes

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

Return type

acl-ip-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "bd" : "bd",
    "src-port" : 5,
    "dst-port" : 2,
    "api.switch-name" : "api.switch-name",
    "dst-ip-mask" : 5,
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "proto" : 7,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "action" : "permit",
    "id" : "id",
    "src-ip-mask" : 1
  }, {
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "bd" : "bd",
    "src-port" : 5,
    "dst-port" : 2,
    "api.switch-name" : "api.switch-name",
    "dst-ip-mask" : 5,
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "proto" : 7,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "action" : "permit",
    "id" : "id",
    "src-ip-mask" : 1
  } ]
}

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

default

success acl-ip-show-response

Up
get /acl-ips/name/{name}
(showIpAclByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

acl-ip-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "bd" : "bd",
    "src-port" : 5,
    "dst-port" : 2,
    "api.switch-name" : "api.switch-name",
    "dst-ip-mask" : 5,
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "proto" : 7,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "action" : "permit",
    "id" : "id",
    "src-ip-mask" : 1
  }, {
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "bd" : "bd",
    "src-port" : 5,
    "dst-port" : 2,
    "api.switch-name" : "api.switch-name",
    "dst-ip-mask" : 5,
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "proto" : 7,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "action" : "permit",
    "id" : "id",
    "src-ip-mask" : 1
  } ]
}

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

default

success acl-ip-show-response

Up
get /acl-ips
(showIpAcls)

Consumes

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

Return type

acl-ip-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "bd" : "bd",
    "src-port" : 5,
    "dst-port" : 2,
    "api.switch-name" : "api.switch-name",
    "dst-ip-mask" : 5,
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "proto" : 7,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "action" : "permit",
    "id" : "id",
    "src-ip-mask" : 1
  }, {
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "bd" : "bd",
    "src-port" : 5,
    "dst-port" : 2,
    "api.switch-name" : "api.switch-name",
    "dst-ip-mask" : 5,
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "proto" : 7,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "action" : "permit",
    "id" : "id",
    "src-ip-mask" : 1
  } ]
}

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

default

success acl-ip-show-response

Up
put /acl-ips/id/{id}
(updateIpAclByIdent)

Path parameters

id (required)
Path Parameter

Consumes

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

Request body

body acl-ip-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
put /acl-ips/name/{name}
(updateIpAclByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body acl-ip-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

AclMacs

Up
post /acl-macs
(createMacAcl)

Consumes

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

Request body

body acl-mac-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /acl-macs/id/{id}
(deleteMacAclByIdent)

Path parameters

id (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /acl-macs/name/{name}
(deleteMacAclByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /acl-macs/id/{id}
(showMacAclByIdent)

Path parameters

id (required)
Path Parameter

Consumes

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

Return type

acl-mac-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "dst-mac" : "dst-mac",
    "ether-type" : "0x800",
    "api.switch-name" : "api.switch-name",
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "src-mac" : "src-mac",
    "action" : "permit",
    "id" : "id",
    "dst-mac-mask" : "dst-mac-mask",
    "src-mac-mask" : "src-mac-mask"
  }, {
    "bd" : "bd",
    "dst-mac" : "dst-mac",
    "ether-type" : "0x800",
    "api.switch-name" : "api.switch-name",
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "src-mac" : "src-mac",
    "action" : "permit",
    "id" : "id",
    "dst-mac-mask" : "dst-mac-mask",
    "src-mac-mask" : "src-mac-mask"
  } ]
}

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

default

success acl-mac-show-response

Up
get /acl-macs/name/{name}
(showMacAclByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

acl-mac-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "dst-mac" : "dst-mac",
    "ether-type" : "0x800",
    "api.switch-name" : "api.switch-name",
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "src-mac" : "src-mac",
    "action" : "permit",
    "id" : "id",
    "dst-mac-mask" : "dst-mac-mask",
    "src-mac-mask" : "src-mac-mask"
  }, {
    "bd" : "bd",
    "dst-mac" : "dst-mac",
    "ether-type" : "0x800",
    "api.switch-name" : "api.switch-name",
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "src-mac" : "src-mac",
    "action" : "permit",
    "id" : "id",
    "dst-mac-mask" : "dst-mac-mask",
    "src-mac-mask" : "src-mac-mask"
  } ]
}

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

default

success acl-mac-show-response

Up
get /acl-macs
(showMacAcls)

Consumes

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

Return type

acl-mac-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "dst-mac" : "dst-mac",
    "ether-type" : "0x800",
    "api.switch-name" : "api.switch-name",
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "src-mac" : "src-mac",
    "action" : "permit",
    "id" : "id",
    "dst-mac-mask" : "dst-mac-mask",
    "src-mac-mask" : "src-mac-mask"
  }, {
    "bd" : "bd",
    "dst-mac" : "dst-mac",
    "ether-type" : "0x800",
    "api.switch-name" : "api.switch-name",
    "vlan" : 0,
    "port" : 6,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "src-mac" : "src-mac",
    "action" : "permit",
    "id" : "id",
    "dst-mac-mask" : "dst-mac-mask",
    "src-mac-mask" : "src-mac-mask"
  } ]
}

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

default

success acl-mac-show-response

Up
put /acl-macs/id/{id}
(updateMacAclByIdent)

Path parameters

id (required)
Path Parameter

Consumes

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

Request body

body acl-mac-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
put /acl-macs/name/{name}
(updateMacAclByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body acl-mac-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

AdminIpmi

Up
get /admin-ipmi
(showAdminIpmi)

Consumes

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

Return type

admin-ipmi-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ip" : "ip",
    "gateway-ip" : "gateway-ip",
    "secondary-netmask" : 6,
    "GUID" : "GUID",
    "secondary-mac" : "secondary-mac",
    "api.switch-name" : "api.switch-name",
    "secondary-gateway-ip" : "secondary-gateway-ip",
    "mac" : "mac",
    "secondary-ip" : "secondary-ip",
    "netmask" : 0,
    "enable" : true,
    "secondary-enable" : true,
    "user" : "user",
    "addr-type" : "static",
    "secondary-addr-type" : "static"
  }, {
    "ip" : "ip",
    "gateway-ip" : "gateway-ip",
    "secondary-netmask" : 6,
    "GUID" : "GUID",
    "secondary-mac" : "secondary-mac",
    "api.switch-name" : "api.switch-name",
    "secondary-gateway-ip" : "secondary-gateway-ip",
    "mac" : "mac",
    "secondary-ip" : "secondary-ip",
    "netmask" : 0,
    "enable" : true,
    "secondary-enable" : true,
    "user" : "user",
    "addr-type" : "static",
    "secondary-addr-type" : "static"
  } ]
}

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

default

success admin-ipmi-show-response

Up
put /admin-ipmi
(updateAdminIpmi)

Consumes

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

Request body

body admin-ipmi-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

AdminServices

Up
get /admin-services/{if}
(showAdminServiceByNic)

Path parameters

if (required)
Path Parameter

Consumes

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

Return type

admin-service-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "web-port" : 6,
    "web-log" : true,
    "web" : true,
    "net-api" : true,
    "ssh" : true,
    "web-ssl" : true,
    "nfs" : true,
    "web-ssl-port" : 0,
    "snmp" : true,
    "icmp" : true,
    "api.switch-name" : "api.switch-name",
    "if" : "if"
  }, {
    "web-port" : 6,
    "web-log" : true,
    "web" : true,
    "net-api" : true,
    "ssh" : true,
    "web-ssl" : true,
    "nfs" : true,
    "web-ssl-port" : 0,
    "snmp" : true,
    "icmp" : true,
    "api.switch-name" : "api.switch-name",
    "if" : "if"
  } ]
}

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

default

success admin-service-show-response

Up
get /admin-services
(showAdminServices)

Consumes

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

Return type

admin-service-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "web-port" : 6,
    "web-log" : true,
    "web" : true,
    "net-api" : true,
    "ssh" : true,
    "web-ssl" : true,
    "nfs" : true,
    "web-ssl-port" : 0,
    "snmp" : true,
    "icmp" : true,
    "api.switch-name" : "api.switch-name",
    "if" : "if"
  }, {
    "web-port" : 6,
    "web-log" : true,
    "web" : true,
    "net-api" : true,
    "ssh" : true,
    "web-ssl" : true,
    "nfs" : true,
    "web-ssl-port" : 0,
    "snmp" : true,
    "icmp" : true,
    "api.switch-name" : "api.switch-name",
    "if" : "if"
  } ]
}

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

default

success admin-service-show-response

Up
put /admin-services/{if}
(updateAdminServiceByNic)

Path parameters

if (required)
Path Parameter

Consumes

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

Request body

body admin-service-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

AdminSessionTimeout

Up
get /admin-session-timeout
(showAdminSessionTimeout)

Consumes

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

Return type

admin-session-timeout-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "api.switch-name" : "api.switch-name",
    "timeout" : 0
  }, {
    "api.switch-name" : "api.switch-name",
    "timeout" : 0
  } ]
}

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

default

success admin-session-timeout-show-response

Up
put /admin-session-timeout
(updateAdminSessionTimeout)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

AdminSftp

Up
put /admin-sftp
(modifyAdminSftpByUsage1)

Consumes

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

Request body

body admin-sftp-modify-1 (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /admin-sftp
(showAdminSftp)

Consumes

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

Return type

admin-sftp-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "sftp-user" : "sftp-user",
    "enable" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "sftp-user" : "sftp-user",
    "enable" : true,
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success admin-sftp-show-response

AdminSyslogs

Up
post /admin-syslogs/{syslog-name}/matches
(addAdminSyslogMatchByAdminSyslogName)

Path parameters

syslog-name (required)
Path Parameter

Consumes

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

Request body

body admin-syslog-match-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /admin-syslogs
(createAdminSyslog)

Consumes

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

Request body

body admin-syslog-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /admin-syslogs/{name}
(deleteAdminSyslogByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /admin-syslogs/{syslog-name}/matches/{name}
(removeAdminSyslogMatchByNameByName)

Path parameters

syslog-name (required)
Path Parameter
name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /admin-syslogs/{name}
(showAdminSyslogByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

admin-syslog-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : 0,
    "scope" : "local",
    "name" : "name",
    "host" : "host",
    "export-container-logs" : true,
    "message-format" : "structured",
    "export-os-logs" : true,
    "transport" : "tcp-tls",
    "api.switch-name" : "api.switch-name",
    "status" : "status"
  }, {
    "port" : 0,
    "scope" : "local",
    "name" : "name",
    "host" : "host",
    "export-container-logs" : true,
    "message-format" : "structured",
    "export-os-logs" : true,
    "transport" : "tcp-tls",
    "api.switch-name" : "api.switch-name",
    "status" : "status"
  } ]
}

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

default

success admin-syslog-show-response

Up
get /admin-syslogs/{syslog-name}/matches/{name}
(showAdminSyslogMatchByNameByName)

Path parameters

syslog-name (required)
Path Parameter
name (required)
Path Parameter

Consumes

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

Return type

admin-syslog-match-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "msg-code" : 5,
    "msg-show-time" : "msg-show-time",
    "msg-bd" : "msg-bd",
    "msg-remote_switch" : "msg-remote_switch",
    "api.switch-name" : "api.switch-name",
    "msg-client-pid" : 6,
    "msg-switch" : "msg-switch",
    "msg-length" : 9,
    "msg-user" : "msg-user",
    "msg-time" : "msg-time",
    "set-facility" : 3,
    "msg-message" : "msg-message",
    "msg-args" : "msg-args",
    "msg-reverse" : true,
    "msg-vxlan" : "msg-vxlan",
    "msg-name" : "msg-name",
    "msg-vlan" : 2,
    "msg-level" : "critical",
    "msg-program" : "msg-program",
    "msg-vnet" : "msg-vnet",
    "msg-port" : 5,
    "msg-starting-point" : 7,
    "name" : "name",
    "msg-pid" : 0,
    "msg-event-type" : "system",
    "set-severity" : 1,
    "msg-category" : "event",
    "msg-client-addr" : "msg-client-addr",
    "msg-since-last-reset" : true
  }, {
    "msg-code" : 5,
    "msg-show-time" : "msg-show-time",
    "msg-bd" : "msg-bd",
    "msg-remote_switch" : "msg-remote_switch",
    "api.switch-name" : "api.switch-name",
    "msg-client-pid" : 6,
    "msg-switch" : "msg-switch",
    "msg-length" : 9,
    "msg-user" : "msg-user",
    "msg-time" : "msg-time",
    "set-facility" : 3,
    "msg-message" : "msg-message",
    "msg-args" : "msg-args",
    "msg-reverse" : true,
    "msg-vxlan" : "msg-vxlan",
    "msg-name" : "msg-name",
    "msg-vlan" : 2,
    "msg-level" : "critical",
    "msg-program" : "msg-program",
    "msg-vnet" : "msg-vnet",
    "msg-port" : 5,
    "msg-starting-point" : 7,
    "name" : "name",
    "msg-pid" : 0,
    "msg-event-type" : "system",
    "set-severity" : 1,
    "msg-category" : "event",
    "msg-client-addr" : "msg-client-addr",
    "msg-since-last-reset" : true
  } ]
}

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

default

success admin-syslog-match-show-response

Up
get /admin-syslogs/{syslog-name}/matches
(showAdminSyslogMatchesByAdminSyslogName)

Path parameters

syslog-name (required)
Path Parameter

Consumes

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

Return type

admin-syslog-match-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "msg-code" : 5,
    "msg-show-time" : "msg-show-time",
    "msg-bd" : "msg-bd",
    "msg-remote_switch" : "msg-remote_switch",
    "api.switch-name" : "api.switch-name",
    "msg-client-pid" : 6,
    "msg-switch" : "msg-switch",
    "msg-length" : 9,
    "msg-user" : "msg-user",
    "msg-time" : "msg-time",
    "set-facility" : 3,
    "msg-message" : "msg-message",
    "msg-args" : "msg-args",
    "msg-reverse" : true,
    "msg-vxlan" : "msg-vxlan",
    "msg-name" : "msg-name",
    "msg-vlan" : 2,
    "msg-level" : "critical",
    "msg-program" : "msg-program",
    "msg-vnet" : "msg-vnet",
    "msg-port" : 5,
    "msg-starting-point" : 7,
    "name" : "name",
    "msg-pid" : 0,
    "msg-event-type" : "system",
    "set-severity" : 1,
    "msg-category" : "event",
    "msg-client-addr" : "msg-client-addr",
    "msg-since-last-reset" : true
  }, {
    "msg-code" : 5,
    "msg-show-time" : "msg-show-time",
    "msg-bd" : "msg-bd",
    "msg-remote_switch" : "msg-remote_switch",
    "api.switch-name" : "api.switch-name",
    "msg-client-pid" : 6,
    "msg-switch" : "msg-switch",
    "msg-length" : 9,
    "msg-user" : "msg-user",
    "msg-time" : "msg-time",
    "set-facility" : 3,
    "msg-message" : "msg-message",
    "msg-args" : "msg-args",
    "msg-reverse" : true,
    "msg-vxlan" : "msg-vxlan",
    "msg-name" : "msg-name",
    "msg-vlan" : 2,
    "msg-level" : "critical",
    "msg-program" : "msg-program",
    "msg-vnet" : "msg-vnet",
    "msg-port" : 5,
    "msg-starting-point" : 7,
    "name" : "name",
    "msg-pid" : 0,
    "msg-event-type" : "system",
    "set-severity" : 1,
    "msg-category" : "event",
    "msg-client-addr" : "msg-client-addr",
    "msg-since-last-reset" : true
  } ]
}

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

default

success admin-syslog-match-show-response

Up
get /admin-syslogs
(showAdminSyslogs)

Consumes

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

Return type

admin-syslog-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : 0,
    "scope" : "local",
    "name" : "name",
    "host" : "host",
    "export-container-logs" : true,
    "message-format" : "structured",
    "export-os-logs" : true,
    "transport" : "tcp-tls",
    "api.switch-name" : "api.switch-name",
    "status" : "status"
  }, {
    "port" : 0,
    "scope" : "local",
    "name" : "name",
    "host" : "host",
    "export-container-logs" : true,
    "message-format" : "structured",
    "export-os-logs" : true,
    "transport" : "tcp-tls",
    "api.switch-name" : "api.switch-name",
    "status" : "status"
  } ]
}

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

default

success admin-syslog-show-response

Up
put /admin-syslogs/{name}
(updateAdminSyslogByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body admin-syslog-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
put /admin-syslogs/{syslog-name}/matches/{name}
(updateAdminSyslogMatchByNameByName)

Path parameters

syslog-name (required)
Path Parameter
name (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

admin-syslog-match-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "msg-code" : 5,
    "msg-show-time" : "msg-show-time",
    "msg-bd" : "msg-bd",
    "msg-remote_switch" : "msg-remote_switch",
    "api.switch-name" : "api.switch-name",
    "msg-client-pid" : 6,
    "msg-switch" : "msg-switch",
    "msg-length" : 9,
    "msg-user" : "msg-user",
    "msg-time" : "msg-time",
    "set-facility" : 3,
    "msg-message" : "msg-message",
    "msg-args" : "msg-args",
    "msg-reverse" : true,
    "msg-vxlan" : "msg-vxlan",
    "msg-name" : "msg-name",
    "msg-vlan" : 2,
    "msg-level" : "critical",
    "msg-program" : "msg-program",
    "msg-vnet" : "msg-vnet",
    "msg-port" : 5,
    "msg-starting-point" : 7,
    "name" : "name",
    "msg-pid" : 0,
    "msg-event-type" : "system",
    "set-severity" : 1,
    "msg-category" : "event",
    "msg-client-addr" : "msg-client-addr",
    "msg-since-last-reset" : true
  }, {
    "msg-code" : 5,
    "msg-show-time" : "msg-show-time",
    "msg-bd" : "msg-bd",
    "msg-remote_switch" : "msg-remote_switch",
    "api.switch-name" : "api.switch-name",
    "msg-client-pid" : 6,
    "msg-switch" : "msg-switch",
    "msg-length" : 9,
    "msg-user" : "msg-user",
    "msg-time" : "msg-time",
    "set-facility" : 3,
    "msg-message" : "msg-message",
    "msg-args" : "msg-args",
    "msg-reverse" : true,
    "msg-vxlan" : "msg-vxlan",
    "msg-name" : "msg-name",
    "msg-vlan" : 2,
    "msg-level" : "critical",
    "msg-program" : "msg-program",
    "msg-vnet" : "msg-vnet",
    "msg-port" : 5,
    "msg-starting-point" : 7,
    "name" : "name",
    "msg-pid" : 0,
    "msg-event-type" : "system",
    "set-severity" : 1,
    "msg-category" : "event",
    "msg-client-addr" : "msg-client-addr",
    "msg-since-last-reset" : true
  } ]
}

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

default

success admin-syslog-match-show-response

Alerts

Up
get /alerts
(showAlerts)

Consumes

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

Return type

alert-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "level" : "critical",
    "message" : "message",
    "api.switch-name" : "api.switch-name"
  }, {
    "level" : "critical",
    "message" : "message",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success alert-show-response

ApiInstalls

Up
post /api-installs/install
(installApi)

Consumes

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

Request body

body api-install-install (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

BezelPortmaps

Up
get /bezel-portmaps
(showBezelPortmaps)

Consumes

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

Return type

bezel-portmap-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : 0,
    "api.switch-name" : "api.switch-name",
    "bezel-intf" : "bezel-intf"
  }, {
    "port" : 0,
    "api.switch-name" : "api.switch-name",
    "bezel-intf" : "bezel-intf"
  } ]
}

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

default

success bezel-portmap-show-response

Bootenvs

Up
post /bootenvs/activate-and-reboot
(activateBootenv)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /bootenvs/{name}
(deleteBootenvByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /bootenvs/{name}
(showBootenvByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

bootenv-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "reboot" : true,
    "current" : true,
    "created" : "created",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "apply-current-config" : true,
    "space" : 0
  }, {
    "reboot" : true,
    "current" : true,
    "created" : "created",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "apply-current-config" : true,
    "space" : 0
  } ]
}

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

default

success bootenv-show-response

Up
get /bootenvs
(showBootenvs)

Consumes

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

Return type

bootenv-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "reboot" : true,
    "current" : true,
    "created" : "created",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "apply-current-config" : true,
    "space" : 0
  }, {
    "reboot" : true,
    "current" : true,
    "created" : "created",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "apply-current-config" : true,
    "space" : 0
  } ]
}

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

default

success bootenv-show-response

BridgeDomains

Up
post /bridge-domains/{name}/ports
(addBrDomPortByBrDomName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body bridge-domain-port-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /bridge-domains/name={name}/ports
(addBrDomPortByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body bridge-domain-port-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /bridge-domains
(createBrDom)

Consumes

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

Request body

body bridge-domain-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /bridge-domains/{name}/ports/{port}
(removeBrDomPortByNameByPorts)

Path parameters

name (required)
Path Parameter
port (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /bridge-domains/name={name}/ports/{port}
(removeBrDomPortByPrimaryKeyAllNameByPorts)

Path parameters

name (required)
Path Parameter
port (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /bridge-domains/{name}
(showBrDomByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

bridge-domain-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 2,
    "active" : true,
    "peer-net-id" : 0,
    "description" : "description",
    "qinq_rsvd_vlan" : 6,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "hw-vpn" : 5,
    "auto-vxlan" : true,
    "local-rsvd-vlan" : 9,
    "net-id" : 1,
    "rsvd-vlan" : 7,
    "hw-mcast-group" : 5,
    "scope" : "local",
    "name" : "name"
  }, {
    "vxlan" : 2,
    "active" : true,
    "peer-net-id" : 0,
    "description" : "description",
    "qinq_rsvd_vlan" : 6,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "hw-vpn" : 5,
    "auto-vxlan" : true,
    "local-rsvd-vlan" : 9,
    "net-id" : 1,
    "rsvd-vlan" : 7,
    "hw-mcast-group" : 5,
    "scope" : "local",
    "name" : "name"
  } ]
}

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

default

success bridge-domain-show-response

Up
get /bridge-domains/name={name}
(showBrDomByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

bridge-domain-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 2,
    "active" : true,
    "peer-net-id" : 0,
    "description" : "description",
    "qinq_rsvd_vlan" : 6,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "hw-vpn" : 5,
    "auto-vxlan" : true,
    "local-rsvd-vlan" : 9,
    "net-id" : 1,
    "rsvd-vlan" : 7,
    "hw-mcast-group" : 5,
    "scope" : "local",
    "name" : "name"
  }, {
    "vxlan" : 2,
    "active" : true,
    "peer-net-id" : 0,
    "description" : "description",
    "qinq_rsvd_vlan" : 6,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "hw-vpn" : 5,
    "auto-vxlan" : true,
    "local-rsvd-vlan" : 9,
    "net-id" : 1,
    "rsvd-vlan" : 7,
    "hw-mcast-group" : 5,
    "scope" : "local",
    "name" : "name"
  } ]
}

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

default

success bridge-domain-show-response

Up
get /bridge-domains/{name}/ports/{port}
(showBrDomPortByNameByPorts)

Path parameters

name (required)
Path Parameter
port (required)
Path Parameter

Consumes

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

Return type

bridge-domain-port-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "outer-vlan" : 0,
    "port" : "port",
    "active-ports" : "active-ports",
    "qinq-untagged-port-vlan" : 6,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 1
  }, {
    "vlans" : "vlans",
    "outer-vlan" : 0,
    "port" : "port",
    "active-ports" : "active-ports",
    "qinq-untagged-port-vlan" : 6,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 1
  } ]
}

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

default

success bridge-domain-port-show-response

Up
get /bridge-domains/name={name}/ports
(showBrDomPortByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

bridge-domain-port-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "outer-vlan" : 0,
    "port" : "port",
    "active-ports" : "active-ports",
    "qinq-untagged-port-vlan" : 6,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 1
  }, {
    "vlans" : "vlans",
    "outer-vlan" : 0,
    "port" : "port",
    "active-ports" : "active-ports",
    "qinq-untagged-port-vlan" : 6,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 1
  } ]
}

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

default

success bridge-domain-port-show-response

Up
get /bridge-domains/name={name}/ports/{port}
(showBrDomPortByPrimaryKeyAllNameByPorts)

Path parameters

name (required)
Path Parameter
port (required)
Path Parameter

Consumes

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

Return type

bridge-domain-port-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "outer-vlan" : 0,
    "port" : "port",
    "active-ports" : "active-ports",
    "qinq-untagged-port-vlan" : 6,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 1
  }, {
    "vlans" : "vlans",
    "outer-vlan" : 0,
    "port" : "port",
    "active-ports" : "active-ports",
    "qinq-untagged-port-vlan" : 6,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 1
  } ]
}

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

default

success bridge-domain-port-show-response

Up
get /bridge-domains/{name}/ports
(showBrDomPortsByBrDomName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

bridge-domain-port-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "outer-vlan" : 0,
    "port" : "port",
    "active-ports" : "active-ports",
    "qinq-untagged-port-vlan" : 6,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 1
  }, {
    "vlans" : "vlans",
    "outer-vlan" : 0,
    "port" : "port",
    "active-ports" : "active-ports",
    "qinq-untagged-port-vlan" : 6,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 1
  } ]
}

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

default

success bridge-domain-port-show-response

Up
get /bridge-domains
(showBrDoms)

Consumes

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

Return type

bridge-domain-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 2,
    "active" : true,
    "peer-net-id" : 0,
    "description" : "description",
    "qinq_rsvd_vlan" : 6,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "hw-vpn" : 5,
    "auto-vxlan" : true,
    "local-rsvd-vlan" : 9,
    "net-id" : 1,
    "rsvd-vlan" : 7,
    "hw-mcast-group" : 5,
    "scope" : "local",
    "name" : "name"
  }, {
    "vxlan" : 2,
    "active" : true,
    "peer-net-id" : 0,
    "description" : "description",
    "qinq_rsvd_vlan" : 6,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "hw-vpn" : 5,
    "auto-vxlan" : true,
    "local-rsvd-vlan" : 9,
    "net-id" : 1,
    "rsvd-vlan" : 7,
    "hw-mcast-group" : 5,
    "scope" : "local",
    "name" : "name"
  } ]
}

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

default

success bridge-domain-show-response

Up
put /bridge-domains/{name}
(updateBrDomByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body bridge-domain-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
put /bridge-domains/name={name}
(updateBrDomByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body bridge-domain-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

CertExpirationAlert

Up
get /cert-expiration-alert
(showCertExpiryAlert)

Consumes

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

Return type

cert-expiration-alert-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "days-before-expiration" : 0,
    "api.switch-name" : "api.switch-name",
    "netvisor" : true
  }, {
    "days-before-expiration" : 0,
    "api.switch-name" : "api.switch-name",
    "netvisor" : true
  } ]
}

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

default

success cert-expiration-alert-show-response

Up
put /cert-expiration-alert
(updateCertExpiryAlert)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

CertRequests

Up
post /cert-requests
(createCertRequest)

Consumes

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

Request body

body cert-request-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /cert-requests/{name}
(showCertRequests)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

cert-request-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "container" : "container",
    "cert-request" : "cert-request",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  }, {
    "container" : "container",
    "cert-request" : "cert-request",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success cert-request-show-response

Certs

Up
post /certs
(createCertCommon)

Consumes

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

Request body

body cert-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /certs/{name}
(deleteCertCommonByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /certs/import
(importCertCommonByUsage1)

Consumes

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

Request body

body cert-import-1 (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /certs/{name}
(showCertCommonByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

cert-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "container" : "container",
    "country" : "country",
    "valid-to" : "valid-to",
    "serial-number" : 0,
    "city" : "city",
    "subject" : "subject",
    "organizational-unit" : "organizational-unit",
    "api.switch-name" : "api.switch-name",
    "issuer" : "issuer",
    "common-name" : "common-name",
    "cert-type" : "ca",
    "organization" : "organization",
    "name" : "name",
    "state" : "state",
    "valid-from" : "valid-from"
  }, {
    "container" : "container",
    "country" : "country",
    "valid-to" : "valid-to",
    "serial-number" : 0,
    "city" : "city",
    "subject" : "subject",
    "organizational-unit" : "organizational-unit",
    "api.switch-name" : "api.switch-name",
    "issuer" : "issuer",
    "common-name" : "common-name",
    "cert-type" : "ca",
    "organization" : "organization",
    "name" : "name",
    "state" : "state",
    "valid-from" : "valid-from"
  } ]
}

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

default

success cert-show-response

Up
get /certs
(showCertCommons)

Consumes

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

Return type

cert-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "container" : "container",
    "country" : "country",
    "valid-to" : "valid-to",
    "serial-number" : 0,
    "city" : "city",
    "subject" : "subject",
    "organizational-unit" : "organizational-unit",
    "api.switch-name" : "api.switch-name",
    "issuer" : "issuer",
    "common-name" : "common-name",
    "cert-type" : "ca",
    "organization" : "organization",
    "name" : "name",
    "state" : "state",
    "valid-from" : "valid-from"
  }, {
    "container" : "container",
    "country" : "country",
    "valid-to" : "valid-to",
    "serial-number" : 0,
    "city" : "city",
    "subject" : "subject",
    "organizational-unit" : "organizational-unit",
    "api.switch-name" : "api.switch-name",
    "issuer" : "issuer",
    "common-name" : "common-name",
    "cert-type" : "ca",
    "organization" : "organization",
    "name" : "name",
    "state" : "state",
    "valid-from" : "valid-from"
  } ]
}

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

default

success cert-show-response

Up
post /certs/upload
(uploadCertCommonByUsage1)

Consumes

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

Request body

body cert-upload-1 (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

ClientServerStats

Up
post /client-server-stats/clear
(clearCliservStats)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /client-server-stats/clear-history
(clearHistoryCliservStats)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /client-server-stats
(showCliservStats)

Consumes

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

Query parameters

limit-output (optional)
Query Parameter — default: 20 format: int32
sort-asc (optional)
Query Parameter
sort-desc (optional)
Query Parameter
sum-by (optional)
Query Parameter

Return type

client-server-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "syn-resends" : 7,
    "bd" : "bd",
    "syn-ack-resends" : 1,
    "within-last" : 9,
    "est" : 2,
    "syn" : 3,
    "fin" : 4,
    "server-ip" : "server-ip",
    "api.switch-name" : "api.switch-name",
    "server-port" : 5,
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 5,
    "first-seen" : "first-seen",
    "server-switch-port" : 9,
    "vlan" : 0,
    "last-seen-ago" : 1,
    "obytes" : 1,
    "server-mac" : "server-mac",
    "avg-dur" : 7,
    "vxlan" : 6,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ibytes" : 1,
    "count" : 4,
    "client-ip" : "client-ip",
    "client-mac" : "client-mac",
    "last-seen" : "last-seen",
    "client-switch-port" : 5,
    "total-bytes" : 6,
    "interval" : 2,
    "time" : "time",
    "avg-lat" : 1
  }, {
    "older-than" : 7,
    "syn-resends" : 7,
    "bd" : "bd",
    "syn-ack-resends" : 1,
    "within-last" : 9,
    "est" : 2,
    "syn" : 3,
    "fin" : 4,
    "server-ip" : "server-ip",
    "api.switch-name" : "api.switch-name",
    "server-port" : 5,
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 5,
    "first-seen" : "first-seen",
    "server-switch-port" : 9,
    "vlan" : 0,
    "last-seen-ago" : 1,
    "obytes" : 1,
    "server-mac" : "server-mac",
    "avg-dur" : 7,
    "vxlan" : 6,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ibytes" : 1,
    "count" : 4,
    "client-ip" : "client-ip",
    "client-mac" : "client-mac",
    "last-seen" : "last-seen",
    "client-switch-port" : 5,
    "total-bytes" : 6,
    "interval" : 2,
    "time" : "time",
    "avg-lat" : 1
  } ]
}

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

default

success client-server-stats-show-response

ClusterBringdown

Up
get /cluster-bringdown
(showClusterBringdown)

Consumes

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

Return type

cluster-bringdown-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlag-port-staggered-interval" : 0,
    "api.switch-name" : "api.switch-name"
  }, {
    "vlag-port-staggered-interval" : 0,
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success cluster-bringdown-show-response

Up
put /cluster-bringdown
(updateClusterBringdown)

Consumes

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

Request body

body cluster-bringdown-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

ClusterBringup

Up
get /cluster-bringup
(showClusterBringup)

Consumes

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

Return type

cluster-bringup-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "l3-port-bringup-mode" : "staggered",
    "l3-to-vlag-delay" : 5,
    "vrouter-if-bringup-mode" : "staggered",
    "vlag-port-bringup-mode" : "staggered",
    "maximum-sync-delay" : 5,
    "port-defer-bringup-mode" : "staggered",
    "port-defer-bringup-staggered-interval" : 9,
    "vrouter-if-staggered-interval" : 3,
    "minimum-sync-delay" : 0,
    "api.switch-name" : "api.switch-name",
    "l3-to-vlan-interface-delay" : 2,
    "port-defer-bringup-delay" : 7,
    "vlag-port-staggered-interval" : 1,
    "state" : "ports-disabled",
    "l3-port-staggered-interval" : 6
  }, {
    "l3-port-bringup-mode" : "staggered",
    "l3-to-vlag-delay" : 5,
    "vrouter-if-bringup-mode" : "staggered",
    "vlag-port-bringup-mode" : "staggered",
    "maximum-sync-delay" : 5,
    "port-defer-bringup-mode" : "staggered",
    "port-defer-bringup-staggered-interval" : 9,
    "vrouter-if-staggered-interval" : 3,
    "minimum-sync-delay" : 0,
    "api.switch-name" : "api.switch-name",
    "l3-to-vlan-interface-delay" : 2,
    "port-defer-bringup-delay" : 7,
    "vlag-port-staggered-interval" : 1,
    "state" : "ports-disabled",
    "l3-port-staggered-interval" : 6
  } ]
}

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

default

success cluster-bringup-show-response

Up
put /cluster-bringup
(updateClusterBringup)

Consumes

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

Request body

body cluster-bringup-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

ClusterMemberships

Up
get /cluster-memberships/{name}
(showClusterMembershipByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

cluster-membership-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "remote-ports" : "remote-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "forwarding-delay" : 3,
    "mst-max-hops" : 4,
    "ports" : "ports",
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "switch" : 6,
    "mode" : "none",
    "enable" : true,
    "mst-config-name" : "mst-config-name",
    "bridge-priority" : 7,
    "state" : "offline",
    "id" : "id",
    "validate" : true,
    "cluster-node-2" : 5,
    "cluster-sync-offline-count" : 2,
    "cluster-node-1" : 5,
    "bpdus-bridge-ports" : true,
    "max-age" : 2,
    "root-guard-wait-time" : 7,
    "cluster-sync-timeout" : 1,
    "name" : "name",
    "hello-time" : 9,
    "bridge-id" : "bridge-id"
  }, {
    "remote-ports" : "remote-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "forwarding-delay" : 3,
    "mst-max-hops" : 4,
    "ports" : "ports",
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "switch" : 6,
    "mode" : "none",
    "enable" : true,
    "mst-config-name" : "mst-config-name",
    "bridge-priority" : 7,
    "state" : "offline",
    "id" : "id",
    "validate" : true,
    "cluster-node-2" : 5,
    "cluster-sync-offline-count" : 2,
    "cluster-node-1" : 5,
    "bpdus-bridge-ports" : true,
    "max-age" : 2,
    "root-guard-wait-time" : 7,
    "cluster-sync-timeout" : 1,
    "name" : "name",
    "hello-time" : 9,
    "bridge-id" : "bridge-id"
  } ]
}

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

default

success cluster-membership-show-response

Up
get /cluster-memberships
(showClusterMemberships)

Consumes

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

Return type

cluster-membership-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "remote-ports" : "remote-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "forwarding-delay" : 3,
    "mst-max-hops" : 4,
    "ports" : "ports",
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "switch" : 6,
    "mode" : "none",
    "enable" : true,
    "mst-config-name" : "mst-config-name",
    "bridge-priority" : 7,
    "state" : "offline",
    "id" : "id",
    "validate" : true,
    "cluster-node-2" : 5,
    "cluster-sync-offline-count" : 2,
    "cluster-node-1" : 5,
    "bpdus-bridge-ports" : true,
    "max-age" : 2,
    "root-guard-wait-time" : 7,
    "cluster-sync-timeout" : 1,
    "name" : "name",
    "hello-time" : 9,
    "bridge-id" : "bridge-id"
  }, {
    "remote-ports" : "remote-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "forwarding-delay" : 3,
    "mst-max-hops" : 4,
    "ports" : "ports",
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "switch" : 6,
    "mode" : "none",
    "enable" : true,
    "mst-config-name" : "mst-config-name",
    "bridge-priority" : 7,
    "state" : "offline",
    "id" : "id",
    "validate" : true,
    "cluster-node-2" : 5,
    "cluster-sync-offline-count" : 2,
    "cluster-node-1" : 5,
    "bpdus-bridge-ports" : true,
    "max-age" : 2,
    "root-guard-wait-time" : 7,
    "cluster-sync-timeout" : 1,
    "name" : "name",
    "hello-time" : 9,
    "bridge-id" : "bridge-id"
  } ]
}

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

default

success cluster-membership-show-response

Up
put /cluster-memberships/{name}
(updateClusterMembershipByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Clusters

Up
post /clusters
(createCluster)

Consumes

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

Request body

body cluster-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /clusters/{name}
(deleteClusterByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /clusters/info
(infoCluster)

Consumes

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

Return type

cluster-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "remote-ports" : "remote-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "forwarding-delay" : 3,
    "mst-max-hops" : 4,
    "ports" : "ports",
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "switch" : 6,
    "mode" : "none",
    "enable" : true,
    "mst-config-name" : "mst-config-name",
    "bridge-priority" : 7,
    "state" : "offline",
    "id" : "id",
    "validate" : true,
    "cluster-node-2" : 5,
    "cluster-sync-offline-count" : 2,
    "cluster-node-1" : 5,
    "bpdus-bridge-ports" : true,
    "max-age" : 2,
    "root-guard-wait-time" : 7,
    "cluster-sync-timeout" : 1,
    "name" : "name",
    "hello-time" : 9,
    "bridge-id" : "bridge-id"
  }, {
    "remote-ports" : "remote-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "forwarding-delay" : 3,
    "mst-max-hops" : 4,
    "ports" : "ports",
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "switch" : 6,
    "mode" : "none",
    "enable" : true,
    "mst-config-name" : "mst-config-name",
    "bridge-priority" : 7,
    "state" : "offline",
    "id" : "id",
    "validate" : true,
    "cluster-node-2" : 5,
    "cluster-sync-offline-count" : 2,
    "cluster-node-1" : 5,
    "bpdus-bridge-ports" : true,
    "max-age" : 2,
    "root-guard-wait-time" : 7,
    "cluster-sync-timeout" : 1,
    "name" : "name",
    "hello-time" : 9,
    "bridge-id" : "bridge-id"
  } ]
}

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

default

success cluster-show-response

Up
get /clusters/{name}
(showClusterByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

cluster-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "remote-ports" : "remote-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "forwarding-delay" : 3,
    "mst-max-hops" : 4,
    "ports" : "ports",
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "switch" : 6,
    "mode" : "none",
    "enable" : true,
    "mst-config-name" : "mst-config-name",
    "bridge-priority" : 7,
    "state" : "offline",
    "id" : "id",
    "validate" : true,
    "cluster-node-2" : 5,
    "cluster-sync-offline-count" : 2,
    "cluster-node-1" : 5,
    "bpdus-bridge-ports" : true,
    "max-age" : 2,
    "root-guard-wait-time" : 7,
    "cluster-sync-timeout" : 1,
    "name" : "name",
    "hello-time" : 9,
    "bridge-id" : "bridge-id"
  }, {
    "remote-ports" : "remote-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "forwarding-delay" : 3,
    "mst-max-hops" : 4,
    "ports" : "ports",
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "switch" : 6,
    "mode" : "none",
    "enable" : true,
    "mst-config-name" : "mst-config-name",
    "bridge-priority" : 7,
    "state" : "offline",
    "id" : "id",
    "validate" : true,
    "cluster-node-2" : 5,
    "cluster-sync-offline-count" : 2,
    "cluster-node-1" : 5,
    "bpdus-bridge-ports" : true,
    "max-age" : 2,
    "root-guard-wait-time" : 7,
    "cluster-sync-timeout" : 1,
    "name" : "name",
    "hello-time" : 9,
    "bridge-id" : "bridge-id"
  } ]
}

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

default

success cluster-show-response

Up
get /clusters
(showClusters)

Consumes

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

Return type

cluster-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "remote-ports" : "remote-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "forwarding-delay" : 3,
    "mst-max-hops" : 4,
    "ports" : "ports",
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "switch" : 6,
    "mode" : "none",
    "enable" : true,
    "mst-config-name" : "mst-config-name",
    "bridge-priority" : 7,
    "state" : "offline",
    "id" : "id",
    "validate" : true,
    "cluster-node-2" : 5,
    "cluster-sync-offline-count" : 2,
    "cluster-node-1" : 5,
    "bpdus-bridge-ports" : true,
    "max-age" : 2,
    "root-guard-wait-time" : 7,
    "cluster-sync-timeout" : 1,
    "name" : "name",
    "hello-time" : 9,
    "bridge-id" : "bridge-id"
  }, {
    "remote-ports" : "remote-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "forwarding-delay" : 3,
    "mst-max-hops" : 4,
    "ports" : "ports",
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "switch" : 6,
    "mode" : "none",
    "enable" : true,
    "mst-config-name" : "mst-config-name",
    "bridge-priority" : 7,
    "state" : "offline",
    "id" : "id",
    "validate" : true,
    "cluster-node-2" : 5,
    "cluster-sync-offline-count" : 2,
    "cluster-node-1" : 5,
    "bpdus-bridge-ports" : true,
    "max-age" : 2,
    "root-guard-wait-time" : 7,
    "cluster-sync-timeout" : 1,
    "name" : "name",
    "hello-time" : 9,
    "bridge-id" : "bridge-id"
  } ]
}

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

default

success cluster-show-response

Up
put /clusters/{name}
(updateClusterByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body cluster-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

ConnectionLatencies

Up
get /connection-latencies
(showLatencyBins)

Consumes

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

Return type

connection-latency-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "num-bins" : 1,
    "min" : 0,
    "total-bytes" : 3,
    "max" : 6,
    "ibytes" : 9,
    "num-conns" : 5,
    "obytes" : 7,
    "api.switch-name" : "api.switch-name",
    "percent" : 5,
    "avg-dur" : 2
  }, {
    "num-bins" : 1,
    "min" : 0,
    "total-bytes" : 3,
    "max" : 6,
    "ibytes" : 9,
    "num-conns" : 5,
    "obytes" : 7,
    "api.switch-name" : "api.switch-name",
    "percent" : 5,
    "avg-dur" : 2
  } ]
}

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

default

success connection-latency-show-response

ConnectionStats

Up
post /connection-stats/clear-history
(clearHistoryHostStat)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /connection-stats/clear
(clearHostStat)

Consumes

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

Request body

body connection-stats-clear (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /connection-stats
(showHostStats)

Consumes

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

Query parameters

limit-output (optional)
Query Parameter — default: 20 format: int32
sort-asc (optional)
Query Parameter
sort-desc (optional)
Query Parameter
sum-by (optional)
Query Parameter

Return type

connection-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 2,
    "bd" : "bd",
    "start-time" : "start-time",
    "within-last" : 4,
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 5,
    "count" : 1,
    "oconns" : 5,
    "iconns" : 1,
    "api.switch-name" : "api.switch-name",
    "last-seen" : "last-seen",
    "mac" : "mac",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 9,
    "first-seen" : "first-seen",
    "vlan" : 0,
    "total-bytes" : 7,
    "port" : 6,
    "last-seen-ago" : 7,
    "interval" : 3,
    "obytes" : 2,
    "time" : "time"
  }, {
    "older-than" : 2,
    "bd" : "bd",
    "start-time" : "start-time",
    "within-last" : 4,
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 5,
    "count" : 1,
    "oconns" : 5,
    "iconns" : 1,
    "api.switch-name" : "api.switch-name",
    "last-seen" : "last-seen",
    "mac" : "mac",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 9,
    "first-seen" : "first-seen",
    "vlan" : 0,
    "total-bytes" : 7,
    "port" : 6,
    "last-seen-ago" : 7,
    "interval" : 3,
    "obytes" : 2,
    "time" : "time"
  } ]
}

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

default

success connection-stats-show-response

ConnectionStatsSettings

Up
get /connection-stats-settings
(showConnStatSettings)

Consumes

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

Return type

connection-stats-settings-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "fabric-connection-backup-enable" : true,
    "client-server-stats-max-cnt" : 5,
    "connection-stats-cur-cnt" : 7,
    "connection-max-memory" : 1,
    "connection-stats-log-disk-space" : 5,
    "fabric-connection-max-count" : 2,
    "client-server-stats-log-interval" : 6,
    "api.switch-name" : "api.switch-name",
    "client-server-stats-log-disk-space" : 7,
    "connection-stats-max-cnt" : 2,
    "client-server-stats-log-enable" : true,
    "service-stat-max-memory" : 9,
    "fabric-connection-current-count" : 4,
    "fabric-connection-max-memory" : 9,
    "enable" : true,
    "fabric-connection-backup-used-disk-space" : 7,
    "connection-backup-interval" : 1,
    "fabric-connection-backup-interval" : 6,
    "client-server-stats-max-memory" : 1,
    "service-stat-max-cnt" : 9,
    "redirect-analytics-interface" : "none",
    "connection-stats-log-enable" : true,
    "service-stat-cur-cnt" : 3,
    "client-server-stats-cur-cnt" : 5,
    "connection-current-count" : 6,
    "connection-backup-used-disk-space" : 1,
    "connection-backup-enable" : true,
    "connection-max-count" : 0,
    "connection-stats-max-memory" : 1,
    "connection-stats-log-interval" : 4
  }, {
    "fabric-connection-backup-enable" : true,
    "client-server-stats-max-cnt" : 5,
    "connection-stats-cur-cnt" : 7,
    "connection-max-memory" : 1,
    "connection-stats-log-disk-space" : 5,
    "fabric-connection-max-count" : 2,
    "client-server-stats-log-interval" : 6,
    "api.switch-name" : "api.switch-name",
    "client-server-stats-log-disk-space" : 7,
    "connection-stats-max-cnt" : 2,
    "client-server-stats-log-enable" : true,
    "service-stat-max-memory" : 9,
    "fabric-connection-current-count" : 4,
    "fabric-connection-max-memory" : 9,
    "enable" : true,
    "fabric-connection-backup-used-disk-space" : 7,
    "connection-backup-interval" : 1,
    "fabric-connection-backup-interval" : 6,
    "client-server-stats-max-memory" : 1,
    "service-stat-max-cnt" : 9,
    "redirect-analytics-interface" : "none",
    "connection-stats-log-enable" : true,
    "service-stat-cur-cnt" : 3,
    "client-server-stats-cur-cnt" : 5,
    "connection-current-count" : 6,
    "connection-backup-used-disk-space" : 1,
    "connection-backup-enable" : true,
    "connection-max-count" : 0,
    "connection-stats-max-memory" : 1,
    "connection-stats-log-interval" : 4
  } ]
}

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

default

success connection-stats-settings-show-response

Up
put /connection-stats-settings
(updateConnStatSettings)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Connections

Up
post /connections/clear
(clearConnStat)

Consumes

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

Request body

body connection-clear (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /connections/clear-history
(clearHistoryConnStat)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /connections
(showConnStats)

Consumes

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

Query parameters

limit-output (optional)
Query Parameter — default: 20 format: int32
sort-asc (optional)
Query Parameter
sort-desc (optional)
Query Parameter
sum-by (optional)
Query Parameter

Return type

connection-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dur" : 5,
    "older-than" : 4,
    "tunnel-vnet" : "tunnel-vnet",
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "ended-time" : "ended-time",
    "within-last" : 7,
    "tunnel-vlan" : 1,
    "src-port" : 7,
    "tunnel-bd" : "tunnel-bd",
    "dst-port" : 9,
    "since-start" : true,
    "dscp" : 1,
    "started-time-ns" : 6,
    "egress-bd" : "egress-bd",
    "src-mac" : "src-mac",
    "vxlan" : 6,
    "start-time" : "start-time",
    "ether-type" : "0x800",
    "count" : 1,
    "proto" : 5,
    "interval" : 2,
    "tunnel-dst-ip" : "tunnel-dst-ip",
    "tunnel-src-ip" : "tunnel-src-ip",
    "syn-resends" : 9,
    "bd" : "bd",
    "syn-ack-resends" : 6,
    "latency" : 8,
    "egress-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "egress-vnet" : "egress-vnet",
    "update-id" : 3,
    "vnet" : "vnet",
    "duration" : 3,
    "vlan" : 0,
    "obytes" : 7,
    "tunnel-proto" : 9,
    "dst-mac" : "dst-mac",
    "tunnel-dst-port" : 5,
    "transition-state" : "any",
    "end-time" : "end-time",
    "tunnel-src-mac" : "tunnel-src-mac",
    "ibytes" : 9,
    "dst-switch-port" : 6,
    "tunnel-dst-mac" : "tunnel-dst-mac",
    "src-switch-port" : 1,
    "total-bytes" : 6,
    "started-time" : "started-time",
    "time" : "time",
    "tunnel-src-port" : 4,
    "age" : 2,
    "cur-state" : "syn"
  }, {
    "dur" : 5,
    "older-than" : 4,
    "tunnel-vnet" : "tunnel-vnet",
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "ended-time" : "ended-time",
    "within-last" : 7,
    "tunnel-vlan" : 1,
    "src-port" : 7,
    "tunnel-bd" : "tunnel-bd",
    "dst-port" : 9,
    "since-start" : true,
    "dscp" : 1,
    "started-time-ns" : 6,
    "egress-bd" : "egress-bd",
    "src-mac" : "src-mac",
    "vxlan" : 6,
    "start-time" : "start-time",
    "ether-type" : "0x800",
    "count" : 1,
    "proto" : 5,
    "interval" : 2,
    "tunnel-dst-ip" : "tunnel-dst-ip",
    "tunnel-src-ip" : "tunnel-src-ip",
    "syn-resends" : 9,
    "bd" : "bd",
    "syn-ack-resends" : 6,
    "latency" : 8,
    "egress-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "egress-vnet" : "egress-vnet",
    "update-id" : 3,
    "vnet" : "vnet",
    "duration" : 3,
    "vlan" : 0,
    "obytes" : 7,
    "tunnel-proto" : 9,
    "dst-mac" : "dst-mac",
    "tunnel-dst-port" : 5,
    "transition-state" : "any",
    "end-time" : "end-time",
    "tunnel-src-mac" : "tunnel-src-mac",
    "ibytes" : 9,
    "dst-switch-port" : 6,
    "tunnel-dst-mac" : "tunnel-dst-mac",
    "src-switch-port" : 1,
    "total-bytes" : 6,
    "started-time" : "started-time",
    "time" : "time",
    "tunnel-src-port" : 4,
    "age" : 2,
    "cur-state" : "syn"
  } ]
}

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

default

success connection-show-response

ControlStats

Up
get /control-stats
(showCpuPktStats)

Consumes

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

Return type

control-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "idrops-stp" : 2,
    "older-than" : 3,
    "odrops-stp" : 5,
    "within-last" : 6,
    "odrops-vlan" : 9,
    "api.switch-name" : "api.switch-name",
    "idrop-bytes" : 9,
    "idrops-err" : 1,
    "since-start" : true,
    "duration" : 9,
    "odrops-switch-cfg" : 6,
    "idrops-vlan" : 3,
    "obytes" : 5,
    "odrops-pktsz" : 8,
    "ipkts" : 0,
    "idrops-packet-size" : 7,
    "idrops-vxlan" : 4,
    "odrops-port" : 9,
    "oqfull" : 7,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "odrops-requeue" : 1,
    "ibytes" : 6,
    "idrops-loop" : 1,
    "odrop-bytes" : 7,
    "idrops-from-mirror" : 1,
    "caller" : "Unknown",
    "odrops" : 2,
    "idrops" : 1,
    "opkts" : 5,
    "interval" : 6,
    "idrops-qfull" : 6,
    "time" : "time",
    "odrops-alloc" : 4
  }, {
    "idrops-stp" : 2,
    "older-than" : 3,
    "odrops-stp" : 5,
    "within-last" : 6,
    "odrops-vlan" : 9,
    "api.switch-name" : "api.switch-name",
    "idrop-bytes" : 9,
    "idrops-err" : 1,
    "since-start" : true,
    "duration" : 9,
    "odrops-switch-cfg" : 6,
    "idrops-vlan" : 3,
    "obytes" : 5,
    "odrops-pktsz" : 8,
    "ipkts" : 0,
    "idrops-packet-size" : 7,
    "idrops-vxlan" : 4,
    "odrops-port" : 9,
    "oqfull" : 7,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "odrops-requeue" : 1,
    "ibytes" : 6,
    "idrops-loop" : 1,
    "odrop-bytes" : 7,
    "idrops-from-mirror" : 1,
    "caller" : "Unknown",
    "odrops" : 2,
    "idrops" : 1,
    "opkts" : 5,
    "interval" : 6,
    "idrops-qfull" : 6,
    "time" : "time",
    "odrops-alloc" : 4
  } ]
}

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

default

success control-stats-show-response

Up
get /control-stats/{caller}
(showCpuPktStatsByCaller)

Path parameters

caller (required)
Path Parameter

Consumes

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

Return type

control-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "idrops-stp" : 2,
    "older-than" : 3,
    "odrops-stp" : 5,
    "within-last" : 6,
    "odrops-vlan" : 9,
    "api.switch-name" : "api.switch-name",
    "idrop-bytes" : 9,
    "idrops-err" : 1,
    "since-start" : true,
    "duration" : 9,
    "odrops-switch-cfg" : 6,
    "idrops-vlan" : 3,
    "obytes" : 5,
    "odrops-pktsz" : 8,
    "ipkts" : 0,
    "idrops-packet-size" : 7,
    "idrops-vxlan" : 4,
    "odrops-port" : 9,
    "oqfull" : 7,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "odrops-requeue" : 1,
    "ibytes" : 6,
    "idrops-loop" : 1,
    "odrop-bytes" : 7,
    "idrops-from-mirror" : 1,
    "caller" : "Unknown",
    "odrops" : 2,
    "idrops" : 1,
    "opkts" : 5,
    "interval" : 6,
    "idrops-qfull" : 6,
    "time" : "time",
    "odrops-alloc" : 4
  }, {
    "idrops-stp" : 2,
    "older-than" : 3,
    "odrops-stp" : 5,
    "within-last" : 6,
    "odrops-vlan" : 9,
    "api.switch-name" : "api.switch-name",
    "idrop-bytes" : 9,
    "idrops-err" : 1,
    "since-start" : true,
    "duration" : 9,
    "odrops-switch-cfg" : 6,
    "idrops-vlan" : 3,
    "obytes" : 5,
    "odrops-pktsz" : 8,
    "ipkts" : 0,
    "idrops-packet-size" : 7,
    "idrops-vxlan" : 4,
    "odrops-port" : 9,
    "oqfull" : 7,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "odrops-requeue" : 1,
    "ibytes" : 6,
    "idrops-loop" : 1,
    "odrop-bytes" : 7,
    "idrops-from-mirror" : 1,
    "caller" : "Unknown",
    "odrops" : 2,
    "idrops" : 1,
    "opkts" : 5,
    "interval" : 6,
    "idrops-qfull" : 6,
    "time" : "time",
    "odrops-alloc" : 4
  } ]
}

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

default

success control-stats-show-response

ControlStatsSettings

Up
get /control-stats-settings
(showCpuPktStatsSettings)

Consumes

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

Return type

control-stats-settings-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "disk-space" : 6,
    "enable" : true,
    "interval" : 0,
    "api.switch-name" : "api.switch-name"
  }, {
    "disk-space" : 6,
    "enable" : true,
    "interval" : 0,
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success control-stats-settings-show-response

Up
put /control-stats-settings
(updateCpuPktStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

ControlTraffics

Up
get /control-traffics/{type}
(showControlTrafficByType)

Path parameters

type (required)
Path Parameter

Consumes

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

Return type

control-traffic-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "cpu_class" : "cpu_class",
    "type" : "smac-miss",
    "api.switch-name" : "api.switch-name",
    "class" : "class"
  }, {
    "cpu_class" : "cpu_class",
    "type" : "smac-miss",
    "api.switch-name" : "api.switch-name",
    "class" : "class"
  } ]
}

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

default

success control-traffic-show-response

Up
get /control-traffics
(showControlTraffics)

Consumes

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

Return type

control-traffic-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "cpu_class" : "cpu_class",
    "type" : "smac-miss",
    "api.switch-name" : "api.switch-name",
    "class" : "class"
  }, {
    "cpu_class" : "cpu_class",
    "type" : "smac-miss",
    "api.switch-name" : "api.switch-name",
    "class" : "class"
  } ]
}

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

default

success control-traffic-show-response

Up
put /control-traffics/{type}
(updateControlTrafficByType)

Path parameters

type (required)
Path Parameter

Consumes

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

Request body

body control-traffic-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

DhcpFilters

Up
post /dhcp-filters
(createDhcpFilter)

Consumes

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

Request body

body dhcp-filter-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dhcp-filters/{name}
(deleteDhcpFilterByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /dhcp-filters/{name}
(showDhcpFilterByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

dhcp-filter-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "trusted-ports" : "trusted-ports",
    "vlan" : "vlan",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  }, {
    "trusted-ports" : "trusted-ports",
    "vlan" : "vlan",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success dhcp-filter-show-response

Up
get /dhcp-filters
(showDhcpFilters)

Consumes

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

Return type

dhcp-filter-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "trusted-ports" : "trusted-ports",
    "vlan" : "vlan",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  }, {
    "trusted-ports" : "trusted-ports",
    "vlan" : "vlan",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success dhcp-filter-show-response

Up
put /dhcp-filters/{name}
(updateDhcpFilterByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body dhcp-filter-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

DhcpLeases

Up
get /dhcp-leases
(showDhcpLeases)

Consumes

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

Return type

dhcp-lease-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "start-time" : "start-time",
    "trusted-server" : true,
    "end-time" : "end-time",
    "ip" : "ip",
    "server-ip" : "server-ip",
    "api.switch-name" : "api.switch-name",
    "server-port" : 6,
    "mac" : "mac",
    "db-state" : "unknown",
    "last-msg-time" : "last-msg-time",
    "vlan" : 0,
    "port" : "port",
    "vnet-id" : "vnet-id",
    "dhcp-id" : "dhcp-id",
    "last-msg" : "-"
  }, {
    "bd" : "bd",
    "start-time" : "start-time",
    "trusted-server" : true,
    "end-time" : "end-time",
    "ip" : "ip",
    "server-ip" : "server-ip",
    "api.switch-name" : "api.switch-name",
    "server-port" : 6,
    "mac" : "mac",
    "db-state" : "unknown",
    "last-msg-time" : "last-msg-time",
    "vlan" : 0,
    "port" : "port",
    "vnet-id" : "vnet-id",
    "dhcp-id" : "dhcp-id",
    "last-msg" : "-"
  } ]
}

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

default

success dhcp-lease-show-response

Dhcps

Up
post /dhcps/{dhcp-name}/pools
(addDhcpDhcpPoolByDhcpVnmName)

Path parameters

dhcp-name (required)
Path Parameter

Consumes

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

Request body

body dhcp-pool-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /dhcps/{dhcp-name}/hosts
(addDhcpHostByDhcpVnmName)

Path parameters

dhcp-name (required)
Path Parameter

Consumes

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

Request body

body dhcp-host-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /dhcps/{dhcp-name}/interfaces
(addDhcpNicByDhcpVnmName)

Path parameters

dhcp-name (required)
Path Parameter

Consumes

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

Request body

body dhcp-interface-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /dhcps/{dhcp-name}/pxe-menus
(addDhcpPxeMenuByDhcpVnmName)

Path parameters

dhcp-name (required)
Path Parameter

Consumes

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

Request body

body dhcp-pxe-menu-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /dhcps
(createDhcp)

Consumes

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

Request body

body dhcp-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dhcps/{name}
(deleteDhcpByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /dhcps/migrate
(migrateDhcp)

Consumes

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

Request body

body dhcp-migrate (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dhcps/{dhcp-name}/pools/{dhcp-pool-name}
(removeDhcpDhcpPoolByVnmNameByName)

Path parameters

dhcp-name (required)
Path Parameter
dhcp-pool-name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dhcps/{dhcp-name}/hosts/{hostname}
(removeDhcpHostByVnmNameByHostname)

Path parameters

dhcp-name (required)
Path Parameter
hostname (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dhcps/{dhcp-name}/interfaces/l3-port/{l3-port}
(removeDhcpNicByVnmNameByL3port)

Path parameters

dhcp-name (required)
Path Parameter
l3-port (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dhcps/{dhcp-name}/interfaces/nic/{nic}
(removeDhcpNicByVnmNameByVnic)

Path parameters

dhcp-name (required)
Path Parameter
nic (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dhcps/{dhcp-name}/pxe-menus/{name}
(removeDhcpPxeMenuByVnmNameByName)

Path parameters

dhcp-name (required)
Path Parameter
name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /dhcps/{name}
(showDhcpByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

dhcp-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "template" : true,
    "pxe-menu-timeout" : 5,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "vnet" : "vnet",
    "pxe-boot" : "disabled",
    "max-leasetime" : 6,
    "storage-pool" : "storage-pool",
    "kickstarts-share" : "kickstarts-share",
    "auto_if" : "auto_if",
    "scope" : "local",
    "state" : "disable",
    "id" : "id",
    "initial-ip-pool" : "initial-ip-pool",
    "failover-action" : "stop-old",
    "failover-controller" : 5,
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "default-leasetime" : 1,
    "pxe-default-menu" : "pxe-default-menu",
    "name" : "name",
    "location" : 0,
    "is-global" : true,
    "gateway" : "gateway",
    "status" : "unknown"
  }, {
    "template" : true,
    "pxe-menu-timeout" : 5,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "vnet" : "vnet",
    "pxe-boot" : "disabled",
    "max-leasetime" : 6,
    "storage-pool" : "storage-pool",
    "kickstarts-share" : "kickstarts-share",
    "auto_if" : "auto_if",
    "scope" : "local",
    "state" : "disable",
    "id" : "id",
    "initial-ip-pool" : "initial-ip-pool",
    "failover-action" : "stop-old",
    "failover-controller" : 5,
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "default-leasetime" : 1,
    "pxe-default-menu" : "pxe-default-menu",
    "name" : "name",
    "location" : 0,
    "is-global" : true,
    "gateway" : "gateway",
    "status" : "unknown"
  } ]
}

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

default

success dhcp-show-response

Up
get /dhcps/{dhcp-name}/pools/{dhcp-pool-name}
(showDhcpDhcpPoolByVnmNameByName)

Path parameters

dhcp-name (required)
Path Parameter
dhcp-pool-name (required)
Path Parameter

Consumes

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

Return type

dhcp-pool-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dhcp-pool-name" : "dhcp-pool-name",
    "gateway-ip" : "gateway-ip",
    "kickstarts-url" : "kickstarts-url",
    "start-ip" : "start-ip",
    "dns-ip" : "dns-ip",
    "end-ip" : "end-ip",
    "api.switch-name" : "api.switch-name",
    "ddns-domain" : "ddns-domain",
    "ddns-domain-rev" : "ddns-domain-rev",
    "ntp-server-ip" : "ntp-server-ip",
    "dhcp-ip-pool" : "dhcp-ip-pool",
    "auto_if" : "auto_if",
    "dns2-ip" : "dns2-ip"
  }, {
    "dhcp-pool-name" : "dhcp-pool-name",
    "gateway-ip" : "gateway-ip",
    "kickstarts-url" : "kickstarts-url",
    "start-ip" : "start-ip",
    "dns-ip" : "dns-ip",
    "end-ip" : "end-ip",
    "api.switch-name" : "api.switch-name",
    "ddns-domain" : "ddns-domain",
    "ddns-domain-rev" : "ddns-domain-rev",
    "ntp-server-ip" : "ntp-server-ip",
    "dhcp-ip-pool" : "dhcp-ip-pool",
    "auto_if" : "auto_if",
    "dns2-ip" : "dns2-ip"
  } ]
}

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

default

success dhcp-pool-show-response

Up
get /dhcps/{dhcp-name}/pools
(showDhcpDhcpPoolsByDhcpVnmName)

Path parameters

dhcp-name (required)
Path Parameter

Consumes

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

Return type

dhcp-pool-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dhcp-pool-name" : "dhcp-pool-name",
    "gateway-ip" : "gateway-ip",
    "kickstarts-url" : "kickstarts-url",
    "start-ip" : "start-ip",
    "dns-ip" : "dns-ip",
    "end-ip" : "end-ip",
    "api.switch-name" : "api.switch-name",
    "ddns-domain" : "ddns-domain",
    "ddns-domain-rev" : "ddns-domain-rev",
    "ntp-server-ip" : "ntp-server-ip",
    "dhcp-ip-pool" : "dhcp-ip-pool",
    "auto_if" : "auto_if",
    "dns2-ip" : "dns2-ip"
  }, {
    "dhcp-pool-name" : "dhcp-pool-name",
    "gateway-ip" : "gateway-ip",
    "kickstarts-url" : "kickstarts-url",
    "start-ip" : "start-ip",
    "dns-ip" : "dns-ip",
    "end-ip" : "end-ip",
    "api.switch-name" : "api.switch-name",
    "ddns-domain" : "ddns-domain",
    "ddns-domain-rev" : "ddns-domain-rev",
    "ntp-server-ip" : "ntp-server-ip",
    "dhcp-ip-pool" : "dhcp-ip-pool",
    "auto_if" : "auto_if",
    "dns2-ip" : "dns2-ip"
  } ]
}

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

default

success dhcp-pool-show-response

Up
get /dhcps/{dhcp-name}/hosts/{hostname}
(showDhcpHostByVnmNameByHostname)

Path parameters

dhcp-name (required)
Path Parameter
hostname (required)
Path Parameter

Consumes

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

Return type

dhcp-host-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "hostname" : "hostname",
    "pxe-boot" : true,
    "gateway-ip" : "gateway-ip",
    "fixed-ip" : "fixed-ip",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  }, {
    "hostname" : "hostname",
    "pxe-boot" : true,
    "gateway-ip" : "gateway-ip",
    "fixed-ip" : "fixed-ip",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  } ]
}

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

default

success dhcp-host-show-response

Up
get /dhcps/{dhcp-name}/hosts
(showDhcpHostsByDhcpVnmName)

Path parameters

dhcp-name (required)
Path Parameter

Consumes

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

Return type

dhcp-host-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "hostname" : "hostname",
    "pxe-boot" : true,
    "gateway-ip" : "gateway-ip",
    "fixed-ip" : "fixed-ip",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  }, {
    "hostname" : "hostname",
    "pxe-boot" : true,
    "gateway-ip" : "gateway-ip",
    "fixed-ip" : "fixed-ip",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  } ]
}

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

default

success dhcp-host-show-response

Up
get /dhcps/{dhcp-name}/interfaces/{nic}
(showDhcpNicByVnmNameByVnic)

Path parameters

dhcp-name (required)
Path Parameter
nic (required)
Path Parameter

Consumes

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

Return type

dhcp-interface-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  }, {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  } ]
}

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

default

success dhcp-interface-show-response

Up
get /dhcps/{dhcp-name}/interfaces
(showDhcpNicsByDhcpVnmName)

Path parameters

dhcp-name (required)
Path Parameter

Consumes

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

Return type

dhcp-interface-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  }, {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  } ]
}

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

default

success dhcp-interface-show-response

Up
get /dhcps/{dhcp-name}/pxe-menus/{name}
(showDhcpPxeMenuByVnmNameByName)

Path parameters

dhcp-name (required)
Path Parameter
name (required)
Path Parameter

Consumes

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

Return type

dhcp-pxe-menu-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dhcp-interface" : "dhcp-interface",
    "iso-library" : "iso-library",
    "name" : "name",
    "iso-url" : "iso-url",
    "iso-label" : "iso-label",
    "api.switch-name" : "api.switch-name",
    "append" : "append",
    "menu-label" : "menu-label",
    "kernel-iso-path" : "kernel-iso-path",
    "initrd-iso-path" : "initrd-iso-path"
  }, {
    "dhcp-interface" : "dhcp-interface",
    "iso-library" : "iso-library",
    "name" : "name",
    "iso-url" : "iso-url",
    "iso-label" : "iso-label",
    "api.switch-name" : "api.switch-name",
    "append" : "append",
    "menu-label" : "menu-label",
    "kernel-iso-path" : "kernel-iso-path",
    "initrd-iso-path" : "initrd-iso-path"
  } ]
}

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

default

success dhcp-pxe-menu-show-response

Up
get /dhcps/{dhcp-name}/pxe-menus
(showDhcpPxeMenusByDhcpVnmName)

Path parameters

dhcp-name (required)
Path Parameter

Consumes

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

Return type

dhcp-pxe-menu-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dhcp-interface" : "dhcp-interface",
    "iso-library" : "iso-library",
    "name" : "name",
    "iso-url" : "iso-url",
    "iso-label" : "iso-label",
    "api.switch-name" : "api.switch-name",
    "append" : "append",
    "menu-label" : "menu-label",
    "kernel-iso-path" : "kernel-iso-path",
    "initrd-iso-path" : "initrd-iso-path"
  }, {
    "dhcp-interface" : "dhcp-interface",
    "iso-library" : "iso-library",
    "name" : "name",
    "iso-url" : "iso-url",
    "iso-label" : "iso-label",
    "api.switch-name" : "api.switch-name",
    "append" : "append",
    "menu-label" : "menu-label",
    "kernel-iso-path" : "kernel-iso-path",
    "initrd-iso-path" : "initrd-iso-path"
  } ]
}

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

default

success dhcp-pxe-menu-show-response

Up
get /dhcps
(showDhcps)

Consumes

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

Return type

dhcp-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "template" : true,
    "pxe-menu-timeout" : 5,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "vnet" : "vnet",
    "pxe-boot" : "disabled",
    "max-leasetime" : 6,
    "storage-pool" : "storage-pool",
    "kickstarts-share" : "kickstarts-share",
    "auto_if" : "auto_if",
    "scope" : "local",
    "state" : "disable",
    "id" : "id",
    "initial-ip-pool" : "initial-ip-pool",
    "failover-action" : "stop-old",
    "failover-controller" : 5,
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "default-leasetime" : 1,
    "pxe-default-menu" : "pxe-default-menu",
    "name" : "name",
    "location" : 0,
    "is-global" : true,
    "gateway" : "gateway",
    "status" : "unknown"
  }, {
    "template" : true,
    "pxe-menu-timeout" : 5,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "vnet" : "vnet",
    "pxe-boot" : "disabled",
    "max-leasetime" : 6,
    "storage-pool" : "storage-pool",
    "kickstarts-share" : "kickstarts-share",
    "auto_if" : "auto_if",
    "scope" : "local",
    "state" : "disable",
    "id" : "id",
    "initial-ip-pool" : "initial-ip-pool",
    "failover-action" : "stop-old",
    "failover-controller" : 5,
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "default-leasetime" : 1,
    "pxe-default-menu" : "pxe-default-menu",
    "name" : "name",
    "location" : 0,
    "is-global" : true,
    "gateway" : "gateway",
    "status" : "unknown"
  } ]
}

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

default

success dhcp-show-response

Up
put /dhcps/{name}
(updateDhcpByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body dhcp-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
put /dhcps/{dhcp-name}/pools/{dhcp-pool-name}
(updateDhcpDhcpPoolByVnmNameByName)

Path parameters

dhcp-name (required)
Path Parameter
dhcp-pool-name (required)
Path Parameter

Consumes

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

Request body

body dhcp-pool-modify (optional)
Body Parameter

Return type

dhcp-pool-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dhcp-pool-name" : "dhcp-pool-name",
    "gateway-ip" : "gateway-ip",
    "kickstarts-url" : "kickstarts-url",
    "start-ip" : "start-ip",
    "dns-ip" : "dns-ip",
    "end-ip" : "end-ip",
    "api.switch-name" : "api.switch-name",
    "ddns-domain" : "ddns-domain",
    "ddns-domain-rev" : "ddns-domain-rev",
    "ntp-server-ip" : "ntp-server-ip",
    "dhcp-ip-pool" : "dhcp-ip-pool",
    "auto_if" : "auto_if",
    "dns2-ip" : "dns2-ip"
  }, {
    "dhcp-pool-name" : "dhcp-pool-name",
    "gateway-ip" : "gateway-ip",
    "kickstarts-url" : "kickstarts-url",
    "start-ip" : "start-ip",
    "dns-ip" : "dns-ip",
    "end-ip" : "end-ip",
    "api.switch-name" : "api.switch-name",
    "ddns-domain" : "ddns-domain",
    "ddns-domain-rev" : "ddns-domain-rev",
    "ntp-server-ip" : "ntp-server-ip",
    "dhcp-ip-pool" : "dhcp-ip-pool",
    "auto_if" : "auto_if",
    "dns2-ip" : "dns2-ip"
  } ]
}

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

default

success dhcp-pool-show-response

Up
put /dhcps/{dhcp-name}/interfaces/{nic}
(updateDhcpNicByVnmNameByVnic)

Path parameters

dhcp-name (required)
Path Parameter
nic (required)
Path Parameter

Consumes

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

Request body

body dhcp-interface-modify (optional)
Body Parameter

Return type

dhcp-interface-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  }, {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  } ]
}

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

default

success dhcp-interface-show-response

Up
put /dhcps/{dhcp-name}/pxe-menus/{name}
(updateDhcpPxeMenuByVnmNameByName)

Path parameters

dhcp-name (required)
Path Parameter
name (required)
Path Parameter

Consumes

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

Request body

body dhcp-pxe-menu-modify (optional)
Body Parameter

Return type

dhcp-pxe-menu-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dhcp-interface" : "dhcp-interface",
    "iso-library" : "iso-library",
    "name" : "name",
    "iso-url" : "iso-url",
    "iso-label" : "iso-label",
    "api.switch-name" : "api.switch-name",
    "append" : "append",
    "menu-label" : "menu-label",
    "kernel-iso-path" : "kernel-iso-path",
    "initrd-iso-path" : "initrd-iso-path"
  }, {
    "dhcp-interface" : "dhcp-interface",
    "iso-library" : "iso-library",
    "name" : "name",
    "iso-url" : "iso-url",
    "iso-label" : "iso-label",
    "api.switch-name" : "api.switch-name",
    "append" : "append",
    "menu-label" : "menu-label",
    "kernel-iso-path" : "kernel-iso-path",
    "initrd-iso-path" : "initrd-iso-path"
  } ]
}

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

default

success dhcp-pxe-menu-show-response

DiskLibraries

Up
post /disk-libraries/{disk-library-name}/images
(addDiskLibraryImageByDiskLibraryName)

Path parameters

disk-library-name (required)
Path Parameter

Consumes

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

Request body

body disk-library-image-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /disk-libraries/{disk-library-name}/images/clone
(cloneDiskLibraryImageByDiskLibraryName)

Path parameters

disk-library-name (required)
Path Parameter

Consumes

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

Request body

body disk-library-image-clone (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /disk-libraries/{disk-library-name}/images/export
(exportDiskLibraryImageByDiskLibraryName)

Path parameters

disk-library-name (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /disk-libraries/{disk-library-name}/images/import
(importDiskLibraryImageByDiskLibraryName)

Path parameters

disk-library-name (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /disk-libraries/{disk-library-name}/images/{label}
(removeDiskLibraryImageByNameByLabel)

Path parameters

disk-library-name (required)
Path Parameter
label (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /disk-libraries
(showDiskLibraries)

Consumes

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

Return type

disk-library-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "storage-pool" : "storage-pool",
    "import-share" : "import-share",
    "name" : "name",
    "export-share-path" : "export-share-path",
    "export-share" : "export-share",
    "switch-name" : 0,
    "sharing" : "none",
    "api.switch-name" : "api.switch-name",
    "import-share-path" : "import-share-path",
    "data-set" : "data-set"
  }, {
    "storage-pool" : "storage-pool",
    "import-share" : "import-share",
    "name" : "name",
    "export-share-path" : "export-share-path",
    "export-share" : "export-share",
    "switch-name" : 0,
    "sharing" : "none",
    "api.switch-name" : "api.switch-name",
    "import-share-path" : "import-share-path",
    "data-set" : "data-set"
  } ]
}

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

default

success disk-library-show-response

Up
get /disk-libraries/{name}
(showDiskLibraryByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

disk-library-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "storage-pool" : "storage-pool",
    "import-share" : "import-share",
    "name" : "name",
    "export-share-path" : "export-share-path",
    "export-share" : "export-share",
    "switch-name" : 0,
    "sharing" : "none",
    "api.switch-name" : "api.switch-name",
    "import-share-path" : "import-share-path",
    "data-set" : "data-set"
  }, {
    "storage-pool" : "storage-pool",
    "import-share" : "import-share",
    "name" : "name",
    "export-share-path" : "export-share-path",
    "export-share" : "export-share",
    "switch-name" : 0,
    "sharing" : "none",
    "api.switch-name" : "api.switch-name",
    "import-share-path" : "import-share-path",
    "data-set" : "data-set"
  } ]
}

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

default

success disk-library-show-response

Up
get /disk-libraries/{disk-library-name}/images/{label}
(showDiskLibraryImageByNameByLabel)

Path parameters

disk-library-name (required)
Path Parameter
label (required)
Path Parameter

Consumes

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

Return type

disk-library-image-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "library" : "library",
    "file" : "file",
    "size" : 0,
    "destination-switch" : 6,
    "label" : "label",
    "parent_label" : "parent_label",
    "api.switch-name" : "api.switch-name"
  }, {
    "library" : "library",
    "file" : "file",
    "size" : 0,
    "destination-switch" : 6,
    "label" : "label",
    "parent_label" : "parent_label",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success disk-library-image-show-response

Up
get /disk-libraries/{disk-library-name}/images
(showDiskLibraryImagesByDiskLibraryName)

Path parameters

disk-library-name (required)
Path Parameter

Consumes

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

Return type

disk-library-image-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "library" : "library",
    "file" : "file",
    "size" : 0,
    "destination-switch" : 6,
    "label" : "label",
    "parent_label" : "parent_label",
    "api.switch-name" : "api.switch-name"
  }, {
    "library" : "library",
    "file" : "file",
    "size" : 0,
    "destination-switch" : 6,
    "label" : "label",
    "parent_label" : "parent_label",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success disk-library-image-show-response

Up
get /disk-libraries/{name}/imports
(showDiskLibraryImportsByDiskLibraryName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

disk-library-imports-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  }, {
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success disk-library-imports-show-response

Up
get /disk-libraries/{name}/imports/{name}
(showDiskLibraryImportsByNameByName)

Path parameters

name (required)
Path Parameter
name (required)
Path Parameter

Consumes

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

Return type

disk-library-imports-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  }, {
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success disk-library-imports-show-response

Up
put /disk-libraries/{name}
(updateDiskLibraryByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body disk-library-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Dns

Up
post /dns/{dns-name}/records
(addDnsDnsRecordByDnsVnmName)

Path parameters

dns-name (required)
Path Parameter

Consumes

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

Request body

body dns-record-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /dns/{dns-name}/domains
(addDnsDnsZoneByDnsVnmName)

Path parameters

dns-name (required)
Path Parameter

Consumes

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

Request body

body dns-domain-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /dns/{dns-name}/interfaces
(addDnsNicByDnsVnmName)

Path parameters

dns-name (required)
Path Parameter

Consumes

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

Request body

body dns-interface-add (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /dns
(createDns)

Consumes

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

Request body

body dns-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dns/{name}
(deleteDnsByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /dns/migrate
(migrateDns)

Consumes

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

Request body

body dns-migrate (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dns/{dns-name}/records/{host}
(removeDnsDnsRecordByVnmNameByHost)

Path parameters

dns-name (required)
Path Parameter
host (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dns/{dns-name}/domains/{domain}
(removeDnsDnsZoneByVnmNameByDomain)

Path parameters

dns-name (required)
Path Parameter
domain (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dns/{dns-name}/interfaces/l3-port/{l3-port}
(removeDnsNicByVnmNameByL3port)

Path parameters

dns-name (required)
Path Parameter
l3-port (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dns/{dns-name}/interfaces/nic/{nic}
(removeDnsNicByVnmNameByVnic)

Path parameters

dns-name (required)
Path Parameter
nic (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /dns
(showDns)

Consumes

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

Return type

dns-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "template" : true,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "vnet" : "vnet",
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "storage-pool" : "storage-pool",
    "scope" : "local",
    "name" : "name",
    "location" : 0,
    "state" : "disable",
    "id" : "id",
    "is-global" : true,
    "gateway" : "gateway"
  }, {
    "template" : true,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "vnet" : "vnet",
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "storage-pool" : "storage-pool",
    "scope" : "local",
    "name" : "name",
    "location" : 0,
    "state" : "disable",
    "id" : "id",
    "is-global" : true,
    "gateway" : "gateway"
  } ]
}

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

default

success dns-show-response

Up
get /dns/{name}
(showDnsByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

dns-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "template" : true,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "vnet" : "vnet",
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "storage-pool" : "storage-pool",
    "scope" : "local",
    "name" : "name",
    "location" : 0,
    "state" : "disable",
    "id" : "id",
    "is-global" : true,
    "gateway" : "gateway"
  }, {
    "template" : true,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "vnet" : "vnet",
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "storage-pool" : "storage-pool",
    "scope" : "local",
    "name" : "name",
    "location" : 0,
    "state" : "disable",
    "id" : "id",
    "is-global" : true,
    "gateway" : "gateway"
  } ]
}

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

default

success dns-show-response

Up
get /dns/{dns-name}/records/{host}
(showDnsDnsRecordByVnmNameByHost)

Path parameters

dns-name (required)
Path Parameter
host (required)
Path Parameter

Consumes

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

Return type

dns-record-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "domain" : "domain",
    "ip" : "ip",
    "host" : "host",
    "api.switch-name" : "api.switch-name"
  }, {
    "domain" : "domain",
    "ip" : "ip",
    "host" : "host",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success dns-record-show-response

Up
get /dns/{dns-name}/records
(showDnsDnsRecordsByDnsVnmName)

Path parameters

dns-name (required)
Path Parameter

Consumes

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

Return type

dns-record-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "domain" : "domain",
    "ip" : "ip",
    "host" : "host",
    "api.switch-name" : "api.switch-name"
  }, {
    "domain" : "domain",
    "ip" : "ip",
    "host" : "host",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success dns-record-show-response

Up
get /dns/{dns-name}/domains/{domain}
(showDnsDnsZoneByVnmNameByDomain)

Path parameters

dns-name (required)
Path Parameter
domain (required)
Path Parameter

Consumes

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

Return type

dns-domain-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "reverse-lookup-ip-pool" : "reverse-lookup-ip-pool",
    "reverse-lookup-network" : "reverse-lookup-network",
    "domain" : "domain",
    "forwarder" : "forwarder",
    "dns-id" : "dns-id",
    "forwarding" : "none",
    "type" : "master",
    "dns-ip" : "dns-ip",
    "api.switch-name" : "api.switch-name",
    "reverse-lookup-netmask" : 0
  }, {
    "reverse-lookup-ip-pool" : "reverse-lookup-ip-pool",
    "reverse-lookup-network" : "reverse-lookup-network",
    "domain" : "domain",
    "forwarder" : "forwarder",
    "dns-id" : "dns-id",
    "forwarding" : "none",
    "type" : "master",
    "dns-ip" : "dns-ip",
    "api.switch-name" : "api.switch-name",
    "reverse-lookup-netmask" : 0
  } ]
}

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

default

success dns-domain-show-response

Up
get /dns/{dns-name}/domains
(showDnsDnsZonesByDnsVnmName)

Path parameters

dns-name (required)
Path Parameter

Consumes

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

Return type

dns-domain-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "reverse-lookup-ip-pool" : "reverse-lookup-ip-pool",
    "reverse-lookup-network" : "reverse-lookup-network",
    "domain" : "domain",
    "forwarder" : "forwarder",
    "dns-id" : "dns-id",
    "forwarding" : "none",
    "type" : "master",
    "dns-ip" : "dns-ip",
    "api.switch-name" : "api.switch-name",
    "reverse-lookup-netmask" : 0
  }, {
    "reverse-lookup-ip-pool" : "reverse-lookup-ip-pool",
    "reverse-lookup-network" : "reverse-lookup-network",
    "domain" : "domain",
    "forwarder" : "forwarder",
    "dns-id" : "dns-id",
    "forwarding" : "none",
    "type" : "master",
    "dns-ip" : "dns-ip",
    "api.switch-name" : "api.switch-name",
    "reverse-lookup-netmask" : 0
  } ]
}

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

default

success dns-domain-show-response

Up
get /dns/{dns-name}/interfaces/{nic}
(showDnsNicByVnmNameByVnic)

Path parameters

dns-name (required)
Path Parameter
nic (required)
Path Parameter

Consumes

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

Return type

dns-interface-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  }, {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  } ]
}

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

default

success dns-interface-show-response

Up
get /dns/{dns-name}/interfaces
(showDnsNicsByDnsVnmName)

Path parameters

dns-name (required)
Path Parameter

Consumes

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

Return type

dns-interface-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  }, {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  } ]
}

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

default

success dns-interface-show-response

Up
put /dns/{name}
(updateDnsByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body dns-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
put /dns/{dns-name}/domains/{domain}
(updateDnsDnsZoneByVnmNameByDomain)

Path parameters

dns-name (required)
Path Parameter
domain (required)
Path Parameter

Consumes

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

Request body

body dns-domain-modify (optional)
Body Parameter

Return type

dns-domain-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "reverse-lookup-ip-pool" : "reverse-lookup-ip-pool",
    "reverse-lookup-network" : "reverse-lookup-network",
    "domain" : "domain",
    "forwarder" : "forwarder",
    "dns-id" : "dns-id",
    "forwarding" : "none",
    "type" : "master",
    "dns-ip" : "dns-ip",
    "api.switch-name" : "api.switch-name",
    "reverse-lookup-netmask" : 0
  }, {
    "reverse-lookup-ip-pool" : "reverse-lookup-ip-pool",
    "reverse-lookup-network" : "reverse-lookup-network",
    "domain" : "domain",
    "forwarder" : "forwarder",
    "dns-id" : "dns-id",
    "forwarding" : "none",
    "type" : "master",
    "dns-ip" : "dns-ip",
    "api.switch-name" : "api.switch-name",
    "reverse-lookup-netmask" : 0
  } ]
}

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

default

success dns-domain-show-response

Up
put /dns/{dns-name}/interfaces/{nic}
(updateDnsNicByVnmNameByVnic)

Path parameters

dns-name (required)
Path Parameter
nic (required)
Path Parameter

Consumes

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

Request body

body dns-interface-modify (optional)
Body Parameter

Return type

dns-interface-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  }, {
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "nic-state" : "down",
    "is-vip" : true,
    "is-primary" : true,
    "priority-tag" : true,
    "netmask2" : 6
  } ]
}

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

default

success dns-interface-show-response

DscpMaps

Up
post /dscp-maps
(createDscpMap)

Consumes

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

Request body

body dscp-map-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /dscp-maps/{name}
(deleteDscpMapByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /dscp-maps/{name}
(showDscpMapByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

dscp-map-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  }, {
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success dscp-map-show-response

Up
get /dscp-maps/{name}/pri-maps/{pri}
(showDscpMapPriorityMapByNameByPri)

Path parameters

name (required)
Path Parameter
pri (required)
Path Parameter

Consumes

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

Return type

dscp-map-pri-map-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "pri" : 0,
    "dsmap" : "dsmap",
    "api.switch-name" : "api.switch-name"
  }, {
    "pri" : 0,
    "dsmap" : "dsmap",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success dscp-map-pri-map-show-response

Up
get /dscp-maps/{name}/pri-maps
(showDscpMapPriorityMapsByDscpMapName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

dscp-map-pri-map-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "pri" : 0,
    "dsmap" : "dsmap",
    "api.switch-name" : "api.switch-name"
  }, {
    "pri" : 0,
    "dsmap" : "dsmap",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success dscp-map-pri-map-show-response

Up
get /dscp-maps
(showDscpMaps)

Consumes

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

Return type

dscp-map-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  }, {
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success dscp-map-show-response

Up
put /dscp-maps/{name}/pri-maps/{pri}
(updateDscpMapPriorityMapByNameByPri)

Path parameters

name (required)
Path Parameter
pri (required)
Path Parameter

Consumes

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

Request body

body dscp-map-pri-map-modify (optional)
Body Parameter

Return type

dscp-map-pri-map-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "pri" : 0,
    "dsmap" : "dsmap",
    "api.switch-name" : "api.switch-name"
  }, {
    "pri" : 0,
    "dsmap" : "dsmap",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success dscp-map-pri-map-show-response

ErrDisable

Up
post /err-disable/clear-counters
(clearCountersPortErrorRecovery)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /err-disable
(showPortErrorRecovery)

Consumes

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

Return type

err-disable-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "macsecurity" : true,
    "bpduguard" : true,
    "recovery-timer" : 0,
    "api.switch-name" : "api.switch-name"
  }, {
    "macsecurity" : true,
    "bpduguard" : true,
    "recovery-timer" : 0,
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success err-disable-show-response

Up
put /err-disable
(updatePortErrorRecovery)

Consumes

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

Request body

body err-disable-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Eula

Up
get /eula
(showEula)

Consumes

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

Return type

eula-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "accepted" : true,
    "api.switch-name" : "api.switch-name",
    "timestamp" : "timestamp"
  }, {
    "accepted" : true,
    "api.switch-name" : "api.switch-name",
    "timestamp" : "timestamp"
  } ]
}

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

default

success eula-show-response

FabricAnycastMac

Up
get /fabric-anycast-mac
(showFabricAnycastMac)

Consumes

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

Return type

fabric-anycast-mac-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  }, {
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  } ]
}

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

default

success fabric-anycast-mac-show-response

Up
put /fabric-anycast-mac
(updateFabricAnycastMac)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

FabricCommPorts

Up
get /fabric-comm-ports
(showFabcommPorts)

Consumes

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

Return type

fabric-comm-ports-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "l2-encap-port" : 5,
    "vport-statistics-port" : 5,
    "range-start" : 1,
    "api.switch-name" : "api.switch-name",
    "cluster-traffic-forwarding-port" : 1,
    "icmpv6-encap-port" : 7,
    "fabric-port" : 4,
    "igmp-port" : 2,
    "proxy-port" : 1,
    "cluster-analytics-port" : 3,
    "fabric-keepalive-port" : 0,
    "filesystem-replication-port" : 6,
    "notify-port" : 7,
    "igmp-encap-port" : 2,
    "arp-encap-port" : 9
  }, {
    "l2-encap-port" : 5,
    "vport-statistics-port" : 5,
    "range-start" : 1,
    "api.switch-name" : "api.switch-name",
    "cluster-traffic-forwarding-port" : 1,
    "icmpv6-encap-port" : 7,
    "fabric-port" : 4,
    "igmp-port" : 2,
    "proxy-port" : 1,
    "cluster-analytics-port" : 3,
    "fabric-keepalive-port" : 0,
    "filesystem-replication-port" : 6,
    "notify-port" : 7,
    "igmp-encap-port" : 2,
    "arp-encap-port" : 9
  } ]
}

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

default

success fabric-comm-ports-show-response

Up
put /fabric-comm-ports
(updateFabcommPorts)

Consumes

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

Request body

body fabric-comm-ports-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

FabricCommVrouterBgps

Up
post /fabric-comm-vrouter-bgps
(createFabcommVrouterBgp)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

FabricInBandNetworks

Up
post /fabric-in-band-networks
(createFabricInBandNetwork)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /fabric-in-band-networks/{network}
(deleteFabricInBandNetworkByNetwork)

Path parameters

network (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /fabric-in-band-networks/{network}
(showFabricInBandNetworkByNetwork)

Path parameters

network (required)
Path Parameter

Consumes

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

Return type

fabric-in-band-network-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  } ]
}

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

default

success fabric-in-band-network-show-response

Up
get /fabric-in-band-networks
(showFabricInBandNetworks)

Consumes

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

Return type

fabric-in-band-network-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  } ]
}

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

default

success fabric-in-band-network-show-response

FabricLocal

Up
put /fabric-local
(updateFabricInstLocal)

Consumes

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

Request body

body fabric-local-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

FabricNodes

Up
post /fabric-nodes/evict
(evictFabricSwitchInfoByUsage1)

Consumes

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

Request body

body fabric-node-evict-1 (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /fabric-nodes
(showFabricSwitchInfos)

Consumes

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

Return type

fabric-node-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vmgmt-ipv6-unnumbered" : true,
    "in-band-vlan" : 7,
    "in-band-if-nat-realm" : "internal",
    "mgmt-assignment-linklocal" : "none",
    "in-band-sec-addresses" : 3,
    "mgmt-linklocal" : "mgmt-linklocal",
    "vmgmt-assignment2" : "none",
    "device-state" : "device-state",
    "mgmt-ipv6-unnumbered" : true,
    "in-band-assignment-linklocal" : "none",
    "in-band-ip" : "in-band-ip",
    "mgmt-if-nat-realm" : "internal",
    "state" : "offline",
    "id" : 4,
    "mgmt-netmask" : 1,
    "cluster-id" : "cluster-id",
    "in-band-secondary-macs" : "in-band-secondary-macs",
    "mgmt-ip2" : "mgmt-ip2",
    "in-band-vnet-id" : "in-band-vnet-id",
    "vmgmt-public-vlan" : 5,
    "mgmt-vnet-id" : "mgmt-vnet-id",
    "vmgmt-vnet-id" : "vmgmt-vnet-id",
    "in-band-public-vlan" : 9,
    "version" : "version",
    "in-band-netmask" : 6,
    "in-band-linklocal" : "in-band-linklocal",
    "fab-id" : "fab-id",
    "in-band-bd" : "in-band-bd",
    "vmgmt-netmask" : 1,
    "vmgmt-ip" : "vmgmt-ip",
    "name" : "name",
    "mgmt-mac" : "mgmt-mac",
    "vmgmt-mac" : "vmgmt-mac",
    "in-band-mac" : "in-band-mac",
    "vmgmt-linklocal" : "vmgmt-linklocal",
    "in-band-vlan-type" : "public",
    "mgmt-assignment2" : "none",
    "mgmt-ip" : "mgmt-ip",
    "ports" : 9,
    "api.switch-name" : "api.switch-name",
    "fab-name" : "fab-name",
    "vmgmt-ip2" : "vmgmt-ip2",
    "keepalive-timeout" : 2,
    "location-id" : 7,
    "out-port" : 5,
    "vmgmt-secondary-macs" : "vmgmt-secondary-macs",
    "cluster-tid" : 4,
    "vmgmt-assignment-linklocal" : "none",
    "in-band-ip2" : "in-band-ip2",
    "control-network" : "in-band",
    "firmware-upgrade" : "firmware-upgrade",
    "fabric-network" : "in-band",
    "mgmt-public-vlan" : 6,
    "serial" : "serial",
    "local-mac" : "local-mac",
    "fab-tid" : 1,
    "in-band-assignment2" : "none",
    "vmgmt-vlan" : 1,
    "in-band-netmask2" : 7,
    "mgmt-sec-addresses" : 1,
    "vmgmt-netmask2" : 5,
    "mgmt-netmask2" : 0,
    "mgmt-secondary-macs" : "mgmt-secondary-macs",
    "vmgmt-sec-addresses" : 2
  }, {
    "vmgmt-ipv6-unnumbered" : true,
    "in-band-vlan" : 7,
    "in-band-if-nat-realm" : "internal",
    "mgmt-assignment-linklocal" : "none",
    "in-band-sec-addresses" : 3,
    "mgmt-linklocal" : "mgmt-linklocal",
    "vmgmt-assignment2" : "none",
    "device-state" : "device-state",
    "mgmt-ipv6-unnumbered" : true,
    "in-band-assignment-linklocal" : "none",
    "in-band-ip" : "in-band-ip",
    "mgmt-if-nat-realm" : "internal",
    "state" : "offline",
    "id" : 4,
    "mgmt-netmask" : 1,
    "cluster-id" : "cluster-id",
    "in-band-secondary-macs" : "in-band-secondary-macs",
    "mgmt-ip2" : "mgmt-ip2",
    "in-band-vnet-id" : "in-band-vnet-id",
    "vmgmt-public-vlan" : 5,
    "mgmt-vnet-id" : "mgmt-vnet-id",
    "vmgmt-vnet-id" : "vmgmt-vnet-id",
    "in-band-public-vlan" : 9,
    "version" : "version",
    "in-band-netmask" : 6,
    "in-band-linklocal" : "in-band-linklocal",
    "fab-id" : "fab-id",
    "in-band-bd" : "in-band-bd",
    "vmgmt-netmask" : 1,
    "vmgmt-ip" : "vmgmt-ip",
    "name" : "name",
    "mgmt-mac" : "mgmt-mac",
    "vmgmt-mac" : "vmgmt-mac",
    "in-band-mac" : "in-band-mac",
    "vmgmt-linklocal" : "vmgmt-linklocal",
    "in-band-vlan-type" : "public",
    "mgmt-assignment2" : "none",
    "mgmt-ip" : "mgmt-ip",
    "ports" : 9,
    "api.switch-name" : "api.switch-name",
    "fab-name" : "fab-name",
    "vmgmt-ip2" : "vmgmt-ip2",
    "keepalive-timeout" : 2,
    "location-id" : 7,
    "out-port" : 5,
    "vmgmt-secondary-macs" : "vmgmt-secondary-macs",
    "cluster-tid" : 4,
    "vmgmt-assignment-linklocal" : "none",
    "in-band-ip2" : "in-band-ip2",
    "control-network" : "in-band",
    "firmware-upgrade" : "firmware-upgrade",
    "fabric-network" : "in-band",
    "mgmt-public-vlan" : 6,
    "serial" : "serial",
    "local-mac" : "local-mac",
    "fab-tid" : 1,
    "in-band-assignment2" : "none",
    "vmgmt-vlan" : 1,
    "in-band-netmask2" : 7,
    "mgmt-sec-addresses" : 1,
    "vmgmt-netmask2" : 5,
    "mgmt-netmask2" : 0,
    "mgmt-secondary-macs" : "mgmt-secondary-macs",
    "vmgmt-sec-addresses" : 2
  } ]
}

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

default

success fabric-node-show-response

FabricStats

Up
get /fabric-stats/{id}
(showFabricStatByIdent)

Path parameters

id (required)
Path Parameter

Consumes

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

Return type

fabric-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 7,
    "udp-bytes" : 7,
    "tcp-bytes" : 4,
    "storage" : 5,
    "api.switch-name" : "api.switch-name",
    "servers" : 6,
    "vlan" : 2,
    "tcp-completed" : 2,
    "VM" : 5,
    "tcp-est" : 3,
    "id" : 0,
    "arp" : 1,
    "tcp-syn" : 9
  }, {
    "vxlan" : 7,
    "udp-bytes" : 7,
    "tcp-bytes" : 4,
    "storage" : 5,
    "api.switch-name" : "api.switch-name",
    "servers" : 6,
    "vlan" : 2,
    "tcp-completed" : 2,
    "VM" : 5,
    "tcp-est" : 3,
    "id" : 0,
    "arp" : 1,
    "tcp-syn" : 9
  } ]
}

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

default

success fabric-stats-show-response

Up
get /fabric-stats
(showFabricStats)

Consumes

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

Return type

fabric-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 7,
    "udp-bytes" : 7,
    "tcp-bytes" : 4,
    "storage" : 5,
    "api.switch-name" : "api.switch-name",
    "servers" : 6,
    "vlan" : 2,
    "tcp-completed" : 2,
    "VM" : 5,
    "tcp-est" : 3,
    "id" : 0,
    "arp" : 1,
    "tcp-syn" : 9
  }, {
    "vxlan" : 7,
    "udp-bytes" : 7,
    "tcp-bytes" : 4,
    "storage" : 5,
    "api.switch-name" : "api.switch-name",
    "servers" : 6,
    "vlan" : 2,
    "tcp-completed" : 2,
    "VM" : 5,
    "tcp-est" : 3,
    "id" : 0,
    "arp" : 1,
    "tcp-syn" : 9
  } ]
}

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

default

success fabric-stats-show-response

FabricUpgradeStatuses

Up
get /fabric-upgrade-statuses
(showFabricUpgradeStatuses)

Consumes

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

Return type

fabric-upgrade-status-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "cluster" : "cluster",
    "reboot-count" : 0,
    "upload-server" : "upload-server",
    "log" : "log",
    "use-proxy" : true,
    "reboot-group" : "reboot-group",
    "proxy-host" : "proxy-host",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "switch" : "switch",
    "proxy-port" : 6,
    "version-available" : "version-available",
    "state" : "state",
    "track" : "track"
  }, {
    "cluster" : "cluster",
    "reboot-count" : 0,
    "upload-server" : "upload-server",
    "log" : "log",
    "use-proxy" : true,
    "reboot-group" : "reboot-group",
    "proxy-host" : "proxy-host",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "switch" : "switch",
    "proxy-port" : 6,
    "version-available" : "version-available",
    "state" : "state",
    "track" : "track"
  } ]
}

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

default

success fabric-upgrade-status-show-response

FabricUpgrades

Up
post /fabric-upgrades/abort
(abortFabricUpgrade)

Consumes

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

Request body

body fabric-upgrade-abort (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /fabric-upgrades/prepare-cancel
(cancelFabricUpgrade)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /fabric-upgrades/finish
(finishFabricUpgrade)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /fabric-upgrades/prepare-resume
(resumeFabricUpgrade)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /fabric-upgrades
(showFabricUpgrades)

Consumes

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

Return type

fabric-upgrade-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "reboot-count" : 0,
    "proxy-port" : 6,
    "upload-server" : "upload-server",
    "use-proxy" : true,
    "version-available" : "version-available",
    "reboot-group" : "reboot-group",
    "proxy-host" : "proxy-host",
    "track" : "track",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available"
  }, {
    "reboot-count" : 0,
    "proxy-port" : 6,
    "upload-server" : "upload-server",
    "use-proxy" : true,
    "version-available" : "version-available",
    "reboot-group" : "reboot-group",
    "proxy-host" : "proxy-host",
    "track" : "track",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available"
  } ]
}

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

default

success fabric-upgrade-show-response

Up
post /fabric-upgrades/start
(startFabricUpgrade)

Consumes

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

Request body

body fabric-upgrade-start (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

FabricVnics

Up
post /fabric-vnics/create
(ifCreateFabricVnic)

Consumes

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

Request body

body fabric-vnic-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /fabric-vnics/delete
(ifDeleteFabricVnic)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /fabric-vnics/modify
(ifModifyFabricVnic)

Consumes

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

Request body

body fabric-vnic-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /fabric-vnics/{nic}
(showFabricVnicByVnic)

Path parameters

nic (required)
Path Parameter

Consumes

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

Return type

fabric-vnic-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "assignment2" : "none",
    "vlan" : 1,
    "netmask" : 0,
    "ip" : "ip",
    "nic" : "nic",
    "sec-addresses" : 6,
    "api.switch-name" : "api.switch-name",
    "assignment-linklocal" : "none"
  }, {
    "assignment2" : "none",
    "vlan" : 1,
    "netmask" : 0,
    "ip" : "ip",
    "nic" : "nic",
    "sec-addresses" : 6,
    "api.switch-name" : "api.switch-name",
    "assignment-linklocal" : "none"
  } ]
}

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

default

success fabric-vnic-show-response

Up
get /fabric-vnics
(showFabricVnics)

Consumes

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

Return type

fabric-vnic-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "assignment2" : "none",
    "vlan" : 1,
    "netmask" : 0,
    "ip" : "ip",
    "nic" : "nic",
    "sec-addresses" : 6,
    "api.switch-name" : "api.switch-name",
    "assignment-linklocal" : "none"
  }, {
    "assignment2" : "none",
    "vlan" : 1,
    "netmask" : 0,
    "ip" : "ip",
    "nic" : "nic",
    "sec-addresses" : 6,
    "api.switch-name" : "api.switch-name",
    "assignment-linklocal" : "none"
  } ]
}

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

default

success fabric-vnic-show-response

Fabrics

Up
post /fabrics
(createFabric)

Consumes

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

Request body

body fabric-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /fabrics/info
(infoFabric)

Consumes

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

Return type

fabric-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "over-l3" : true,
    "vlan" : 0,
    "delete-conflicts" : true,
    "name" : "name",
    "control-network" : "in-band",
    "id" : "id",
    "repeer-to-cluster-node" : 1,
    "api.switch-name" : "api.switch-name",
    "switch-ip" : "switch-ip",
    "tid" : 6,
    "fabric-advertisement-network" : "inband-mgmt",
    "fabric-network" : "in-band"
  }, {
    "over-l3" : true,
    "vlan" : 0,
    "delete-conflicts" : true,
    "name" : "name",
    "control-network" : "in-band",
    "id" : "id",
    "repeer-to-cluster-node" : 1,
    "api.switch-name" : "api.switch-name",
    "switch-ip" : "switch-ip",
    "tid" : 6,
    "fabric-advertisement-network" : "inband-mgmt",
    "fabric-network" : "in-band"
  } ]
}

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

default

success fabric-show-response

Up
post /fabrics/join
(joinFabricByUsage2)

Consumes

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

Request body

body fabric-join-2 (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /fabrics/id/{id}
(showFabricByIdent)

Path parameters

id (required)
Path Parameter

Consumes

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

Return type

fabric-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "over-l3" : true,
    "vlan" : 0,
    "delete-conflicts" : true,
    "name" : "name",
    "control-network" : "in-band",
    "id" : "id",
    "repeer-to-cluster-node" : 1,
    "api.switch-name" : "api.switch-name",
    "switch-ip" : "switch-ip",
    "tid" : 6,
    "fabric-advertisement-network" : "inband-mgmt",
    "fabric-network" : "in-band"
  }, {
    "over-l3" : true,
    "vlan" : 0,
    "delete-conflicts" : true,
    "name" : "name",
    "control-network" : "in-band",
    "id" : "id",
    "repeer-to-cluster-node" : 1,
    "api.switch-name" : "api.switch-name",
    "switch-ip" : "switch-ip",
    "tid" : 6,
    "fabric-advertisement-network" : "inband-mgmt",
    "fabric-network" : "in-band"
  } ]
}

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

default

success fabric-show-response

Up
get /fabrics/name/{name}
(showFabricByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

fabric-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "over-l3" : true,
    "vlan" : 0,
    "delete-conflicts" : true,
    "name" : "name",
    "control-network" : "in-band",
    "id" : "id",
    "repeer-to-cluster-node" : 1,
    "api.switch-name" : "api.switch-name",
    "switch-ip" : "switch-ip",
    "tid" : 6,
    "fabric-advertisement-network" : "inband-mgmt",
    "fabric-network" : "in-band"
  }, {
    "over-l3" : true,
    "vlan" : 0,
    "delete-conflicts" : true,
    "name" : "name",
    "control-network" : "in-band",
    "id" : "id",
    "repeer-to-cluster-node" : 1,
    "api.switch-name" : "api.switch-name",
    "switch-ip" : "switch-ip",
    "tid" : 6,
    "fabric-advertisement-network" : "inband-mgmt",
    "fabric-network" : "in-band"
  } ]
}

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

default

success fabric-show-response

Up
get /fabrics
(showFabrics)

Consumes

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

Return type

fabric-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "over-l3" : true,
    "vlan" : 0,
    "delete-conflicts" : true,
    "name" : "name",
    "control-network" : "in-band",
    "id" : "id",
    "repeer-to-cluster-node" : 1,
    "api.switch-name" : "api.switch-name",
    "switch-ip" : "switch-ip",
    "tid" : 6,
    "fabric-advertisement-network" : "inband-mgmt",
    "fabric-network" : "in-band"
  }, {
    "over-l3" : true,
    "vlan" : 0,
    "delete-conflicts" : true,
    "name" : "name",
    "control-network" : "in-band",
    "id" : "id",
    "repeer-to-cluster-node" : 1,
    "api.switch-name" : "api.switch-name",
    "switch-ip" : "switch-ip",
    "tid" : 6,
    "fabric-advertisement-network" : "inband-mgmt",
    "fabric-network" : "in-band"
  } ]
}

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

default

success fabric-show-response

Up
post /fabrics/unjoin
(unjoinFabric)

Consumes

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

Request body

body fabric-unjoin (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

FlowTables

Up
get /flow-tables
(showFlowTables)

Consumes

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

Return type

flow-table-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "hw-id" : 0,
    "id" : 6,
    "api.switch-name" : "api.switch-name",
    "flow-hw-id" : 1,
    "flow-name" : "flow-name"
  }, {
    "name" : "name",
    "hw-id" : 0,
    "id" : 6,
    "api.switch-name" : "api.switch-name",
    "flow-hw-id" : 1,
    "flow-name" : "flow-name"
  } ]
}

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

default

success flow-table-show-response

HogViolatorStats

Up
get /hog-violator-stats
(showHogViolatorStats)

Consumes

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

Return type

hog-violator-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mismatches" : 6,
    "older-than" : 2,
    "drop-bytes" : 4,
    "policer-drops" : 7,
    "start-time" : "start-time",
    "within-last" : 7,
    "end-time" : "end-time",
    "cpu-tx-pkts" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "pkts" : 9,
    "vnet" : "vnet",
    "duration" : 5,
    "drops" : 1,
    "cpu-tx-bytes" : 1,
    "policer-drop-bytes" : 1,
    "bytes" : 0,
    "name" : "name",
    "interval" : 5,
    "id" : "id",
    "time" : "time",
    "cpu-pkts" : 3,
    "cpu-bytes" : 2
  }, {
    "mismatches" : 6,
    "older-than" : 2,
    "drop-bytes" : 4,
    "policer-drops" : 7,
    "start-time" : "start-time",
    "within-last" : 7,
    "end-time" : "end-time",
    "cpu-tx-pkts" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "pkts" : 9,
    "vnet" : "vnet",
    "duration" : 5,
    "drops" : 1,
    "cpu-tx-bytes" : 1,
    "policer-drop-bytes" : 1,
    "bytes" : 0,
    "name" : "name",
    "interval" : 5,
    "id" : "id",
    "time" : "time",
    "cpu-pkts" : 3,
    "cpu-bytes" : 2
  } ]
}

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

default

success hog-violator-stats-show-response

Up
get /hog-violator-stats/{name}
(showHogViolatorStatsByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

hog-violator-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mismatches" : 6,
    "older-than" : 2,
    "drop-bytes" : 4,
    "policer-drops" : 7,
    "start-time" : "start-time",
    "within-last" : 7,
    "end-time" : "end-time",
    "cpu-tx-pkts" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "pkts" : 9,
    "vnet" : "vnet",
    "duration" : 5,
    "drops" : 1,
    "cpu-tx-bytes" : 1,
    "policer-drop-bytes" : 1,
    "bytes" : 0,
    "name" : "name",
    "interval" : 5,
    "id" : "id",
    "time" : "time",
    "cpu-pkts" : 3,
    "cpu-bytes" : 2
  }, {
    "mismatches" : 6,
    "older-than" : 2,
    "drop-bytes" : 4,
    "policer-drops" : 7,
    "start-time" : "start-time",
    "within-last" : 7,
    "end-time" : "end-time",
    "cpu-tx-pkts" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "pkts" : 9,
    "vnet" : "vnet",
    "duration" : 5,
    "drops" : 1,
    "cpu-tx-bytes" : 1,
    "policer-drop-bytes" : 1,
    "bytes" : 0,
    "name" : "name",
    "interval" : 5,
    "id" : "id",
    "time" : "time",
    "cpu-pkts" : 3,
    "cpu-bytes" : 2
  } ]
}

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

default

success hog-violator-stats-show-response

HogViolators

Up
get /hog-violators/mac={mac},vnet-id={vnet-id},bd={bd},vlan={vlan},vxlan={vxlan},port={port}
(showHogViolatorByUniqueKeyAll)

Path parameters

mac (required)
Path Parameter
vnet-id (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter
vxlan (required)
Path Parameter
port (required)
Path Parameter

Consumes

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

Return type

hog-violator-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "bd" : "bd",
    "vflow3" : "vflow3",
    "vflow2" : "vflow2",
    "created" : "created",
    "vflow" : "vflow",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "cpu-class" : "cpu-class",
    "vlan" : 0,
    "port" : 1,
    "idle-count" : 5,
    "hog-cpu-class" : "hog-cpu-class",
    "vnet-id" : "vnet-id",
    "vflow6" : "vflow6",
    "vflow5" : "vflow5",
    "vflow4" : "vflow4"
  }, {
    "vxlan" : 6,
    "bd" : "bd",
    "vflow3" : "vflow3",
    "vflow2" : "vflow2",
    "created" : "created",
    "vflow" : "vflow",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "cpu-class" : "cpu-class",
    "vlan" : 0,
    "port" : 1,
    "idle-count" : 5,
    "hog-cpu-class" : "hog-cpu-class",
    "vnet-id" : "vnet-id",
    "vflow6" : "vflow6",
    "vflow5" : "vflow5",
    "vflow4" : "vflow4"
  } ]
}

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

default

success hog-violator-show-response

Up
get /hog-violators
(showHogViolators)

Consumes

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

Return type

hog-violator-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "bd" : "bd",
    "vflow3" : "vflow3",
    "vflow2" : "vflow2",
    "created" : "created",
    "vflow" : "vflow",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "cpu-class" : "cpu-class",
    "vlan" : 0,
    "port" : 1,
    "idle-count" : 5,
    "hog-cpu-class" : "hog-cpu-class",
    "vnet-id" : "vnet-id",
    "vflow6" : "vflow6",
    "vflow5" : "vflow5",
    "vflow4" : "vflow4"
  }, {
    "vxlan" : 6,
    "bd" : "bd",
    "vflow3" : "vflow3",
    "vflow2" : "vflow2",
    "created" : "created",
    "vflow" : "vflow",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "cpu-class" : "cpu-class",
    "vlan" : 0,
    "port" : 1,
    "idle-count" : 5,
    "hog-cpu-class" : "hog-cpu-class",
    "vnet-id" : "vnet-id",
    "vflow6" : "vflow6",
    "vflow5" : "vflow5",
    "vflow4" : "vflow4"
  } ]
}

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

default

success hog-violator-show-response

IdLed

Up
get /id-led
(showLocationLed)

Consumes

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

Return type

id-led-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "enable" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "enable" : true,
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success id-led-show-response

Up
put /id-led
(updateLocationLed)

Consumes

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

Request body

body id-led-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

IgmpQuerierIps

Up
get /igmp-querier-ips/{vlans-on-querier-ip}
(showIgmpSnoopingQuerierIpByVlanMap)

Path parameters

vlans-on-querier-ip (required)
Path Parameter

Consumes

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

Return type

igmp-querier-ip-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "querier-ip" : "querier-ip",
    "vlans-on-querier-ip" : "vlans-on-querier-ip",
    "api.switch-name" : "api.switch-name"
  }, {
    "querier-ip" : "querier-ip",
    "vlans-on-querier-ip" : "vlans-on-querier-ip",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-querier-ip-show-response

Up
get /igmp-querier-ips
(showIgmpSnoopingQuerierIps)

Consumes

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

Return type

igmp-querier-ip-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "querier-ip" : "querier-ip",
    "vlans-on-querier-ip" : "vlans-on-querier-ip",
    "api.switch-name" : "api.switch-name"
  }, {
    "querier-ip" : "querier-ip",
    "vlans-on-querier-ip" : "vlans-on-querier-ip",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-querier-ip-show-response

Up
put /igmp-querier-ips/{vlans-on-querier-ip}
(updateIgmpSnoopingQuerierIpByVlanMap)

Path parameters

vlans-on-querier-ip (required)
Path Parameter

Consumes

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

Request body

body igmp-querier-ip-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

IgmpRouters

Up
get /igmp-routers/{node-ip}
(showIgmpRouterByHost)

Path parameters

node-ip (required)
Path Parameter

Consumes

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

Return type

igmp-router-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-router-show-response

Up
get /igmp-routers
(showIgmpRouters)

Consumes

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

Return type

igmp-router-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-router-show-response

IgmpSnooping

Up
get /igmp-snooping
(showIgmpSnooping)

Consumes

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

Return type

igmp-snooping-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : true,
    "no-snoop-linklocal-vlans" : "no-snoop-linklocal-vlans",
    "api.switch-name" : "api.switch-name",
    "query-max-response-time" : 6,
    "igmpv2-vlans" : "igmpv2-vlans",
    "enable" : true,
    "scope" : "local",
    "interop-v2-vlans" : "interop-v2-vlans",
    "enable-vlans" : "enable-vlans",
    "snoop-linklocal-vlans" : "snoop-linklocal-vlans",
    "query-interval" : 0,
    "nvOS-managed-vlans" : "nvOS-managed-vlans",
    "igmpv3-vlans" : "igmpv3-vlans"
  }, {
    "vxlan" : true,
    "no-snoop-linklocal-vlans" : "no-snoop-linklocal-vlans",
    "api.switch-name" : "api.switch-name",
    "query-max-response-time" : 6,
    "igmpv2-vlans" : "igmpv2-vlans",
    "enable" : true,
    "scope" : "local",
    "interop-v2-vlans" : "interop-v2-vlans",
    "enable-vlans" : "enable-vlans",
    "snoop-linklocal-vlans" : "snoop-linklocal-vlans",
    "query-interval" : 0,
    "nvOS-managed-vlans" : "nvOS-managed-vlans",
    "igmpv3-vlans" : "igmpv3-vlans"
  } ]
}

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

default

success igmp-snooping-show-response

Up
put /igmp-snooping
(updateIgmpSnooping)

Consumes

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

Request body

body igmp-snooping-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

IgmpStaticGroups

Up
post /igmp-static-groups
(createIgmpStaticGroup)

Consumes

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

Request body

body igmp-static-group-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /igmp-static-groups/group-ip={group-ip},vnet-id={vnet-id},bd={bd},vlan={vlan}
(deleteIgmpStaticGroupByUniqueKeyAll)

Path parameters

group-ip (required)
Path Parameter
vnet-id (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /igmp-static-groups/group-ip={group-ip},vnet-id={vnet-id},bd={bd},vlan={vlan}
(showIgmpStaticGroupByUniqueKeyAll)

Path parameters

group-ip (required)
Path Parameter
vnet-id (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Return type

igmp-static-group-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "vlan" : 0,
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "bd" : "bd",
    "vlan" : 0,
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-static-group-show-response

Up
get /igmp-static-groups
(showIgmpStaticGroups)

Consumes

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

Return type

igmp-static-group-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "vlan" : 0,
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "bd" : "bd",
    "vlan" : 0,
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-static-group-show-response

IgmpStaticSources

Up
post /igmp-static-sources
(createIgmpStaticSource)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /igmp-static-sources/group-ip={group-ip},bd={bd},vlan={vlan},source-ip={source-ip}
(deleteIgmpStaticSourceByUniqueKeyAll)

Path parameters

group-ip (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter
source-ip (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /igmp-static-sources/group-ip={group-ip},bd={bd},vlan={vlan},source-ip={source-ip}
(showIgmpStaticSourceByUniqueKeyAll)

Path parameters

group-ip (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter
source-ip (required)
Path Parameter

Consumes

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

Return type

igmp-static-source-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "vlan" : 0,
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "source-ip" : "source-ip",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "bd" : "bd",
    "vlan" : 0,
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "source-ip" : "source-ip",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-static-source-show-response

Up
get /igmp-static-sources
(showIgmpStaticSources)

Consumes

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

Return type

igmp-static-source-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "vlan" : 0,
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "source-ip" : "source-ip",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "bd" : "bd",
    "vlan" : 0,
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "source-ip" : "source-ip",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-static-source-show-response

IgmpStats

Up
post /igmp-stats/clear
(clearIgmpStats)

Consumes

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

Request body

body igmp-stats-clear (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /igmp-stats
(showIgmpStats)

Consumes

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

Return type

igmp-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ignored" : 1,
    "v1-member-reports" : 2,
    "drops" : 6,
    "v2-leave-group" : 9,
    "vlan" : 0,
    "v3-queries" : 5,
    "v2-member-reports" : 7,
    "api.switch-name" : "api.switch-name",
    "v2-queries" : 5,
    "v3-member-reports" : 3,
    "queries-sent" : 2
  }, {
    "ignored" : 1,
    "v1-member-reports" : 2,
    "drops" : 6,
    "v2-leave-group" : 9,
    "vlan" : 0,
    "v3-queries" : 5,
    "v2-member-reports" : 7,
    "api.switch-name" : "api.switch-name",
    "v2-queries" : 5,
    "v3-member-reports" : 3,
    "queries-sent" : 2
  } ]
}

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

default

success igmp-stats-show-response

Up
get /igmp-stats/{vlan}
(showIgmpStatsByVlan)

Path parameters

vlan (required)
Path Parameter

Consumes

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

Return type

igmp-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ignored" : 1,
    "v1-member-reports" : 2,
    "drops" : 6,
    "v2-leave-group" : 9,
    "vlan" : 0,
    "v3-queries" : 5,
    "v2-member-reports" : 7,
    "api.switch-name" : "api.switch-name",
    "v2-queries" : 5,
    "v3-member-reports" : 3,
    "queries-sent" : 2
  }, {
    "ignored" : 1,
    "v1-member-reports" : 2,
    "drops" : 6,
    "v2-leave-group" : 9,
    "vlan" : 0,
    "v3-queries" : 5,
    "v2-member-reports" : 7,
    "api.switch-name" : "api.switch-name",
    "v2-queries" : 5,
    "v3-member-reports" : 3,
    "queries-sent" : 2
  } ]
}

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

default

success igmp-stats-show-response

IgmpSwitches

Up
get /igmp-switches
(showIgmpSwitches)

Consumes

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

Return type

igmp-switches-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-switches-show-response

Up
get /igmp-switches/{node-ip}
(showIgmpSwitchesByHost)

Path parameters

node-ip (required)
Path Parameter

Consumes

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

Return type

igmp-switches-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-switches-show-response

Igmps

Up
get /igmps/{node-ip}
(showIgmpHostByHost)

Path parameters

node-ip (required)
Path Parameter

Consumes

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

Return type

igmp-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "expires" : 5,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "node-type" : "host",
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "source" : "source",
    "api.switch-name" : "api.switch-name"
  }, {
    "vxlan" : 0,
    "expires" : 5,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "node-type" : "host",
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "source" : "source",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-show-response

Up
get /igmps
(showIgmpHosts)

Consumes

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

Return type

igmp-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "expires" : 5,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "node-type" : "host",
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "source" : "source",
    "api.switch-name" : "api.switch-name"
  }, {
    "vxlan" : 0,
    "expires" : 5,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "node-type" : "host",
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "source" : "source",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success igmp-show-response

InlineServices

Up
post /inline-services
(createInlineService)

Consumes

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

Request body

body inline-service-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /inline-services/{name}
(deleteInlineServiceByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /inline-services/{name}
(showInlineServiceByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

inline-service-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "rx-port" : "rx-port",
    "heartbeat" : "heartbeat",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "tx-port" : "tx-port",
    "status" : "down"
  }, {
    "rx-port" : "rx-port",
    "heartbeat" : "heartbeat",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "tx-port" : "tx-port",
    "status" : "down"
  } ]
}

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

default

success inline-service-show-response

Up
get /inline-services
(showInlineServices)

Consumes

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

Return type

inline-service-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "rx-port" : "rx-port",
    "heartbeat" : "heartbeat",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "tx-port" : "tx-port",
    "status" : "down"
  }, {
    "rx-port" : "rx-port",
    "heartbeat" : "heartbeat",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "tx-port" : "tx-port",
    "status" : "down"
  } ]
}

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

default

success inline-service-show-response

Up
put /inline-services/{name}
(updateInlineServiceByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body inline-service-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

InterfaceStats

Up
get /interface-stats
(showInterfaceStats)

Consumes

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

Return type

interface-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ierrs" : 5,
    "oerrs" : 2,
    "ibytes" : 0,
    "nic" : "nic",
    "opkts" : 5,
    "obytes" : 6,
    "time" : "time",
    "api.switch-name" : "api.switch-name",
    "ipkts" : 1
  }, {
    "ierrs" : 5,
    "oerrs" : 2,
    "ibytes" : 0,
    "nic" : "nic",
    "opkts" : 5,
    "obytes" : 6,
    "time" : "time",
    "api.switch-name" : "api.switch-name",
    "ipkts" : 1
  } ]
}

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

default

success interface-stats-show-response

Up
get /interface-stats/{nic}
(showInterfaceStatsByNic)

Path parameters

nic (required)
Path Parameter

Consumes

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

Return type

interface-stats-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ierrs" : 5,
    "oerrs" : 2,
    "ibytes" : 0,
    "nic" : "nic",
    "opkts" : 5,
    "obytes" : 6,
    "time" : "time",
    "api.switch-name" : "api.switch-name",
    "ipkts" : 1
  }, {
    "ierrs" : 5,
    "oerrs" : 2,
    "ibytes" : 0,
    "nic" : "nic",
    "opkts" : 5,
    "obytes" : 6,
    "time" : "time",
    "api.switch-name" : "api.switch-name",
    "ipkts" : 1
  } ]
}

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

default

success interface-stats-show-response

IpPools

Up
post /ip-pools
(createIpPoolByUsage1)

Consumes

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

Request body

body ip-pool-create-1 (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /ip-pools/{name}
(deleteIpPoolByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /ip-pools/{name}
(showIpPoolByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

ip-pool-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "vlan" : 0,
    "netmask" : 6,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "start-ip" : "start-ip",
    "end-ip" : "end-ip",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "bd" : "bd",
    "vlan" : 0,
    "netmask" : 6,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "start-ip" : "start-ip",
    "end-ip" : "end-ip",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  } ]
}

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

default

success ip-pool-show-response

Up
get /ip-pools
(showIpPools)

Consumes

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

Return type

ip-pool-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "vlan" : 0,
    "netmask" : 6,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "start-ip" : "start-ip",
    "end-ip" : "end-ip",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "bd" : "bd",
    "vlan" : 0,
    "netmask" : 6,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "start-ip" : "start-ip",
    "end-ip" : "end-ip",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  } ]
}

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

default

success ip-pool-show-response

Up
put /ip-pools/{name}
(updateIpPoolByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body ip-pool-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

IpfixCollectors

Up
post /ipfix-collectors
(createIpfixCollector)

Consumes

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

Request body

body ipfix-collector-create (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /ipfix-collectors/{name}
(deleteIpfixCollectorByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /ipfix-collectors/{name}
(showIpfixCollectorByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

ipfix-collector-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "transport-protocol" : 6,
    "port" : 0,
    "name" : "name",
    "host" : "host",
    "api.switch-name" : "api.switch-name"
  }, {
    "transport-protocol" : 6,
    "port" : 0,
    "name" : "name",
    "host" : "host",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success ipfix-collector-show-response

Up
get /ipfix-collectors
(showIpfixCollectors)

Consumes

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

Return type

ipfix-collector-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "transport-protocol" : 6,
    "port" : 0,
    "name" : "name",
    "host" : "host",
    "api.switch-name" : "api.switch-name"
  }, {
    "transport-protocol" : 6,
    "port" : 0,
    "name" : "name",
    "host" : "host",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success ipfix-collector-show-response

Up
put /ipfix-collectors/{name}
(updateIpfixCollectorByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body ipfix-collector-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

IpfixService

Up
get /ipfix-service
(showIpfixService)

Consumes

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

Return type

ipfix-service-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "udp-template-resend-interval" : 1,
    "max-connections-exported" : 5,
    "enable-service" : true,
    "export-interval" : 0,
    "state" : "disable",
    "obs-domain" : 6,
    "api.switch-name" : "api.switch-name"
  }, {
    "udp-template-resend-interval" : 1,
    "max-connections-exported" : 5,
    "enable-service" : true,
    "export-interval" : 0,
    "state" : "disable",
    "obs-domain" : 6,
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success ipfix-service-show-response

Up
put /ipfix-service
(updateIpfixService)

Consumes

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

Request body

body ipfix-service-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Ipv6securityRaguards

Up
post /ipv6security-raguards/{name}/ports
(addIpv6securityRaguardPortByIpv6securityRaguardName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /ipv6security-raguards/{name}/vlans
(addIpv6securityRaguardVlanByIpv6securityRaguardName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /ipv6security-raguards
(createIpv6securityRaguard)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /ipv6security-raguards/{name}
(deleteIpv6securityRaguardByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /ipv6security-raguards/{name}/ports/{ports}
(removeIpv6securityRaguardPortByNameByPorts)

Path parameters

name (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /ipv6security-raguards/{name}/vlans/{vlans}
(removeIpv6securityRaguardVlanByNameByVlans)

Path parameters

name (required)
Path Parameter
vlans (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /ipv6security-raguards/{name}
(showIpv6securityRaguardByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

ipv6security-raguard-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "attached-vlans" : "attached-vlans",
    "prefix-list" : "prefix-list",
    "access-list" : "access-list",
    "router-priority" : "low",
    "name" : "name",
    "attached-ports" : "attached-ports",
    "api.switch-name" : "api.switch-name",
    "device" : "host"
  }, {
    "attached-vlans" : "attached-vlans",
    "prefix-list" : "prefix-list",
    "access-list" : "access-list",
    "router-priority" : "low",
    "name" : "name",
    "attached-ports" : "attached-ports",
    "api.switch-name" : "api.switch-name",
    "device" : "host"
  } ]
}

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

default

success ipv6security-raguard-show-response

Up
get /ipv6security-raguards/{name}/ports/{ports}
(showIpv6securityRaguardPortByNameByPorts)

Path parameters

name (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

ipv6security-raguard-port-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success ipv6security-raguard-port-show-response

Up
get /ipv6security-raguards/{name}/ports
(showIpv6securityRaguardPortsByIpv6securityRaguardName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

ipv6security-raguard-port-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success ipv6security-raguard-port-show-response

Up
get /ipv6security-raguards/{name}/vlans/{vlans}
(showIpv6securityRaguardVlanByNameByVlans)

Path parameters

name (required)
Path Parameter
vlans (required)
Path Parameter

Consumes

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

Return type

ipv6security-raguard-vlan-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlans" : "vlans",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success ipv6security-raguard-vlan-show-response

Up
get /ipv6security-raguards/{name}/vlans
(showIpv6securityRaguardVlansByIpv6securityRaguardName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

ipv6security-raguard-vlan-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlans" : "vlans",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success ipv6security-raguard-vlan-show-response

Up
get /ipv6security-raguards
(showIpv6securityRaguards)

Consumes

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

Return type

ipv6security-raguard-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "attached-vlans" : "attached-vlans",
    "prefix-list" : "prefix-list",
    "access-list" : "access-list",
    "router-priority" : "low",
    "name" : "name",
    "attached-ports" : "attached-ports",
    "api.switch-name" : "api.switch-name",
    "device" : "host"
  }, {
    "attached-vlans" : "attached-vlans",
    "prefix-list" : "prefix-list",
    "access-list" : "access-list",
    "router-priority" : "low",
    "name" : "name",
    "attached-ports" : "attached-ports",
    "api.switch-name" : "api.switch-name",
    "device" : "host"
  } ]
}

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

default

success ipv6security-raguard-show-response

Up
put /ipv6security-raguards/{name}
(updateIpv6securityRaguardByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

IsoLibraries

Up
post /iso-libraries/{iso-library-name}/images/export
(exportIsoLibraryImageByIsoLibraryName)

Path parameters

iso-library-name (required)
Path Parameter

Consumes

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

Request body

body iso-library-image-export (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /iso-libraries/{iso-library-name}/images/import
(importIsoLibraryImageByIsoLibraryName)

Path parameters

iso-library-name (required)
Path Parameter

Consumes

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

Request body

body iso-library-image-import (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /iso-libraries/{iso-library-name}/images/{label}
(removeIsoLibraryImageByNameByLabel)

Path parameters

iso-library-name (required)
Path Parameter
label (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /iso-libraries
(showIsoLibraries)

Consumes

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

Return type

iso-library-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "storage-pool" : "storage-pool",
    "import-share" : "import-share",
    "name" : "name",
    "export-share-path" : "export-share-path",
    "export-share" : "export-share",
    "sharing" : "none",
    "api.switch-name" : "api.switch-name",
    "import-share-path" : "import-share-path",
    "data-set" : "data-set"
  }, {
    "storage-pool" : "storage-pool",
    "import-share" : "import-share",
    "name" : "name",
    "export-share-path" : "export-share-path",
    "export-share" : "export-share",
    "sharing" : "none",
    "api.switch-name" : "api.switch-name",
    "import-share-path" : "import-share-path",
    "data-set" : "data-set"
  } ]
}

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

default

success iso-library-show-response

Up
get /iso-libraries/{name}
(showIsoLibraryByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

iso-library-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "storage-pool" : "storage-pool",
    "import-share" : "import-share",
    "name" : "name",
    "export-share-path" : "export-share-path",
    "export-share" : "export-share",
    "sharing" : "none",
    "api.switch-name" : "api.switch-name",
    "import-share-path" : "import-share-path",
    "data-set" : "data-set"
  }, {
    "storage-pool" : "storage-pool",
    "import-share" : "import-share",
    "name" : "name",
    "export-share-path" : "export-share-path",
    "export-share" : "export-share",
    "sharing" : "none",
    "api.switch-name" : "api.switch-name",
    "import-share-path" : "import-share-path",
    "data-set" : "data-set"
  } ]
}

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

default

success iso-library-show-response

Up
get /iso-libraries/{iso-library-name}/images/{label}
(showIsoLibraryImageByNameByLabel)

Path parameters

iso-library-name (required)
Path Parameter
label (required)
Path Parameter

Consumes

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

Return type

iso-library-image-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "library" : "library",
    "file" : "file",
    "label" : "label",
    "api.switch-name" : "api.switch-name"
  }, {
    "library" : "library",
    "file" : "file",
    "label" : "label",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success iso-library-image-show-response

Up
get /iso-libraries/{iso-library-name}/images
(showIsoLibraryImagesByIsoLibraryName)

Path parameters

iso-library-name (required)
Path Parameter

Consumes

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

Return type

iso-library-image-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "library" : "library",
    "file" : "file",
    "label" : "label",
    "api.switch-name" : "api.switch-name"
  }, {
    "library" : "library",
    "file" : "file",
    "label" : "label",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success iso-library-image-show-response

Up
put /iso-libraries/{name}
(updateIsoLibraryByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body iso-library-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

L2Checks

Up
get /l2-checks/fix
(fixL2Check)

Consumes

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

Return type

l2-check-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "bd" : "bd",
    "sw-port" : 1,
    "hw-state" : "active",
    "fix-action" : "none",
    "sw-state" : "active",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnet" : "vnet",
    "vlan" : 0,
    "hw-port" : 5,
    "public-vlan" : 5,
    "tunnel-name" : "tunnel-name"
  }, {
    "vxlan" : 6,
    "bd" : "bd",
    "sw-port" : 1,
    "hw-state" : "active",
    "fix-action" : "none",
    "sw-state" : "active",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnet" : "vnet",
    "vlan" : 0,
    "hw-port" : 5,
    "public-vlan" : 5,
    "tunnel-name" : "tunnel-name"
  } ]
}

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

default

success l2-check-show-response

Up
get /l2-checks/mac={mac},vnet={vnet},bd={bd},vlan={vlan},vxlan={vxlan}
(showL2CheckByUniqueKeyAll)

Path parameters

mac (required)
Path Parameter
vnet (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter
vxlan (required)
Path Parameter

Consumes

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

Return type

l2-check-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "bd" : "bd",
    "sw-port" : 1,
    "hw-state" : "active",
    "fix-action" : "none",
    "sw-state" : "active",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnet" : "vnet",
    "vlan" : 0,
    "hw-port" : 5,
    "public-vlan" : 5,
    "tunnel-name" : "tunnel-name"
  }, {
    "vxlan" : 6,
    "bd" : "bd",
    "sw-port" : 1,
    "hw-state" : "active",
    "fix-action" : "none",
    "sw-state" : "active",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnet" : "vnet",
    "vlan" : 0,
    "hw-port" : 5,
    "public-vlan" : 5,
    "tunnel-name" : "tunnel-name"
  } ]
}

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

default

success l2-check-show-response

Up
get /l2-checks
(showL2Checks)

Consumes

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

Return type

l2-check-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "bd" : "bd",
    "sw-port" : 1,
    "hw-state" : "active",
    "fix-action" : "none",
    "sw-state" : "active",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnet" : "vnet",
    "vlan" : 0,
    "hw-port" : 5,
    "public-vlan" : 5,
    "tunnel-name" : "tunnel-name"
  }, {
    "vxlan" : 6,
    "bd" : "bd",
    "sw-port" : 1,
    "hw-state" : "active",
    "fix-action" : "none",
    "sw-state" : "active",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnet" : "vnet",
    "vlan" : 0,
    "hw-port" : 5,
    "public-vlan" : 5,
    "tunnel-name" : "tunnel-name"
  } ]
}

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

default

success l2-check-show-response

L2Histories

Up
get /l2-histories
(showL2Histories)

Consumes

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

Query parameters

limit-output (optional)
Query Parameter — default: 20 format: int32
sort-asc (optional)
Query Parameter
sort-desc (optional)
Query Parameter
sum-by (optional)
Query Parameter

Return type

l2-history-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 6,
    "reason" : "activate",
    "within-last" : 8,
    "last-reason" : "activate",
    "alt-owner-port" : 4,
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "start-time" : "start-time",
    "last-caller" : "init",
    "ip" : "ip",
    "count" : 9,
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 1,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "interval" : 9,
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 7,
    "vs-type" : "none",
    "changes" : "changes",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 2,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "duration" : 9,
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "log-type" : "l2-save",
    "cpus" : 7,
    "intf" : 9,
    "end-time" : "end-time",
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "caller" : "init",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "time" : "time",
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  }, {
    "older-than" : 6,
    "reason" : "activate",
    "within-last" : 8,
    "last-reason" : "activate",
    "alt-owner-port" : 4,
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "start-time" : "start-time",
    "last-caller" : "init",
    "ip" : "ip",
    "count" : 9,
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 1,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "interval" : 9,
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 7,
    "vs-type" : "none",
    "changes" : "changes",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 2,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "duration" : 9,
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "log-type" : "l2-save",
    "cpus" : 7,
    "intf" : 9,
    "end-time" : "end-time",
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "caller" : "init",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "time" : "time",
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  } ]
}

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

default

success l2-history-show-response

Up
get /l2-histories/mac={mac},vnet={vnet},bd={bd},vlan={vlan},vxlan={vxlan},ip={ip}
(showL2HistoryByUniqueKeyAll)

Path parameters

mac (required)
Path Parameter
vnet (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter
vxlan (required)
Path Parameter
ip (required)
Path Parameter

Consumes

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

Return type

l2-history-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 6,
    "reason" : "activate",
    "within-last" : 8,
    "last-reason" : "activate",
    "alt-owner-port" : 4,
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "start-time" : "start-time",
    "last-caller" : "init",
    "ip" : "ip",
    "count" : 9,
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 1,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "interval" : 9,
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 7,
    "vs-type" : "none",
    "changes" : "changes",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 2,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "duration" : 9,
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "log-type" : "l2-save",
    "cpus" : 7,
    "intf" : 9,
    "end-time" : "end-time",
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "caller" : "init",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "time" : "time",
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  }, {
    "older-than" : 6,
    "reason" : "activate",
    "within-last" : 8,
    "last-reason" : "activate",
    "alt-owner-port" : 4,
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "start-time" : "start-time",
    "last-caller" : "init",
    "ip" : "ip",
    "count" : 9,
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 1,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "interval" : 9,
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 7,
    "vs-type" : "none",
    "changes" : "changes",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 2,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "duration" : 9,
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "log-type" : "l2-save",
    "cpus" : 7,
    "intf" : 9,
    "end-time" : "end-time",
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "caller" : "init",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "time" : "time",
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  } ]
}

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

default

success l2-history-show-response

L2Setting

Up
get /l2-setting
(showL2Setting)

Consumes

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

Return type

l2-setting-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "l3-arp-cur-count" : 5,
    "l2-checker" : true,
    "l2-cur-count" : 7,
    "aging-time" : 9,
    "l3-arp-cur-mem" : 2,
    "l2-max-count" : 3,
    "l2-max-mem" : 6,
    "api.switch-name" : "api.switch-name",
    "l2-checker-interval" : 4,
    "software-aging" : true,
    "l3-arp-max-count" : 2,
    "l2-active-count" : 0,
    "l2-cur-mem" : 1,
    "l3-arp-max-mem" : 5
  }, {
    "l3-arp-cur-count" : 5,
    "l2-checker" : true,
    "l2-cur-count" : 7,
    "aging-time" : 9,
    "l3-arp-cur-mem" : 2,
    "l2-max-count" : 3,
    "l2-max-mem" : 6,
    "api.switch-name" : "api.switch-name",
    "l2-checker-interval" : 4,
    "software-aging" : true,
    "l3-arp-max-count" : 2,
    "l2-active-count" : 0,
    "l2-cur-mem" : 1,
    "l3-arp-max-mem" : 5
  } ]
}

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

default

success l2-setting-show-response

Up
put /l2-setting
(updateL2Setting)

Consumes

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

Request body

body l2-setting-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

L2StaticMulticastGroups

Up
post /l2-static-multicast-groups/group-mac={group-mac},vnet-id={vnet-id},bd={bd},vlan={vlan}/ports
(addL2StaticMulticastGroupPortByUniqueKeyAll)

Path parameters

group-mac (required)
Path Parameter
vnet-id (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /l2-static-multicast-groups
(createL2StaticMulticastGroup)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
delete /l2-static-multicast-groups/group-mac={group-mac},vnet-id={vnet-id},bd={bd},vlan={vlan}
(deleteL2StaticMulticastGroupByUniqueKeyAll)

Path parameters

group-mac (required)
Path Parameter
vnet-id (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /l2-static-multicast-groups/group-mac={group-mac},vnet-id={vnet-id},bd={bd},vlan={vlan}
(showL2StaticMulticastGroupByUniqueKeyAll)

Path parameters

group-mac (required)
Path Parameter
vnet-id (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Return type

l2-static-multicast-group-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "vlan" : 0,
    "group-mac" : "group-mac",
    "vnet-id" : "vnet-id",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "bd" : "bd",
    "vlan" : 0,
    "group-mac" : "group-mac",
    "vnet-id" : "vnet-id",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success l2-static-multicast-group-show-response

Up
get /l2-static-multicast-groups/group-mac={group-mac},vnet-id={vnet-id},bd={bd},vlan={vlan}/ports
(showL2StaticMulticastGroupPortByUniqueKeyAll)

Path parameters

group-mac (required)
Path Parameter
vnet-id (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Return type

l2-static-multicast-group-port-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success l2-static-multicast-group-port-show-response

Up
get /l2-static-multicast-groups
(showL2StaticMulticastGroups)

Consumes

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

Return type

l2-static-multicast-group-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "vlan" : 0,
    "group-mac" : "group-mac",
    "vnet-id" : "vnet-id",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "bd" : "bd",
    "vlan" : 0,
    "group-mac" : "group-mac",
    "vnet-id" : "vnet-id",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success l2-static-multicast-group-show-response

L2Tables

Up
post /l2-tables/flush
(flushL2Table)

Consumes

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

Request body

body l2-table-flush (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /l2-tables/mac={mac},vnet={vnet},bd={bd},vlan={vlan},vxlan={vxlan},ip={ip}
(showL2TableByUniqueKeyAll)

Path parameters

mac (required)
Path Parameter
vnet (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter
vxlan (required)
Path Parameter
ip (required)
Path Parameter

Consumes

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

Return type

l2-table-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "alt-owner-port" : 7,
    "vnic-type" : "untagged",
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 5,
    "public-vlan" : 7,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 2,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 3,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 9,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 4,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "cpus" : 1,
    "intf" : 2,
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  }, {
    "alt-owner-port" : 7,
    "vnic-type" : "untagged",
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 5,
    "public-vlan" : 7,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 2,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 3,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 9,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 4,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "cpus" : 1,
    "intf" : 2,
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  } ]
}

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

default

success l2-table-show-response

Up
get /l2-tables
(showL2Tables)

Consumes

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

Return type

l2-table-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "alt-owner-port" : 7,
    "vnic-type" : "untagged",
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 5,
    "public-vlan" : 7,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 2,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 3,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 9,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 4,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "cpus" : 1,
    "intf" : 2,
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  }, {
    "alt-owner-port" : 7,
    "vnic-type" : "untagged",
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 5,
    "public-vlan" : 7,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 2,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 3,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 9,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 4,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "cpus" : 1,
    "intf" : 2,
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  } ]
}

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

default

success l2-table-show-response

L3Checks

Up
get /l3-checks/fix
(fixL3Check)

Consumes

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

Return type

l3-check-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 0,
    "bd" : "bd",
    "vlan" : 1,
    "prelen" : 6,
    "ip" : "ip",
    "fix-action" : "none",
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  }, {
    "vrid" : 0,
    "bd" : "bd",
    "vlan" : 1,
    "prelen" : 6,
    "ip" : "ip",
    "fix-action" : "none",
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  } ]
}

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

default

success l3-check-show-response

Up
get /l3-checks/vrid={vrid},ip={ip},prelen={prelen},vnet-id={vnet-id},bd={bd},vlan={vlan}
(showL3CheckByUniqueKeyAll)

Path parameters

vrid (required)
Path Parameter
ip (required)
Path Parameter
prelen (required)
Path Parameter
vnet-id (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Return type

l3-check-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 0,
    "bd" : "bd",
    "vlan" : 1,
    "prelen" : 6,
    "ip" : "ip",
    "fix-action" : "none",
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  }, {
    "vrid" : 0,
    "bd" : "bd",
    "vlan" : 1,
    "prelen" : 6,
    "ip" : "ip",
    "fix-action" : "none",
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  } ]
}

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

default

success l3-check-show-response

Up
get /l3-checks
(showL3Checks)

Consumes

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

Return type

l3-check-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 0,
    "bd" : "bd",
    "vlan" : 1,
    "prelen" : 6,
    "ip" : "ip",
    "fix-action" : "none",
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  }, {
    "vrid" : 0,
    "bd" : "bd",
    "vlan" : 1,
    "prelen" : 6,
    "ip" : "ip",
    "fix-action" : "none",
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  } ]
}

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

default

success l3-check-show-response

L3Histories

Up
get /l3-histories
(showL3Histories)

Consumes

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

Query parameters

limit-output (optional)
Query Parameter — default: 20 format: int32
sort-asc (optional)
Query Parameter
sort-desc (optional)
Query Parameter
sum-by (optional)
Query Parameter

Return type

l3-history-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 6,
    "reason" : "activate",
    "within-last" : 8,
    "last-reason" : "activate",
    "alt-owner-port" : 4,
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "start-time" : "start-time",
    "last-caller" : "init",
    "ip" : "ip",
    "count" : 9,
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 1,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "interval" : 9,
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 7,
    "vs-type" : "none",
    "changes" : "changes",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 2,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "duration" : 9,
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "log-type" : "l2-save",
    "cpus" : 7,
    "intf" : 9,
    "end-time" : "end-time",
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "caller" : "init",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "time" : "time",
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  }, {
    "older-than" : 6,
    "reason" : "activate",
    "within-last" : 8,
    "last-reason" : "activate",
    "alt-owner-port" : 4,
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "start-time" : "start-time",
    "last-caller" : "init",
    "ip" : "ip",
    "count" : 9,
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 1,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "interval" : 9,
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 7,
    "vs-type" : "none",
    "changes" : "changes",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 2,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "duration" : 9,
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "log-type" : "l2-save",
    "cpus" : 7,
    "intf" : 9,
    "end-time" : "end-time",
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "caller" : "init",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "time" : "time",
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  } ]
}

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

default

success l3-history-show-response

Up
get /l3-histories/mac={mac},vnet={vnet},bd={bd},vlan={vlan},vxlan={vxlan},ip={ip}
(showL3HistoryByUniqueKeyAll)

Path parameters

mac (required)
Path Parameter
vnet (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter
vxlan (required)
Path Parameter
ip (required)
Path Parameter

Consumes

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

Return type

l3-history-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 6,
    "reason" : "activate",
    "within-last" : 8,
    "last-reason" : "activate",
    "alt-owner-port" : 4,
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "start-time" : "start-time",
    "last-caller" : "init",
    "ip" : "ip",
    "count" : 9,
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 1,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "interval" : 9,
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 7,
    "vs-type" : "none",
    "changes" : "changes",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 2,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "duration" : 9,
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "log-type" : "l2-save",
    "cpus" : 7,
    "intf" : 9,
    "end-time" : "end-time",
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "caller" : "init",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "time" : "time",
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  }, {
    "older-than" : 6,
    "reason" : "activate",
    "within-last" : 8,
    "last-reason" : "activate",
    "alt-owner-port" : 4,
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "start-time" : "start-time",
    "last-caller" : "init",
    "ip" : "ip",
    "count" : 9,
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 1,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "interval" : 9,
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 7,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 7,
    "vs-type" : "none",
    "changes" : "changes",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 2,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "duration" : 9,
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 1,
    "alt-owner-ports" : "alt-owner-ports",
    "vlan" : 0,
    "local-ports" : "local-ports",
    "power" : "none",
    "vtep-ip" : "vtep-ip",
    "owner" : 1,
    "rem-ports" : "rem-ports",
    "os" : "os",
    "log-type" : "l2-save",
    "cpus" : 7,
    "intf" : 9,
    "end-time" : "end-time",
    "alt-owner-state" : "active",
    "rem-intf" : 1,
    "last-seen" : "last-seen",
    "caller" : "init",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 5,
    "time" : "time",
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  } ]
}

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

default

success l3-history-show-response

L3Setting

Up
get /l3-setting
(showL3Setting)

Consumes

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

Return type

l3-setting-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "convergence-time" : 6,
    "aging-time" : 0,
    "l3-checker-fix" : true,
    "l3-checker-interval" : 1,
    "api.switch-name" : "api.switch-name",
    "l3-checker" : true
  }, {
    "convergence-time" : 6,
    "aging-time" : 0,
    "l3-checker-fix" : true,
    "l3-checker-interval" : 1,
    "api.switch-name" : "api.switch-name",
    "l3-checker" : true
  } ]
}

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

default

success l3-setting-show-response

Up
put /l3-setting
(updateL3Setting)

Consumes

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

Request body

body l3-setting-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

L3Tables

Up
get /l3-tables/ip={ip},vnet={vnet},bd={bd},vlan={vlan},vxlan={vxlan}
(showL3TableByUniqueKeyAll)

Path parameters

ip (required)
Path Parameter
vnet (required)
Path Parameter
bd (required)
Path Parameter
vlan (required)
Path Parameter
vxlan (required)
Path Parameter

Consumes

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

Return type

l3-table-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "owner" : 1,
    "bd" : "bd",
    "intf" : 7,
    "ip" : "ip",
    "alt-owner-state" : "active",
    "create-time" : "create-time",
    "api.switch-name" : "api.switch-name",
    "last-seen" : "last-seen",
    "mac" : "mac",
    "vnet" : "vnet",
    "owner-state" : "active",
    "hw-intf" : 9,
    "egress-id" : 3,
    "alt-owner" : 5,
    "hit" : 2,
    "rt-if" : "rt-if",
    "vlan" : 0,
    "peer-state" : "active",
    "public-vlan" : 5,
    "state" : "active",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 6,
    "owner" : 1,
    "bd" : "bd",
    "intf" : 7,
    "ip" : "ip",
    "alt-owner-state" : "active",
    "create-time" : "create-time",
    "api.switch-name" : "api.switch-name",
    "last-seen" : "last-seen",
    "mac" : "mac",
    "vnet" : "vnet",
    "owner-state" : "active",
    "hw-intf" : 9,
    "egress-id" : 3,
    "alt-owner" : 5,
    "hit" : 2,
    "rt-if" : "rt-if",
    "vlan" : 0,
    "peer-state" : "active",
    "public-vlan" : 5,
    "state" : "active",
    "tunnel" : "tunnel"
  } ]
}

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

default

success l3-table-show-response

Up
get /l3-tables
(showL3Tables)

Consumes

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

Return type

l3-table-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "owner" : 1,
    "bd" : "bd",
    "intf" : 7,
    "ip" : "ip",
    "alt-owner-state" : "active",
    "create-time" : "create-time",
    "api.switch-name" : "api.switch-name",
    "last-seen" : "last-seen",
    "mac" : "mac",
    "vnet" : "vnet",
    "owner-state" : "active",
    "hw-intf" : 9,
    "egress-id" : 3,
    "alt-owner" : 5,
    "hit" : 2,
    "rt-if" : "rt-if",
    "vlan" : 0,
    "peer-state" : "active",
    "public-vlan" : 5,
    "state" : "active",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 6,
    "owner" : 1,
    "bd" : "bd",
    "intf" : 7,
    "ip" : "ip",
    "alt-owner-state" : "active",
    "create-time" : "create-time",
    "api.switch-name" : "api.switch-name",
    "last-seen" : "last-seen",
    "mac" : "mac",
    "vnet" : "vnet",
    "owner-state" : "active",
    "hw-intf" : 9,
    "egress-id" : 3,
    "alt-owner" : 5,
    "hit" : 2,
    "rt-if" : "rt-if",
    "vlan" : 0,
    "peer-state" : "active",
    "public-vlan" : 5,
    "state" : "active",
    "tunnel" : "tunnel"
  } ]
}

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

default

success l3-table-show-response

Lacp

Up
get /lacp
(showLacp)

Consumes

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

Return type

lacp-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "system-id" : "system-id",
    "enable" : true,
    "api.switch-name" : "api.switch-name",
    "system-priority" : 0
  }, {
    "system-id" : "system-id",
    "enable" : true,
    "api.switch-name" : "api.switch-name",
    "system-priority" : 0
  } ]
}

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

default

success lacp-show-response

Up
put /lacp
(updateLacp)

Consumes

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

Request body

body lacp-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

LacpPortStatsSettings

Up
get /lacp-port-stats-settings
(showLacpPortStatSettings)

Consumes

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

Return type

lacp-port-stats-settings-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "disk-space" : 6,
    "enable" : true,
    "interval" : 0,
    "api.switch-name" : "api.switch-name"
  }, {
    "disk-space" : 6,
    "enable" : true,
    "interval" : 0,
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success lacp-port-stats-settings-show-response

Up
put /lacp-port-stats-settings
(updateLacpPortStatSettings)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Lldps

Up
get /lldps/chassis-id/{chassis-id}
(showLldpByChassisId)

Path parameters

chassis-id (required)
Path Parameter

Consumes

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

Return type

lldp-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ets-conf" : true,
    "max-frame-size" : 5,
    "ets-recomm" : true,
    "port-desc" : "port-desc",
    "cong-notif" : true,
    "system-cap" : "system-cap",
    "system-cap-enabled" : "system-cap-enabled",
    "api.switch-name" : "api.switch-name",
    "ttl" : 6,
    "chassis-id" : "chassis-id",
    "sys-name" : "sys-name",
    "local-port" : 0,
    "appl-priority" : true,
    "pfc-conf" : true,
    "port-id" : "port-id",
    "port-vlan-id" : 1
  }, {
    "ets-conf" : true,
    "max-frame-size" : 5,
    "ets-recomm" : true,
    "port-desc" : "port-desc",
    "cong-notif" : true,
    "system-cap" : "system-cap",
    "system-cap-enabled" : "system-cap-enabled",
    "api.switch-name" : "api.switch-name",
    "ttl" : 6,
    "chassis-id" : "chassis-id",
    "sys-name" : "sys-name",
    "local-port" : 0,
    "appl-priority" : true,
    "pfc-conf" : true,
    "port-id" : "port-id",
    "port-vlan-id" : 1
  } ]
}

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

default

success lldp-show-response

Up
get /lldps/local-port/{local-port}
(showLldpByLocalPort)

Path parameters

local-port (required)
Path Parameter

Consumes

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

Return type

lldp-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ets-conf" : true,
    "max-frame-size" : 5,
    "ets-recomm" : true,
    "port-desc" : "port-desc",
    "cong-notif" : true,
    "system-cap" : "system-cap",
    "system-cap-enabled" : "system-cap-enabled",
    "api.switch-name" : "api.switch-name",
    "ttl" : 6,
    "chassis-id" : "chassis-id",
    "sys-name" : "sys-name",
    "local-port" : 0,
    "appl-priority" : true,
    "pfc-conf" : true,
    "port-id" : "port-id",
    "port-vlan-id" : 1
  }, {
    "ets-conf" : true,
    "max-frame-size" : 5,
    "ets-recomm" : true,
    "port-desc" : "port-desc",
    "cong-notif" : true,
    "system-cap" : "system-cap",
    "system-cap-enabled" : "system-cap-enabled",
    "api.switch-name" : "api.switch-name",
    "ttl" : 6,
    "chassis-id" : "chassis-id",
    "sys-name" : "sys-name",
    "local-port" : 0,
    "appl-priority" : true,
    "pfc-conf" : true,
    "port-id" : "port-id",
    "port-vlan-id" : 1
  } ]
}

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

default

success lldp-show-response

Up
get /lldps/port-id/{port-id}
(showLldpByPortId)

Path parameters

port-id (required)
Path Parameter

Consumes

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

Return type

lldp-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ets-conf" : true,
    "max-frame-size" : 5,
    "ets-recomm" : true,
    "port-desc" : "port-desc",
    "cong-notif" : true,
    "system-cap" : "system-cap",
    "system-cap-enabled" : "system-cap-enabled",
    "api.switch-name" : "api.switch-name",
    "ttl" : 6,
    "chassis-id" : "chassis-id",
    "sys-name" : "sys-name",
    "local-port" : 0,
    "appl-priority" : true,
    "pfc-conf" : true,
    "port-id" : "port-id",
    "port-vlan-id" : 1
  }, {
    "ets-conf" : true,
    "max-frame-size" : 5,
    "ets-recomm" : true,
    "port-desc" : "port-desc",
    "cong-notif" : true,
    "system-cap" : "system-cap",
    "system-cap-enabled" : "system-cap-enabled",
    "api.switch-name" : "api.switch-name",
    "ttl" : 6,
    "chassis-id" : "chassis-id",
    "sys-name" : "sys-name",
    "local-port" : 0,
    "appl-priority" : true,
    "pfc-conf" : true,
    "port-id" : "port-id",
    "port-vlan-id" : 1
  } ]
}

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

default

success lldp-show-response

Up
get /lldps
(showLldps)

Consumes

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

Return type

lldp-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ets-conf" : true,
    "max-frame-size" : 5,
    "ets-recomm" : true,
    "port-desc" : "port-desc",
    "cong-notif" : true,
    "system-cap" : "system-cap",
    "system-cap-enabled" : "system-cap-enabled",
    "api.switch-name" : "api.switch-name",
    "ttl" : 6,
    "chassis-id" : "chassis-id",
    "sys-name" : "sys-name",
    "local-port" : 0,
    "appl-priority" : true,
    "pfc-conf" : true,
    "port-id" : "port-id",
    "port-vlan-id" : 1
  }, {
    "ets-conf" : true,
    "max-frame-size" : 5,
    "ets-recomm" : true,
    "port-desc" : "port-desc",
    "cong-notif" : true,
    "system-cap" : "system-cap",
    "system-cap-enabled" : "system-cap-enabled",
    "api.switch-name" : "api.switch-name",
    "ttl" : 6,
    "chassis-id" : "chassis-id",
    "sys-name" : "sys-name",
    "local-port" : 0,
    "appl-priority" : true,
    "pfc-conf" : true,
    "port-id" : "port-id",
    "port-vlan-id" : 1
  } ]
}

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

default

success lldp-show-response

LogAdminAudit

Up
get /log-admin-audit
(showAdminAudit)

Consumes

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

Return type

log-admin-audit-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "enable" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "enable" : true,
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success log-admin-audit-show-response

Up
put /log-admin-audit
(updateAdminAudit)

Consumes

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

Request body

body log-admin-audit-modify (optional)
Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

LogAlerts

Up
get /log-alerts
(showLogAlerts)

Consumes

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

Return type

log-alert-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "code" : 0,
    "start-time" : "start-time",
    "within-last" : 9,
    "cur-interval" : 1,
    "end-time" : "end-time",
    "count" : 6,
    "last-message" : "last-message",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "switch" : 5,
    "duration" : 5,
    "name" : "name",
    "interval" : 2,
    "time" : "time"
  }, {
    "older-than" : 7,
    "code" : 0,
    "start-time" : "start-time",
    "within-last" : 9,
    "cur-interval" : 1,
    "end-time" : "end-time",
    "count" : 6,
    "last-message" : "last-message",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "switch" : 5,
    "duration" : 5,
    "name" : "name",
    "interval" : 2,
    "time" : "time"
  } ]
}

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

default

success log-alert-show-response

LogArchivalSchedule

Up
post /log-archival-schedule/files-add
(addListLogArchivalSchedule)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
post /log-archival-schedule/files-remove
(removeListLogArchivalSchedule)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

Up
get /log-archival-schedule
(showLogArchivalSchedule)

Consumes

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

Return type

log-archival-schedule-show-response

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 0,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "archive-server-path" : "archive-server-path",
    "archive-interval" : 0,
    "enable" : true,
    "archive-server-username" : "archive-server-username",
    "archive-server" : "archive-server",
    "log-file" : "log-file",
    "api.switch-name" : "api.switch-name"
  }, {
    "archive-server-path" : "archive-server-path",
    "archive-interval" : 0,
    "enable" : true,
    "archive-server-username" : "archive-server-username",
    "archive-server" : "archive-server",
    "log-file" : "log-file",
    "api.switch-name" : "api.switch-name"
  } ]
}

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

default

success log-archival-schedule-show-response

Up
put /log-archival-schedule
(updateLogArchivalSchedule)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  } ],
  "status" : "Success"
}

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

default

success result-list

LogAuditExceptions

Up
post /log-audit-exceptions
(createLogAuditException)

Consumes

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

Request body

Body Parameter

Return type

result-list

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 0,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 0,
    "