Pluribus Networks REST API (7.0.2-7000219757)

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 ]

REST API Point Features Search (7.0.2-7000219757)

List of Commands

AaaTacacs

AccessLists

AclIps

AclMacs

AdminCcMode

AdminCrlConfig

AdminIpmi

AdminServices

AdminSessionTimeout

AdminSftp

AdminSyslogs

Alerts

ApiInstalls

BezelPortmaps

Bootenvs

BridgeDomains

CertExpirationAlert

CertRequests

Certs

ClientServerStats

ClusterBringdown

ClusterBringup

ClusterMemberships

ClusterVrrpOptimize

Clusters

ConnectionLatencies

ConnectionStats

ConnectionStatsSettings

Connections

ControlStats

ControlStatsSettings

ControlTraffics

DhcpFilters

DhcpLeases

DiskLibraries

DscpMaps

EapHostProfiles

ErrDisable

Eula

EvpnChecks

FabricAnycastMac

FabricCommPorts

FabricCommVrouterBgps

FabricEvpnNodes

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

K8s

K8sConnections

K8sTraces

L2Checks

L2Histories

L2Setting

L2StaticMulticastGroups

L2Tables

L3Checks

L3Histories

L3Routes

L3Setting

L3Tables

Lacp

LacpPortStatsSettings

Lldps

LogAdminAudit

LogAlerts

LogArchivalSchedule

LogArchivalScheduleSshKeies

LogAuditExceptions

LogAudits

LogDatetimeFmtMode

LogEventSettings

LogEvents

LogSessions

LogSystemCounters

LogSystems

MacLimits

MacPool

Mcasts

MgmtSessions

Mirrors

MldRouters

MldSnooping

MldStaticGroups

MldStaticSources

MldStats

MldSwitches

Mlds

MstConfigs

Nodes

NvQueueMirrors

NvQueueStats

NvQueueStatsSettings

ObjectLocations

OpenvswitchRestConfigs

Openvswitches

PnScripts

PnServices

PortAssociationPaths

PortAssociations

PortBufferSettings

PortBuffers

PortBwThresholdAlerts

PortBwThresholdMonInt

PortConfigs

PortCosBws

PortCosRateSettings

PortCosStats

PortCosStatsSettings

PortCosWeight

PortEgresses

PortFecStatsSettings

PortForceLinkups

PortGroups

PortLacpStats

PortLacps

PortLldps

PortLpmode

PortPfcStats

PortPfcStatsSettings

PortPfcs

PortPhys

PortStats

PortStatsSettings

PortStatsSnmps

PortStormControls

PortVlans

PortVnets

PortXcvrMemories

PortXcvrs

Ports

PrefixLists

Ptp

Roles

ServiceHeartbeats

ServiceStats

SflowCollectors

SflowThreadBindings

Sflows

SnmpCommunities

SnmpEngineid

SnmpSystem

SnmpTrapEnable

SnmpTrapSinks

SnmpUsers

SnmpV3TrapSinks

SnmpVacms

Snmps

Software

SoftwareLicenses

SoftwareUpgradeInstantStatuses

SoftwareUpgradeStatuses

StaticArps

StaticEcmpGroups

StorageDevices

StoragePools

StorageStats

Stp

StpPortEvents

StpPortStates

StpPorts

StpStates

Subnets

SwitchBoot

SwitchConfigs

SwitchGroups

SwitchInfo

SwitchMode

SwitchNicInfos

SwitchNicStats

SwitchNicStatsSettings

SwitchRoutes

SwitchSetup

SwitchStatusSettings

SwitchStatuses

SwitchVnics

SyslogTlsCertInfos

SyslogTlsCertRequests

SyslogTlsCerts

System

SystemDiagnosticsHwLimits

SystemSettings

SystemState

SystemStats

SystemStatsHistories

SystemStatsHistorySettings

SystemStatsSettings

Topologies

TransactionNodes

TransactionSettings

Transactions

TrunkStats

Trunks

TunnelHistories

TunnelHistorySettings

TunnelStats

TunnelStatsSettings

Tunnels

Udfs

UplinkGroupPort

Users

VcenterConnections

VflowClasses

VflowMgmtStats

VflowSettings

VflowSkipStats

VflowStats

VflowStatsSettings

VflowTableProfiles

VflowTables

Vflows

VlagStats

Vlags

VlanStats

VlanStatsSettings

Vlans

VleStats

VleTransparent

VleTransparentPort

Vles

VnetManagers

VnetPublicVlans

Vnets

Vpgs

VportHistories

VportSettings

VportStats

VportSystemStats

Vports

VrfMroutes

VrfMulticast

VrfMulticastFlood

VrfMulticastIgmp

Vrfs

VrouterCachedRoutes

VrouterEcmpCachedRoutes

VrouterEcmpGroups

VrouterFibArps

VrouterFibRoutes

VrouterLogs

VrouterMfibRoutes

VrouterMribRoutes

VrouterRibHistories

VrouterRibHistorySettings

VrouterRibRoutes

VrouterRoutesStats

Vrouters

Vsgs

VtepAutoVlan

VtepAutoVxlan

Vteps

VxlanDestPort

VxlanStats

VxlanStatsSettings

WebCertInfos

WebCertRequests

WebCertSelfSigneds

WebCerts

XactTruncates

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Example data

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

Example data

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

AdminCcMode

Up
get /admin-cc-mode
(showAdminCcMode)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 admin-cc-mode-show-response
Up
put /admin-cc-mode
(updateAdminCcMode)

Consumes

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

Request body

body admin-cc-mode-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

AdminCrlConfig

Up
get /admin-crl-config
(showAdminCrlConfig)

Consumes

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

Return type

Example data

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

Produces

This API call produces the 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-crl-config-show-response
Up
put /admin-crl-config
(updateAdminCrlConfig)

Consumes

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

Request body

body admin-crl-config-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ssh" : true,
    "web-ssl" : true,
    "snmp" : true,
    "icmp" : true,
    "api.switch-name" : "api.switch-name",
    "vrrp" : true,
    "web-port" : 6,
    "web-log" : true,
    "web" : true,
    "netconf" : true,
    "nfs" : true,
    "web-ssl-port" : 0,
    "if" : "if"
  }, {
    "ssh" : true,
    "web-ssl" : true,
    "snmp" : true,
    "icmp" : true,
    "api.switch-name" : "api.switch-name",
    "vrrp" : true,
    "web-port" : 6,
    "web-log" : true,
    "web" : true,
    "netconf" : true,
    "nfs" : true,
    "web-ssl-port" : 0,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ssh" : true,
    "web-ssl" : true,
    "snmp" : true,
    "icmp" : true,
    "api.switch-name" : "api.switch-name",
    "vrrp" : true,
    "web-port" : 6,
    "web-log" : true,
    "web" : true,
    "netconf" : true,
    "nfs" : true,
    "web-ssl-port" : 0,
    "if" : "if"
  }, {
    "ssh" : true,
    "web-ssl" : true,
    "snmp" : true,
    "icmp" : true,
    "api.switch-name" : "api.switch-name",
    "vrrp" : true,
    "web-port" : 6,
    "web-log" : true,
    "web" : true,
    "netconf" : true,
    "nfs" : true,
    "web-ssl-port" : 0,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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
get /admin-sftp
(showAdminSftp)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "minimum-pw-length" : 0,
    "sftp-user" : "sftp-user",
    "key-auth" : true,
    "disable-pass-auth" : true,
    "pub-key" : "pub-key",
    "enable" : true,
    "pub-key-content" : "pub-key-content",
    "api.switch-name" : "api.switch-name"
  }, {
    "minimum-pw-length" : 0,
    "sftp-user" : "sftp-user",
    "key-auth" : true,
    "disable-pass-auth" : true,
    "pub-key" : "pub-key",
    "enable" : true,
    "pub-key-content" : "pub-key-content",
    "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
Up
put /admin-sftp
(updateAdminSftp)

Consumes

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

Request body

body admin-sftp-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Example data

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

Produces

This API call produces the 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

Example data

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

Produces

This API call produces the 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

Example data

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Produces

This API call produces the 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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "reboot" : true,
    "current" : true,
    "created" : "created",
    "name" : "name",
    "disable-auto-recovery" : true,
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "apply-current-config" : true,
    "space" : 0
  }, {
    "reboot" : true,
    "current" : true,
    "created" : "created",
    "name" : "name",
    "disable-auto-recovery" : true,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "reboot" : true,
    "current" : true,
    "created" : "created",
    "name" : "name",
    "disable-auto-recovery" : true,
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "apply-current-config" : true,
    "space" : 0
  }, {
    "reboot" : true,
    "current" : true,
    "created" : "created",
    "name" : "name",
    "disable-auto-recovery" : true,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vnet-id={vnet-id}/ports
(addBrDomPortByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter
vnet-id (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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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}
(deleteBrDomByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vnet-id={vnet-id}
(deleteBrDomByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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={port}
(removeBrDomPortByNameUniqueKeyAll)

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vnet-id={vnet-id}/ports
(removeBrDomPortByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Produces

This API call produces the 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},vnet-id={vnet-id}
(showBrDomByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the 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},vnet-id={vnet-id}/ports
(showBrDomPortByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "outer-vlan" : 6,
    "vlan-range" : "vlan-range",
    "cos" : 0,
    "inner-cos" : 2,
    "active-ports" : "active-ports",
    "l2-learning" : "none",
    "outer-cos" : 5,
    "untagged-port-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 5,
    "port" : "port",
    "single-bum-domain" : true,
    "outer-tpid" : "none"
  }, {
    "vlans" : "vlans",
    "outer-vlan" : 6,
    "vlan-range" : "vlan-range",
    "cos" : 0,
    "inner-cos" : 2,
    "active-ports" : "active-ports",
    "l2-learning" : "none",
    "outer-cos" : 5,
    "untagged-port-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 5,
    "port" : "port",
    "single-bum-domain" : true,
    "outer-tpid" : "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 bridge-domain-port-show-response
Up
get /bridge-domains/name={name},vnet-id={vnet-id}/ports/port={port}
(showBrDomPortByPrimaryKeyAllNameSublist)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter
port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "outer-vlan" : 6,
    "vlan-range" : "vlan-range",
    "cos" : 0,
    "inner-cos" : 2,
    "active-ports" : "active-ports",
    "l2-learning" : "none",
    "outer-cos" : 5,
    "untagged-port-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 5,
    "port" : "port",
    "single-bum-domain" : true,
    "outer-tpid" : "none"
  }, {
    "vlans" : "vlans",
    "outer-vlan" : 6,
    "vlan-range" : "vlan-range",
    "cos" : 0,
    "inner-cos" : 2,
    "active-ports" : "active-ports",
    "l2-learning" : "none",
    "outer-cos" : 5,
    "untagged-port-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 5,
    "port" : "port",
    "single-bum-domain" : true,
    "outer-tpid" : "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 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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "outer-vlan" : 6,
    "vlan-range" : "vlan-range",
    "cos" : 0,
    "inner-cos" : 2,
    "active-ports" : "active-ports",
    "l2-learning" : "none",
    "outer-cos" : 5,
    "untagged-port-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 5,
    "port" : "port",
    "single-bum-domain" : true,
    "outer-tpid" : "none"
  }, {
    "vlans" : "vlans",
    "outer-vlan" : 6,
    "vlan-range" : "vlan-range",
    "cos" : 0,
    "inner-cos" : 2,
    "active-ports" : "active-ports",
    "l2-learning" : "none",
    "outer-cos" : 5,
    "untagged-port-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 5,
    "port" : "port",
    "single-bum-domain" : true,
    "outer-tpid" : "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 bridge-domain-port-show-response
Up
get /bridge-domains/{name}/ports/port={port}
(showBrDomPortsByNameUniqueKeyAll)

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "outer-vlan" : 6,
    "vlan-range" : "vlan-range",
    "cos" : 0,
    "inner-cos" : 2,
    "active-ports" : "active-ports",
    "l2-learning" : "none",
    "outer-cos" : 5,
    "untagged-port-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 5,
    "port" : "port",
    "single-bum-domain" : true,
    "outer-tpid" : "none"
  }, {
    "vlans" : "vlans",
    "outer-vlan" : 6,
    "vlan-range" : "vlan-range",
    "cos" : 0,
    "inner-cos" : 2,
    "active-ports" : "active-ports",
    "l2-learning" : "none",
    "outer-cos" : 5,
    "untagged-port-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 5,
    "port" : "port",
    "single-bum-domain" : true,
    "outer-tpid" : "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 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

Example data

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

Produces

This API call produces the 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vnet-id={vnet-id}
(updateBrDomByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter
vnet-id (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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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}/ports/port={port}
(updateBrDomPortByNameUniqueKeyAll)

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:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "outer-vlan" : 6,
    "vlan-range" : "vlan-range",
    "cos" : 0,
    "inner-cos" : 2,
    "active-ports" : "active-ports",
    "l2-learning" : "none",
    "outer-cos" : 5,
    "untagged-port-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 5,
    "port" : "port",
    "single-bum-domain" : true,
    "outer-tpid" : "none"
  }, {
    "vlans" : "vlans",
    "outer-vlan" : 6,
    "vlan-range" : "vlan-range",
    "cos" : 0,
    "inner-cos" : 2,
    "active-ports" : "active-ports",
    "l2-learning" : "none",
    "outer-cos" : 5,
    "untagged-port-vlan" : 1,
    "api.switch-name" : "api.switch-name",
    "inner-vlan" : 5,
    "port" : "port",
    "single-bum-domain" : true,
    "outer-tpid" : "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 bridge-domain-port-show-response
Up
put /bridge-domains/name={name},vnet-id={vnet-id}/ports/port={port}
(updateBrDomPortByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter
port (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "status" : "status"
  }, {
    "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",
    "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 cert-show-response
Up
get /certs
(showCertCommons)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "status" : "status"
  }, {
    "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",
    "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 cert-show-response
Up
get /certs/switch-show
(switchShowCertCommon)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "status" : "status"
  }, {
    "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",
    "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 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "fast_port_down" : true,
    "defer-node-2-ports" : "defer-node-2-ports",
    "vlag-port-staggered-interval" : 0,
    "api.switch-name" : "api.switch-name",
    "defer-node-1-ports" : "defer-node-1-ports"
  }, {
    "fast_port_down" : true,
    "defer-node-2-ports" : "defer-node-2-ports",
    "vlag-port-staggered-interval" : 0,
    "api.switch-name" : "api.switch-name",
    "defer-node-1-ports" : "defer-node-1-ports"
  } ]
}

Produces

This API call produces the 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Produces

This API call produces the 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

Example data

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

Produces

This API call produces the 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

ClusterVrrpOptimize

Up
get /cluster-vrrp-optimize
(showVrrpOptimize)

Consumes

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

Return type

Example data

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

Produces

This API call produces the 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-vrrp-optimize-show-response
Up
put /cluster-vrrp-optimize
(updateVrrpOptimize)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Produces

This API call produces the 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

Example data

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

Produces

This API call produces the 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

Example data

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

Produces

This API call produces the 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "client-server-stats-max-memory" : 7,
    "service-stat-max-cnt" : 1,
    "client-server-stats-max-cnt" : 3,
    "connection-stats-cur-cnt" : 6,
    "connection-max-memory" : 4,
    "nv-queue-max-pkts" : 6,
    "fabric-connection-max-count" : 5,
    "api.switch-name" : "api.switch-name",
    "connection-stats-max-cnt" : 0,
    "service-stat-cur-cnt" : 5,
    "client-server-stats-cur-cnt" : 2,
    "service-stat-max-memory" : 1,
    "connection-current-count" : 9,
    "fabric-connection-current-count" : 2,
    "fabric-connection-max-memory" : 1,
    "enable" : true,
    "connection-max-count" : 7,
    "connection-stats-max-memory" : 1
  }, {
    "client-server-stats-max-memory" : 7,
    "service-stat-max-cnt" : 1,
    "client-server-stats-max-cnt" : 3,
    "connection-stats-cur-cnt" : 6,
    "connection-max-memory" : 4,
    "nv-queue-max-pkts" : 6,
    "fabric-connection-max-count" : 5,
    "api.switch-name" : "api.switch-name",
    "connection-stats-max-cnt" : 0,
    "service-stat-cur-cnt" : 5,
    "client-server-stats-cur-cnt" : 2,
    "service-stat-max-memory" : 1,
    "connection-current-count" : 9,
    "fabric-connection-current-count" : 2,
    "fabric-connection-max-memory" : 1,
    "enable" : true,
    "connection-max-count" : 7,
    "connection-stats-max-memory" : 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 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 6,
    "caller" : "Unknown",
    "odrops" : 2,
    "idrops" : 1,
    "opkts" : 5,
    "interval" : 6,
    "idrops-qfull" : 1,
    "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" : 6,
    "caller" : "Unknown",
    "odrops" : 2,
    "idrops" : 1,
    "opkts" : 5,
    "interval" : 6,
    "idrops-qfull" : 1,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 6,
    "caller" : "Unknown",
    "odrops" : 2,
    "idrops" : 1,
    "opkts" : 5,
    "interval" : 6,
    "idrops-qfull" : 1,
    "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" : 6,
    "caller" : "Unknown",
    "odrops" : 2,
    "idrops" : 1,
    "opkts" : 5,
    "interval" : 6,
    "idrops-qfull" : 1,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "client-port" : 6,
    "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" : 1,
    "mac" : "mac",
    "last-msg-time" : "last-msg-time",
    "vlan" : 0,
    "port" : "port",
    "vnet-id" : "vnet-id",
    "last-msg" : "-"
  }, {
    "client-port" : 6,
    "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" : 1,
    "mac" : "mac",
    "last-msg-time" : "last-msg-time",
    "vlan" : 0,
    "port" : "port",
    "vnet-id" : "vnet-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

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Example data

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

EapHostProfiles

Up
post /eap-host-profiles
(createEapHostProfile)

Consumes

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

Request body

body eap-host-profile-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /eap-host-profiles/{name}
(deleteEapHostProfileByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /eap-host-profiles/{name}
(showEapHostProfileByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mode" : "md5",
    "identity" : "identity",
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  }, {
    "mode" : "md5",
    "identity" : "identity",
    "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 eap-host-profile-show-response
Up
get /eap-host-profiles
(showEapHostProfiles)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mode" : "md5",
    "identity" : "identity",
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name"
  }, {
    "mode" : "md5",
    "identity" : "identity",
    "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 eap-host-profile-show-response
Up
put /eap-host-profiles/{name}
(updateEapHostProfileByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body eap-host-profile-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

EvpnChecks

Up
get /evpn-checks
(showEvpns)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "data1" : "data1",
    "api.switch-name" : "api.switch-name"
  }, {
    "data1" : "data1",
    "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 evpn-check-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

FabricEvpnNodes

Up
get /fabric-evpn-nodes
(showFabricEvpnSwitchInfos)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "evpn-node" : "evpn-node",
    "api.switch-name" : "api.switch-name",
    "fabric-pod" : "fabric-pod",
    "version" : "version",
    "evpn-role" : "primary",
    "vtep-ip" : "vtep-ip"
  }, {
    "evpn-node" : "evpn-node",
    "api.switch-name" : "api.switch-name",
    "fabric-pod" : "fabric-pod",
    "version" : "version",
    "evpn-role" : "primary",
    "vtep-ip" : "vtep-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 fabric-evpn-node-show-response

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 5,
    "vmgmt-wake-on-lan" : true,
    "vmgmt-vrf" : "vmgmt-vrf",
    "mgmt-linklocal" : "mgmt-linklocal",
    "device-state" : "device-state",
    "vmgmt-assignment2" : "none",
    "in-band-assignment-linklocal" : "none",
    "mgmt-ipv6-unnumbered" : true,
    "in-band-ip" : "in-band-ip",
    "mgmt-if-nat-realm" : "internal",
    "state" : "offline",
    "id" : 4,
    "mgmt-netmask" : 1,
    "cluster-id" : "cluster-id",
    "rollforward-failed" : true,
    "in-band-secondary-macs" : "in-band-secondary-macs",
    "in-band-vrf" : "in-band-vrf",
    "mgmt-ip2" : "mgmt-ip2",
    "in-band-vnet-id" : "in-band-vnet-id",
    "vmgmt-public-vlan" : 0,
    "mgmt-vnet-id" : "mgmt-vnet-id",
    "vmgmt-vnet-id" : "vmgmt-vnet-id",
    "in-band-public-vlan" : 5,
    "version" : "version",
    "in-band-netmask" : 6,
    "in-band-linklocal" : "in-band-linklocal",
    "fab-id" : "fab-id",
    "in-band-bd" : "in-band-bd",
    "in-band-wake-on-lan" : true,
    "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",
    "mgmt-vrf" : "mgmt-vrf",
    "control-network" : "in-band",
    "firmware-upgrade" : "firmware-upgrade",
    "mgmt-wake-on-lan" : true,
    "fabric-network" : "in-band",
    "mgmt-public-vlan" : 9,
    "serial" : "serial",
    "local-mac" : "local-mac",
    "fab-tid" : 1,
    "in-band-assignment2" : "none",
    "vmgmt-vlan" : 1,
    "in-band-netmask2" : 1,
    "mgmt-sec-addresses" : 3,
    "vmgmt-netmask2" : 2,
    "mgmt-netmask2" : 7,
    "mgmt-secondary-macs" : "mgmt-secondary-macs",
    "vmgmt-sec-addresses" : 6
  }, {
    "vmgmt-ipv6-unnumbered" : true,
    "in-band-vlan" : 7,
    "in-band-if-nat-realm" : "internal",
    "mgmt-assignment-linklocal" : "none",
    "in-band-sec-addresses" : 5,
    "vmgmt-wake-on-lan" : true,
    "vmgmt-vrf" : "vmgmt-vrf",
    "mgmt-linklocal" : "mgmt-linklocal",
    "device-state" : "device-state",
    "vmgmt-assignment2" : "none",
    "in-band-assignment-linklocal" : "none",
    "mgmt-ipv6-unnumbered" : true,
    "in-band-ip" : "in-band-ip",
    "mgmt-if-nat-realm" : "internal",
    "state" : "offline",
    "id" : 4,
    "mgmt-netmask" : 1,
    "cluster-id" : "cluster-id",
    "rollforward-failed" : true,
    "in-band-secondary-macs" : "in-band-secondary-macs",
    "in-band-vrf" : "in-band-vrf",
    "mgmt-ip2" : "mgmt-ip2",
    "in-band-vnet-id" : "in-band-vnet-id",
    "vmgmt-public-vlan" : 0,
    "mgmt-vnet-id" : "mgmt-vnet-id",
    "vmgmt-vnet-id" : "vmgmt-vnet-id",
    "in-band-public-vlan" : 5,
    "version" : "version",
    "in-band-netmask" : 6,
    "in-band-linklocal" : "in-band-linklocal",
    "fab-id" : "fab-id",
    "in-band-bd" : "in-band-bd",
    "in-band-wake-on-lan" : true,
    "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",
    "mgmt-vrf" : "mgmt-vrf",
    "control-network" : "in-band",
    "firmware-upgrade" : "firmware-upgrade",
    "mgmt-wake-on-lan" : true,
    "fabric-network" : "in-band",
    "mgmt-public-vlan" : 9,
    "serial" : "serial",
    "local-mac" : "local-mac",
    "fab-tid" : 1,
    "in-band-assignment2" : "none",
    "vmgmt-vlan" : 1,
    "in-band-netmask2" : 1,
    "mgmt-sec-addresses" : 3,
    "vmgmt-netmask2" : 2,
    "mgmt-netmask2" : 7,
    "mgmt-secondary-macs" : "mgmt-secondary-macs",
    "vmgmt-sec-addresses" : 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 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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "cluster" : "cluster",
    "upload-server" : "upload-server",
    "log" : "log",
    "use-proxy" : true,
    "proxy-host" : "proxy-host",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "switch" : "switch",
    "download-count" : 6,
    "proxy-port" : 0,
    "version-available" : "version-available",
    "state" : "state",
    "track" : "track",
    "status" : "status"
  }, {
    "cluster" : "cluster",
    "upload-server" : "upload-server",
    "log" : "log",
    "use-proxy" : true,
    "proxy-host" : "proxy-host",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "switch" : "switch",
    "download-count" : 6,
    "proxy-port" : 0,
    "version-available" : "version-available",
    "state" : "state",
    "track" : "track",
    "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 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "proxy-port" : 0,
    "upload-server" : "upload-server",
    "use-proxy" : true,
    "version-available" : "version-available",
    "proxy-host" : "proxy-host",
    "track" : "track",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "status" : "status",
    "download-count" : 6
  }, {
    "proxy-port" : 0,
    "upload-server" : "upload-server",
    "use-proxy" : true,
    "version-available" : "version-available",
    "proxy-host" : "proxy-host",
    "track" : "track",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "status" : "status",
    "download-count" : 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 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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-vnics/delete
(ifDeleteFabricVnic)

Consumes

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

Request body

body fabric-vnic-delete (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "assignment2" : "none",
    "vlan" : 6,
    "netmask" : 0,
    "ip" : "ip",
    "nic" : "nic",
    "sec-addresses" : 5,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "assignment-linklocal" : "none",
    "mac" : "mac",
    "wake-on-lan" : true,
    "vrrp-priority" : 1
  }, {
    "assignment2" : "none",
    "vlan" : 6,
    "netmask" : 0,
    "ip" : "ip",
    "nic" : "nic",
    "sec-addresses" : 5,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "assignment-linklocal" : "none",
    "mac" : "mac",
    "wake-on-lan" : true,
    "vrrp-priority" : 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 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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "assignment2" : "none",
    "vlan" : 6,
    "netmask" : 0,
    "ip" : "ip",
    "nic" : "nic",
    "sec-addresses" : 5,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "assignment-linklocal" : "none",
    "mac" : "mac",
    "wake-on-lan" : true,
    "vrrp-priority" : 1
  }, {
    "assignment2" : "none",
    "vlan" : 6,
    "netmask" : 0,
    "ip" : "ip",
    "nic" : "nic",
    "sec-addresses" : 5,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "assignment-linklocal" : "none",
    "mac" : "mac",
    "wake-on-lan" : true,
    "vrrp-priority" : 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 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Produces

This API call produces the 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

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

Produces

This API call produces the 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

Example data

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

Produces

This API call produces the 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

Example data

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

Produces

This API call produces the 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "hw-id" : 1,
    "id" : 0,
    "api.switch-name" : "api.switch-name",
    "flow-hw-id" : 6,
    "flow-name" : "flow-name"
  }, {
    "name" : "name",
    "hw-id" : 1,
    "id" : 0,
    "api.switch-name" : "api.switch-name",
    "flow-hw-id" : 6,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "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 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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "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 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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vlan={vlan}
(deleteIgmpStaticGroupByUniqueKeyAll)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vlan={vlan}
(showIgmpStaticGroupByUniqueKeyAll)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlan" : 0,
    "group-ip" : "group-ip",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlan" : 0,
    "group-ip" : "group-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-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlan" : 0,
    "group-ip" : "group-ip",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlan" : 0,
    "group-ip" : "group-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-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vlan={vlan},source-ip={source-ip}
(deleteIgmpStaticSourceByUniqueKeyAll)

Path parameters

group-ip (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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vlan={vlan},source-ip={source-ip}
(showIgmpStaticSourceByUniqueKeyAll)

Path parameters

group-ip (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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "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 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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "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 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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "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",
    "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 igmp-show-response
Up
get /igmps
(showIgmpHosts)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "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",
    "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 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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
(createIpPool)

Consumes

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

Request body

body ip-pool-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "import-share" : "import-share",
    "storage-pool" : "storage-pool",
    "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"
  }, {
    "import-share" : "import-share",
    "storage-pool" : "storage-pool",
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "import-share" : "import-share",
    "storage-pool" : "storage-pool",
    "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"
  }, {
    "import-share" : "import-share",
    "storage-pool" : "storage-pool",
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

K8s

Up
get /k8s/{cluster-name}
(showK8sClusterByName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-name"
  }, {
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-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 k8s-show-response
Up
get /k8s/{cluster-name}/cnis/{cni-plugin}
(showK8sClusterCniByNameByName)

Path parameters

cluster-name (required)
Path Parameter
cni-plugin (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "older-than" : 5,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "cni-plugin" : "cni-plugin",
    "udp-port" : 2,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "network-type" : "network-type",
    "duration" : 6,
    "action" : "none",
    "backend" : "backend",
    "interval" : 1
  }, {
    "vxlan" : 0,
    "older-than" : 5,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "cni-plugin" : "cni-plugin",
    "udp-port" : 2,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "network-type" : "network-type",
    "duration" : 6,
    "action" : "none",
    "backend" : "backend",
    "interval" : 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 k8s-cni-show-response
Up
get /k8s/{cluster-name}/cnis
(showK8sClusterCnisByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "older-than" : 5,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "cni-plugin" : "cni-plugin",
    "udp-port" : 2,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "network-type" : "network-type",
    "duration" : 6,
    "action" : "none",
    "backend" : "backend",
    "interval" : 1
  }, {
    "vxlan" : 0,
    "older-than" : 5,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "cni-plugin" : "cni-plugin",
    "udp-port" : 2,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "network-type" : "network-type",
    "duration" : 6,
    "action" : "none",
    "backend" : "backend",
    "interval" : 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 k8s-cni-show-response
Up
get /k8s/{cluster-name}/connectivities
(showK8sClusterConnectivitiesByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "pod" : "pod",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "daemonset" : "daemonset",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "node" : "node",
    "service" : "service",
    "namespace" : "namespace",
    "action" : "none",
    "interval" : 6,
    "connections" : "connections",
    "deployment" : "deployment"
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "pod" : "pod",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "daemonset" : "daemonset",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "node" : "node",
    "service" : "service",
    "namespace" : "namespace",
    "action" : "none",
    "interval" : 6,
    "connections" : "connections",
    "deployment" : "deployment"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success k8s-connectivity-show-response
Up
get /k8s/{cluster-name}/daemonsets
(showK8sClusterDaemonsetsByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "desired-cnt" : 5,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "ready-cnt" : 2,
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "interval" : 6
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "desired-cnt" : 5,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "ready-cnt" : 2,
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "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 k8s-daemonset-show-response
Up
get /k8s/{cluster-name}/daemonsets/name={name},namespace={namespace}
(showK8sClusterDaemonsetsByNameUniqueKeyAll)

Path parameters

cluster-name (required)
Path Parameter
name (required)
Path Parameter
namespace (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "desired-cnt" : 5,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "ready-cnt" : 2,
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "interval" : 6
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "desired-cnt" : 5,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "ready-cnt" : 2,
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "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 k8s-daemonset-show-response
Up
get /k8s/{cluster-name}/deployments
(showK8sClusterDeploymentsByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 5,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "replicas" : 0,
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "ready-replicas" : 2,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "interval" : 1
  }, {
    "older-than" : 5,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "replicas" : 0,
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "ready-replicas" : 2,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "interval" : 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 k8s-deployment-show-response
Up
get /k8s/{cluster-name}/deployments/name={name},namespace={namespace}
(showK8sClusterDeploymentsByNameUniqueKeyAll)

Path parameters

cluster-name (required)
Path Parameter
name (required)
Path Parameter
namespace (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 5,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "replicas" : 0,
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "ready-replicas" : 2,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "interval" : 1
  }, {
    "older-than" : 5,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "replicas" : 0,
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "ready-replicas" : 2,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "interval" : 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 k8s-deployment-show-response
Up
get /k8s/{cluster-name}/endpoints
(showK8sClusterEndpointsByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "endpoints" : "endpoints",
    "start-time" : "start-time",
    "within-last" : 5,
    "target-ports" : "target-ports",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "interval" : 6
  }, {
    "older-than" : 1,
    "endpoints" : "endpoints",
    "start-time" : "start-time",
    "within-last" : 5,
    "target-ports" : "target-ports",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "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 k8s-endpoint-show-response
Up
get /k8s/{cluster-name}/endpoints/name={name},namespace={namespace}
(showK8sClusterEndpointsByNameUniqueKeyAll)

Path parameters

cluster-name (required)
Path Parameter
name (required)
Path Parameter
namespace (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "endpoints" : "endpoints",
    "start-time" : "start-time",
    "within-last" : 5,
    "target-ports" : "target-ports",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "interval" : 6
  }, {
    "older-than" : 1,
    "endpoints" : "endpoints",
    "start-time" : "start-time",
    "within-last" : 5,
    "target-ports" : "target-ports",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "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 k8s-endpoint-show-response
Up
get /k8s/{cluster-name}/impacts/host/{host}
(showK8sClusterImpactByNameByHost)

Path parameters

cluster-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "pod" : "pod",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "impact" : "unknown",
    "daemonset" : "daemonset",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "switch" : "switch",
    "duration" : 0,
    "service" : "service",
    "host" : "host",
    "namespace" : "namespace",
    "action" : "none",
    "interval" : 6,
    "connections" : "connections",
    "deployment" : "deployment"
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "pod" : "pod",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "impact" : "unknown",
    "daemonset" : "daemonset",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "switch" : "switch",
    "duration" : 0,
    "service" : "service",
    "host" : "host",
    "namespace" : "namespace",
    "action" : "none",
    "interval" : 6,
    "connections" : "connections",
    "deployment" : "deployment"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success k8s-impact-show-response
Up
get /k8s/{cluster-name}/impacts/switch/{switch}
(showK8sClusterImpactByNameBySwitchName)

Path parameters

cluster-name (required)
Path Parameter
switch (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "pod" : "pod",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "impact" : "unknown",
    "daemonset" : "daemonset",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "switch" : "switch",
    "duration" : 0,
    "service" : "service",
    "host" : "host",
    "namespace" : "namespace",
    "action" : "none",
    "interval" : 6,
    "connections" : "connections",
    "deployment" : "deployment"
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "pod" : "pod",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "impact" : "unknown",
    "daemonset" : "daemonset",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "switch" : "switch",
    "duration" : 0,
    "service" : "service",
    "host" : "host",
    "namespace" : "namespace",
    "action" : "none",
    "interval" : 6,
    "connections" : "connections",
    "deployment" : "deployment"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success k8s-impact-show-response
Up
get /k8s/{cluster-name}/impacts
(showK8sClusterImpactsByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "pod" : "pod",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "impact" : "unknown",
    "daemonset" : "daemonset",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "switch" : "switch",
    "duration" : 0,
    "service" : "service",
    "host" : "host",
    "namespace" : "namespace",
    "action" : "none",
    "interval" : 6,
    "connections" : "connections",
    "deployment" : "deployment"
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "pod" : "pod",
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "impact" : "unknown",
    "daemonset" : "daemonset",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "switch" : "switch",
    "duration" : 0,
    "service" : "service",
    "host" : "host",
    "namespace" : "namespace",
    "action" : "none",
    "interval" : 6,
    "connections" : "connections",
    "deployment" : "deployment"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success k8s-impact-show-response
Up
get /k8s/{cluster-name}/ingresses
(showK8sClusterIngressesByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "service-port" : "service-port",
    "resource-name" : "resource-name",
    "api.switch-name" : "api.switch-name",
    "resource-kind" : "resource-kind",
    "since-start" : true,
    "duration" : 0,
    "path" : "path",
    "service-name" : "service-name",
    "resource-api-group" : "resource-api-group",
    "name" : "name",
    "namespace" : "namespace",
    "host" : "host",
    "action" : "none",
    "interval" : 6
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "service-port" : "service-port",
    "resource-name" : "resource-name",
    "api.switch-name" : "api.switch-name",
    "resource-kind" : "resource-kind",
    "since-start" : true,
    "duration" : 0,
    "path" : "path",
    "service-name" : "service-name",
    "resource-api-group" : "resource-api-group",
    "name" : "name",
    "namespace" : "namespace",
    "host" : "host",
    "action" : "none",
    "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 k8s-ingress-show-response
Up
get /k8s/{cluster-name}/ingresses/name={name},namespace={namespace}
(showK8sClusterIngressesByNameUniqueKeyAll)

Path parameters

cluster-name (required)
Path Parameter
name (required)
Path Parameter
namespace (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "service-port" : "service-port",
    "resource-name" : "resource-name",
    "api.switch-name" : "api.switch-name",
    "resource-kind" : "resource-kind",
    "since-start" : true,
    "duration" : 0,
    "path" : "path",
    "service-name" : "service-name",
    "resource-api-group" : "resource-api-group",
    "name" : "name",
    "namespace" : "namespace",
    "host" : "host",
    "action" : "none",
    "interval" : 6
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "service-port" : "service-port",
    "resource-name" : "resource-name",
    "api.switch-name" : "api.switch-name",
    "resource-kind" : "resource-kind",
    "since-start" : true,
    "duration" : 0,
    "path" : "path",
    "service-name" : "service-name",
    "resource-api-group" : "resource-api-group",
    "name" : "name",
    "namespace" : "namespace",
    "host" : "host",
    "action" : "none",
    "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 k8s-ingress-show-response
Up
get /k8s/{cluster-name}/nodes/{node}
(showK8sClusterKnodeByNameByName)

Path parameters

cluster-name (required)
Path Parameter
node (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "role" : "role",
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ip" : "ip",
    "pod-CIDR" : "pod-CIDR",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "labels" : "labels",
    "duration" : 0,
    "node" : "node",
    "action" : "none",
    "interval" : 6,
    "status" : "status"
  }, {
    "older-than" : 1,
    "role" : "role",
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ip" : "ip",
    "pod-CIDR" : "pod-CIDR",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "labels" : "labels",
    "duration" : 0,
    "node" : "node",
    "action" : "none",
    "interval" : 6,
    "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 k8s-node-show-response
Up
get /k8s/{cluster-name}/nodes
(showK8sClusterKnodesByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "role" : "role",
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ip" : "ip",
    "pod-CIDR" : "pod-CIDR",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "labels" : "labels",
    "duration" : 0,
    "node" : "node",
    "action" : "none",
    "interval" : 6,
    "status" : "status"
  }, {
    "older-than" : 1,
    "role" : "role",
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ip" : "ip",
    "pod-CIDR" : "pod-CIDR",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "labels" : "labels",
    "duration" : 0,
    "node" : "node",
    "action" : "none",
    "interval" : 6,
    "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 k8s-node-show-response
Up
get /k8s/{cluster-name}/clusters/{control-plane-node}
(showK8sClusterMasterByNameByName)

Path parameters

cluster-name (required)
Path Parameter
control-plane-node (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "control-plane-node" : "control-plane-node",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "action" : "none",
    "controller-status" : "controller-status",
    "scheduler-status" : "scheduler-status",
    "interval" : 6,
    "control-plane-node-ip" : "control-plane-node-ip"
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "control-plane-node" : "control-plane-node",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "action" : "none",
    "controller-status" : "controller-status",
    "scheduler-status" : "scheduler-status",
    "interval" : 6,
    "control-plane-node-ip" : "control-plane-node-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 k8s-cluster-show-response
Up
get /k8s/{cluster-name}/clusters
(showK8sClusterMastersByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "control-plane-node" : "control-plane-node",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "action" : "none",
    "controller-status" : "controller-status",
    "scheduler-status" : "scheduler-status",
    "interval" : 6,
    "control-plane-node-ip" : "control-plane-node-ip"
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "control-plane-node" : "control-plane-node",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "action" : "none",
    "controller-status" : "controller-status",
    "scheduler-status" : "scheduler-status",
    "interval" : 6,
    "control-plane-node-ip" : "control-plane-node-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 k8s-cluster-show-response
Up
get /k8s/{cluster-name}/networks
(showK8sClusterNetworksByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "service-name" : "service-name",
    "endpoints" : "endpoints",
    "ingress-name" : "ingress-name",
    "namespace" : "namespace",
    "host" : "host",
    "selector" : "selector",
    "type" : "type",
    "api.switch-name" : "api.switch-name",
    "node-port" : "node-port",
    "external-ip" : "external-ip"
  }, {
    "service-name" : "service-name",
    "endpoints" : "endpoints",
    "ingress-name" : "ingress-name",
    "namespace" : "namespace",
    "host" : "host",
    "selector" : "selector",
    "type" : "type",
    "api.switch-name" : "api.switch-name",
    "node-port" : "node-port",
    "external-ip" : "external-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 k8s-network-show-response
Up
get /k8s/{cluster-name}/networks/namespace={namespace},ingress-name={ingress-name}
(showK8sClusterNetworksByNameUniqueKeyAll)

Path parameters

cluster-name (required)
Path Parameter
namespace (required)
Path Parameter
ingress-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "service-name" : "service-name",
    "endpoints" : "endpoints",
    "ingress-name" : "ingress-name",
    "namespace" : "namespace",
    "host" : "host",
    "selector" : "selector",
    "type" : "type",
    "api.switch-name" : "api.switch-name",
    "node-port" : "node-port",
    "external-ip" : "external-ip"
  }, {
    "service-name" : "service-name",
    "endpoints" : "endpoints",
    "ingress-name" : "ingress-name",
    "namespace" : "namespace",
    "host" : "host",
    "selector" : "selector",
    "type" : "type",
    "api.switch-name" : "api.switch-name",
    "node-port" : "node-port",
    "external-ip" : "external-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 k8s-network-show-response
Up
get /k8s/{cluster-name}/pods
(showK8sClusterPodsByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ip" : "ip",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "labels" : "labels",
    "duration" : 0,
    "node" : "node",
    "container-state" : "container-state",
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "containers" : "containers",
    "interval" : 6,
    "state" : "state"
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ip" : "ip",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "labels" : "labels",
    "duration" : 0,
    "node" : "node",
    "container-state" : "container-state",
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "containers" : "containers",
    "interval" : 6,
    "state" : "state"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success k8s-pod-show-response
Up
get /k8s/{cluster-name}/pods/name={name},namespace={namespace}
(showK8sClusterPodsByNameUniqueKeyAll)

Path parameters

cluster-name (required)
Path Parameter
name (required)
Path Parameter
namespace (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ip" : "ip",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "labels" : "labels",
    "duration" : 0,
    "node" : "node",
    "container-state" : "container-state",
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "containers" : "containers",
    "interval" : 6,
    "state" : "state"
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ip" : "ip",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "labels" : "labels",
    "duration" : 0,
    "node" : "node",
    "container-state" : "container-state",
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "containers" : "containers",
    "interval" : 6,
    "state" : "state"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success k8s-pod-show-response
Up
get /k8s/{cluster-name}/services
(showK8sClusterServicesByK8sClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ports" : "ports",
    "type" : "type",
    "api.switch-name" : "api.switch-name",
    "external-ip" : "external-ip",
    "since-start" : true,
    "service-ip" : "service-ip",
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "interval" : 6
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ports" : "ports",
    "type" : "type",
    "api.switch-name" : "api.switch-name",
    "external-ip" : "external-ip",
    "since-start" : true,
    "service-ip" : "service-ip",
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "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 k8s-service-show-response
Up
get /k8s/{cluster-name}/services/name={name},namespace={namespace}
(showK8sClusterServicesByNameUniqueKeyAll)

Path parameters

cluster-name (required)
Path Parameter
name (required)
Path Parameter
namespace (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ports" : "ports",
    "type" : "type",
    "api.switch-name" : "api.switch-name",
    "external-ip" : "external-ip",
    "since-start" : true,
    "service-ip" : "service-ip",
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "interval" : 6
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "last-changed" : "last-changed",
    "end-time" : "end-time",
    "ports" : "ports",
    "type" : "type",
    "api.switch-name" : "api.switch-name",
    "external-ip" : "external-ip",
    "since-start" : true,
    "service-ip" : "service-ip",
    "duration" : 0,
    "name" : "name",
    "namespace" : "namespace",
    "action" : "none",
    "selector" : "selector",
    "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 k8s-service-show-response
Up
get /k8s
(showK8sClusters)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-name"
  }, {
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-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 k8s-show-response

K8sConnections

Up
post /k8s-connections
(createK8sConn)

Consumes

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

Request body

body k8s-connection-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /k8s-connections/{cluster-name}
(deleteK8sConnByClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /k8s-connections/{cluster-name}
(showK8sConnByClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "disk-space" : 6,
    "k8s-vlan" : 0,
    "kube-config" : "kube-config",
    "track-history" : true,
    "overlay-vxlan-analytics" : true,
    "create-vport" : true,
    "api-server" : "api-server",
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-name",
    "enable" : true,
    "connected-at" : "connected-at",
    "rest-user" : "rest-user",
    "connection-error" : "connection-error",
    "status" : "none"
  }, {
    "disk-space" : 6,
    "k8s-vlan" : 0,
    "kube-config" : "kube-config",
    "track-history" : true,
    "overlay-vxlan-analytics" : true,
    "create-vport" : true,
    "api-server" : "api-server",
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-name",
    "enable" : true,
    "connected-at" : "connected-at",
    "rest-user" : "rest-user",
    "connection-error" : "connection-error",
    "status" : "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 k8s-connection-show-response
Up
get /k8s-connections
(showK8sConns)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "disk-space" : 6,
    "k8s-vlan" : 0,
    "kube-config" : "kube-config",
    "track-history" : true,
    "overlay-vxlan-analytics" : true,
    "create-vport" : true,
    "api-server" : "api-server",
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-name",
    "enable" : true,
    "connected-at" : "connected-at",
    "rest-user" : "rest-user",
    "connection-error" : "connection-error",
    "status" : "none"
  }, {
    "disk-space" : 6,
    "k8s-vlan" : 0,
    "kube-config" : "kube-config",
    "track-history" : true,
    "overlay-vxlan-analytics" : true,
    "create-vport" : true,
    "api-server" : "api-server",
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-name",
    "enable" : true,
    "connected-at" : "connected-at",
    "rest-user" : "rest-user",
    "connection-error" : "connection-error",
    "status" : "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 k8s-connection-show-response
Up
put /k8s-connections/{cluster-name}
(updateK8sConnByClusterName)

Path parameters

cluster-name (required)
Path Parameter

Consumes

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

Request body

body k8s-connection-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

K8sTraces

Up
get /k8s-traces/src-node={src-node},dest-node={dest-node}
(showPodToPodPathsBySrcNodeDestNode)

Path parameters

src-node (required)
Path Parameter
dest-node (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "src-pod" : "src-pod",
    "dest-pod" : "dest-pod",
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-name"
  }, {
    "src-pod" : "src-pod",
    "dest-pod" : "dest-pod",
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-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 k8s-trace-show-response
Up
get /k8s-traces/src-pod={src-pod},dest-pod={dest-pod}
(showPodToPodPathsBySrcPodDestPod)

Path parameters

src-pod (required)
Path Parameter
dest-pod (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "src-pod" : "src-pod",
    "dest-pod" : "dest-pod",
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-name"
  }, {
    "src-pod" : "src-pod",
    "dest-pod" : "dest-pod",
    "api.switch-name" : "api.switch-name",
    "cluster-name" : "cluster-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 k8s-trace-show-response

L2Checks

Up
get /l2-checks/fix
(fixL2Check)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "bd" : "bd",
    "sw-port" : 1,
    "fix-action" : "none",
    "hw-state" : "active",
    "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,
    "fix-action" : "none",
    "hw-state" : "active",
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "bd" : "bd",
    "sw-port" : 1,
    "fix-action" : "none",
    "hw-state" : "active",
    "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,
    "fix-action" : "none",
    "hw-state" : "active",
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "bd" : "bd",
    "sw-port" : 1,
    "fix-action" : "none",
    "hw-state" : "active",
    "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,
    "fix-action" : "none",
    "hw-state" : "active",
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 8,
    "reason" : "activate",
    "within-last" : 9,
    "alt-owner-port" : 4,
    "last-reason" : "activate",
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 0,
    "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" : 6,
    "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" : 6,
    "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" : 8,
    "reason" : "activate",
    "within-last" : 9,
    "alt-owner-port" : 4,
    "last-reason" : "activate",
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 0,
    "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" : 6,
    "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" : 6,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 8,
    "reason" : "activate",
    "within-last" : 9,
    "alt-owner-port" : 4,
    "last-reason" : "activate",
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 0,
    "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" : 6,
    "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" : 6,
    "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" : 8,
    "reason" : "activate",
    "within-last" : 9,
    "alt-owner-port" : 4,
    "last-reason" : "activate",
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 0,
    "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" : 6,
    "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" : 6,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 0,
    "aging-time" : 9,
    "l3-arp-cur-mem" : 7,
    "l2-max-count" : 3,
    "l2-max-mem" : 1,
    "api.switch-name" : "api.switch-name",
    "l2-checker-interval" : 2,
    "software-aging" : true,
    "l3-arp-max-count" : 4,
    "l2-active-count" : 6,
    "l2-cur-mem" : 5,
    "l3-arp-max-mem" : 2
  }, {
    "l3-arp-cur-count" : 5,
    "l2-checker" : true,
    "l2-cur-count" : 0,
    "aging-time" : 9,
    "l3-arp-cur-mem" : 7,
    "l2-max-count" : 3,
    "l2-max-mem" : 1,
    "api.switch-name" : "api.switch-name",
    "l2-checker-interval" : 2,
    "software-aging" : true,
    "l3-arp-max-count" : 4,
    "l2-active-count" : 6,
    "l2-cur-mem" : 5,
    "l3-arp-max-mem" : 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 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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vlan={vlan}/ports
(addL2StaticMulticastGroupPortByUniqueKeyAll)

Path parameters

group-mac (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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vlan={vlan}
(deleteL2StaticMulticastGroupByUniqueKeyAll)

Path parameters

group-mac (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vlan={vlan}/ports
(removeL2StaticMulticastGroupPortByUniqueKeyAll)

Path parameters

group-mac (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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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},vlan={vlan}
(showL2StaticMulticastGroupByUniqueKeyAll)

Path parameters

group-mac (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlan" : 0,
    "group-mac" : "group-mac",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlan" : 0,
    "group-mac" : "group-mac",
    "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
(showL2StaticMulticastGroups)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlan" : 0,
    "group-mac" : "group-mac",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlan" : 0,
    "group-mac" : "group-mac",
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 3,
    "local-intf" : 5,
    "public-vlan" : 1,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 5,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 2,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 6,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 1,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 4,
    "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" : 7,
    "intf" : 1,
    "alt-owner-state" : "active",
    "rem-intf" : 9,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 7,
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  }, {
    "alt-owner-port" : 7,
    "vnic-type" : "untagged",
    "hostname" : "hostname",
    "hit" : 3,
    "local-intf" : 5,
    "public-vlan" : 1,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 5,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 2,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 6,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 1,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 4,
    "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" : 7,
    "intf" : 1,
    "alt-owner-state" : "active",
    "rem-intf" : 9,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 7,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 3,
    "local-intf" : 5,
    "public-vlan" : 1,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 5,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 2,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 6,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 1,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 4,
    "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" : 7,
    "intf" : 1,
    "alt-owner-state" : "active",
    "rem-intf" : 9,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 7,
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  }, {
    "alt-owner-port" : 7,
    "vnic-type" : "untagged",
    "hostname" : "hostname",
    "hit" : 3,
    "local-intf" : 5,
    "public-vlan" : 1,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 5,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 2,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 6,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 1,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 4,
    "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" : 7,
    "intf" : 1,
    "alt-owner-state" : "active",
    "rem-intf" : 9,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 7,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 8,
    "reason" : "activate",
    "within-last" : 9,
    "alt-owner-port" : 4,
    "last-reason" : "activate",
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 0,
    "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" : 6,
    "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" : 6,
    "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" : 8,
    "reason" : "activate",
    "within-last" : 9,
    "alt-owner-port" : 4,
    "last-reason" : "activate",
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 0,
    "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" : 6,
    "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" : 6,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 8,
    "reason" : "activate",
    "within-last" : 9,
    "alt-owner-port" : 4,
    "last-reason" : "activate",
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 0,
    "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" : 6,
    "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" : 6,
    "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" : 8,
    "reason" : "activate",
    "within-last" : 9,
    "alt-owner-port" : 4,
    "last-reason" : "activate",
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 0,
    "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" : 6,
    "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" : 6,
    "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

L3Routes

Up
get /l3-routes/vrf_name={vrf_name},vrf_vnet={vrf_vnet},network={network},netmask={netmask},gateway-ip={gateway-ip}
(showL3RouteByUniqueKeyAll)

Path parameters

vrf_name (required)
Path Parameter
vrf_vnet (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
gateway-ip (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "owner" : 6,
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "router-mac" : "router-mac",
    "api.switch-name" : "api.switch-name",
    "vrf_name" : "vrf_name",
    "vrf_vnet" : "vrf_vnet",
    "network" : "network"
  }, {
    "owner" : 6,
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "router-mac" : "router-mac",
    "api.switch-name" : "api.switch-name",
    "vrf_name" : "vrf_name",
    "vrf_vnet" : "vrf_vnet",
    "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 l3-route-show-response
Up
get /l3-routes
(showL3Routes)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "owner" : 6,
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "router-mac" : "router-mac",
    "api.switch-name" : "api.switch-name",
    "vrf_name" : "vrf_name",
    "vrf_vnet" : "vrf_vnet",
    "network" : "network"
  }, {
    "owner" : 6,
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "router-mac" : "router-mac",
    "api.switch-name" : "api.switch-name",
    "vrf_name" : "vrf_name",
    "vrf_vnet" : "vrf_vnet",
    "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 l3-route-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "owner" : 1,
    "bd" : "bd",
    "intf" : 3,
    "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" : 7,
    "egress-id" : 9,
    "alt-owner" : 5,
    "hit" : 5,
    "rt-if" : "rt-if",
    "vlan" : 0,
    "peer-state" : "active",
    "public-vlan" : 2,
    "state" : "active",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 6,
    "owner" : 1,
    "bd" : "bd",
    "intf" : 3,
    "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" : 7,
    "egress-id" : 9,
    "alt-owner" : 5,
    "hit" : 5,
    "rt-if" : "rt-if",
    "vlan" : 0,
    "peer-state" : "active",
    "public-vlan" : 2,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "owner" : 1,
    "bd" : "bd",
    "intf" : 3,
    "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" : 7,
    "egress-id" : 9,
    "alt-owner" : 5,
    "hit" : 5,
    "rt-if" : "rt-if",
    "vlan" : 0,
    "peer-state" : "active",
    "public-vlan" : 2,
    "state" : "active",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 6,
    "owner" : 1,
    "bd" : "bd",
    "intf" : 3,
    "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" : 7,
    "egress-id" : 9,
    "alt-owner" : 5,
    "hit" : 5,
    "rt-if" : "rt-if",
    "vlan" : 0,
    "peer-state" : "active",
    "public-vlan" : 2,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "bezel-port" : "bezel-port",
    "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",
    "bezel-port" : "bezel-port",
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "bezel-port" : "bezel-port",
    "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",
    "bezel-port" : "bezel-port",
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "bezel-port" : "bezel-port",
    "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",
    "bezel-port" : "bezel-port",
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "bezel-port" : "bezel-port",
    "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",
    "bezel-port" : "bezel-port",
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 9,
    "code" : 6,
    "start-time" : "start-time",
    "within-last" : 3,
    "cur-interval" : 5,
    "end-time" : "end-time",
    "count" : 1,
    "last-message" : "last-message",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "switch" : 5,
    "duration" : 2,
    "port" : 0,
    "name" : "name",
    "interval" : 7,
    "time" : "time"
  }, {
    "older-than" : 9,
    "code" : 6,
    "start-time" : "start-time",
    "within-last" : 3,
    "cur-interval" : 5,
    "end-time" : "end-time",
    "count" : 1,
    "last-message" : "last-message",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "switch" : 5,
    "duration" : 2,
    "port" : 0,
    "name" : "name",
    "interval" : 7,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /log-archival-schedule
(modifyLogArchivalScheduleByUsage1)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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/files-show
(showListLogArchivalSchedule)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "archive-server-path" : "archive-server-path",
    "archive-interval" : 0,
    "key-auth" : true,
    "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,
    "key-auth" : true,
    "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
get /log-archival-schedule
(showLogArchivalSchedule)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "archive-server-path" : "archive-server-path",
    "archive-interval" : 0,
    "key-auth" : true,
    "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,
    "key-auth" : true,
    "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

LogArchivalScheduleSshKeies

Up
post /log-archival-schedule-ssh-keies/clear
(clearLogArchivalScheduleSshKey)

Consumes

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

Request body

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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-ssh-keies/export
(exportLogArchivalScheduleSshKey)

Consumes

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

Request body

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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-ssh-keies/gen
(genLogArchivalScheduleSshKey)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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-ssh-keies/import
(importLogArchivalScheduleSshKey)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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-ssh-keies
(showLogArchivalScheduleSshKeies)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "key-bits" : 0,
    "key-type" : "rsa",
    "file-private-key" : "file-private-key",
    "file-public-key" : "file-public-key",
    "api.switch-name" : "api.switch-name"
  }, {
    "key-bits" : 0,
    "key-type" : "rsa",
    "file-private-key" : "file-private-key",
    "file-public-key" : "file-public-key",
    "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-ssh-key-show-response

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /log-audit-exceptions/type={type},pattern={pattern},access={access}
(deleteLogAuditExceptionByUniqueKeyAll)

Path parameters

type (required)
Path Parameter
pattern (required)
Path Parameter
access (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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-audit-exceptions/type={type},pattern={pattern},access={access}
(showLogAuditExceptionByUniqueKeyAll)

Path parameters

type (required)
Path Parameter
pattern (required)
Path Parameter
access (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "access" : "any",
    "scope" : "local",
    "pattern" : "pattern",
    "type" : "cli",
    "api.switch-name" : "api.switch-name"
  }, {
    "access" : "any",
    "scope" : "local",
    "pattern" : "pattern",
    "type" : "cli",
    "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-audit-exception-show-response
Up
get /log-audit-exceptions
(showLogAuditExceptions)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "access" : "any",
    "scope" : "local",
    "pattern" : "pattern",
    "type" : "cli",
    "api.switch-name" : "api.switch-name"
  }, {
    "access" : "any",
    "scope" : "local",
    "pattern" : "pattern",
    "type" : "cli",
    "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-audit-exception-show-response

LogAudits

Up
get /log-audits
(showAuditLogs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "time" : "time",
    "user" : "user"
  }, {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "time" : "time",
    "user" : "user"
  } ]
}

Produces

This API call produces the 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-audit-show-response

LogDatetimeFmtMode

Up
get /log-datetime-fmt-mode
(showDatetimefmt)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "classic-mode" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "classic-mode" : 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-datetime-fmt-mode-show-response
Up
put /log-datetime-fmt-mode
(updateDatetimefmt)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

LogEventSettings

Up
get /log-event-settings
(showLogEventSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "tcp" : true,
    "vdp" : true,
    "mld" : true,
    "vport" : true,
    "mroute" : true,
    "storage" : true,
    "tacacs" : true,
    "api.switch-name" : "api.switch-name",
    "ptp" : true,
    "stp" : true,
    "igmp" : true,
    "lacp" : true,
    "evb" : true,
    "lacp-port-event" : true,
    "system" : true,
    "ecp" : true,
    "port" : true,
    "lldp" : true
  }, {
    "tcp" : true,
    "vdp" : true,
    "mld" : true,
    "vport" : true,
    "mroute" : true,
    "storage" : true,
    "tacacs" : true,
    "api.switch-name" : "api.switch-name",
    "ptp" : true,
    "stp" : true,
    "igmp" : true,
    "lacp" : true,
    "evb" : true,
    "lacp-port-event" : true,
    "system" : true,
    "ecp" : true,
    "port" : true,
    "lldp" : 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 log-event-settings-show-response
Up
put /log-event-settings
(updateLogEventSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

LogEvents

Up
get /log-events
(showEventLogs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "event-type" : "system",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "time" : "time"
  }, {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "event-type" : "system",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "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-event-show-response

LogSessions

Up
get /log-sessions
(showSessionLogs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "time" : "time",
    "user" : "user"
  }, {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "time" : "time",
    "user" : "user"
  } ]
}

Produces

This API call produces the 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-session-show-response

LogSystemCounters

Up
post /log-system-counters/reset
(resetSystemLogCounters)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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-system-counters
(showSystemLogCounters)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "warn" : 1,
    "note" : 5,
    "critical" : 0,
    "reset-time" : "reset-time",
    "error" : 6,
    "api.switch-name" : "api.switch-name",
    "info" : 5
  }, {
    "warn" : 1,
    "note" : 5,
    "critical" : 0,
    "reset-time" : "reset-time",
    "error" : 6,
    "api.switch-name" : "api.switch-name",
    "info" : 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 log-system-counters-show-response

LogSystems

Up
get /log-systems
(showSystemLogs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "time" : "time",
    "user" : "user"
  }, {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "time" : "time",
    "user" : "user"
  } ]
}

Produces

This API call produces the 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-system-show-response
Up
get /log-systems/{since-last-reset}
(showSystemLogs_1)

Path parameters

since-last-reset (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "time" : "time",
    "user" : "user"
  }, {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "time" : "time",
    "user" : "user"
  } ]
}

Produces

This API call produces the 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-system-show-response

MacLimits

Up
get /mac-limits/{port}
(showMacLimitByPorts)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : "port",
    "mac-limit" : 6,
    "mac-limit-action" : "log",
    "num-macs" : 0,
    "api.switch-name" : "api.switch-name"
  }, {
    "port" : "port",
    "mac-limit" : 6,
    "mac-limit-action" : "log",
    "num-macs" : 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 mac-limit-show-response
Up
get /mac-limits
(showMacLimits)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : "port",
    "mac-limit" : 6,
    "mac-limit-action" : "log",
    "num-macs" : 0,
    "api.switch-name" : "api.switch-name"
  }, {
    "port" : "port",
    "mac-limit" : 6,
    "mac-limit-action" : "log",
    "num-macs" : 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 mac-limit-show-response
Up
put /mac-limits/{port}
(updateMacLimitByPorts)

Path parameters

port (required)
Path Parameter

Consumes

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

Request body

body mac-limit-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

MacPool

Up
get /mac-pool
(showMacPool)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 mac-pool-show-response

Mcasts

Up
get /mcasts
(showMcasts)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "group-ports" : "group-ports",
    "vlan" : 0,
    "group-id" : 6,
    "group-ip" : "group-ip",
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name"
  }, {
    "bd" : "bd",
    "group-ports" : "group-ports",
    "vlan" : 0,
    "group-id" : 6,
    "group-ip" : "group-ip",
    "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 mcast-show-response

MgmtSessions

Up
get /mgmt-sessions/{user}
(showMgmtSessionByUser)

Path parameters

user (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vnet" : "vnet",
    "login-time" : "login-time",
    "from-ip" : "from-ip",
    "remote-node" : "remote-node",
    "pid" : 0,
    "terminal" : "terminal",
    "cli-user" : "cli-user",
    "type" : "cli",
    "api.switch-name" : "api.switch-name",
    "user" : "user"
  }, {
    "vnet" : "vnet",
    "login-time" : "login-time",
    "from-ip" : "from-ip",
    "remote-node" : "remote-node",
    "pid" : 0,
    "terminal" : "terminal",
    "cli-user" : "cli-user",
    "type" : "cli",
    "api.switch-name" : "api.switch-name",
    "user" : "user"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success mgmt-session-show-response
Up
get /mgmt-sessions
(showMgmtSessions)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vnet" : "vnet",
    "login-time" : "login-time",
    "from-ip" : "from-ip",
    "remote-node" : "remote-node",
    "pid" : 0,
    "terminal" : "terminal",
    "cli-user" : "cli-user",
    "type" : "cli",
    "api.switch-name" : "api.switch-name",
    "user" : "user"
  }, {
    "vnet" : "vnet",
    "login-time" : "login-time",
    "from-ip" : "from-ip",
    "remote-node" : "remote-node",
    "pid" : 0,
    "terminal" : "terminal",
    "cli-user" : "cli-user",
    "type" : "cli",
    "api.switch-name" : "api.switch-name",
    "user" : "user"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success mgmt-session-show-response

Mirrors

Up
post /mirrors
(createMirror)

Consumes

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

Request body

body mirror-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /mirrors/{name}
(deleteMirrorByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /mirrors/{name}
(showMirrorByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "loopback-port" : 0,
    "span-src-mac" : "span-src-mac",
    "api.switch-name" : "api.switch-name",
    "span-remote-ip" : "span-remote-ip",
    "span-tagging-vlan" : 1,
    "span-local-ip" : "span-local-ip",
    "span-dst-mac" : "span-dst-mac",
    "nvie-mirror" : true,
    "enable" : true,
    "name" : "name",
    "other-egress-out" : true,
    "id" : "id",
    "in-port" : "in-port",
    "out-port" : "out-port",
    "span-encap" : "none",
    "filtering" : "port",
    "span-tos" : 5,
    "direction" : "ingress",
    "out-trunk" : 6
  }, {
    "loopback-port" : 0,
    "span-src-mac" : "span-src-mac",
    "api.switch-name" : "api.switch-name",
    "span-remote-ip" : "span-remote-ip",
    "span-tagging-vlan" : 1,
    "span-local-ip" : "span-local-ip",
    "span-dst-mac" : "span-dst-mac",
    "nvie-mirror" : true,
    "enable" : true,
    "name" : "name",
    "other-egress-out" : true,
    "id" : "id",
    "in-port" : "in-port",
    "out-port" : "out-port",
    "span-encap" : "none",
    "filtering" : "port",
    "span-tos" : 5,
    "direction" : "ingress",
    "out-trunk" : 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 mirror-show-response
Up
get /mirrors
(showMirrors)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "loopback-port" : 0,
    "span-src-mac" : "span-src-mac",
    "api.switch-name" : "api.switch-name",
    "span-remote-ip" : "span-remote-ip",
    "span-tagging-vlan" : 1,
    "span-local-ip" : "span-local-ip",
    "span-dst-mac" : "span-dst-mac",
    "nvie-mirror" : true,
    "enable" : true,
    "name" : "name",
    "other-egress-out" : true,
    "id" : "id",
    "in-port" : "in-port",
    "out-port" : "out-port",
    "span-encap" : "none",
    "filtering" : "port",
    "span-tos" : 5,
    "direction" : "ingress",
    "out-trunk" : 6
  }, {
    "loopback-port" : 0,
    "span-src-mac" : "span-src-mac",
    "api.switch-name" : "api.switch-name",
    "span-remote-ip" : "span-remote-ip",
    "span-tagging-vlan" : 1,
    "span-local-ip" : "span-local-ip",
    "span-dst-mac" : "span-dst-mac",
    "nvie-mirror" : true,
    "enable" : true,
    "name" : "name",
    "other-egress-out" : true,
    "id" : "id",
    "in-port" : "in-port",
    "out-port" : "out-port",
    "span-encap" : "none",
    "filtering" : "port",
    "span-tos" : 5,
    "direction" : "ingress",
    "out-trunk" : 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 mirror-show-response
Up
put /mirrors/{name}
(updateMirrorByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body mirror-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

MldRouters

Up
get /mld-routers/{node-ip}
(showMldRouterByHost)

Path parameters

node-ip (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "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 mld-router-show-response
Up
get /mld-routers
(showMldRouters)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "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 mld-router-show-response

MldSnooping

Up
get /mld-snooping
(showMldSnooping)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mldv2-vlans" : "mldv2-vlans",
    "vlans" : "vlans",
    "query-max-response-time" : 6,
    "snoop-nd-vlans" : "snoop-nd-vlans",
    "enable" : true,
    "scope" : "local",
    "snoop-linklocal-vlans" : "snoop-linklocal-vlans",
    "query-interval" : 0,
    "nvOS-managed-vlans" : "nvOS-managed-vlans",
    "interop-v1-vlans" : "interop-v1-vlans",
    "api.switch-name" : "api.switch-name",
    "mldv1-vlans" : "mldv1-vlans"
  }, {
    "mldv2-vlans" : "mldv2-vlans",
    "vlans" : "vlans",
    "query-max-response-time" : 6,
    "snoop-nd-vlans" : "snoop-nd-vlans",
    "enable" : true,
    "scope" : "local",
    "snoop-linklocal-vlans" : "snoop-linklocal-vlans",
    "query-interval" : 0,
    "nvOS-managed-vlans" : "nvOS-managed-vlans",
    "interop-v1-vlans" : "interop-v1-vlans",
    "api.switch-name" : "api.switch-name",
    "mldv1-vlans" : "mldv1-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 mld-snooping-show-response
Up
put /mld-snooping
(updateMldSnooping)

Consumes

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

Request body

body mld-snooping-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

MldStaticGroups

Up
post /mld-static-groups
(createMldStaticGroup)

Consumes

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

Request body

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /mld-static-groups/group-ip={group-ip},vlan={vlan}
(deleteMldStaticGroupByUniqueKeyAll)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /mld-static-groups/group-ip={group-ip},vlan={vlan}
(showMldStaticGroupByUniqueKeyAll)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlan" : 0,
    "group-ip" : "group-ip",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlan" : 0,
    "group-ip" : "group-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 mld-static-group-show-response
Up
get /mld-static-groups
(showMldStaticGroups)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlan" : 0,
    "group-ip" : "group-ip",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlan" : 0,
    "group-ip" : "group-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 mld-static-group-show-response

MldStaticSources

Up
post /mld-static-sources
(createMldStaticSource)

Consumes

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

Request body

body mld-static-source-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /mld-static-sources/group-ip={group-ip},vlan={vlan},source-ip={source-ip}
(deleteMldStaticSourceByUniqueKeyAll)

Path parameters

group-ip (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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /mld-static-sources/group-ip={group-ip},vlan={vlan},source-ip={source-ip}
(showMldStaticSourceByUniqueKeyAll)

Path parameters

group-ip (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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 mld-static-source-show-response
Up
get /mld-static-sources
(showMldStaticSources)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 mld-static-source-show-response

MldStats

Up
get /mld-stats
(showMldStats)

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success mld-stats-show-response

MldSwitches

Up
get /mld-switches
(showMldSwitches)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "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 mld-switches-show-response
Up
get /mld-switches/{node-ip}
(showMldSwitchesByHost)

Path parameters

node-ip (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "vxlan" : 0,
    "bd" : "bd",
    "vlan" : 6,
    "node-ip" : "node-ip",
    "port" : 1,
    "vnet-id" : "vnet-id",
    "api.switch-name" : "api.switch-name",
    "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 mld-switches-show-response

Mlds

Up
get /mlds/{node-ip}
(showMldHostByHost)

Path parameters

node-ip (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "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",
    "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 mld-show-response
Up
get /mlds
(showMldHosts)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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",
    "tunnel" : "tunnel"
  }, {
    "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",
    "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 mld-show-response

MstConfigs

Up
post /mst-configs
(createMstConfig)

Consumes

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

Request body

body mst-config-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /mst-configs/{instance-id}
(deleteMstConfigById)

Path parameters

instance-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /mst-configs/{instance-id}
(showMstConfigById)

Path parameters

instance-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "instance-id" : 0,
    "bridge-priority" : 6,
    "api.switch-name" : "api.switch-name"
  }, {
    "vlans" : "vlans",
    "instance-id" : 0,
    "bridge-priority" : 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 mst-config-show-response
Up
get /mst-configs
(showMstConfigs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "instance-id" : 0,
    "bridge-priority" : 6,
    "api.switch-name" : "api.switch-name"
  }, {
    "vlans" : "vlans",
    "instance-id" : 0,
    "bridge-priority" : 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 mst-config-show-response
Up
put /mst-configs/{instance-id}
(updateMstConfigById)

Path parameters

instance-id (required)
Path Parameter

Consumes

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

Request body

body mst-config-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Nodes

Up
get /nodes/info
(infoNode)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 5,
    "vmgmt-wake-on-lan" : true,
    "vmgmt-vrf" : "vmgmt-vrf",
    "mgmt-linklocal" : "mgmt-linklocal",
    "device-state" : "device-state",
    "vmgmt-assignment2" : "none",
    "in-band-assignment-linklocal" : "none",
    "mgmt-ipv6-unnumbered" : true,
    "in-band-ip" : "in-band-ip",
    "mgmt-if-nat-realm" : "internal",
    "state" : "offline",
    "id" : 4,
    "mgmt-netmask" : 1,
    "cluster-id" : "cluster-id",
    "rollforward-failed" : true,
    "in-band-secondary-macs" : "in-band-secondary-macs",
    "in-band-vrf" : "in-band-vrf",
    "mgmt-ip2" : "mgmt-ip2",
    "in-band-vnet-id" : "in-band-vnet-id",
    "vmgmt-public-vlan" : 0,
    "mgmt-vnet-id" : "mgmt-vnet-id",
    "vmgmt-vnet-id" : "vmgmt-vnet-id",
    "in-band-public-vlan" : 5,
    "version" : "version",
    "in-band-netmask" : 6,
    "in-band-linklocal" : "in-band-linklocal",
    "fab-id" : "fab-id",
    "in-band-bd" : "in-band-bd",
    "in-band-wake-on-lan" : true,
    "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",
    "mgmt-vrf" : "mgmt-vrf",
    "control-network" : "in-band",
    "firmware-upgrade" : "firmware-upgrade",
    "mgmt-wake-on-lan" : true,
    "fabric-network" : "in-band",
    "mgmt-public-vlan" : 9,
    "serial" : "serial",
    "local-mac" : "local-mac",
    "fab-tid" : 1,
    "in-band-assignment2" : "none",
    "vmgmt-vlan" : 1,
    "in-band-netmask2" : 1,
    "mgmt-sec-addresses" : 3,
    "vmgmt-netmask2" : 2,
    "mgmt-netmask2" : 7,
    "mgmt-secondary-macs" : "mgmt-secondary-macs",
    "vmgmt-sec-addresses" : 6
  }, {
    "vmgmt-ipv6-unnumbered" : true,
    "in-band-vlan" : 7,
    "in-band-if-nat-realm" : "internal",
    "mgmt-assignment-linklocal" : "none",
    "in-band-sec-addresses" : 5,
    "vmgmt-wake-on-lan" : true,
    "vmgmt-vrf" : "vmgmt-vrf",
    "mgmt-linklocal" : "mgmt-linklocal",
    "device-state" : "device-state",
    "vmgmt-assignment2" : "none",
    "in-band-assignment-linklocal" : "none",
    "mgmt-ipv6-unnumbered" : true,
    "in-band-ip" : "in-band-ip",
    "mgmt-if-nat-realm" : "internal",
    "state" : "offline",
    "id" : 4,
    "mgmt-netmask" : 1,
    "cluster-id" : "cluster-id",
    "rollforward-failed" : true,
    "in-band-secondary-macs" : "in-band-secondary-macs",
    "in-band-vrf" : "in-band-vrf",
    "mgmt-ip2" : "mgmt-ip2",
    "in-band-vnet-id" : "in-band-vnet-id",
    "vmgmt-public-vlan" : 0,
    "mgmt-vnet-id" : "mgmt-vnet-id",
    "vmgmt-vnet-id" : "vmgmt-vnet-id",
    "in-band-public-vlan" : 5,
    "version" : "version",
    "in-band-netmask" : 6,
    "in-band-linklocal" : "in-band-linklocal",
    "fab-id" : "fab-id",
    "in-band-bd" : "in-band-bd",
    "in-band-wake-on-lan" : true,
    "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",
    "mgmt-vrf" : "mgmt-vrf",
    "control-network" : "in-band",
    "firmware-upgrade" : "firmware-upgrade",
    "mgmt-wake-on-lan" : true,
    "fabric-network" : "in-band",
    "mgmt-public-vlan" : 9,
    "serial" : "serial",
    "local-mac" : "local-mac",
    "fab-tid" : 1,
    "in-band-assignment2" : "none",
    "vmgmt-vlan" : 1,
    "in-band-netmask2" : 1,
    "mgmt-sec-addresses" : 3,
    "vmgmt-netmask2" : 2,
    "mgmt-netmask2" : 7,
    "mgmt-secondary-macs" : "mgmt-secondary-macs",
    "vmgmt-sec-addresses" : 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 node-show-response
Up
get /nodes
(showNodes)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 5,
    "vmgmt-wake-on-lan" : true,
    "vmgmt-vrf" : "vmgmt-vrf",
    "mgmt-linklocal" : "mgmt-linklocal",
    "device-state" : "device-state",
    "vmgmt-assignment2" : "none",
    "in-band-assignment-linklocal" : "none",
    "mgmt-ipv6-unnumbered" : true,
    "in-band-ip" : "in-band-ip",
    "mgmt-if-nat-realm" : "internal",
    "state" : "offline",
    "id" : 4,
    "mgmt-netmask" : 1,
    "cluster-id" : "cluster-id",
    "rollforward-failed" : true,
    "in-band-secondary-macs" : "in-band-secondary-macs",
    "in-band-vrf" : "in-band-vrf",
    "mgmt-ip2" : "mgmt-ip2",
    "in-band-vnet-id" : "in-band-vnet-id",
    "vmgmt-public-vlan" : 0,
    "mgmt-vnet-id" : "mgmt-vnet-id",
    "vmgmt-vnet-id" : "vmgmt-vnet-id",
    "in-band-public-vlan" : 5,
    "version" : "version",
    "in-band-netmask" : 6,
    "in-band-linklocal" : "in-band-linklocal",
    "fab-id" : "fab-id",
    "in-band-bd" : "in-band-bd",
    "in-band-wake-on-lan" : true,
    "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",
    "mgmt-vrf" : "mgmt-vrf",
    "control-network" : "in-band",
    "firmware-upgrade" : "firmware-upgrade",
    "mgmt-wake-on-lan" : true,
    "fabric-network" : "in-band",
    "mgmt-public-vlan" : 9,
    "serial" : "serial",
    "local-mac" : "local-mac",
    "fab-tid" : 1,
    "in-band-assignment2" : "none",
    "vmgmt-vlan" : 1,
    "in-band-netmask2" : 1,
    "mgmt-sec-addresses" : 3,
    "vmgmt-netmask2" : 2,
    "mgmt-netmask2" : 7,
    "mgmt-secondary-macs" : "mgmt-secondary-macs",
    "vmgmt-sec-addresses" : 6
  }, {
    "vmgmt-ipv6-unnumbered" : true,
    "in-band-vlan" : 7,
    "in-band-if-nat-realm" : "internal",
    "mgmt-assignment-linklocal" : "none",
    "in-band-sec-addresses" : 5,
    "vmgmt-wake-on-lan" : true,
    "vmgmt-vrf" : "vmgmt-vrf",
    "mgmt-linklocal" : "mgmt-linklocal",
    "device-state" : "device-state",
    "vmgmt-assignment2" : "none",
    "in-band-assignment-linklocal" : "none",
    "mgmt-ipv6-unnumbered" : true,
    "in-band-ip" : "in-band-ip",
    "mgmt-if-nat-realm" : "internal",
    "state" : "offline",
    "id" : 4,
    "mgmt-netmask" : 1,
    "cluster-id" : "cluster-id",
    "rollforward-failed" : true,
    "in-band-secondary-macs" : "in-band-secondary-macs",
    "in-band-vrf" : "in-band-vrf",
    "mgmt-ip2" : "mgmt-ip2",
    "in-band-vnet-id" : "in-band-vnet-id",
    "vmgmt-public-vlan" : 0,
    "mgmt-vnet-id" : "mgmt-vnet-id",
    "vmgmt-vnet-id" : "vmgmt-vnet-id",
    "in-band-public-vlan" : 5,
    "version" : "version",
    "in-band-netmask" : 6,
    "in-band-linklocal" : "in-band-linklocal",
    "fab-id" : "fab-id",
    "in-band-bd" : "in-band-bd",
    "in-band-wake-on-lan" : true,
    "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",
    "mgmt-vrf" : "mgmt-vrf",
    "control-network" : "in-band",
    "firmware-upgrade" : "firmware-upgrade",
    "mgmt-wake-on-lan" : true,
    "fabric-network" : "in-band",
    "mgmt-public-vlan" : 9,
    "serial" : "serial",
    "local-mac" : "local-mac",
    "fab-tid" : 1,
    "in-band-assignment2" : "none",
    "vmgmt-vlan" : 1,
    "in-band-netmask2" : 1,
    "mgmt-sec-addresses" : 3,
    "vmgmt-netmask2" : 2,
    "mgmt-netmask2" : 7,
    "mgmt-secondary-macs" : "mgmt-secondary-macs",
    "vmgmt-sec-addresses" : 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 node-show-response

NvQueueMirrors

Up
get /nv-queue-mirrors/{name}
(showQueuePktMirrorByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success nv-queue-mirror-show-response
Up
get /nv-queue-mirrors
(showQueuePktMirrors)

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success nv-queue-mirror-show-response
Up
put /nv-queue-mirrors/{name}
(updateQueuePktMirrorByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body nv-queue-mirror-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

NvQueueStats

Up
post /nv-queue-stats/clear
(clearQueueStats)

Consumes

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

Request body

body nv-queue-stats-clear (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /nv-queue-stats
(showQueueStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "q-high" : 5,
    "older-than" : 0,
    "within-last" : 9,
    "q-pts-12" : 9,
    "q-underflow" : 3,
    "q-pts-11" : 4,
    "q-pts-10" : 1,
    "q-pts-16" : 2,
    "q-pts-15" : 1,
    "q-pts-14" : 1,
    "since-start" : true,
    "q-pts-13" : 9,
    "q-delay-samples" : 6,
    "start-time" : "start-time",
    "q-delay-high" : 0,
    "q-pts-23" : 7,
    "q-pts-22" : 4,
    "q-pts-21" : 6,
    "q-pts-20" : 2,
    "q-pts-27" : 0,
    "q-pts-26" : 6,
    "q-pts-25" : 7,
    "q-pts-24" : 5,
    "q-pts-4" : 1,
    "q-pts-5" : 3,
    "q-pts-19" : 1,
    "q-pts-2" : 1,
    "q-pts-18" : 9,
    "q-pts-3" : 8,
    "q-pts-17" : 1,
    "q-pts-8" : 3,
    "q-in" : 7,
    "q-pts-9" : 7,
    "q-low" : 6,
    "q-pts-6" : 8,
    "q-pts-7" : 5,
    "name" : "name",
    "interval" : 9,
    "q-out" : 3,
    "q-pts-0" : 4,
    "q-pts-1" : 7,
    "q-pts-30" : 5,
    "q-max" : 2,
    "q-pts-34" : 7,
    "q-pts-33" : 6,
    "q-pts-32" : 3,
    "q-pts-31" : 6,
    "q-pts-38" : 4,
    "api.switch-name" : "api.switch-name",
    "q-pts-37" : 0,
    "q-pts-36" : 3,
    "q-pts-35" : 7,
    "duration" : 7,
    "q-pts-29" : 3,
    "q-pts-28" : 4,
    "q-overflow" : 6,
    "q-pts-41" : 6,
    "q-pts-40" : 4,
    "end-time" : "end-time",
    "q-pts-44" : 6,
    "q-pts-43" : 5,
    "q-pts-42" : 9,
    "q-pts-39" : 6,
    "time" : "time",
    "q-delay-avg" : 0
  }, {
    "q-high" : 5,
    "older-than" : 0,
    "within-last" : 9,
    "q-pts-12" : 9,
    "q-underflow" : 3,
    "q-pts-11" : 4,
    "q-pts-10" : 1,
    "q-pts-16" : 2,
    "q-pts-15" : 1,
    "q-pts-14" : 1,
    "since-start" : true,
    "q-pts-13" : 9,
    "q-delay-samples" : 6,
    "start-time" : "start-time",
    "q-delay-high" : 0,
    "q-pts-23" : 7,
    "q-pts-22" : 4,
    "q-pts-21" : 6,
    "q-pts-20" : 2,
    "q-pts-27" : 0,
    "q-pts-26" : 6,
    "q-pts-25" : 7,
    "q-pts-24" : 5,
    "q-pts-4" : 1,
    "q-pts-5" : 3,
    "q-pts-19" : 1,
    "q-pts-2" : 1,
    "q-pts-18" : 9,
    "q-pts-3" : 8,
    "q-pts-17" : 1,
    "q-pts-8" : 3,
    "q-in" : 7,
    "q-pts-9" : 7,
    "q-low" : 6,
    "q-pts-6" : 8,
    "q-pts-7" : 5,
    "name" : "name",
    "interval" : 9,
    "q-out" : 3,
    "q-pts-0" : 4,
    "q-pts-1" : 7,
    "q-pts-30" : 5,
    "q-max" : 2,
    "q-pts-34" : 7,
    "q-pts-33" : 6,
    "q-pts-32" : 3,
    "q-pts-31" : 6,
    "q-pts-38" : 4,
    "api.switch-name" : "api.switch-name",
    "q-pts-37" : 0,
    "q-pts-36" : 3,
    "q-pts-35" : 7,
    "duration" : 7,
    "q-pts-29" : 3,
    "q-pts-28" : 4,
    "q-overflow" : 6,
    "q-pts-41" : 6,
    "q-pts-40" : 4,
    "end-time" : "end-time",
    "q-pts-44" : 6,
    "q-pts-43" : 5,
    "q-pts-42" : 9,
    "q-pts-39" : 6,
    "time" : "time",
    "q-delay-avg" : 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 nv-queue-stats-show-response
Up
get /nv-queue-stats/{name}
(showQueueStatsByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "q-high" : 5,
    "older-than" : 0,
    "within-last" : 9,
    "q-pts-12" : 9,
    "q-underflow" : 3,
    "q-pts-11" : 4,
    "q-pts-10" : 1,
    "q-pts-16" : 2,
    "q-pts-15" : 1,
    "q-pts-14" : 1,
    "since-start" : true,
    "q-pts-13" : 9,
    "q-delay-samples" : 6,
    "start-time" : "start-time",
    "q-delay-high" : 0,
    "q-pts-23" : 7,
    "q-pts-22" : 4,
    "q-pts-21" : 6,
    "q-pts-20" : 2,
    "q-pts-27" : 0,
    "q-pts-26" : 6,
    "q-pts-25" : 7,
    "q-pts-24" : 5,
    "q-pts-4" : 1,
    "q-pts-5" : 3,
    "q-pts-19" : 1,
    "q-pts-2" : 1,
    "q-pts-18" : 9,
    "q-pts-3" : 8,
    "q-pts-17" : 1,
    "q-pts-8" : 3,
    "q-in" : 7,
    "q-pts-9" : 7,
    "q-low" : 6,
    "q-pts-6" : 8,
    "q-pts-7" : 5,
    "name" : "name",
    "interval" : 9,
    "q-out" : 3,
    "q-pts-0" : 4,
    "q-pts-1" : 7,
    "q-pts-30" : 5,
    "q-max" : 2,
    "q-pts-34" : 7,
    "q-pts-33" : 6,
    "q-pts-32" : 3,
    "q-pts-31" : 6,
    "q-pts-38" : 4,
    "api.switch-name" : "api.switch-name",
    "q-pts-37" : 0,
    "q-pts-36" : 3,
    "q-pts-35" : 7,
    "duration" : 7,
    "q-pts-29" : 3,
    "q-pts-28" : 4,
    "q-overflow" : 6,
    "q-pts-41" : 6,
    "q-pts-40" : 4,
    "end-time" : "end-time",
    "q-pts-44" : 6,
    "q-pts-43" : 5,
    "q-pts-42" : 9,
    "q-pts-39" : 6,
    "time" : "time",
    "q-delay-avg" : 0
  }, {
    "q-high" : 5,
    "older-than" : 0,
    "within-last" : 9,
    "q-pts-12" : 9,
    "q-underflow" : 3,
    "q-pts-11" : 4,
    "q-pts-10" : 1,
    "q-pts-16" : 2,
    "q-pts-15" : 1,
    "q-pts-14" : 1,
    "since-start" : true,
    "q-pts-13" : 9,
    "q-delay-samples" : 6,
    "start-time" : "start-time",
    "q-delay-high" : 0,
    "q-pts-23" : 7,
    "q-pts-22" : 4,
    "q-pts-21" : 6,
    "q-pts-20" : 2,
    "q-pts-27" : 0,
    "q-pts-26" : 6,
    "q-pts-25" : 7,
    "q-pts-24" : 5,
    "q-pts-4" : 1,
    "q-pts-5" : 3,
    "q-pts-19" : 1,
    "q-pts-2" : 1,
    "q-pts-18" : 9,
    "q-pts-3" : 8,
    "q-pts-17" : 1,
    "q-pts-8" : 3,
    "q-in" : 7,
    "q-pts-9" : 7,
    "q-low" : 6,
    "q-pts-6" : 8,
    "q-pts-7" : 5,
    "name" : "name",
    "interval" : 9,
    "q-out" : 3,
    "q-pts-0" : 4,
    "q-pts-1" : 7,
    "q-pts-30" : 5,
    "q-max" : 2,
    "q-pts-34" : 7,
    "q-pts-33" : 6,
    "q-pts-32" : 3,
    "q-pts-31" : 6,
    "q-pts-38" : 4,
    "api.switch-name" : "api.switch-name",
    "q-pts-37" : 0,
    "q-pts-36" : 3,
    "q-pts-35" : 7,
    "duration" : 7,
    "q-pts-29" : 3,
    "q-pts-28" : 4,
    "q-overflow" : 6,
    "q-pts-41" : 6,
    "q-pts-40" : 4,
    "end-time" : "end-time",
    "q-pts-44" : 6,
    "q-pts-43" : 5,
    "q-pts-42" : 9,
    "q-pts-39" : 6,
    "time" : "time",
    "q-delay-avg" : 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 nv-queue-stats-show-response

NvQueueStatsSettings

Up
get /nv-queue-stats-settings
(showQueueStatsSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 nv-queue-stats-settings-show-response
Up
put /nv-queue-stats-settings
(updateQueueStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

ObjectLocations

Up
get /object-locations/{location}
(showObjectLocationByLocation)

Path parameters

location (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "new-location" : 6,
    "location" : 0,
    "type" : "type",
    "api.switch-name" : "api.switch-name"
  }, {
    "name" : "name",
    "new-location" : 6,
    "location" : 0,
    "type" : "type",
    "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 object-location-show-response
Up
get /object-locations
(showObjectLocations)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "new-location" : 6,
    "location" : 0,
    "type" : "type",
    "api.switch-name" : "api.switch-name"
  }, {
    "name" : "name",
    "new-location" : 6,
    "location" : 0,
    "type" : "type",
    "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 object-location-show-response
Up
put /object-locations/{location}
(updateObjectLocationByLocation)

Path parameters

location (required)
Path Parameter

Consumes

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

Request body

body object-location-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

OpenvswitchRestConfigs

Up
post /openvswitch-rest-configs
(createOvsRestConfig)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /openvswitch-rest-configs/{user-name}
(deleteOvsRestConfigByUsername)

Path parameters

user-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /openvswitch-rest-configs/{user-name}
(showOvsRestConfigByUsername)

Path parameters

user-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ip-address" : "ip-address",
    "user-name" : "user-name",
    "api.switch-name" : "api.switch-name"
  }, {
    "ip-address" : "ip-address",
    "user-name" : "user-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 openvswitch-rest-config-show-response
Up
get /openvswitch-rest-configs
(showOvsRestConfigs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ip-address" : "ip-address",
    "user-name" : "user-name",
    "api.switch-name" : "api.switch-name"
  }, {
    "ip-address" : "ip-address",
    "user-name" : "user-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 openvswitch-rest-config-show-response

Openvswitches

Up
post /openvswitches/{ovs-name}/interfaces
(addOvsNicByOvsOvsVnmName)

Path parameters

ovs-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /openvswitches/{name}/hwvtep-managers
(addOvsOvsManagersByOvsOvsVnmName)

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /openvswitches
(createOvs)

Consumes

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

Request body

body openvswitch-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /openvswitches/{name}
(deleteOvsByOvsVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /openvswitches/{ovs-name}/interfaces/l3-port/{l3-port}
(removeOvsNicByOvsVnmNameByL3port)

Path parameters

ovs-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /openvswitches/{ovs-name}/interfaces/nic/{nic}
(removeOvsNicByOvsVnmNameByVnic)

Path parameters

ovs-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /openvswitches/{name}/hwvtep-managers/{ip}
(removeOvsOvsManagersByOvsVnmNameByIp)

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /openvswitches
(showOvs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "template" : true,
    "cert-location" : "none",
    "global-vtep" : true,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "db-socket" : "db-socket",
    "mode" : "standalone",
    "vnet" : "vnet",
    "ca-cert-name" : "ca-cert-name",
    "storage-pool" : "storage-pool",
    "scope" : "local",
    "id" : "id",
    "state" : "disable",
    "bfd" : true,
    "tunnel-ip" : "tunnel-ip",
    "failover-action" : "stop-old",
    "cert-name" : "cert-name",
    "db-port" : 6,
    "db-conn-type" : "unix-socket",
    "failover-controller" : 0,
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "name" : "name",
    "db-ip" : "db-ip",
    "location" : 1,
    "is-global" : true,
    "gateway" : "gateway"
  }, {
    "template" : true,
    "cert-location" : "none",
    "global-vtep" : true,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "db-socket" : "db-socket",
    "mode" : "standalone",
    "vnet" : "vnet",
    "ca-cert-name" : "ca-cert-name",
    "storage-pool" : "storage-pool",
    "scope" : "local",
    "id" : "id",
    "state" : "disable",
    "bfd" : true,
    "tunnel-ip" : "tunnel-ip",
    "failover-action" : "stop-old",
    "cert-name" : "cert-name",
    "db-port" : 6,
    "db-conn-type" : "unix-socket",
    "failover-controller" : 0,
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "name" : "name",
    "db-ip" : "db-ip",
    "location" : 1,
    "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 openvswitch-show-response
Up
get /openvswitches/{name}
(showOvsByOvsVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "template" : true,
    "cert-location" : "none",
    "global-vtep" : true,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "db-socket" : "db-socket",
    "mode" : "standalone",
    "vnet" : "vnet",
    "ca-cert-name" : "ca-cert-name",
    "storage-pool" : "storage-pool",
    "scope" : "local",
    "id" : "id",
    "state" : "disable",
    "bfd" : true,
    "tunnel-ip" : "tunnel-ip",
    "failover-action" : "stop-old",
    "cert-name" : "cert-name",
    "db-port" : 6,
    "db-conn-type" : "unix-socket",
    "failover-controller" : 0,
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "name" : "name",
    "db-ip" : "db-ip",
    "location" : 1,
    "is-global" : true,
    "gateway" : "gateway"
  }, {
    "template" : true,
    "cert-location" : "none",
    "global-vtep" : true,
    "type" : "vnet-mgr",
    "api.switch-name" : "api.switch-name",
    "db-socket" : "db-socket",
    "mode" : "standalone",
    "vnet" : "vnet",
    "ca-cert-name" : "ca-cert-name",
    "storage-pool" : "storage-pool",
    "scope" : "local",
    "id" : "id",
    "state" : "disable",
    "bfd" : true,
    "tunnel-ip" : "tunnel-ip",
    "failover-action" : "stop-old",
    "cert-name" : "cert-name",
    "db-port" : 6,
    "db-conn-type" : "unix-socket",
    "failover-controller" : 0,
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "vnet-service" : true,
    "name" : "name",
    "db-ip" : "db-ip",
    "location" : 1,
    "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 openvswitch-show-response
Up
get /openvswitches/{ovs-name}/interfaces/{nic}
(showOvsNicByOvsVnmNameByVnic)

Path parameters

ovs-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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 openvswitch-interface-show-response
Up
get /openvswitches/{ovs-name}/interfaces
(showOvsNicsByOvsOvsVnmName)

Path parameters

ovs-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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 openvswitch-interface-show-response
Up
get /openvswitches/{name}/hwvtep-managers
(showOvsOvsManagersByOvsOvsVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "controller-ip" : "controller-ip",
    "connection-method" : "unix-socket",
    "port" : 0,
    "manager-type" : "odl",
    "ip" : "ip",
    "auto-service-binding" : true,
    "api.switch-name" : "api.switch-name",
    "username" : "username",
    "status" : "status"
  }, {
    "controller-ip" : "controller-ip",
    "connection-method" : "unix-socket",
    "port" : 0,
    "manager-type" : "odl",
    "ip" : "ip",
    "auto-service-binding" : true,
    "api.switch-name" : "api.switch-name",
    "username" : "username",
    "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 openvswitch-hwvtep-manager-show-response
Up
get /openvswitches/{name}/hwvtep-managers/{ip}
(showOvsOvsManagersByOvsVnmNameByIp)

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "controller-ip" : "controller-ip",
    "connection-method" : "unix-socket",
    "port" : 0,
    "manager-type" : "odl",
    "ip" : "ip",
    "auto-service-binding" : true,
    "api.switch-name" : "api.switch-name",
    "username" : "username",
    "status" : "status"
  }, {
    "controller-ip" : "controller-ip",
    "connection-method" : "unix-socket",
    "port" : 0,
    "manager-type" : "odl",
    "ip" : "ip",
    "auto-service-binding" : true,
    "api.switch-name" : "api.switch-name",
    "username" : "username",
    "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 openvswitch-hwvtep-manager-show-response
Up
put /openvswitches/{name}
(updateOvsByOvsVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body openvswitch-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /openvswitches/{ovs-name}/interfaces/{nic}
(updateOvsNicByOvsVnmNameByVnic)

Path parameters

ovs-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 Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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 openvswitch-interface-show-response

PnScripts

Up
post /pn-scripts/run
(runPnScript)

Consumes

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

Request body

body pn-script-run (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /pn-scripts/{name}
(showPnScriptByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 pn-script-show-response
Up
get /pn-scripts
(showPnScripts)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 pn-script-show-response

PnServices

Up
get /pn-services
(showPnServices)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "split-brain",
    "api.switch-name" : "api.switch-name",
    "status" : "status"
  }, {
    "name" : "split-brain",
    "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 pn-service-show-response

PortAssociationPaths

Up
post /port-association-paths
(createPortAssocPath)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-association-paths/{name}
(deletePortAssocPathByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-association-paths/{name}
(showPortAssocPathByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "path" : "path",
    "node2" : 6,
    "topology" : "topology",
    "name" : "name",
    "node2-port" : 5,
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node1-port" : 1,
    "status" : "down"
  }, {
    "path" : "path",
    "node2" : 6,
    "topology" : "topology",
    "name" : "name",
    "node2-port" : 5,
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node1-port" : 1,
    "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 port-association-path-show-response
Up
get /port-association-paths
(showPortAssocPaths)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "path" : "path",
    "node2" : 6,
    "topology" : "topology",
    "name" : "name",
    "node2-port" : 5,
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node1-port" : 1,
    "status" : "down"
  }, {
    "path" : "path",
    "node2" : 6,
    "topology" : "topology",
    "name" : "name",
    "node2-port" : 5,
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node1-port" : 1,
    "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 port-association-path-show-response

PortAssociations

Up
post /port-associations/{port-association-name}/services
(addPortAssocPortAssocServiceByPortAssocName)

Path parameters

port-association-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-associations
(createPortAssoc)

Consumes

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

Request body

body port-association-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-associations/{name}
(deletePortAssocByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-associations/{port-association-name}/services/{inline-service}
(removePortAssocPortAssocServiceByNameByInlineService)

Path parameters

port-association-name (required)
Path Parameter
inline-service (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-associations/{name}
(showPortAssocByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bidir" : true,
    "slave-ports" : "slave-ports",
    "enable" : true,
    "master-ports" : "master-ports",
    "monitor-ports" : "monitor-ports",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "virtual-wire" : true,
    "policy" : "all-masters"
  }, {
    "bidir" : true,
    "slave-ports" : "slave-ports",
    "enable" : true,
    "master-ports" : "master-ports",
    "monitor-ports" : "monitor-ports",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "virtual-wire" : true,
    "policy" : "all-masters"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-association-show-response
Up
get /port-associations/{port-association-name}/services/{inline-service}
(showPortAssocPortAssocServiceByNameByInlineService)

Path parameters

port-association-name (required)
Path Parameter
inline-service (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "policy-action" : "fail-open",
    "inline-service" : "inline-service",
    "api.switch-name" : "api.switch-name",
    "order" : 0
  }, {
    "policy-action" : "fail-open",
    "inline-service" : "inline-service",
    "api.switch-name" : "api.switch-name",
    "order" : 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 port-association-service-show-response
Up
get /port-associations/{port-association-name}/services
(showPortAssocPortAssocServicesByPortAssocName)

Path parameters

port-association-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "policy-action" : "fail-open",
    "inline-service" : "inline-service",
    "api.switch-name" : "api.switch-name",
    "order" : 0
  }, {
    "policy-action" : "fail-open",
    "inline-service" : "inline-service",
    "api.switch-name" : "api.switch-name",
    "order" : 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 port-association-service-show-response
Up
get /port-associations
(showPortAssocs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bidir" : true,
    "slave-ports" : "slave-ports",
    "enable" : true,
    "master-ports" : "master-ports",
    "monitor-ports" : "monitor-ports",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "virtual-wire" : true,
    "policy" : "all-masters"
  }, {
    "bidir" : true,
    "slave-ports" : "slave-ports",
    "enable" : true,
    "master-ports" : "master-ports",
    "monitor-ports" : "monitor-ports",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "virtual-wire" : true,
    "policy" : "all-masters"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-association-show-response
Up
put /port-associations/{name}
(updatePortAssocByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body port-association-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-associations/{port-association-name}/services/{inline-service}
(updatePortAssocPortAssocServiceByNameByInlineService)

Path parameters

port-association-name (required)
Path Parameter
inline-service (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "policy-action" : "fail-open",
    "inline-service" : "inline-service",
    "api.switch-name" : "api.switch-name",
    "order" : 0
  }, {
    "policy-action" : "fail-open",
    "inline-service" : "inline-service",
    "api.switch-name" : "api.switch-name",
    "order" : 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 port-association-service-show-response

PortBufferSettings

Up
get /port-buffer-settings
(showPortBufferSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 port-buffer-settings-show-response
Up
put /port-buffer-settings
(updatePortBufferSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortBuffers

Up
get /port-buffers/{port}
(showPortBufferByPortNum)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "start-time" : "start-time",
    "within-last" : 9,
    "egress-used-buf-val" : 5,
    "end-time" : "end-time",
    "ingress-used-buf-val" : 6,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 5,
    "ingress-used-buf" : 0,
    "port" : "port",
    "interval" : 2,
    "time" : "time",
    "egress-used-buf" : 1
  }, {
    "older-than" : 7,
    "start-time" : "start-time",
    "within-last" : 9,
    "egress-used-buf-val" : 5,
    "end-time" : "end-time",
    "ingress-used-buf-val" : 6,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 5,
    "ingress-used-buf" : 0,
    "port" : "port",
    "interval" : 2,
    "time" : "time",
    "egress-used-buf" : 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 port-buffer-show-response
Up
get /port-buffers
(showPortBuffers)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "start-time" : "start-time",
    "within-last" : 9,
    "egress-used-buf-val" : 5,
    "end-time" : "end-time",
    "ingress-used-buf-val" : 6,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 5,
    "ingress-used-buf" : 0,
    "port" : "port",
    "interval" : 2,
    "time" : "time",
    "egress-used-buf" : 1
  }, {
    "older-than" : 7,
    "start-time" : "start-time",
    "within-last" : 9,
    "egress-used-buf-val" : 5,
    "end-time" : "end-time",
    "ingress-used-buf-val" : 6,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 5,
    "ingress-used-buf" : 0,
    "port" : "port",
    "interval" : 2,
    "time" : "time",
    "egress-used-buf" : 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 port-buffer-show-response

PortBwThresholdAlerts

Up
get /port-bw-threshold-alerts/{port}
(showPortBwThresholdByPorts)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : "port",
    "bw-threshold" : "bw-threshold",
    "api.switch-name" : "api.switch-name"
  }, {
    "port" : "port",
    "bw-threshold" : "bw-threshold",
    "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 port-bw-threshold-alert-show-response
Up
get /port-bw-threshold-alerts
(showPortBwThresholds)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : "port",
    "bw-threshold" : "bw-threshold",
    "api.switch-name" : "api.switch-name"
  }, {
    "port" : "port",
    "bw-threshold" : "bw-threshold",
    "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 port-bw-threshold-alert-show-response
Up
put /port-bw-threshold-alerts/{port}
(updatePortBwThresholdByPorts)

Path parameters

port (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortBwThresholdMonInt

Up
get /port-bw-threshold-mon-int
(showPortBwThresholdMonInt)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "monitor-interval" : 0,
    "api.switch-name" : "api.switch-name"
  }, {
    "monitor-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 port-bw-threshold-mon-int-show-response
Up
put /port-bw-threshold-mon-int
(updatePortBwThresholdMonInt)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortConfigs

Up
get /port-configs/description/{description}
(showPortConfigByDescription)

Path parameters

description (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "defer-bringup" : true,
    "port-mac-address" : "port-mac-address",
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "fec" : "fec",
    "vle-id" : "vle-id",
    "rport" : 9,
    "description" : "description",
    "in_use" : true,
    "lport" : 5,
    "api.switch-name" : "api.switch-name",
    "speed" : 0,
    "rswitch-ip" : "rswitch-ip",
    "switch" : 2,
    "routing" : true,
    "reflect" : "reflect",
    "egress-rate-limit" : 4,
    "allowed-tpid" : "vlan",
    "enable" : "enable",
    "lacp-priority" : 7,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 7,
    "host-enable" : true,
    "loopback" : "no-loopback",
    "rswitch" : 2,
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "pause" : true,
    "bw-bps" : 6,
    "send-port" : 1,
    "port" : "port",
    "stp-port-priority" : 5,
    "loop-vlans" : "loop-vlans",
    "rswitch-mac" : "rswitch-mac",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "vxlan-termination" : "vxlan-termination",
    "stp-port-cost" : 1,
    "config" : "10m",
    "lldp" : true,
    "updown_time" : 3
  }, {
    "defer-bringup" : true,
    "port-mac-address" : "port-mac-address",
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "fec" : "fec",
    "vle-id" : "vle-id",
    "rport" : 9,
    "description" : "description",
    "in_use" : true,
    "lport" : 5,
    "api.switch-name" : "api.switch-name",
    "speed" : 0,
    "rswitch-ip" : "rswitch-ip",
    "switch" : 2,
    "routing" : true,
    "reflect" : "reflect",
    "egress-rate-limit" : 4,
    "allowed-tpid" : "vlan",
    "enable" : "enable",
    "lacp-priority" : 7,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 7,
    "host-enable" : true,
    "loopback" : "no-loopback",
    "rswitch" : 2,
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "pause" : true,
    "bw-bps" : 6,
    "send-port" : 1,
    "port" : "port",
    "stp-port-priority" : 5,
    "loop-vlans" : "loop-vlans",
    "rswitch-mac" : "rswitch-mac",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "vxlan-termination" : "vxlan-termination",
    "stp-port-cost" : 1,
    "config" : "10m",
    "lldp" : true,
    "updown_time" : 3
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-config-show-response
Up
get /port-configs/{port}
(showPortConfigByPorts)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "defer-bringup" : true,
    "port-mac-address" : "port-mac-address",
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "fec" : "fec",
    "vle-id" : "vle-id",
    "rport" : 9,
    "description" : "description",
    "in_use" : true,
    "lport" : 5,
    "api.switch-name" : "api.switch-name",
    "speed" : 0,
    "rswitch-ip" : "rswitch-ip",
    "switch" : 2,
    "routing" : true,
    "reflect" : "reflect",
    "egress-rate-limit" : 4,
    "allowed-tpid" : "vlan",
    "enable" : "enable",
    "lacp-priority" : 7,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 7,
    "host-enable" : true,
    "loopback" : "no-loopback",
    "rswitch" : 2,
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "pause" : true,
    "bw-bps" : 6,
    "send-port" : 1,
    "port" : "port",
    "stp-port-priority" : 5,
    "loop-vlans" : "loop-vlans",
    "rswitch-mac" : "rswitch-mac",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "vxlan-termination" : "vxlan-termination",
    "stp-port-cost" : 1,
    "config" : "10m",
    "lldp" : true,
    "updown_time" : 3
  }, {
    "defer-bringup" : true,
    "port-mac-address" : "port-mac-address",
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "fec" : "fec",
    "vle-id" : "vle-id",
    "rport" : 9,
    "description" : "description",
    "in_use" : true,
    "lport" : 5,
    "api.switch-name" : "api.switch-name",
    "speed" : 0,
    "rswitch-ip" : "rswitch-ip",
    "switch" : 2,
    "routing" : true,
    "reflect" : "reflect",
    "egress-rate-limit" : 4,
    "allowed-tpid" : "vlan",
    "enable" : "enable",
    "lacp-priority" : 7,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 7,
    "host-enable" : true,
    "loopback" : "no-loopback",
    "rswitch" : 2,
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "pause" : true,
    "bw-bps" : 6,
    "send-port" : 1,
    "port" : "port",
    "stp-port-priority" : 5,
    "loop-vlans" : "loop-vlans",
    "rswitch-mac" : "rswitch-mac",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "vxlan-termination" : "vxlan-termination",
    "stp-port-cost" : 1,
    "config" : "10m",
    "lldp" : true,
    "updown_time" : 3
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-config-show-response
Up
get /port-configs
(showPortConfigs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "defer-bringup" : true,
    "port-mac-address" : "port-mac-address",
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "fec" : "fec",
    "vle-id" : "vle-id",
    "rport" : 9,
    "description" : "description",
    "in_use" : true,
    "lport" : 5,
    "api.switch-name" : "api.switch-name",
    "speed" : 0,
    "rswitch-ip" : "rswitch-ip",
    "switch" : 2,
    "routing" : true,
    "reflect" : "reflect",
    "egress-rate-limit" : 4,
    "allowed-tpid" : "vlan",
    "enable" : "enable",
    "lacp-priority" : 7,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 7,
    "host-enable" : true,
    "loopback" : "no-loopback",
    "rswitch" : 2,
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "pause" : true,
    "bw-bps" : 6,
    "send-port" : 1,
    "port" : "port",
    "stp-port-priority" : 5,
    "loop-vlans" : "loop-vlans",
    "rswitch-mac" : "rswitch-mac",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "vxlan-termination" : "vxlan-termination",
    "stp-port-cost" : 1,
    "config" : "10m",
    "lldp" : true,
    "updown_time" : 3
  }, {
    "defer-bringup" : true,
    "port-mac-address" : "port-mac-address",
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "fec" : "fec",
    "vle-id" : "vle-id",
    "rport" : 9,
    "description" : "description",
    "in_use" : true,
    "lport" : 5,
    "api.switch-name" : "api.switch-name",
    "speed" : 0,
    "rswitch-ip" : "rswitch-ip",
    "switch" : 2,
    "routing" : true,
    "reflect" : "reflect",
    "egress-rate-limit" : 4,
    "allowed-tpid" : "vlan",
    "enable" : "enable",
    "lacp-priority" : 7,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 7,
    "host-enable" : true,
    "loopback" : "no-loopback",
    "rswitch" : 2,
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "pause" : true,
    "bw-bps" : 6,
    "send-port" : 1,
    "port" : "port",
    "stp-port-priority" : 5,
    "loop-vlans" : "loop-vlans",
    "rswitch-mac" : "rswitch-mac",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "vxlan-termination" : "vxlan-termination",
    "stp-port-cost" : 1,
    "config" : "10m",
    "lldp" : true,
    "updown_time" : 3
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-config-show-response
Up
put /port-configs/description/{description}
(updatePortConfigByDescriptionByUsage1)

Path parameters

description (required)
Path Parameter

Consumes

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

Request body

body port-config-modify-1 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-configs/{port}
(updatePortConfigByPortsByUsage1)

Path parameters

port (required)
Path Parameter

Consumes

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

Request body

body port-config-modify-1 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortCosBws

Up
get /port-cos-bws/cos={cos},port={port}
(showPortCosBwByUniqueKeyAll)

Path parameters

cos (required)
Path Parameter
port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "min-bw-guarantee" : "min-bw-guarantee",
    "port" : "port",
    "cos" : 0,
    "weight" : 6,
    "max-bw-limit" : "max-bw-limit",
    "api.switch-name" : "api.switch-name"
  }, {
    "min-bw-guarantee" : "min-bw-guarantee",
    "port" : "port",
    "cos" : 0,
    "weight" : 6,
    "max-bw-limit" : "max-bw-limit",
    "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 port-cos-bw-show-response
Up
get /port-cos-bws
(showPortCosBws)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "min-bw-guarantee" : "min-bw-guarantee",
    "port" : "port",
    "cos" : 0,
    "weight" : 6,
    "max-bw-limit" : "max-bw-limit",
    "api.switch-name" : "api.switch-name"
  }, {
    "min-bw-guarantee" : "min-bw-guarantee",
    "port" : "port",
    "cos" : 0,
    "weight" : 6,
    "max-bw-limit" : "max-bw-limit",
    "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 port-cos-bw-show-response
Up
put /port-cos-bws/cos={cos},port={port}
(updatePortCosBwByUniqueKeyAll)

Path parameters

cos (required)
Path Parameter
port (required)
Path Parameter

Consumes

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

Request body

body port-cos-bw-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortCosRateSettings

Up
get /port-cos-rate-settings/{port}
(showPortCosRateSettingByPort)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "cos9-rate" : 2,
    "cos10-rate" : 4,
    "cos2-rate" : 1,
    "cos6-rate" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "cos1-rate" : 6,
    "cos4-rate" : 5,
    "cos7-rate" : 9,
    "port" : "control-port",
    "cos8-rate" : 3,
    "cos5-rate" : 2,
    "cos0-rate" : 0,
    "cos3-rate" : 5,
    "cos11-rate" : 7
  }, {
    "cos9-rate" : 2,
    "cos10-rate" : 4,
    "cos2-rate" : 1,
    "cos6-rate" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "cos1-rate" : 6,
    "cos4-rate" : 5,
    "cos7-rate" : 9,
    "port" : "control-port",
    "cos8-rate" : 3,
    "cos5-rate" : 2,
    "cos0-rate" : 0,
    "cos3-rate" : 5,
    "cos11-rate" : 7
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-cos-rate-setting-show-response
Up
get /port-cos-rate-settings
(showPortCosRateSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "cos9-rate" : 2,
    "cos10-rate" : 4,
    "cos2-rate" : 1,
    "cos6-rate" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "cos1-rate" : 6,
    "cos4-rate" : 5,
    "cos7-rate" : 9,
    "port" : "control-port",
    "cos8-rate" : 3,
    "cos5-rate" : 2,
    "cos0-rate" : 0,
    "cos3-rate" : 5,
    "cos11-rate" : 7
  }, {
    "cos9-rate" : 2,
    "cos10-rate" : 4,
    "cos2-rate" : 1,
    "cos6-rate" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "cos1-rate" : 6,
    "cos4-rate" : 5,
    "cos7-rate" : 9,
    "port" : "control-port",
    "cos8-rate" : 3,
    "cos5-rate" : 2,
    "cos0-rate" : 0,
    "cos3-rate" : 5,
    "cos11-rate" : 7
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-cos-rate-setting-show-response
Up
put /port-cos-rate-settings/{port}
(updatePortCosRateSettingByPort)

Path parameters

port (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortCosStats

Up
post /port-cos-stats/clear
(clearCosStatsByUsage1)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-cos-stats
(showCosStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 0,
    "within-last" : 6,
    "cos10-droppkts" : 0,
    "cos5-obits" : 1,
    "cos6-opkts" : 9,
    "since-start" : true,
    "cos11-opkts" : 6,
    "cos9-droppkts" : 6,
    "cos8-obits" : 3,
    "cos0-droppkts" : 4,
    "cos3-droppkts" : 2,
    "cos3-opkts" : 3,
    "cos0-opkts" : 0,
    "cos1-dropbits" : 7,
    "cos6-droppkts" : 9,
    "start-time" : "start-time",
    "cos4-obits" : 4,
    "cos4-dropbits" : 7,
    "cos2-opkts" : 5,
    "cos1-obits" : 8,
    "cos8-droppkts" : 2,
    "cos10-obits" : 3,
    "port" : "port",
    "cos9-opkts" : 5,
    "cos2-droppkts" : 2,
    "interval" : 4,
    "cos5-dropbits" : 6,
    "cos7-obits" : 6,
    "cos0-dropbits" : 6,
    "cos1-opkts" : 3,
    "cos6-dropbits" : 5,
    "cos3-dropbits" : 9,
    "cos1-droppkts" : 3,
    "cos7-droppkts" : 6,
    "cos0-obits" : 5,
    "cos11-obits" : 7,
    "cos11-droppkts" : 1,
    "cos4-droppkts" : 1,
    "api.switch-name" : "api.switch-name",
    "cos10-dropbits" : 3,
    "duration" : 3,
    "cos5-opkts" : 7,
    "cos3-obits" : 7,
    "cos8-opkts" : 1,
    "cos9-dropbits" : 6,
    "cos10-opkts" : 7,
    "end-time" : "end-time",
    "cos11-dropbits" : 0,
    "cos5-droppkts" : 1,
    "cos7-opkts" : 9,
    "cos6-obits" : 4,
    "cos7-dropbits" : 8,
    "cos9-obits" : 6,
    "cos4-opkts" : 1,
    "cos8-dropbits" : 6,
    "cos2-obits" : 7,
    "cos2-dropbits" : 5,
    "time" : "time"
  }, {
    "older-than" : 0,
    "within-last" : 6,
    "cos10-droppkts" : 0,
    "cos5-obits" : 1,
    "cos6-opkts" : 9,
    "since-start" : true,
    "cos11-opkts" : 6,
    "cos9-droppkts" : 6,
    "cos8-obits" : 3,
    "cos0-droppkts" : 4,
    "cos3-droppkts" : 2,
    "cos3-opkts" : 3,
    "cos0-opkts" : 0,
    "cos1-dropbits" : 7,
    "cos6-droppkts" : 9,
    "start-time" : "start-time",
    "cos4-obits" : 4,
    "cos4-dropbits" : 7,
    "cos2-opkts" : 5,
    "cos1-obits" : 8,
    "cos8-droppkts" : 2,
    "cos10-obits" : 3,
    "port" : "port",
    "cos9-opkts" : 5,
    "cos2-droppkts" : 2,
    "interval" : 4,
    "cos5-dropbits" : 6,
    "cos7-obits" : 6,
    "cos0-dropbits" : 6,
    "cos1-opkts" : 3,
    "cos6-dropbits" : 5,
    "cos3-dropbits" : 9,
    "cos1-droppkts" : 3,
    "cos7-droppkts" : 6,
    "cos0-obits" : 5,
    "cos11-obits" : 7,
    "cos11-droppkts" : 1,
    "cos4-droppkts" : 1,
    "api.switch-name" : "api.switch-name",
    "cos10-dropbits" : 3,
    "duration" : 3,
    "cos5-opkts" : 7,
    "cos3-obits" : 7,
    "cos8-opkts" : 1,
    "cos9-dropbits" : 6,
    "cos10-opkts" : 7,
    "end-time" : "end-time",
    "cos11-dropbits" : 0,
    "cos5-droppkts" : 1,
    "cos7-opkts" : 9,
    "cos6-obits" : 4,
    "cos7-dropbits" : 8,
    "cos9-obits" : 6,
    "cos4-opkts" : 1,
    "cos8-dropbits" : 6,
    "cos2-obits" : 7,
    "cos2-dropbits" : 5,
    "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 port-cos-stats-show-response
Up
get /port-cos-stats/{port}
(showCosStatsByPort)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 0,
    "within-last" : 6,
    "cos10-droppkts" : 0,
    "cos5-obits" : 1,
    "cos6-opkts" : 9,
    "since-start" : true,
    "cos11-opkts" : 6,
    "cos9-droppkts" : 6,
    "cos8-obits" : 3,
    "cos0-droppkts" : 4,
    "cos3-droppkts" : 2,
    "cos3-opkts" : 3,
    "cos0-opkts" : 0,
    "cos1-dropbits" : 7,
    "cos6-droppkts" : 9,
    "start-time" : "start-time",
    "cos4-obits" : 4,
    "cos4-dropbits" : 7,
    "cos2-opkts" : 5,
    "cos1-obits" : 8,
    "cos8-droppkts" : 2,
    "cos10-obits" : 3,
    "port" : "port",
    "cos9-opkts" : 5,
    "cos2-droppkts" : 2,
    "interval" : 4,
    "cos5-dropbits" : 6,
    "cos7-obits" : 6,
    "cos0-dropbits" : 6,
    "cos1-opkts" : 3,
    "cos6-dropbits" : 5,
    "cos3-dropbits" : 9,
    "cos1-droppkts" : 3,
    "cos7-droppkts" : 6,
    "cos0-obits" : 5,
    "cos11-obits" : 7,
    "cos11-droppkts" : 1,
    "cos4-droppkts" : 1,
    "api.switch-name" : "api.switch-name",
    "cos10-dropbits" : 3,
    "duration" : 3,
    "cos5-opkts" : 7,
    "cos3-obits" : 7,
    "cos8-opkts" : 1,
    "cos9-dropbits" : 6,
    "cos10-opkts" : 7,
    "end-time" : "end-time",
    "cos11-dropbits" : 0,
    "cos5-droppkts" : 1,
    "cos7-opkts" : 9,
    "cos6-obits" : 4,
    "cos7-dropbits" : 8,
    "cos9-obits" : 6,
    "cos4-opkts" : 1,
    "cos8-dropbits" : 6,
    "cos2-obits" : 7,
    "cos2-dropbits" : 5,
    "time" : "time"
  }, {
    "older-than" : 0,
    "within-last" : 6,
    "cos10-droppkts" : 0,
    "cos5-obits" : 1,
    "cos6-opkts" : 9,
    "since-start" : true,
    "cos11-opkts" : 6,
    "cos9-droppkts" : 6,
    "cos8-obits" : 3,
    "cos0-droppkts" : 4,
    "cos3-droppkts" : 2,
    "cos3-opkts" : 3,
    "cos0-opkts" : 0,
    "cos1-dropbits" : 7,
    "cos6-droppkts" : 9,
    "start-time" : "start-time",
    "cos4-obits" : 4,
    "cos4-dropbits" : 7,
    "cos2-opkts" : 5,
    "cos1-obits" : 8,
    "cos8-droppkts" : 2,
    "cos10-obits" : 3,
    "port" : "port",
    "cos9-opkts" : 5,
    "cos2-droppkts" : 2,
    "interval" : 4,
    "cos5-dropbits" : 6,
    "cos7-obits" : 6,
    "cos0-dropbits" : 6,
    "cos1-opkts" : 3,
    "cos6-dropbits" : 5,
    "cos3-dropbits" : 9,
    "cos1-droppkts" : 3,
    "cos7-droppkts" : 6,
    "cos0-obits" : 5,
    "cos11-obits" : 7,
    "cos11-droppkts" : 1,
    "cos4-droppkts" : 1,
    "api.switch-name" : "api.switch-name",
    "cos10-dropbits" : 3,
    "duration" : 3,
    "cos5-opkts" : 7,
    "cos3-obits" : 7,
    "cos8-opkts" : 1,
    "cos9-dropbits" : 6,
    "cos10-opkts" : 7,
    "end-time" : "end-time",
    "cos11-dropbits" : 0,
    "cos5-droppkts" : 1,
    "cos7-opkts" : 9,
    "cos6-obits" : 4,
    "cos7-dropbits" : 8,
    "cos9-obits" : 6,
    "cos4-opkts" : 1,
    "cos8-dropbits" : 6,
    "cos2-obits" : 7,
    "cos2-dropbits" : 5,
    "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 port-cos-stats-show-response

PortCosStatsSettings

Up
get /port-cos-stats-settings
(showCosStatsSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 port-cos-stats-settings-show-response
Up
put /port-cos-stats-settings
(updateCosStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortCosWeight

Up
get /port-cos-weight
(showPortCosWeight)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "cos9-weight" : 2,
    "cos7-weight" : 9,
    "cos6-weight" : 7,
    "cos8-weight" : 3,
    "cos11-weight" : 7,
    "cos10-weight" : 4,
    "api.switch-name" : "api.switch-name",
    "cos1-weight" : 6,
    "cos2-weight" : 1,
    "cos0-weight" : 0,
    "cos3-weight" : 5,
    "cos4-weight" : 5,
    "cos5-weight" : 2
  }, {
    "cos9-weight" : 2,
    "cos7-weight" : 9,
    "cos6-weight" : 7,
    "cos8-weight" : 3,
    "cos11-weight" : 7,
    "cos10-weight" : 4,
    "api.switch-name" : "api.switch-name",
    "cos1-weight" : 6,
    "cos2-weight" : 1,
    "cos0-weight" : 0,
    "cos3-weight" : 5,
    "cos4-weight" : 5,
    "cos5-weight" : 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 port-cos-weight-show-response
Up
put /port-cos-weight
(updatePortCosWeight)

Consumes

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

Request body

body port-cos-weight-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortEgresses

Up
get /port-egresses/check
(checkPortEgress)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "active-active-vlags" : "active-active-vlags",
    "no-local-switching" : "no-local-switching",
    "port" : "port",
    "rx-only" : "rx-only",
    "api.switch-name" : "api.switch-name",
    "mir_prevent_out" : "mir_prevent_out",
    "egress" : "egress",
    "loopback" : "loopback"
  }, {
    "active-active-vlags" : "active-active-vlags",
    "no-local-switching" : "no-local-switching",
    "port" : "port",
    "rx-only" : "rx-only",
    "api.switch-name" : "api.switch-name",
    "mir_prevent_out" : "mir_prevent_out",
    "egress" : "egress",
    "loopback" : "loopback"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-egress-show-response
Up
get /port-egresses/fix
(fixPortEgress)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "active-active-vlags" : "active-active-vlags",
    "no-local-switching" : "no-local-switching",
    "port" : "port",
    "rx-only" : "rx-only",
    "api.switch-name" : "api.switch-name",
    "mir_prevent_out" : "mir_prevent_out",
    "egress" : "egress",
    "loopback" : "loopback"
  }, {
    "active-active-vlags" : "active-active-vlags",
    "no-local-switching" : "no-local-switching",
    "port" : "port",
    "rx-only" : "rx-only",
    "api.switch-name" : "api.switch-name",
    "mir_prevent_out" : "mir_prevent_out",
    "egress" : "egress",
    "loopback" : "loopback"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-egress-show-response
Up
get /port-egresses/{port}
(showPortEgressByPorts)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "active-active-vlags" : "active-active-vlags",
    "no-local-switching" : "no-local-switching",
    "port" : "port",
    "rx-only" : "rx-only",
    "api.switch-name" : "api.switch-name",
    "mir_prevent_out" : "mir_prevent_out",
    "egress" : "egress",
    "loopback" : "loopback"
  }, {
    "active-active-vlags" : "active-active-vlags",
    "no-local-switching" : "no-local-switching",
    "port" : "port",
    "rx-only" : "rx-only",
    "api.switch-name" : "api.switch-name",
    "mir_prevent_out" : "mir_prevent_out",
    "egress" : "egress",
    "loopback" : "loopback"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-egress-show-response
Up
get /port-egresses
(showPortEgresses)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "active-active-vlags" : "active-active-vlags",
    "no-local-switching" : "no-local-switching",
    "port" : "port",
    "rx-only" : "rx-only",
    "api.switch-name" : "api.switch-name",
    "mir_prevent_out" : "mir_prevent_out",
    "egress" : "egress",
    "loopback" : "loopback"
  }, {
    "active-active-vlags" : "active-active-vlags",
    "no-local-switching" : "no-local-switching",
    "port" : "port",
    "rx-only" : "rx-only",
    "api.switch-name" : "api.switch-name",
    "mir_prevent_out" : "mir_prevent_out",
    "egress" : "egress",
    "loopback" : "loopback"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-egress-show-response

PortFecStatsSettings

Up
get /port-fec-stats-settings
(showPortFecStatsSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 port-fec-stats-settings-show-response
Up
put /port-fec-stats-settings
(updatePortFecStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortForceLinkups

Up
post /port-force-linkups/add
(addPortForceLinkup)

Consumes

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

Request body

body port-force-linkup-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-force-linkups/remove
(removePortForceLinkup)

Consumes

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

Request body

body port-force-linkup-remove (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-force-linkups/{port-id}
(showPortForceLinkupByPortId)

Path parameters

port-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mode" : "tx",
    "port-id" : 0,
    "api.switch-name" : "api.switch-name"
  }, {
    "mode" : "tx",
    "port-id" : 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 port-force-linkup-show-response
Up
get /port-force-linkups
(showPortForceLinkups)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mode" : "tx",
    "port-id" : 0,
    "api.switch-name" : "api.switch-name"
  }, {
    "mode" : "tx",
    "port-id" : 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 port-force-linkup-show-response

PortGroups

Up
get /port-groups/ports={ports},device={device}
(showPortGroupByUniqueKeyAll)

Path parameters

ports (required)
Path Parameter
device (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "device" : 0
  }, {
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "device" : 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 port-group-show-response
Up
get /port-groups
(showPortGroups)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "device" : 0
  }, {
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "device" : 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 port-group-show-response

PortLacpStats

Up
post /port-lacp-stats/clear
(clearPortLacpStats)

Consumes

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

Request body

body port-lacp-stats-clear (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-lacp-stats
(showPortLacpStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "lacp-defaulted" : 9,
    "lacp-pdu-tx" : 5,
    "start-time" : "start-time",
    "within-last" : 1,
    "lacp-pdu-rx" : 3,
    "lacp-expired" : 2,
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 2,
    "lacp-allocate-failure" : 1,
    "port" : "port",
    "lacp-port-down" : 6,
    "lacp-marker-rx" : 7,
    "lacp-port-up" : 5,
    "lacp-marker-tx" : 0,
    "interval" : 4,
    "time" : "time"
  }, {
    "older-than" : 7,
    "lacp-defaulted" : 9,
    "lacp-pdu-tx" : 5,
    "start-time" : "start-time",
    "within-last" : 1,
    "lacp-pdu-rx" : 3,
    "lacp-expired" : 2,
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 2,
    "lacp-allocate-failure" : 1,
    "port" : "port",
    "lacp-port-down" : 6,
    "lacp-marker-rx" : 7,
    "lacp-port-up" : 5,
    "lacp-marker-tx" : 0,
    "interval" : 4,
    "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 port-lacp-stats-show-response
Up
get /port-lacp-stats/{port}
(showPortLacpStatsByPort)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "lacp-defaulted" : 9,
    "lacp-pdu-tx" : 5,
    "start-time" : "start-time",
    "within-last" : 1,
    "lacp-pdu-rx" : 3,
    "lacp-expired" : 2,
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 2,
    "lacp-allocate-failure" : 1,
    "port" : "port",
    "lacp-port-down" : 6,
    "lacp-marker-rx" : 7,
    "lacp-port-up" : 5,
    "lacp-marker-tx" : 0,
    "interval" : 4,
    "time" : "time"
  }, {
    "older-than" : 7,
    "lacp-defaulted" : 9,
    "lacp-pdu-tx" : 5,
    "start-time" : "start-time",
    "within-last" : 1,
    "lacp-pdu-rx" : 3,
    "lacp-expired" : 2,
    "end-time" : "end-time",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 2,
    "lacp-allocate-failure" : 1,
    "port" : "port",
    "lacp-port-down" : 6,
    "lacp-marker-rx" : 7,
    "lacp-port-up" : 5,
    "lacp-marker-tx" : 0,
    "interval" : 4,
    "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 port-lacp-stats-show-response

PortLacps

Up
get /port-lacps/{port}
(showPortLacpByPort)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "coll" : true,
    "aggregatable" : true,
    "dist" : true,
    "api.switch-name" : "api.switch-name",
    "neighbor" : true,
    "sync" : true,
    "system-priority" : 1,
    "timeout" : "slow",
    "mode" : "off",
    "expired" : true,
    "port" : "port",
    "system-id" : "system-id",
    "defaulted" : true,
    "name" : "name",
    "port-priority" : 6,
    "port-type" : "none",
    "test-mode" : "none",
    "port-state" : "port-state",
    "lacp-key" : 0
  }, {
    "coll" : true,
    "aggregatable" : true,
    "dist" : true,
    "api.switch-name" : "api.switch-name",
    "neighbor" : true,
    "sync" : true,
    "system-priority" : 1,
    "timeout" : "slow",
    "mode" : "off",
    "expired" : true,
    "port" : "port",
    "system-id" : "system-id",
    "defaulted" : true,
    "name" : "name",
    "port-priority" : 6,
    "port-type" : "none",
    "test-mode" : "none",
    "port-state" : "port-state",
    "lacp-key" : 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 port-lacp-show-response
Up
get /port-lacps
(showPortLacps)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "coll" : true,
    "aggregatable" : true,
    "dist" : true,
    "api.switch-name" : "api.switch-name",
    "neighbor" : true,
    "sync" : true,
    "system-priority" : 1,
    "timeout" : "slow",
    "mode" : "off",
    "expired" : true,
    "port" : "port",
    "system-id" : "system-id",
    "defaulted" : true,
    "name" : "name",
    "port-priority" : 6,
    "port-type" : "none",
    "test-mode" : "none",
    "port-state" : "port-state",
    "lacp-key" : 0
  }, {
    "coll" : true,
    "aggregatable" : true,
    "dist" : true,
    "api.switch-name" : "api.switch-name",
    "neighbor" : true,
    "sync" : true,
    "system-priority" : 1,
    "timeout" : "slow",
    "mode" : "off",
    "expired" : true,
    "port" : "port",
    "system-id" : "system-id",
    "defaulted" : true,
    "name" : "name",
    "port-priority" : 6,
    "port-type" : "none",
    "test-mode" : "none",
    "port-state" : "port-state",
    "lacp-key" : 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 port-lacp-show-response
Up
put /port-lacps/{port}
(updatePortLacpByPort)

Path parameters

port (required)
Path Parameter

Consumes

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

Request body

body port-lacp-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortLldps

Up
get /port-lldps/{port}
(showPortLldpByPorts)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : "port",
    "api.switch-name" : "api.switch-name",
    "lldp" : true
  }, {
    "port" : "port",
    "api.switch-name" : "api.switch-name",
    "lldp" : 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 port-lldp-show-response
Up
get /port-lldps
(showPortLldps)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : "port",
    "api.switch-name" : "api.switch-name",
    "lldp" : true
  }, {
    "port" : "port",
    "api.switch-name" : "api.switch-name",
    "lldp" : 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 port-lldp-show-response
Up
put /port-lldps/{port}
(updatePortLldpByPorts)

Path parameters

port (required)
Path Parameter

Consumes

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

Request body

body port-lldp-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortLpmode

Up
post /port-lpmode/recover
(recoverPortRecoverLpmode)

Consumes

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

Request body

body port-lpmode-recover (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortPfcStats

Up
post /port-pfc-stats/clear
(clearPortPfcStatsByUsage1)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-pfc-stats
(showPortPfcStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 4,
    "pri6-tx" : 1,
    "within-last" : 5,
    "pri4-rx" : 3,
    "pri4-tx" : 2,
    "pri2-tx" : 2,
    "pri6-rx" : 1,
    "pri0-tx" : 6,
    "pri2-rx" : 5,
    "pri0-rx" : 0,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 7,
    "pri7-rx" : 1,
    "pri5-tx" : 7,
    "pri7-tx" : 6,
    "start-time" : "start-time",
    "pri3-tx" : 9,
    "pri1-tx" : 5,
    "pri3-rx" : 7,
    "end-time" : "end-time",
    "pri5-rx" : 4,
    "pri1-rx" : 1,
    "port" : "port",
    "interval" : 1,
    "time" : "time"
  }, {
    "older-than" : 4,
    "pri6-tx" : 1,
    "within-last" : 5,
    "pri4-rx" : 3,
    "pri4-tx" : 2,
    "pri2-tx" : 2,
    "pri6-rx" : 1,
    "pri0-tx" : 6,
    "pri2-rx" : 5,
    "pri0-rx" : 0,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 7,
    "pri7-rx" : 1,
    "pri5-tx" : 7,
    "pri7-tx" : 6,
    "start-time" : "start-time",
    "pri3-tx" : 9,
    "pri1-tx" : 5,
    "pri3-rx" : 7,
    "end-time" : "end-time",
    "pri5-rx" : 4,
    "pri1-rx" : 1,
    "port" : "port",
    "interval" : 1,
    "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 port-pfc-stats-show-response
Up
get /port-pfc-stats/{port}
(showPortPfcStatsByPort)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 4,
    "pri6-tx" : 1,
    "within-last" : 5,
    "pri4-rx" : 3,
    "pri4-tx" : 2,
    "pri2-tx" : 2,
    "pri6-rx" : 1,
    "pri0-tx" : 6,
    "pri2-rx" : 5,
    "pri0-rx" : 0,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 7,
    "pri7-rx" : 1,
    "pri5-tx" : 7,
    "pri7-tx" : 6,
    "start-time" : "start-time",
    "pri3-tx" : 9,
    "pri1-tx" : 5,
    "pri3-rx" : 7,
    "end-time" : "end-time",
    "pri5-rx" : 4,
    "pri1-rx" : 1,
    "port" : "port",
    "interval" : 1,
    "time" : "time"
  }, {
    "older-than" : 4,
    "pri6-tx" : 1,
    "within-last" : 5,
    "pri4-rx" : 3,
    "pri4-tx" : 2,
    "pri2-tx" : 2,
    "pri6-rx" : 1,
    "pri0-tx" : 6,
    "pri2-rx" : 5,
    "pri0-rx" : 0,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 7,
    "pri7-rx" : 1,
    "pri5-tx" : 7,
    "pri7-tx" : 6,
    "start-time" : "start-time",
    "pri3-tx" : 9,
    "pri1-tx" : 5,
    "pri3-rx" : 7,
    "end-time" : "end-time",
    "pri5-rx" : 4,
    "pri1-rx" : 1,
    "port" : "port",
    "interval" : 1,
    "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 port-pfc-stats-show-response

PortPfcStatsSettings

Up
get /port-pfc-stats-settings
(showPortPfcStatsSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 port-pfc-stats-settings-show-response
Up
put /port-pfc-stats-settings
(updatePortPfcStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortPfcs

Up
post /port-pfcs
(createPortPfc)

Consumes

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

Request body

body port-pfc-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-pfcs/{priority}
(deletePortPfcByPriority)

Path parameters

priority (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-pfcs/{priority}
(showPortPfcByPriority)

Path parameters

priority (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : "port",
    "priority" : 0,
    "error" : "error",
    "api.switch-name" : "api.switch-name"
  }, {
    "port" : "port",
    "priority" : 0,
    "error" : "error",
    "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 port-pfc-show-response
Up
get /port-pfcs
(showPortPfcs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : "port",
    "priority" : 0,
    "error" : "error",
    "api.switch-name" : "api.switch-name"
  }, {
    "port" : "port",
    "priority" : 0,
    "error" : "error",
    "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 port-pfc-show-response
Up
put /port-pfcs/{priority}
(updatePortPfcByPriority)

Path parameters

priority (required)
Path Parameter

Consumes

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

Request body

body port-pfc-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortPhys

Up
get /port-phys
(showPhysPorts)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "def-vlan" : 5,
    "dfe-coarse" : "not-started",
    "fec" : "fec",
    "medium" : "medium",
    "bezel-port" : "bezel-port",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "mode" : "off",
    "dfe-fine" : "not-started",
    "port" : 0,
    "max-frame" : 1,
    "eth-mode" : "1000base-x",
    "dfe-mode" : "static",
    "state" : "off",
    "autoneg" : "autoneg"
  }, {
    "def-vlan" : 5,
    "dfe-coarse" : "not-started",
    "fec" : "fec",
    "medium" : "medium",
    "bezel-port" : "bezel-port",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "mode" : "off",
    "dfe-fine" : "not-started",
    "port" : 0,
    "max-frame" : 1,
    "eth-mode" : "1000base-x",
    "dfe-mode" : "static",
    "state" : "off",
    "autoneg" : "autoneg"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-phy-show-response

PortStats

Up
post /port-stats/clear
(clearPortStatsByUsage1)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-stats
(showPortStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "port" : "port",
    "oPauseFs" : 4,
    "interval" : 1,
    "time" : "time",
    "obits" : 6
  }, {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "port" : "port",
    "oPauseFs" : 4,
    "interval" : 1,
    "time" : "time",
    "obits" : 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 port-stats-show-response
Up
get /port-stats/{port}
(showPortStatsByPortNum)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "port" : "port",
    "oPauseFs" : 4,
    "interval" : 1,
    "time" : "time",
    "obits" : 6
  }, {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "port" : "port",
    "oPauseFs" : 4,
    "interval" : 1,
    "time" : "time",
    "obits" : 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 port-stats-show-response

PortStatsSettings

Up
get /port-stats-settings
(showPortStatsSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "disk-space" : 6,
    "enable" : true,
    "interval" : 0,
    "congestion-threshold" : 1,
    "api.switch-name" : "api.switch-name"
  }, {
    "disk-space" : 6,
    "enable" : true,
    "interval" : 0,
    "congestion-threshold" : 1,
    "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 port-stats-settings-show-response
Up
put /port-stats-settings
(updatePortStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortStatsSnmps

Up
get /port-stats-snmps/{port}
(showPortStatsSnmpByPortNum)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 1,
    "port-clear-count" : 0,
    "HER-bytes" : 9,
    "iUpkts" : 7,
    "oPkts" : 3,
    "port_clear_time" : 6,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "all-ports" : true,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 2,
    "obytes" : 9,
    "port-clear-time" : 1,
    "iMpkts" : 7,
    "ierrs" : 9,
    "oMpkts" : 2,
    "HER-bits" : 6,
    "ibytes" : 5,
    "odiscards" : 1,
    "counter" : 5,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 9,
    "port" : "port",
    "oPauseFs" : 4,
    "obits" : 6
  }, {
    "iPauseFs" : 1,
    "port-clear-count" : 0,
    "HER-bytes" : 9,
    "iUpkts" : 7,
    "oPkts" : 3,
    "port_clear_time" : 6,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "all-ports" : true,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 2,
    "obytes" : 9,
    "port-clear-time" : 1,
    "iMpkts" : 7,
    "ierrs" : 9,
    "oMpkts" : 2,
    "HER-bits" : 6,
    "ibytes" : 5,
    "odiscards" : 1,
    "counter" : 5,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 9,
    "port" : "port",
    "oPauseFs" : 4,
    "obits" : 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 port-stats-snmp-show-response
Up
get /port-stats-snmps
(showPortStatsSnmps)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 1,
    "port-clear-count" : 0,
    "HER-bytes" : 9,
    "iUpkts" : 7,
    "oPkts" : 3,
    "port_clear_time" : 6,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "all-ports" : true,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 2,
    "obytes" : 9,
    "port-clear-time" : 1,
    "iMpkts" : 7,
    "ierrs" : 9,
    "oMpkts" : 2,
    "HER-bits" : 6,
    "ibytes" : 5,
    "odiscards" : 1,
    "counter" : 5,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 9,
    "port" : "port",
    "oPauseFs" : 4,
    "obits" : 6
  }, {
    "iPauseFs" : 1,
    "port-clear-count" : 0,
    "HER-bytes" : 9,
    "iUpkts" : 7,
    "oPkts" : 3,
    "port_clear_time" : 6,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "all-ports" : true,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 2,
    "obytes" : 9,
    "port-clear-time" : 1,
    "iMpkts" : 7,
    "ierrs" : 9,
    "oMpkts" : 2,
    "HER-bits" : 6,
    "ibytes" : 5,
    "odiscards" : 1,
    "counter" : 5,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 9,
    "port" : "port",
    "oPauseFs" : 4,
    "obits" : 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 port-stats-snmp-show-response

PortStormControls

Up
get /port-storm-controls/intf/{intf}
(showPortStormControlById)

Path parameters

intf (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "rswitch" : 9,
    "trunk" : 7,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "port" : "port",
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 1,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 6,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "intf" : 0,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 7,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "stp-port-cost" : 5,
    "config" : "10m"
  }, {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "rswitch" : 9,
    "trunk" : 7,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "port" : "port",
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 1,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 6,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "intf" : 0,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 7,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "stp-port-cost" : 5,
    "config" : "10m"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-storm-control-show-response
Up
get /port-storm-controls/name/{name}
(showPortStormControlByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "rswitch" : 9,
    "trunk" : 7,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "port" : "port",
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 1,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 6,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "intf" : 0,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 7,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "stp-port-cost" : 5,
    "config" : "10m"
  }, {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "rswitch" : 9,
    "trunk" : 7,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "port" : "port",
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 1,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 6,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "intf" : 0,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 7,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "stp-port-cost" : 5,
    "config" : "10m"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-storm-control-show-response
Up
get /port-storm-controls/port/{port}
(showPortStormControlByPorts)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "rswitch" : 9,
    "trunk" : 7,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "port" : "port",
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 1,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 6,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "intf" : 0,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 7,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "stp-port-cost" : 5,
    "config" : "10m"
  }, {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "rswitch" : 9,
    "trunk" : 7,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "port" : "port",
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 1,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 6,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "intf" : 0,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 7,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "stp-port-cost" : 5,
    "config" : "10m"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-storm-control-show-response
Up
get /port-storm-controls
(showPortStormControls)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "rswitch" : 9,
    "trunk" : 7,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "port" : "port",
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 1,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 6,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "intf" : 0,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 7,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "stp-port-cost" : 5,
    "config" : "10m"
  }, {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "rswitch" : 9,
    "trunk" : 7,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "port" : "port",
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 1,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 6,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "intf" : 0,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 7,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "crc-check" : "crc-check-enable",
    "stp-port-cost" : 5,
    "config" : "10m"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-storm-control-show-response
Up
put /port-storm-controls/{port}
(updatePortStormControlByPorts)

Path parameters

port (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

PortVlans

Up
post /port-vlans/add
(customAddPortVlan)

Consumes

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

Request body

body port-vlan-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-vlans/remove
(customRemovePortVlan)

Consumes

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

Request body

body port-vlan-remove (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /port-vlans/{port-desc}
(showPortVlanByPortDesc)

Path parameters

port-desc (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "untagged-vlan" : 6,
    "port" : 0,
    "vnet-id" : "vnet-id",
    "port-desc" : "port-desc",
    "description" : "description",
    "bezel-port" : "bezel-port",
    "ports" : "ports",
    "active-vlans" : "active-vlans",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlans" : "vlans",
    "untagged-vlan" : 6,
    "port" : 0,
    "vnet-id" : "vnet-id",
    "port-desc" : "port-desc",
    "description" : "description",
    "bezel-port" : "bezel-port",
    "ports" : "ports",
    "active-vlans" : "active-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 port-vlan-show-response
Up
get /port-vlans
(showPortVlans)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "untagged-vlan" : 6,
    "port" : 0,
    "vnet-id" : "vnet-id",
    "port-desc" : "port-desc",
    "description" : "description",
    "bezel-port" : "bezel-port",
    "ports" : "ports",
    "active-vlans" : "active-vlans",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlans" : "vlans",
    "untagged-vlan" : 6,
    "port" : 0,
    "vnet-id" : "vnet-id",
    "port-desc" : "port-desc",
    "description" : "description",
    "bezel-port" : "bezel-port",
    "ports" : "ports",
    "active-vlans" : "active-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 port-vlan-show-response

PortVnets

Up
get /port-vnets/{name}
(showPortVnetByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-vnet-show-response
Up
get /port-vnets
(showPortVnets)

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-vnet-show-response

PortXcvrMemories

Up
get /port-xcvr-memories
(showXcvrMemories)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "pages" : "pages",
    "port" : 0,
    "api.switch-name" : "api.switch-name"
  }, {
    "pages" : "pages",
    "port" : 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 port-xcvr-memory-show-response

PortXcvrs

Up
get /port-xcvrs
(showXcvrPorts)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vcc10[V]" : "vcc10[V]",
    "temp[C]" : "temp[C]",
    "serial-number" : "serial-number",
    "vendor-part-number" : "vendor-part-number",
    "vcc33[V]" : "vcc33[V]",
    "rx-pwr[dBm]" : "rx-pwr[dBm]",
    "bezel-port" : "bezel-port",
    "tx-bias[mA]" : "tx-bias[mA]",
    "type" : "unknown",
    "api.switch-name" : "api.switch-name",
    "port" : 0,
    "vcc18[V]" : "vcc18[V]",
    "fw-rev" : "fw-rev",
    "part-number" : "part-number",
    "eth-mode" : "1000base-x",
    "vendor-name" : "vendor-name",
    "state" : "default",
    "cbl-len" : 6,
    "supported" : true,
    "tx-pwr[dBm]" : "tx-pwr[dBm]"
  }, {
    "vcc10[V]" : "vcc10[V]",
    "temp[C]" : "temp[C]",
    "serial-number" : "serial-number",
    "vendor-part-number" : "vendor-part-number",
    "vcc33[V]" : "vcc33[V]",
    "rx-pwr[dBm]" : "rx-pwr[dBm]",
    "bezel-port" : "bezel-port",
    "tx-bias[mA]" : "tx-bias[mA]",
    "type" : "unknown",
    "api.switch-name" : "api.switch-name",
    "port" : 0,
    "vcc18[V]" : "vcc18[V]",
    "fw-rev" : "fw-rev",
    "part-number" : "part-number",
    "eth-mode" : "1000base-x",
    "vendor-name" : "vendor-name",
    "state" : "default",
    "cbl-len" : 6,
    "supported" : true,
    "tx-pwr[dBm]" : "tx-pwr[dBm]"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-xcvr-show-response

Ports

Up
get /ports
(showVports)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "err-bpduguard" : 7,
    "bd" : "bd",
    "link-detail" : true,
    "rport" : 1,
    "description" : "description",
    "lport" : 5,
    "bezel-port" : "bezel-port",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnet" : "vnet",
    "hide-connections" : true,
    "hostname" : "hostname",
    "vlan" : 0,
    "recover-time" : 5,
    "vxlan" : 6,
    "rswitch" : 2,
    "ip" : "ip",
    "rem-mac" : "rem-mac",
    "trunk" : "trunk",
    "last-seen" : "last-seen",
    "err-maclimit" : 9,
    "rem-ip" : "rem-ip",
    "port" : "port",
    "loop-vlans" : "loop-vlans",
    "switch-id" : 3,
    "config" : "10m",
    "status" : "phy-up"
  }, {
    "err-bpduguard" : 7,
    "bd" : "bd",
    "link-detail" : true,
    "rport" : 1,
    "description" : "description",
    "lport" : 5,
    "bezel-port" : "bezel-port",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnet" : "vnet",
    "hide-connections" : true,
    "hostname" : "hostname",
    "vlan" : 0,
    "recover-time" : 5,
    "vxlan" : 6,
    "rswitch" : 2,
    "ip" : "ip",
    "rem-mac" : "rem-mac",
    "trunk" : "trunk",
    "last-seen" : "last-seen",
    "err-maclimit" : 9,
    "rem-ip" : "rem-ip",
    "port" : "port",
    "loop-vlans" : "loop-vlans",
    "switch-id" : 3,
    "config" : "10m",
    "status" : "phy-up"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success port-show-response

PrefixLists

Up
post /prefix-lists/{name}/networks
(addNvOSPrefixListNetworkByNvOSPrefixListName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body prefix-list-network-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /prefix-lists
(createNvOSPrefixList)

Consumes

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

Request body

body prefix-list-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /prefix-lists/{name}
(deleteNvOSPrefixListByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /prefix-lists/{name}/networks/netmask/{netmask}
(removeNvOSPrefixListNetworkByNameByNetmask)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /prefix-lists/{name}/networks/network/{network}
(removeNvOSPrefixListNetworkByNameByNetwork)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /prefix-lists/{name}
(showNvOSPrefixListByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 prefix-list-show-response
Up
get /prefix-lists/{name}/networks/netmask/{netmask}
(showNvOSPrefixListNetworkByNameByNetmask)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 prefix-list-network-show-response
Up
get /prefix-lists/{name}/networks/network/{network}
(showNvOSPrefixListNetworkByNameByNetwork)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 prefix-list-network-show-response
Up
get /prefix-lists/{name}/networks
(showNvOSPrefixListNetworksByNvOSPrefixListName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 prefix-list-network-show-response
Up
get /prefix-lists
(showNvOSPrefixLists)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 prefix-list-show-response

Ptp

Up
get /ptp
(showPtp)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "slave-port" : 5,
    "sync-interval" : 2,
    "last-delay" : 6,
    "last-time-correction" : 0,
    "enable" : true,
    "master-ports" : "master-ports",
    "last-frequency-correction" : 1,
    "frequency-adjust-interval" : 7,
    "current-time" : "current-time",
    "clock-frequency" : 5,
    "api.switch-name" : "api.switch-name"
  }, {
    "slave-port" : 5,
    "sync-interval" : 2,
    "last-delay" : 6,
    "last-time-correction" : 0,
    "enable" : true,
    "master-ports" : "master-ports",
    "last-frequency-correction" : 1,
    "frequency-adjust-interval" : 7,
    "current-time" : "current-time",
    "clock-frequency" : 5,
    "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 ptp-show-response
Up
put /ptp
(updatePtp)

Consumes

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

Request body

body ptp-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Roles

Up
post /roles
(createRole)

Consumes

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

Request body

body role-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /roles/{name}
(deleteRoleByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /roles/{name}
(showRoleByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "access" : "read-only",
    "group-id" : 0,
    "shell" : true,
    "scope" : "local",
    "running-config" : true,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "sudo" : true,
    "id" : "id",
    "api.switch-name" : "api.switch-name",
    "delete-from-users" : true
  }, {
    "access" : "read-only",
    "group-id" : 0,
    "shell" : true,
    "scope" : "local",
    "running-config" : true,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "sudo" : true,
    "id" : "id",
    "api.switch-name" : "api.switch-name",
    "delete-from-users" : 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 role-show-response
Up
get /roles
(showRoles)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "access" : "read-only",
    "group-id" : 0,
    "shell" : true,
    "scope" : "local",
    "running-config" : true,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "sudo" : true,
    "id" : "id",
    "api.switch-name" : "api.switch-name",
    "delete-from-users" : true
  }, {
    "access" : "read-only",
    "group-id" : 0,
    "shell" : true,
    "scope" : "local",
    "running-config" : true,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "sudo" : true,
    "id" : "id",
    "api.switch-name" : "api.switch-name",
    "delete-from-users" : 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 role-show-response
Up
put /roles/{name}
(updateRoleByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body role-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

ServiceHeartbeats

Up
post /service-heartbeats
(createServiceHeartbeat)

Consumes

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

Request body

body service-heartbeat-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /service-heartbeats/{name}
(deleteServiceHeartbeatByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /service-heartbeats/{name}
(showServiceHeartbeatByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dst-mac" : "dst-mac",
    "vlan" : 1,
    "payload" : "payload",
    "name" : "name",
    "src-mac" : "src-mac",
    "interval" : 0,
    "type" : "normal",
    "api.switch-name" : "api.switch-name",
    "retry" : 6
  }, {
    "dst-mac" : "dst-mac",
    "vlan" : 1,
    "payload" : "payload",
    "name" : "name",
    "src-mac" : "src-mac",
    "interval" : 0,
    "type" : "normal",
    "api.switch-name" : "api.switch-name",
    "retry" : 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 service-heartbeat-show-response
Up
get /service-heartbeats
(showServiceHeartbeats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dst-mac" : "dst-mac",
    "vlan" : 1,
    "payload" : "payload",
    "name" : "name",
    "src-mac" : "src-mac",
    "interval" : 0,
    "type" : "normal",
    "api.switch-name" : "api.switch-name",
    "retry" : 6
  }, {
    "dst-mac" : "dst-mac",
    "vlan" : 1,
    "payload" : "payload",
    "name" : "name",
    "src-mac" : "src-mac",
    "interval" : 0,
    "type" : "normal",
    "api.switch-name" : "api.switch-name",
    "retry" : 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 service-heartbeat-show-response
Up
put /service-heartbeats/{name}
(updateServiceHeartbeatByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body service-heartbeat-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

ServiceStats

Up
post /service-stats/clear
(clearServiceStat)

Consumes

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

Request body

body service-stats-clear (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /service-stats
(showServiceStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "service" : 0,
    "bytes" : 6,
    "api.switch-name" : "api.switch-name"
  }, {
    "service" : 0,
    "bytes" : 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 service-stats-show-response

SflowCollectors

Up
post /sflow-collectors
(createSflowCollector)

Consumes

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

Request body

body sflow-collector-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /sflow-collectors/{name}
(deleteSflowCollectorByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /sflow-collectors/{name}
(showSflowCollectorByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "collector-port" : 0,
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "collector-ip" : "collector-ip"
  }, {
    "collector-port" : 0,
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "collector-ip" : "collector-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 sflow-collector-show-response
Up
get /sflow-collectors
(showSflowCollectors)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "collector-port" : 0,
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "collector-ip" : "collector-ip"
  }, {
    "collector-port" : 0,
    "scope" : "local",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "collector-ip" : "collector-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 sflow-collector-show-response
Up
put /sflow-collectors/{name}
(updateSflowCollectorByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body sflow-collector-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SflowThreadBindings

Up
get /sflow-thread-bindings/{name}
(showSflowThreadBindingByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "nv-msg-queue-name" : "nv-msg-queue-name",
    "name" : "name",
    "nv-cache-queue-name" : "nv-cache-queue-name",
    "api.switch-name" : "api.switch-name",
    "thread-id" : 0
  }, {
    "nv-msg-queue-name" : "nv-msg-queue-name",
    "name" : "name",
    "nv-cache-queue-name" : "nv-cache-queue-name",
    "api.switch-name" : "api.switch-name",
    "thread-id" : 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 sflow-thread-binding-show-response
Up
get /sflow-thread-bindings
(showSflowThreadBindings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "nv-msg-queue-name" : "nv-msg-queue-name",
    "name" : "name",
    "nv-cache-queue-name" : "nv-cache-queue-name",
    "api.switch-name" : "api.switch-name",
    "thread-id" : 0
  }, {
    "nv-msg-queue-name" : "nv-msg-queue-name",
    "name" : "name",
    "nv-cache-queue-name" : "nv-cache-queue-name",
    "api.switch-name" : "api.switch-name",
    "thread-id" : 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 sflow-thread-binding-show-response

Sflows

Up
post /sflows/{sflow-name}/ports
(addSflowSflowPortBySflowName)

Path parameters

sflow-name (required)
Path Parameter

Consumes

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

Request body

body sflow-port-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /sflows
(createSflow)

Consumes

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

Request body

body sflow-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /sflows/{name}
(deleteSflowByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /sflows/{sflow-name}/ports/{ports}
(removeSflowSflowPortByNameByPmap)

Path parameters

sflow-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /sflows/{name}
(showSflowByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "sample-pkt-cnt" : 6,
    "malformed-ip-packet-drops" : 2,
    "sample-rate" : 2,
    "malformed-packet-drops" : 5,
    "malformed-vlan-packet-drops" : 5,
    "internal-nq-drops" : 3,
    "type" : "ingress",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "internal-q-drops" : 7,
    "trunc-length" : 7,
    "agent-id" : "agent-id",
    "vlan" : 0,
    "oversize-packet-drops" : 9,
    "counter-polling-interval" : 4,
    "name" : "name",
    "sample-drops" : 1,
    "sample-type" : "raw"
  }, {
    "sample-pkt-cnt" : 6,
    "malformed-ip-packet-drops" : 2,
    "sample-rate" : 2,
    "malformed-packet-drops" : 5,
    "malformed-vlan-packet-drops" : 5,
    "internal-nq-drops" : 3,
    "type" : "ingress",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "internal-q-drops" : 7,
    "trunc-length" : 7,
    "agent-id" : "agent-id",
    "vlan" : 0,
    "oversize-packet-drops" : 9,
    "counter-polling-interval" : 4,
    "name" : "name",
    "sample-drops" : 1,
    "sample-type" : "raw"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success sflow-show-response
Up
get /sflows/{sflow-name}/ports/{ports}
(showSflowSflowPortByNameByPmap)

Path parameters

sflow-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 sflow-port-show-response
Up
get /sflows/{sflow-name}/ports
(showSflowSflowPortsBySflowName)

Path parameters

sflow-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 sflow-port-show-response
Up
get /sflows
(showSflows)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "sample-pkt-cnt" : 6,
    "malformed-ip-packet-drops" : 2,
    "sample-rate" : 2,
    "malformed-packet-drops" : 5,
    "malformed-vlan-packet-drops" : 5,
    "internal-nq-drops" : 3,
    "type" : "ingress",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "internal-q-drops" : 7,
    "trunc-length" : 7,
    "agent-id" : "agent-id",
    "vlan" : 0,
    "oversize-packet-drops" : 9,
    "counter-polling-interval" : 4,
    "name" : "name",
    "sample-drops" : 1,
    "sample-type" : "raw"
  }, {
    "sample-pkt-cnt" : 6,
    "malformed-ip-packet-drops" : 2,
    "sample-rate" : 2,
    "malformed-packet-drops" : 5,
    "malformed-vlan-packet-drops" : 5,
    "internal-nq-drops" : 3,
    "type" : "ingress",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "internal-q-drops" : 7,
    "trunc-length" : 7,
    "agent-id" : "agent-id",
    "vlan" : 0,
    "oversize-packet-drops" : 9,
    "counter-polling-interval" : 4,
    "name" : "name",
    "sample-drops" : 1,
    "sample-type" : "raw"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success sflow-show-response
Up
put /sflows/{name}
(updateSflowByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body sflow-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SnmpCommunities

Up
post /snmp-communities
(createAdminSnmpCommunity)

Consumes

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

Request body

body snmp-community-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /snmp-communities/{community-string}
(deleteAdminSnmpCommunityByCommunityString)

Path parameters

community-string (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /snmp-communities
(showAdminSnmpCommunities)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "community-string" : "community-string",
    "community-type" : "read-only",
    "api.switch-name" : "api.switch-name"
  }, {
    "community-string" : "community-string",
    "community-type" : "read-only",
    "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 snmp-community-show-response
Up
get /snmp-communities/{community-string}
(showAdminSnmpCommunityByCommunityString)

Path parameters

community-string (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "community-string" : "community-string",
    "community-type" : "read-only",
    "api.switch-name" : "api.switch-name"
  }, {
    "community-string" : "community-string",
    "community-type" : "read-only",
    "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 snmp-community-show-response
Up
put /snmp-communities/{community-string}
(updateAdminSnmpCommunityByCommunityString)

Path parameters

community-string (required)
Path Parameter

Consumes

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

Request body

body snmp-community-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SnmpEngineid

Up
get /snmp-engineid
(showAdminSnmpEngineid)

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success snmp-engineid-show-response
Up
put /snmp-engineid
(updateAdminSnmpEngineid)

Consumes

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

Request body

body snmp-engineid-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SnmpSystem

Up
post /snmp-system/clear
(clearAdminSnmpSystem)

Consumes

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

Request body

body snmp-system-clear (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /snmp-system
(showAdminSnmpSystem)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "syslocation" : "syslocation",
    "syscontact" : "syscontact",
    "api.switch-name" : "api.switch-name"
  }, {
    "syslocation" : "syslocation",
    "syscontact" : "syscontact",
    "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 snmp-system-show-response
Up
put /snmp-system
(updateAdminSnmpSystem)

Consumes

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

Request body

body snmp-system-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SnmpTrapEnable

Up
get /snmp-trap-enable
(showAdminSnmpTrapEnable)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "stp-port-modified" : true,
    "link-congestion-detected" : true,
    "physical-sensors" : true,
    "vrrp-new-master" : true,
    "interface-up-down" : true,
    "api.switch-name" : "api.switch-name",
    "login-failure" : true,
    "sysup-alert" : true,
    "default-monitors" : true,
    "vport-modified" : true,
    "stp-port-state-failed" : true,
    "disable-start-stop" : true,
    "high-system-usage-threshold" : "high-system-usage-threshold",
    "port-oir-error-state" : true,
    "stp-new-root" : true,
    "mirror-to-cpu" : true,
    "lacp-status" : true,
    "cluster-tr-diverge" : true,
    "low-disk-space" : true,
    "cert-expiry" : true,
    "system-usage" : true,
    "fabric-node-state-changed" : true,
    "port-bw-threshold-exceed-event" : true,
    "low-disk-space-threshold" : "low-disk-space-threshold",
    "stp-topology-changed" : true,
    "link-up-down" : true
  }, {
    "stp-port-modified" : true,
    "link-congestion-detected" : true,
    "physical-sensors" : true,
    "vrrp-new-master" : true,
    "interface-up-down" : true,
    "api.switch-name" : "api.switch-name",
    "login-failure" : true,
    "sysup-alert" : true,
    "default-monitors" : true,
    "vport-modified" : true,
    "stp-port-state-failed" : true,
    "disable-start-stop" : true,
    "high-system-usage-threshold" : "high-system-usage-threshold",
    "port-oir-error-state" : true,
    "stp-new-root" : true,
    "mirror-to-cpu" : true,
    "lacp-status" : true,
    "cluster-tr-diverge" : true,
    "low-disk-space" : true,
    "cert-expiry" : true,
    "system-usage" : true,
    "fabric-node-state-changed" : true,
    "port-bw-threshold-exceed-event" : true,
    "low-disk-space-threshold" : "low-disk-space-threshold",
    "stp-topology-changed" : true,
    "link-up-down" : 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 snmp-trap-enable-show-response
Up
put /snmp-trap-enable
(updateAdminSnmpTrapEnable)

Consumes

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

Request body

body snmp-trap-enable-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SnmpTrapSinks

Up
post /snmp-trap-sinks
(createAdminSnmpTrapSink)

Consumes

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

Request body

body snmp-trap-sink-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /snmp-trap-sinks/community={community},dest-host={dest-host},dest-port={dest-port}
(deleteAdminSnmpTrapSinkByUniqueKeyAll)

Path parameters

community (required)
Path Parameter
dest-host (required)
Path Parameter
dest-port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /snmp-trap-sinks/community={community},dest-host={dest-host},dest-port={dest-port}
(showAdminSnmpTrapSinkByUniqueKeyAll)

Path parameters

community (required)
Path Parameter
dest-host (required)
Path Parameter
dest-port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dest-port" : 0,
    "dest-host" : "dest-host",
    "community" : "community",
    "type" : "TRAP_TYPE_V1_TRAP",
    "api.switch-name" : "api.switch-name"
  }, {
    "dest-port" : 0,
    "dest-host" : "dest-host",
    "community" : "community",
    "type" : "TRAP_TYPE_V1_TRAP",
    "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 snmp-trap-sink-show-response
Up
get /snmp-trap-sinks
(showAdminSnmpTrapSinks)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dest-port" : 0,
    "dest-host" : "dest-host",
    "community" : "community",
    "type" : "TRAP_TYPE_V1_TRAP",
    "api.switch-name" : "api.switch-name"
  }, {
    "dest-port" : 0,
    "dest-host" : "dest-host",
    "community" : "community",
    "type" : "TRAP_TYPE_V1_TRAP",
    "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 snmp-trap-sink-show-response

SnmpUsers

Up
post /snmp-users
(createAdminSnmpUser)

Consumes

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

Request body

body snmp-user-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /snmp-users/{user-name}
(deleteAdminSnmpUserByUserName)

Path parameters

user-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /snmp-users/{user-name}
(showAdminSnmpUserByUserName)

Path parameters

user-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "user-name" : "user-name",
    "auth" : true,
    "priv" : true,
    "api.switch-name" : "api.switch-name",
    "auth-hash" : "md5"
  }, {
    "user-name" : "user-name",
    "auth" : true,
    "priv" : true,
    "api.switch-name" : "api.switch-name",
    "auth-hash" : "md5"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success snmp-user-show-response
Up
get /snmp-users
(showAdminSnmpUsers)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "user-name" : "user-name",
    "auth" : true,
    "priv" : true,
    "api.switch-name" : "api.switch-name",
    "auth-hash" : "md5"
  }, {
    "user-name" : "user-name",
    "auth" : true,
    "priv" : true,
    "api.switch-name" : "api.switch-name",
    "auth-hash" : "md5"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success snmp-user-show-response
Up
put /snmp-users/{user-name}
(updateAdminSnmpUserByUserName)

Path parameters

user-name (required)
Path Parameter

Consumes

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

Request body

body snmp-user-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SnmpV3TrapSinks

Up
post /snmp-v3-trap-sinks
(createAdminSnmpV3TrapSink)

Consumes

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

Request body

body snmp-v3-trap-sink-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /snmp-v3-trap-sinks/user-name={user-name},dest-host={dest-host},dest-port={dest-port}
(deleteAdminSnmpV3TrapSinkByUniqueKeyAll)

Path parameters

user-name (required)
Path Parameter
dest-host (required)
Path Parameter
dest-port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /snmp-v3-trap-sinks/user-name={user-name},dest-host={dest-host},dest-port={dest-port}
(showAdminSnmpV3TrapSinkByUniqueKeyAll)

Path parameters

user-name (required)
Path Parameter
dest-host (required)
Path Parameter
dest-port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dest-port" : 0,
    "user-name" : "user-name",
    "auth" : true,
    "dest-host" : "dest-host",
    "engine-id" : "engine-id",
    "priv" : true,
    "type" : "TRAP_TYPE_V3_TRAP",
    "api.switch-name" : "api.switch-name"
  }, {
    "dest-port" : 0,
    "user-name" : "user-name",
    "auth" : true,
    "dest-host" : "dest-host",
    "engine-id" : "engine-id",
    "priv" : true,
    "type" : "TRAP_TYPE_V3_TRAP",
    "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 snmp-v3-trap-sink-show-response
Up
get /snmp-v3-trap-sinks
(showAdminSnmpV3TrapSinks)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dest-port" : 0,
    "user-name" : "user-name",
    "auth" : true,
    "dest-host" : "dest-host",
    "engine-id" : "engine-id",
    "priv" : true,
    "type" : "TRAP_TYPE_V3_TRAP",
    "api.switch-name" : "api.switch-name"
  }, {
    "dest-port" : 0,
    "user-name" : "user-name",
    "auth" : true,
    "dest-host" : "dest-host",
    "engine-id" : "engine-id",
    "priv" : true,
    "type" : "TRAP_TYPE_V3_TRAP",
    "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 snmp-v3-trap-sink-show-response

SnmpVacms

Up
post /snmp-vacms
(createAdminSnmpVacm)

Consumes

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

Request body

body snmp-vacm-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /snmp-vacms/{user-name}
(deleteAdminSnmpVacmByUserName)

Path parameters

user-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /snmp-vacms/{user-name}
(showAdminSnmpVacmByUserName)

Path parameters

user-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "user-type" : "rouser",
    "view" : "view",
    "oid-restrict" : "oid-restrict",
    "user-name" : "user-name",
    "auth" : true,
    "priv" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "user-type" : "rouser",
    "view" : "view",
    "oid-restrict" : "oid-restrict",
    "user-name" : "user-name",
    "auth" : true,
    "priv" : 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 snmp-vacm-show-response
Up
get /snmp-vacms
(showAdminSnmpVacms)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "user-type" : "rouser",
    "view" : "view",
    "oid-restrict" : "oid-restrict",
    "user-name" : "user-name",
    "auth" : true,
    "priv" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "user-type" : "rouser",
    "view" : "view",
    "oid-restrict" : "oid-restrict",
    "user-name" : "user-name",
    "auth" : true,
    "priv" : 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 snmp-vacm-show-response
Up
put /snmp-vacms/{user-name}
(updateAdminSnmpVacmByUserName)

Path parameters

user-name (required)
Path Parameter

Consumes

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

Request body

body snmp-vacm-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Snmps

Up
get /snmps/name={name},show-type={show-type}
(showSnmpFuncsByNameShowType)

Path parameters

name (required)
Path Parameter
show-type (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "community-string" : "community-string",
    "user-name" : "user-name",
    "show-type" : "walk",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "value" : "value"
  }, {
    "community-string" : "community-string",
    "user-name" : "user-name",
    "show-type" : "walk",
    "name" : "name",
    "api.switch-name" : "api.switch-name",
    "value" : "value"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success snmp-show-response

Software

Up
get /software
(showSoftware)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "proxy-port" : 0,
    "upload-server" : "upload-server",
    "use-proxy" : true,
    "version-available" : "version-available",
    "proxy-host" : "proxy-host",
    "track" : "track",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "status" : "status",
    "download-count" : 6
  }, {
    "proxy-port" : 0,
    "upload-server" : "upload-server",
    "use-proxy" : true,
    "version-available" : "version-available",
    "proxy-host" : "proxy-host",
    "track" : "track",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "status" : "status",
    "download-count" : 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 software-show-response
Up
post /software/upgrade-abort
(upgradeAbortSoftware)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /software/upgrade-reboot
(upgradeRebootSoftware)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /software/upgrade
(upgradeSoftwareByUsage3)

Consumes

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

Request body

body software-upgrade-3 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SoftwareLicenses

Up
post /software-licenses/import-product-ids
(importPidsSoftwareLicense)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /software-licenses/install
(installSoftwareLicense)

Consumes

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

Request body

body software-license-install (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /software-licenses/{license-id}
(showSoftwareLicenseByCode)

Path parameters

license-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "upgrade" : true,
    "pending" : true,
    "license-id" : "license-id",
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "upgrade-from" : "upgrade-from",
    "feature" : "feature",
    "expires-on" : "expires-on",
    "sysconfig" : true,
    "id" : 0,
    "prompt" : "prompt",
    "key" : "key",
    "pid-file" : "pid-file",
    "status" : "unknown"
  }, {
    "upgrade" : true,
    "pending" : true,
    "license-id" : "license-id",
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "upgrade-from" : "upgrade-from",
    "feature" : "feature",
    "expires-on" : "expires-on",
    "sysconfig" : true,
    "id" : 0,
    "prompt" : "prompt",
    "key" : "key",
    "pid-file" : "pid-file",
    "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 software-license-show-response
Up
get /software-licenses
(showSoftwareLicenses)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "upgrade" : true,
    "pending" : true,
    "license-id" : "license-id",
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "upgrade-from" : "upgrade-from",
    "feature" : "feature",
    "expires-on" : "expires-on",
    "sysconfig" : true,
    "id" : 0,
    "prompt" : "prompt",
    "key" : "key",
    "pid-file" : "pid-file",
    "status" : "unknown"
  }, {
    "upgrade" : true,
    "pending" : true,
    "license-id" : "license-id",
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "upgrade-from" : "upgrade-from",
    "feature" : "feature",
    "expires-on" : "expires-on",
    "sysconfig" : true,
    "id" : 0,
    "prompt" : "prompt",
    "key" : "key",
    "pid-file" : "pid-file",
    "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 software-license-show-response

SoftwareUpgradeInstantStatuses

Up
get /software-upgrade-instant-statuses
(showSoftwareUpgradeInstStatuses)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "proxy-port" : 0,
    "upload-server" : "upload-server",
    "log" : "log",
    "use-proxy" : true,
    "version-available" : "version-available",
    "proxy-host" : "proxy-host",
    "track" : "track",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "status" : "status",
    "download-count" : 6
  }, {
    "proxy-port" : 0,
    "upload-server" : "upload-server",
    "log" : "log",
    "use-proxy" : true,
    "version-available" : "version-available",
    "proxy-host" : "proxy-host",
    "track" : "track",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "status" : "status",
    "download-count" : 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 software-upgrade-instant-status-show-response

SoftwareUpgradeStatuses

Up
get /software-upgrade-statuses
(showSoftwareUpgradeStatuses)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "proxy-port" : 0,
    "upload-server" : "upload-server",
    "log" : "log",
    "use-proxy" : true,
    "version-available" : "version-available",
    "proxy-host" : "proxy-host",
    "track" : "track",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "status" : "status",
    "download-count" : 6
  }, {
    "proxy-port" : 0,
    "upload-server" : "upload-server",
    "log" : "log",
    "use-proxy" : true,
    "version-available" : "version-available",
    "proxy-host" : "proxy-host",
    "track" : "track",
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "upgrade-status" : "available",
    "status" : "status",
    "download-count" : 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 software-upgrade-status-show-response

StaticArps

Up
post /static-arps
(createUnicastStaticArpByUsage1)

Consumes

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

Request body

body static-arp-create-1 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /static-arps/ip={ip},vxlan={vxlan},vlan={vlan}
(deleteUnicastStaticArpByUniqueKeyAll)

Path parameters

ip (required)
Path Parameter
vxlan (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /static-arps/ip={ip},vxlan={vxlan},vlan={vlan}
(showUnicastStaticArpByUniqueKeyAll)

Path parameters

ip (required)
Path Parameter
vxlan (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "vlan" : 6,
    "ip" : "ip",
    "scope" : "local",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  }, {
    "vxlan" : 0,
    "vlan" : 6,
    "ip" : "ip",
    "scope" : "local",
    "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 static-arp-show-response
Up
get /static-arps
(showUnicastStaticArps)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "vlan" : 6,
    "ip" : "ip",
    "scope" : "local",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  }, {
    "vxlan" : 0,
    "vlan" : 6,
    "ip" : "ip",
    "scope" : "local",
    "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 static-arp-show-response

StaticEcmpGroups

Up
post /static-ecmp-groups/{group-name}/nhs
(addStaticEcmpGroupNhByStaticEcmpGroupName)

Path parameters

group-name (required)
Path Parameter

Consumes

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

Request body

body static-ecmp-group-nh-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /static-ecmp-groups
(createStaticEcmpGroup)

Consumes

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

Request body

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /static-ecmp-groups/{group-name}
(deleteStaticEcmpGroupByName)

Path parameters

group-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /static-ecmp-groups/{group-name}/nhs/{ip}
(removeStaticEcmpGroupNhByNameByIp)

Path parameters

group-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /static-ecmp-groups/{group-name}
(showStaticEcmpGroupByName)

Path parameters

group-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 0,
    "group-name" : "group-name",
    "vrouter-name" : "vrouter-name",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "hw-ecmp-id" : 6,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "hash-type" : "static-fixed"
  }, {
    "vrid" : 0,
    "group-name" : "group-name",
    "vrouter-name" : "vrouter-name",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "hw-ecmp-id" : 6,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "hash-type" : "static-fixed"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success static-ecmp-group-show-response
Up
get /static-ecmp-groups/{group-name}/nhs/{ip}
(showStaticEcmpGroupNhByNameByIp)

Path parameters

group-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "egress-id" : 6,
    "vlan" : 0,
    "ip" : "ip",
    "api.switch-name" : "api.switch-name"
  }, {
    "egress-id" : 6,
    "vlan" : 0,
    "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 static-ecmp-group-nh-show-response
Up
get /static-ecmp-groups/{group-name}/nhs
(showStaticEcmpGroupNhsByStaticEcmpGroupName)

Path parameters

group-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "egress-id" : 6,
    "vlan" : 0,
    "ip" : "ip",
    "api.switch-name" : "api.switch-name"
  }, {
    "egress-id" : 6,
    "vlan" : 0,
    "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 static-ecmp-group-nh-show-response
Up
get /static-ecmp-groups
(showStaticEcmpGroups)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 0,
    "group-name" : "group-name",
    "vrouter-name" : "vrouter-name",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "hw-ecmp-id" : 6,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "hash-type" : "static-fixed"
  }, {
    "vrid" : 0,
    "group-name" : "group-name",
    "vrouter-name" : "vrouter-name",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "hw-ecmp-id" : 6,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "hash-type" : "static-fixed"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success static-ecmp-group-show-response
Up
put /static-ecmp-groups/{group-name}
(updateStaticEcmpGroupByName)

Path parameters

group-name (required)
Path Parameter

Consumes

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

Request body

body static-ecmp-group-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

StorageDevices

Up
post /storage-devices/free
(freeStorageDevice)

Consumes

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

Request body

body storage-device-free (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /storage-devices/{name}
(showStorageDeviceByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "path" : "path",
    "disk" : "disk",
    "name" : "name",
    "label" : "label",
    "type" : "disk",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "in-use" : true,
    "capacity" : 0,
    "status" : "faulty"
  }, {
    "path" : "path",
    "disk" : "disk",
    "name" : "name",
    "label" : "label",
    "type" : "disk",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "in-use" : true,
    "capacity" : 0,
    "status" : "faulty"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success storage-device-show-response
Up
get /storage-devices
(showStorageDevices)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "path" : "path",
    "disk" : "disk",
    "name" : "name",
    "label" : "label",
    "type" : "disk",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "in-use" : true,
    "capacity" : 0,
    "status" : "faulty"
  }, {
    "path" : "path",
    "disk" : "disk",
    "name" : "name",
    "label" : "label",
    "type" : "disk",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "in-use" : true,
    "capacity" : 0,
    "status" : "faulty"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success storage-device-show-response

StoragePools

Up
post /storage-pools/{storage-pool-name}/devices
(addStoragePoolDeviceByStoragePoolName)

Path parameters

storage-pool-name (required)
Path Parameter

Consumes

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

Request body

body storage-pool-device-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /storage-pools
(createStoragePool)

Consumes

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

Request body

body storage-pool-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /storage-pools/{name}
(deleteStoragePoolByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /storage-pools/{storage-pool-name}/devices/{name}
(removeStoragePoolDeviceByNameByName)

Path parameters

storage-pool-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /storage-pools/{storage-pool-name}/devices/replace
(replaceStoragePoolDeviceByStoragePoolName)

Path parameters

storage-pool-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /storage-pools/{name}
(showStoragePoolByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "avail" : 6,
    "device1" : "device1",
    "device2" : "device2",
    "device3" : "device3",
    "device4" : "device4",
    "used" : 0,
    "ha-pool" : "ha-pool",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "raid-type" : "no-raid",
    "peer-pool" : "peer-pool",
    "name" : "name",
    "state" : "state",
    "peer-switch" : 1,
    "status" : "corrupt-cache"
  }, {
    "avail" : 6,
    "device1" : "device1",
    "device2" : "device2",
    "device3" : "device3",
    "device4" : "device4",
    "used" : 0,
    "ha-pool" : "ha-pool",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "raid-type" : "no-raid",
    "peer-pool" : "peer-pool",
    "name" : "name",
    "state" : "state",
    "peer-switch" : 1,
    "status" : "corrupt-cache"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success storage-pool-show-response
Up
get /storage-pools/{storage-pool-name}/devices/{name}
(showStoragePoolDeviceByNameByName)

Path parameters

storage-pool-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "path" : "path",
    "disk" : "disk",
    "name" : "name",
    "label" : "label",
    "type" : "disk",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "in-use" : true,
    "capacity" : 0,
    "status" : "faulty"
  }, {
    "path" : "path",
    "disk" : "disk",
    "name" : "name",
    "label" : "label",
    "type" : "disk",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "in-use" : true,
    "capacity" : 0,
    "status" : "faulty"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success storage-pool-device-show-response
Up
get /storage-pools/{storage-pool-name}/devices
(showStoragePoolDevicesByStoragePoolName)

Path parameters

storage-pool-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "path" : "path",
    "disk" : "disk",
    "name" : "name",
    "label" : "label",
    "type" : "disk",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "in-use" : true,
    "capacity" : 0,
    "status" : "faulty"
  }, {
    "path" : "path",
    "disk" : "disk",
    "name" : "name",
    "label" : "label",
    "type" : "disk",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "in-use" : true,
    "capacity" : 0,
    "status" : "faulty"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success storage-pool-device-show-response
Up
get /storage-pools
(showStoragePools)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "avail" : 6,
    "device1" : "device1",
    "device2" : "device2",
    "device3" : "device3",
    "device4" : "device4",
    "used" : 0,
    "ha-pool" : "ha-pool",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "raid-type" : "no-raid",
    "peer-pool" : "peer-pool",
    "name" : "name",
    "state" : "state",
    "peer-switch" : 1,
    "status" : "corrupt-cache"
  }, {
    "avail" : 6,
    "device1" : "device1",
    "device2" : "device2",
    "device3" : "device3",
    "device4" : "device4",
    "used" : 0,
    "ha-pool" : "ha-pool",
    "api.switch-name" : "api.switch-name",
    "data-set" : "data-set",
    "raid-type" : "no-raid",
    "peer-pool" : "peer-pool",
    "name" : "name",
    "state" : "state",
    "peer-switch" : 1,
    "status" : "corrupt-cache"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success storage-pool-show-response
Up
put /storage-pools/{name}
(updateStoragePoolByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body storage-pool-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

StorageStats

Up
get /storage-stats
(showStorageStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : 0,
    "write-bytes" : 6,
    "read-bytes" : 1,
    "server-ip" : "server-ip",
    "api.switch-name" : "api.switch-name",
    "switch" : 5
  }, {
    "port" : 0,
    "write-bytes" : 6,
    "read-bytes" : 1,
    "server-ip" : "server-ip",
    "api.switch-name" : "api.switch-name",
    "switch" : 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 storage-stats-show-response

Stp

Up
get /stp
(showStpGlobal)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mst-config-id-mismatch-on-peer-ports" : "mst-config-id-mismatch-on-peer-ports",
    "mst-digest-mismatch-on-ports" : "mst-digest-mismatch-on-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "bpdus-bridge-ports" : true,
    "forwarding-delay" : 5,
    "mst-config-revision" : 2,
    "max-age" : 0,
    "mst-max-hops" : 5,
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "mst-revision-mismatch-on-peer-ports" : "mst-revision-mismatch-on-peer-ports",
    "root-guard-wait-time" : 7,
    "enable" : true,
    "hello-time" : 1,
    "mst-config-id-mismatch-on-ports" : "mst-config-id-mismatch-on-ports",
    "mst-config-name" : "mst-config-name",
    "bridge-id" : "bridge-id",
    "bridge-priority" : 6,
    "mst-digest-mismatch-on-peer-ports" : "mst-digest-mismatch-on-peer-ports",
    "mst-revision-mismatch-on-ports" : "mst-revision-mismatch-on-ports"
  }, {
    "mst-config-id-mismatch-on-peer-ports" : "mst-config-id-mismatch-on-peer-ports",
    "mst-digest-mismatch-on-ports" : "mst-digest-mismatch-on-ports",
    "cluster-mode" : "none",
    "stp-mode" : "rstp",
    "bpdus-bridge-ports" : true,
    "forwarding-delay" : 5,
    "mst-config-revision" : 2,
    "max-age" : 0,
    "mst-max-hops" : 5,
    "mst-config-digest" : "mst-config-digest",
    "api.switch-name" : "api.switch-name",
    "mst-revision-mismatch-on-peer-ports" : "mst-revision-mismatch-on-peer-ports",
    "root-guard-wait-time" : 7,
    "enable" : true,
    "hello-time" : 1,
    "mst-config-id-mismatch-on-ports" : "mst-config-id-mismatch-on-ports",
    "mst-config-name" : "mst-config-name",
    "bridge-id" : "bridge-id",
    "bridge-priority" : 6,
    "mst-digest-mismatch-on-peer-ports" : "mst-digest-mismatch-on-peer-ports",
    "mst-revision-mismatch-on-ports" : "mst-revision-mismatch-on-ports"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success stp-show-response
Up
put /stp
(updateStpGlobal)

Consumes

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

Request body

body stp-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

StpPortEvents

Up
get /stp-port-events
(showStpPortEvents)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 2,
    "instance" : 6,
    "start-time" : "start-time",
    "within-last" : 7,
    "end-time" : "end-time",
    "count" : 1,
    "initial-state" : "Disabled",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 5,
    "vlan" : "vlan",
    "final-state" : "Disabled",
    "port" : 0,
    "interval" : 5,
    "other-state" : "Disabled",
    "time" : "time"
  }, {
    "older-than" : 2,
    "instance" : 6,
    "start-time" : "start-time",
    "within-last" : 7,
    "end-time" : "end-time",
    "count" : 1,
    "initial-state" : "Disabled",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 5,
    "vlan" : "vlan",
    "final-state" : "Disabled",
    "port" : 0,
    "interval" : 5,
    "other-state" : "Disabled",
    "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 stp-port-event-show-response

StpPortStates

Up
get /stp-port-states
(showStpPortStates)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "role" : "Disabled",
    "root-guard-timer" : 9,
    "sm-table-bits" : "sm-table-bits",
    "topology-timer" : 2,
    "forward-timer" : 6,
    "recent-backup-timer" : 5,
    "vlag-peer-port" : 3,
    "api.switch-name" : "api.switch-name",
    "sm-table" : "sm-table",
    "vlan" : "vlan",
    "message-times" : "message-times",
    "peer" : true,
    "info-is" : "disabled",
    "state" : "new-info",
    "migration-timer" : 7,
    "stp-state" : "Disabled",
    "designated-times" : "designated-times",
    "message-priority" : "message-priority",
    "edge-delay-timer" : 2,
    "designated-priority" : "designated-priority",
    "recent-root-timer" : 5,
    "port" : "port",
    "selected-role" : "Disabled",
    "port-priority" : "port-priority",
    "hello-timer" : 0,
    "rcvd-info-timer" : 1,
    "port-times" : "port-times"
  }, {
    "role" : "Disabled",
    "root-guard-timer" : 9,
    "sm-table-bits" : "sm-table-bits",
    "topology-timer" : 2,
    "forward-timer" : 6,
    "recent-backup-timer" : 5,
    "vlag-peer-port" : 3,
    "api.switch-name" : "api.switch-name",
    "sm-table" : "sm-table",
    "vlan" : "vlan",
    "message-times" : "message-times",
    "peer" : true,
    "info-is" : "disabled",
    "state" : "new-info",
    "migration-timer" : 7,
    "stp-state" : "Disabled",
    "designated-times" : "designated-times",
    "message-priority" : "message-priority",
    "edge-delay-timer" : 2,
    "designated-priority" : "designated-priority",
    "recent-root-timer" : 5,
    "port" : "port",
    "selected-role" : "Disabled",
    "port-priority" : "port-priority",
    "hello-timer" : 0,
    "rcvd-info-timer" : 1,
    "port-times" : "port-times"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success stp-port-state-show-response

StpPorts

Up
get /stp-ports/{port}
(showStpPortByPort)

Path parameters

port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "filter" : "filter",
    "edge" : true,
    "cost" : 6,
    "port" : "port",
    "root-guard" : true,
    "block" : "block",
    "priority" : 0,
    "api.switch-name" : "api.switch-name",
    "bpdu-guard" : true
  }, {
    "filter" : "filter",
    "edge" : true,
    "cost" : 6,
    "port" : "port",
    "root-guard" : true,
    "block" : "block",
    "priority" : 0,
    "api.switch-name" : "api.switch-name",
    "bpdu-guard" : 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 stp-port-show-response
Up
get /stp-ports
(showStpPorts)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "filter" : "filter",
    "edge" : true,
    "cost" : 6,
    "port" : "port",
    "root-guard" : true,
    "block" : "block",
    "priority" : 0,
    "api.switch-name" : "api.switch-name",
    "bpdu-guard" : true
  }, {
    "filter" : "filter",
    "edge" : true,
    "cost" : 6,
    "port" : "port",
    "root-guard" : true,
    "block" : "block",
    "priority" : 0,
    "api.switch-name" : "api.switch-name",
    "bpdu-guard" : 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 stp-port-show-response
Up
put /stp-ports/{port}
(updateStpPortByPort)

Path parameters

port (required)
Path Parameter

Consumes

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

Request body

body stp-port-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

StpStates

Up
get /stp-states
(showStpStates)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "backup" : "backup",
    "internal" : true,
    "forwarding-delay" : 9,
    "root-port(peer)" : 1,
    "run-scheduled" : true,
    "learning" : "learning",
    "forwarding" : "forwarding",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "root-priority" : 5,
    "edge" : "edge",
    "vlan" : "vlan",
    "designated" : "designated",
    "peer" : true,
    "topo-change-timer" : "topo-change-timer",
    "nonroot-reroot-timer" : "nonroot-reroot-timer",
    "disabled" : "disabled",
    "bridge-priority" : 2,
    "root-port" : 5,
    "instance-id" : 0,
    "root-id" : "root-id",
    "max-age" : 6,
    "discarding" : "discarding",
    "alternate" : "alternate",
    "name" : "name",
    "hello-time" : 7,
    "bridge-id" : "bridge-id",
    "fwd-delay-timer" : "fwd-delay-timer"
  }, {
    "backup" : "backup",
    "internal" : true,
    "forwarding-delay" : 9,
    "root-port(peer)" : 1,
    "run-scheduled" : true,
    "learning" : "learning",
    "forwarding" : "forwarding",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "root-priority" : 5,
    "edge" : "edge",
    "vlan" : "vlan",
    "designated" : "designated",
    "peer" : true,
    "topo-change-timer" : "topo-change-timer",
    "nonroot-reroot-timer" : "nonroot-reroot-timer",
    "disabled" : "disabled",
    "bridge-priority" : 2,
    "root-port" : 5,
    "instance-id" : 0,
    "root-id" : "root-id",
    "max-age" : 6,
    "discarding" : "discarding",
    "alternate" : "alternate",
    "name" : "name",
    "hello-time" : 7,
    "bridge-id" : "bridge-id",
    "fwd-delay-timer" : "fwd-delay-timer"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success stp-state-show-response

Subnets

Up
post /subnets
(createSubnet)

Consumes

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

Request body

body subnet-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /subnets/name/{name}
(deleteSubnetByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /subnets/name={name},vnet-id={vnet-id}
(deleteSubnetByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /subnets/name/{name}
(showSubnetByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "network6" : "network6",
    "anycast-gw-ip6" : "anycast-gw-ip6",
    "packet-relay" : "enable",
    "hw-state" : true,
    "description" : "description",
    "anycast-gw-ip" : "anycast-gw-ip",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "leaked-on" : "leaked-on",
    "forward-ip6-2" : "forward-ip6-2",
    "vlan" : 0,
    "netmask" : 1,
    "linklocal" : "linklocal",
    "enable" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "forward-ip" : "forward-ip",
    "state" : "init",
    "forward-ip2" : "forward-ip2",
    "forward-ip6" : "forward-ip6",
    "vxlan" : 6,
    "evpn-export-leaked-networks" : "permit",
    "forward-proto" : "dhcp",
    "vrf" : "vrf",
    "flood" : "enable",
    "wake-on-lan" : true,
    "name" : "name",
    "netmask6" : 5
  }, {
    "network6" : "network6",
    "anycast-gw-ip6" : "anycast-gw-ip6",
    "packet-relay" : "enable",
    "hw-state" : true,
    "description" : "description",
    "anycast-gw-ip" : "anycast-gw-ip",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "leaked-on" : "leaked-on",
    "forward-ip6-2" : "forward-ip6-2",
    "vlan" : 0,
    "netmask" : 1,
    "linklocal" : "linklocal",
    "enable" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "forward-ip" : "forward-ip",
    "state" : "init",
    "forward-ip2" : "forward-ip2",
    "forward-ip6" : "forward-ip6",
    "vxlan" : 6,
    "evpn-export-leaked-networks" : "permit",
    "forward-proto" : "dhcp",
    "vrf" : "vrf",
    "flood" : "enable",
    "wake-on-lan" : true,
    "name" : "name",
    "netmask6" : 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 subnet-show-response
Up
get /subnets/name={name},vnet-id={vnet-id}
(showSubnetByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "network6" : "network6",
    "anycast-gw-ip6" : "anycast-gw-ip6",
    "packet-relay" : "enable",
    "hw-state" : true,
    "description" : "description",
    "anycast-gw-ip" : "anycast-gw-ip",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "leaked-on" : "leaked-on",
    "forward-ip6-2" : "forward-ip6-2",
    "vlan" : 0,
    "netmask" : 1,
    "linklocal" : "linklocal",
    "enable" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "forward-ip" : "forward-ip",
    "state" : "init",
    "forward-ip2" : "forward-ip2",
    "forward-ip6" : "forward-ip6",
    "vxlan" : 6,
    "evpn-export-leaked-networks" : "permit",
    "forward-proto" : "dhcp",
    "vrf" : "vrf",
    "flood" : "enable",
    "wake-on-lan" : true,
    "name" : "name",
    "netmask6" : 5
  }, {
    "network6" : "network6",
    "anycast-gw-ip6" : "anycast-gw-ip6",
    "packet-relay" : "enable",
    "hw-state" : true,
    "description" : "description",
    "anycast-gw-ip" : "anycast-gw-ip",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "leaked-on" : "leaked-on",
    "forward-ip6-2" : "forward-ip6-2",
    "vlan" : 0,
    "netmask" : 1,
    "linklocal" : "linklocal",
    "enable" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "forward-ip" : "forward-ip",
    "state" : "init",
    "forward-ip2" : "forward-ip2",
    "forward-ip6" : "forward-ip6",
    "vxlan" : 6,
    "evpn-export-leaked-networks" : "permit",
    "forward-proto" : "dhcp",
    "vrf" : "vrf",
    "flood" : "enable",
    "wake-on-lan" : true,
    "name" : "name",
    "netmask6" : 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 subnet-show-response
Up
get /subnets
(showSubnets)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "network6" : "network6",
    "anycast-gw-ip6" : "anycast-gw-ip6",
    "packet-relay" : "enable",
    "hw-state" : true,
    "description" : "description",
    "anycast-gw-ip" : "anycast-gw-ip",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "leaked-on" : "leaked-on",
    "forward-ip6-2" : "forward-ip6-2",
    "vlan" : 0,
    "netmask" : 1,
    "linklocal" : "linklocal",
    "enable" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "forward-ip" : "forward-ip",
    "state" : "init",
    "forward-ip2" : "forward-ip2",
    "forward-ip6" : "forward-ip6",
    "vxlan" : 6,
    "evpn-export-leaked-networks" : "permit",
    "forward-proto" : "dhcp",
    "vrf" : "vrf",
    "flood" : "enable",
    "wake-on-lan" : true,
    "name" : "name",
    "netmask6" : 5
  }, {
    "network6" : "network6",
    "anycast-gw-ip6" : "anycast-gw-ip6",
    "packet-relay" : "enable",
    "hw-state" : true,
    "description" : "description",
    "anycast-gw-ip" : "anycast-gw-ip",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "leaked-on" : "leaked-on",
    "forward-ip6-2" : "forward-ip6-2",
    "vlan" : 0,
    "netmask" : 1,
    "linklocal" : "linklocal",
    "enable" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "forward-ip" : "forward-ip",
    "state" : "init",
    "forward-ip2" : "forward-ip2",
    "forward-ip6" : "forward-ip6",
    "vxlan" : 6,
    "evpn-export-leaked-networks" : "permit",
    "forward-proto" : "dhcp",
    "vrf" : "vrf",
    "flood" : "enable",
    "wake-on-lan" : true,
    "name" : "name",
    "netmask6" : 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 subnet-show-response
Up
put /subnets/name/{name}
(updateSubnetByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body subnet-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /subnets/name={name},vnet-id={vnet-id}
(updateSubnetByPrimaryKeyAllName)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Request body

body subnet-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SwitchBoot

Up
post /switch-boot/solaris
(solarisSwitchBootByUsage1)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SwitchConfigs

Up
post /switch-configs/copy-to-import
(copyToImportNvOSConfig)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /switch-configs/export
(exportNvOSConfig)

Consumes

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

Request body

body switch-config-export (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /switch-configs/import
(importNvOSConfig)

Consumes

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

Request body

body switch-config-import (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /switch-configs
(showNvOSConfigs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "upload-server" : "upload-server",
    "export-file" : "export-file",
    "import-file" : "import-file",
    "api.switch-name" : "api.switch-name",
    "apply-system-config" : true
  }, {
    "upload-server" : "upload-server",
    "export-file" : "export-file",
    "import-file" : "import-file",
    "api.switch-name" : "api.switch-name",
    "apply-system-config" : 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 switch-config-show-response

SwitchGroups

Up
post /switch-groups/{name}/members
(addSwitchGroupMemberBySwitchGroupName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body switch-group-member-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /switch-groups
(createSwitchGroup)

Consumes

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

Request body

body switch-group-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /switch-groups/{name}
(deleteSwitchGroupByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /switch-groups/{name}/members/{member}
(removeSwitchGroupMemberByNameByName)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /switch-groups/{name}
(showSwitchGroupByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "description" : "description",
    "api.switch-name" : "api.switch-name"
  }, {
    "name" : "name",
    "description" : "description",
    "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 switch-group-show-response
Up
get /switch-groups/{name}/members/{member}
(showSwitchGroupMemberByNameByName)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "member" : "member",
    "api.switch-name" : "api.switch-name"
  }, {
    "member" : "member",
    "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 switch-group-member-show-response
Up
get /switch-groups/{name}/members
(showSwitchGroupMembersBySwitchGroupName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "member" : "member",
    "api.switch-name" : "api.switch-name"
  }, {
    "member" : "member",
    "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 switch-group-member-show-response
Up
get /switch-groups
(showSwitchGroups)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "description" : "description",
    "api.switch-name" : "api.switch-name"
  }, {
    "name" : "name",
    "description" : "description",
    "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 switch-group-show-response
Up
put /switch-groups/{name}
(updateSwitchGroupByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body switch-group-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SwitchInfo

Up
get /switch-info
(showHwInfo)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "chassis-serial" : "chassis-serial",
    "system-mem" : 0,
    "disk-firmware" : "disk-firmware",
    "api.switch-name" : "api.switch-name",
    "ps2-status" : "ps2-status",
    "bmc-version" : "bmc-version",
    "netvisor-cert-valid-till" : "netvisor-cert-valid-till",
    "switch-device" : "switch-device",
    "cpu3-type" : "cpu3-type",
    "fan8-status" : "fan8-status",
    "disk-model" : "disk-model",
    "bios-version" : "bios-version",
    "polaris-device" : "polaris-device",
    "model" : "model",
    "fan7-status" : "fan7-status",
    "fan1-status" : "fan1-status",
    "fan2-status" : "fan2-status",
    "fan6-status" : "fan6-status",
    "fan9-status" : "fan9-status",
    "fan4-status" : "fan4-status",
    "disk-type" : "disk-type",
    "gandalf-version" : "gandalf-version",
    "fan5-status" : "fan5-status",
    "fan3-status" : "fan3-status",
    "netvisor-cert-valid-from" : "netvisor-cert-valid-from",
    "cpu2-type" : "cpu2-type",
    "ps1-status" : "ps1-status",
    "disk-serial" : "disk-serial",
    "fan12-status" : "fan12-status",
    "fan13-status" : "fan13-status",
    "fan14-status" : "fan14-status",
    "fan15-status" : "fan15-status",
    "switch-cpld-version" : "switch-cpld-version",
    "bmc-cpld-version" : "bmc-cpld-version",
    "disk-size" : 6,
    "fan16-status" : "fan16-status",
    "cpu4-type" : "cpu4-type",
    "cpu-cpld-version" : "cpu-cpld-version",
    "fan10-status" : "fan10-status",
    "fan11-status" : "fan11-status",
    "bios-vendor" : "bios-vendor",
    "cpu1-type" : "cpu1-type"
  }, {
    "chassis-serial" : "chassis-serial",
    "system-mem" : 0,
    "disk-firmware" : "disk-firmware",
    "api.switch-name" : "api.switch-name",
    "ps2-status" : "ps2-status",
    "bmc-version" : "bmc-version",
    "netvisor-cert-valid-till" : "netvisor-cert-valid-till",
    "switch-device" : "switch-device",
    "cpu3-type" : "cpu3-type",
    "fan8-status" : "fan8-status",
    "disk-model" : "disk-model",
    "bios-version" : "bios-version",
    "polaris-device" : "polaris-device",
    "model" : "model",
    "fan7-status" : "fan7-status",
    "fan1-status" : "fan1-status",
    "fan2-status" : "fan2-status",
    "fan6-status" : "fan6-status",
    "fan9-status" : "fan9-status",
    "fan4-status" : "fan4-status",
    "disk-type" : "disk-type",
    "gandalf-version" : "gandalf-version",
    "fan5-status" : "fan5-status",
    "fan3-status" : "fan3-status",
    "netvisor-cert-valid-from" : "netvisor-cert-valid-from",
    "cpu2-type" : "cpu2-type",
    "ps1-status" : "ps1-status",
    "disk-serial" : "disk-serial",
    "fan12-status" : "fan12-status",
    "fan13-status" : "fan13-status",
    "fan14-status" : "fan14-status",
    "fan15-status" : "fan15-status",
    "switch-cpld-version" : "switch-cpld-version",
    "bmc-cpld-version" : "bmc-cpld-version",
    "disk-size" : 6,
    "fan16-status" : "fan16-status",
    "cpu4-type" : "cpu4-type",
    "cpu-cpld-version" : "cpu-cpld-version",
    "fan10-status" : "fan10-status",
    "fan11-status" : "fan11-status",
    "bios-vendor" : "bios-vendor",
    "cpu1-type" : "cpu1-type"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success switch-info-show-response

SwitchMode

Up
get /switch-mode
(showSwitchMode)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "switch-mode" : "store-and-forward",
    "api.switch-name" : "api.switch-name"
  }, {
    "switch-mode" : "store-and-forward",
    "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 switch-mode-show-response
Up
put /switch-mode
(updateSwitchMode)

Consumes

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

Request body

body switch-mode-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SwitchNicInfos

Up
get /switch-nic-infos/{name}
(showSwitchNicInfoByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "txpause" : true,
    "rxqnum" : 6,
    "txqsize" : 5,
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "speed" : 0,
    "driver" : "driver",
    "rxpause" : true,
    "rxqsize" : 5,
    "name" : "name",
    "txqnum" : 1,
    "autoneg" : true,
    "firmware" : "firmware"
  }, {
    "txpause" : true,
    "rxqnum" : 6,
    "txqsize" : 5,
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "speed" : 0,
    "driver" : "driver",
    "rxpause" : true,
    "rxqsize" : 5,
    "name" : "name",
    "txqnum" : 1,
    "autoneg" : true,
    "firmware" : "firmware"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success switch-nic-info-show-response
Up
get /switch-nic-infos
(showSwitchNicInfos)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "txpause" : true,
    "rxqnum" : 6,
    "txqsize" : 5,
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "speed" : 0,
    "driver" : "driver",
    "rxpause" : true,
    "rxqsize" : 5,
    "name" : "name",
    "txqnum" : 1,
    "autoneg" : true,
    "firmware" : "firmware"
  }, {
    "txpause" : true,
    "rxqnum" : 6,
    "txqsize" : 5,
    "api.switch-name" : "api.switch-name",
    "version" : "version",
    "speed" : 0,
    "driver" : "driver",
    "rxpause" : true,
    "rxqsize" : 5,
    "name" : "name",
    "txqnum" : 1,
    "autoneg" : true,
    "firmware" : "firmware"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success switch-nic-info-show-response

SwitchNicStats

Up
get /switch-nic-stats
(showSwitchNicStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ipkts_19" : 4,
    "older-than" : 0,
    "rxnobuf" : 6,
    "mcast" : 1,
    "within-last" : 7,
    "ipkts_15" : 0,
    "ipkts_16" : 7,
    "ipkts_17" : 6,
    "ipkts_18" : 0,
    "opkts_2" : 3,
    "idrops_14" : 3,
    "opkts_3" : 4,
    "idrops_13" : 7,
    "opkts_4" : 0,
    "idrops_12" : 8,
    "opkts_5" : 6,
    "idrops_11" : 5,
    "idrops_10" : 5,
    "opkts_0" : 7,
    "opkts_1" : 5,
    "ibcast" : 4,
    "ipkts_22" : 3,
    "ipkts_23" : 3,
    "idrops_19" : 0,
    "opkts_23" : 1,
    "idrops_18" : 7,
    "opkts_22" : 2,
    "idrops_17" : 5,
    "ipkts_20" : 8,
    "opkts_21" : 0,
    "idrops_16" : 9,
    "ipkts_21" : 7,
    "opkts_20" : 3,
    "idrops_15" : 3,
    "start-time" : "start-time",
    "opkts_6" : 4,
    "ioverruns" : 1,
    "opkts_7" : 1,
    "opkts_8" : 4,
    "opkts_9" : 7,
    "ipkts_3" : 6,
    "ipkts_2" : 9,
    "bcast" : 1,
    "ipkts_1" : 8,
    "idrops_23" : 8,
    "ipkts_0" : 6,
    "idrops_22" : 3,
    "idrops_21" : 2,
    "idrops_20" : 3,
    "imcast" : 3,
    "ipkts_9" : 6,
    "interval" : 0,
    "ipkts_8" : 6,
    "ipkts_7" : 2,
    "ipkts_6" : 1,
    "ipkts_5" : 6,
    "ipkts_4" : 3,
    "api.switch-name" : "api.switch-name",
    "obytes" : 5,
    "ipkts" : 0,
    "ierrs" : 5,
    "end-time" : "end-time",
    "ibytes" : 6,
    "obcast" : 7,
    "ififoerrs" : 4,
    "odrops" : 9,
    "icrcerrs" : 7,
    "idrops" : 7,
    "ipkts_11" : 6,
    "ipkts_12" : 3,
    "ipkts_13" : 3,
    "ipkts_14" : 7,
    "ipkts_10" : 5,
    "omcast" : 2,
    "since-start" : true,
    "ishorterrs" : 9,
    "idrops_3" : 8,
    "idrops_2" : 4,
    "idrops_1" : 6,
    "idrops_0" : 8,
    "idrops_7" : 9,
    "idrops_6" : 3,
    "idrops_5" : 1,
    "idrops_4" : 9,
    "idrops_9" : 0,
    "idrops_8" : 8,
    "name" : "name",
    "ofifoerrs" : 5,
    "duration" : 4,
    "oerrs" : 2,
    "ilongerrs" : 9,
    "opkts_16" : 4,
    "opkts_15" : 5,
    "opkts_14" : 7,
    "opkts_13" : 0,
    "opkts_19" : 4,
    "opkts_18" : 8,
    "iframeerrs" : 1,
    "opkts_17" : 6,
    "opkts" : 1,
    "time" : "time",
    "opkts_12" : 9,
    "opkts_11" : 0,
    "opkts_10" : 9
  }, {
    "ipkts_19" : 4,
    "older-than" : 0,
    "rxnobuf" : 6,
    "mcast" : 1,
    "within-last" : 7,
    "ipkts_15" : 0,
    "ipkts_16" : 7,
    "ipkts_17" : 6,
    "ipkts_18" : 0,
    "opkts_2" : 3,
    "idrops_14" : 3,
    "opkts_3" : 4,
    "idrops_13" : 7,
    "opkts_4" : 0,
    "idrops_12" : 8,
    "opkts_5" : 6,
    "idrops_11" : 5,
    "idrops_10" : 5,
    "opkts_0" : 7,
    "opkts_1" : 5,
    "ibcast" : 4,
    "ipkts_22" : 3,
    "ipkts_23" : 3,
    "idrops_19" : 0,
    "opkts_23" : 1,
    "idrops_18" : 7,
    "opkts_22" : 2,
    "idrops_17" : 5,
    "ipkts_20" : 8,
    "opkts_21" : 0,
    "idrops_16" : 9,
    "ipkts_21" : 7,
    "opkts_20" : 3,
    "idrops_15" : 3,
    "start-time" : "start-time",
    "opkts_6" : 4,
    "ioverruns" : 1,
    "opkts_7" : 1,
    "opkts_8" : 4,
    "opkts_9" : 7,
    "ipkts_3" : 6,
    "ipkts_2" : 9,
    "bcast" : 1,
    "ipkts_1" : 8,
    "idrops_23" : 8,
    "ipkts_0" : 6,
    "idrops_22" : 3,
    "idrops_21" : 2,
    "idrops_20" : 3,
    "imcast" : 3,
    "ipkts_9" : 6,
    "interval" : 0,
    "ipkts_8" : 6,
    "ipkts_7" : 2,
    "ipkts_6" : 1,
    "ipkts_5" : 6,
    "ipkts_4" : 3,
    "api.switch-name" : "api.switch-name",
    "obytes" : 5,
    "ipkts" : 0,
    "ierrs" : 5,
    "end-time" : "end-time",
    "ibytes" : 6,
    "obcast" : 7,
    "ififoerrs" : 4,
    "odrops" : 9,
    "icrcerrs" : 7,
    "idrops" : 7,
    "ipkts_11" : 6,
    "ipkts_12" : 3,
    "ipkts_13" : 3,
    "ipkts_14" : 7,
    "ipkts_10" : 5,
    "omcast" : 2,
    "since-start" : true,
    "ishorterrs" : 9,
    "idrops_3" : 8,
    "idrops_2" : 4,
    "idrops_1" : 6,
    "idrops_0" : 8,
    "idrops_7" : 9,
    "idrops_6" : 3,
    "idrops_5" : 1,
    "idrops_4" : 9,
    "idrops_9" : 0,
    "idrops_8" : 8,
    "name" : "name",
    "ofifoerrs" : 5,
    "duration" : 4,
    "oerrs" : 2,
    "ilongerrs" : 9,
    "opkts_16" : 4,
    "opkts_15" : 5,
    "opkts_14" : 7,
    "opkts_13" : 0,
    "opkts_19" : 4,
    "opkts_18" : 8,
    "iframeerrs" : 1,
    "opkts_17" : 6,
    "opkts" : 1,
    "time" : "time",
    "opkts_12" : 9,
    "opkts_11" : 0,
    "opkts_10" : 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 switch-nic-stats-show-response
Up
get /switch-nic-stats/{name}
(showSwitchNicStatsByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ipkts_19" : 4,
    "older-than" : 0,
    "rxnobuf" : 6,
    "mcast" : 1,
    "within-last" : 7,
    "ipkts_15" : 0,
    "ipkts_16" : 7,
    "ipkts_17" : 6,
    "ipkts_18" : 0,
    "opkts_2" : 3,
    "idrops_14" : 3,
    "opkts_3" : 4,
    "idrops_13" : 7,
    "opkts_4" : 0,
    "idrops_12" : 8,
    "opkts_5" : 6,
    "idrops_11" : 5,
    "idrops_10" : 5,
    "opkts_0" : 7,
    "opkts_1" : 5,
    "ibcast" : 4,
    "ipkts_22" : 3,
    "ipkts_23" : 3,
    "idrops_19" : 0,
    "opkts_23" : 1,
    "idrops_18" : 7,
    "opkts_22" : 2,
    "idrops_17" : 5,
    "ipkts_20" : 8,
    "opkts_21" : 0,
    "idrops_16" : 9,
    "ipkts_21" : 7,
    "opkts_20" : 3,
    "idrops_15" : 3,
    "start-time" : "start-time",
    "opkts_6" : 4,
    "ioverruns" : 1,
    "opkts_7" : 1,
    "opkts_8" : 4,
    "opkts_9" : 7,
    "ipkts_3" : 6,
    "ipkts_2" : 9,
    "bcast" : 1,
    "ipkts_1" : 8,
    "idrops_23" : 8,
    "ipkts_0" : 6,
    "idrops_22" : 3,
    "idrops_21" : 2,
    "idrops_20" : 3,
    "imcast" : 3,
    "ipkts_9" : 6,
    "interval" : 0,
    "ipkts_8" : 6,
    "ipkts_7" : 2,
    "ipkts_6" : 1,
    "ipkts_5" : 6,
    "ipkts_4" : 3,
    "api.switch-name" : "api.switch-name",
    "obytes" : 5,
    "ipkts" : 0,
    "ierrs" : 5,
    "end-time" : "end-time",
    "ibytes" : 6,
    "obcast" : 7,
    "ififoerrs" : 4,
    "odrops" : 9,
    "icrcerrs" : 7,
    "idrops" : 7,
    "ipkts_11" : 6,
    "ipkts_12" : 3,
    "ipkts_13" : 3,
    "ipkts_14" : 7,
    "ipkts_10" : 5,
    "omcast" : 2,
    "since-start" : true,
    "ishorterrs" : 9,
    "idrops_3" : 8,
    "idrops_2" : 4,
    "idrops_1" : 6,
    "idrops_0" : 8,
    "idrops_7" : 9,
    "idrops_6" : 3,
    "idrops_5" : 1,
    "idrops_4" : 9,
    "idrops_9" : 0,
    "idrops_8" : 8,
    "name" : "name",
    "ofifoerrs" : 5,
    "duration" : 4,
    "oerrs" : 2,
    "ilongerrs" : 9,
    "opkts_16" : 4,
    "opkts_15" : 5,
    "opkts_14" : 7,
    "opkts_13" : 0,
    "opkts_19" : 4,
    "opkts_18" : 8,
    "iframeerrs" : 1,
    "opkts_17" : 6,
    "opkts" : 1,
    "time" : "time",
    "opkts_12" : 9,
    "opkts_11" : 0,
    "opkts_10" : 9
  }, {
    "ipkts_19" : 4,
    "older-than" : 0,
    "rxnobuf" : 6,
    "mcast" : 1,
    "within-last" : 7,
    "ipkts_15" : 0,
    "ipkts_16" : 7,
    "ipkts_17" : 6,
    "ipkts_18" : 0,
    "opkts_2" : 3,
    "idrops_14" : 3,
    "opkts_3" : 4,
    "idrops_13" : 7,
    "opkts_4" : 0,
    "idrops_12" : 8,
    "opkts_5" : 6,
    "idrops_11" : 5,
    "idrops_10" : 5,
    "opkts_0" : 7,
    "opkts_1" : 5,
    "ibcast" : 4,
    "ipkts_22" : 3,
    "ipkts_23" : 3,
    "idrops_19" : 0,
    "opkts_23" : 1,
    "idrops_18" : 7,
    "opkts_22" : 2,
    "idrops_17" : 5,
    "ipkts_20" : 8,
    "opkts_21" : 0,
    "idrops_16" : 9,
    "ipkts_21" : 7,
    "opkts_20" : 3,
    "idrops_15" : 3,
    "start-time" : "start-time",
    "opkts_6" : 4,
    "ioverruns" : 1,
    "opkts_7" : 1,
    "opkts_8" : 4,
    "opkts_9" : 7,
    "ipkts_3" : 6,
    "ipkts_2" : 9,
    "bcast" : 1,
    "ipkts_1" : 8,
    "idrops_23" : 8,
    "ipkts_0" : 6,
    "idrops_22" : 3,
    "idrops_21" : 2,
    "idrops_20" : 3,
    "imcast" : 3,
    "ipkts_9" : 6,
    "interval" : 0,
    "ipkts_8" : 6,
    "ipkts_7" : 2,
    "ipkts_6" : 1,
    "ipkts_5" : 6,
    "ipkts_4" : 3,
    "api.switch-name" : "api.switch-name",
    "obytes" : 5,
    "ipkts" : 0,
    "ierrs" : 5,
    "end-time" : "end-time",
    "ibytes" : 6,
    "obcast" : 7,
    "ififoerrs" : 4,
    "odrops" : 9,
    "icrcerrs" : 7,
    "idrops" : 7,
    "ipkts_11" : 6,
    "ipkts_12" : 3,
    "ipkts_13" : 3,
    "ipkts_14" : 7,
    "ipkts_10" : 5,
    "omcast" : 2,
    "since-start" : true,
    "ishorterrs" : 9,
    "idrops_3" : 8,
    "idrops_2" : 4,
    "idrops_1" : 6,
    "idrops_0" : 8,
    "idrops_7" : 9,
    "idrops_6" : 3,
    "idrops_5" : 1,
    "idrops_4" : 9,
    "idrops_9" : 0,
    "idrops_8" : 8,
    "name" : "name",
    "ofifoerrs" : 5,
    "duration" : 4,
    "oerrs" : 2,
    "ilongerrs" : 9,
    "opkts_16" : 4,
    "opkts_15" : 5,
    "opkts_14" : 7,
    "opkts_13" : 0,
    "opkts_19" : 4,
    "opkts_18" : 8,
    "iframeerrs" : 1,
    "opkts_17" : 6,
    "opkts" : 1,
    "time" : "time",
    "opkts_12" : 9,
    "opkts_11" : 0,
    "opkts_10" : 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 switch-nic-stats-show-response

SwitchNicStatsSettings

Up
get /switch-nic-stats-settings
(showSwitchNicStatsSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 switch-nic-stats-settings-show-response
Up
put /switch-nic-stats-settings
(updateSwitchNicStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SwitchRoutes

Up
post /switch-routes
(createSwitchRoute)

Consumes

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

Request body

body switch-route-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /switch-routes/network={network},netmask={netmask},gateway-ip={gateway-ip},nic={nic}
(deleteSwitchRouteByUniqueKeyAll)

Path parameters

network (required)
Path Parameter
netmask (required)
Path Parameter
gateway-ip (required)
Path Parameter
nic (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /switch-routes/network={network},netmask={netmask},gateway-ip={gateway-ip},nic={nic}
(showSwitchRouteByUniqueKeyAll)

Path parameters

network (required)
Path Parameter
netmask (required)
Path Parameter
gateway-ip (required)
Path Parameter
nic (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "metric" : 6,
    "gateway-ip" : "gateway-ip",
    "nic" : "nic",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "metric" : 6,
    "gateway-ip" : "gateway-ip",
    "nic" : "nic",
    "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 switch-route-show-response
Up
get /switch-routes
(showSwitchRoutes)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "metric" : 6,
    "gateway-ip" : "gateway-ip",
    "nic" : "nic",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "metric" : 6,
    "gateway-ip" : "gateway-ip",
    "nic" : "nic",
    "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 switch-route-show-response
Up
put /switch-routes/network={network},netmask={netmask},gateway-ip={gateway-ip},nic={nic}
(updateSwitchRouteByUniqueKeyAll)

Path parameters

network (required)
Path Parameter
netmask (required)
Path Parameter
gateway-ip (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 switch-route-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SwitchSetup

Up
get /switch-setup
(showSetup)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "date" : "date",
    "domain-name" : "domain-name",
    "in-band-ip6-assign" : "none",
    "mgmt-link-state" : "down",
    "eula-accepted" : true,
    "hostid" : 0,
    "ntp-server" : "ntp-server",
    "in-band-netmask-ip6" : 7,
    "mgmt-dot1x-enable" : true,
    "device-id" : "device-id",
    "loopback-ip6" : "loopback-ip6",
    "mgmt-dot1x-version" : "802.1X-2001",
    "analytics-store" : "default",
    "mgmt-secondary-link-state" : "down",
    "in-band-ip" : "in-band-ip",
    "mgmt-dot1x-profiles" : "mgmt-dot1x-profiles",
    "mgmt-ip6" : "mgmt-ip6",
    "mgmt-netmask" : 5,
    "gateway-ip6" : "gateway-ip6",
    "motd" : "motd",
    "gateway-ip" : "gateway-ip",
    "disk-mirror" : true,
    "mgmt-ip6-assignment" : "none",
    "switch-name" : "switch-name",
    "dns-ip" : "dns-ip",
    "mgmt-secondary-link-speed" : 6,
    "in-band-netmask" : 2,
    "ntp-tertiary-server" : "ntp-tertiary-server",
    "mgmt-mac" : "mgmt-mac",
    "force" : true,
    "mgmt-lacp-mode" : "off",
    "mgmt-link-speed" : 1,
    "mgmt-dot1x-status" : "mgmt-dot1x-status",
    "ntp-secondary-server" : "ntp-secondary-server",
    "timezone" : "timezone",
    "enable-host-ports" : true,
    "mgmt-ip" : "mgmt-ip",
    "api.switch-name" : "api.switch-name",
    "location-id" : 9,
    "mgmt-lag-capable" : true,
    "mgmt-netmask-ip6" : 5,
    "in-band-ip6" : "in-band-ip6",
    "banner" : "banner",
    "mgmt-ip-assignment" : "none",
    "ntp" : true,
    "loopback-ip" : "loopback-ip",
    "eula_timestamp" : "eula_timestamp",
    "mgmt-lag" : "disable",
    "dns-secondary-ip" : "dns-secondary-ip"
  }, {
    "date" : "date",
    "domain-name" : "domain-name",
    "in-band-ip6-assign" : "none",
    "mgmt-link-state" : "down",
    "eula-accepted" : true,
    "hostid" : 0,
    "ntp-server" : "ntp-server",
    "in-band-netmask-ip6" : 7,
    "mgmt-dot1x-enable" : true,
    "device-id" : "device-id",
    "loopback-ip6" : "loopback-ip6",
    "mgmt-dot1x-version" : "802.1X-2001",
    "analytics-store" : "default",
    "mgmt-secondary-link-state" : "down",
    "in-band-ip" : "in-band-ip",
    "mgmt-dot1x-profiles" : "mgmt-dot1x-profiles",
    "mgmt-ip6" : "mgmt-ip6",
    "mgmt-netmask" : 5,
    "gateway-ip6" : "gateway-ip6",
    "motd" : "motd",
    "gateway-ip" : "gateway-ip",
    "disk-mirror" : true,
    "mgmt-ip6-assignment" : "none",
    "switch-name" : "switch-name",
    "dns-ip" : "dns-ip",
    "mgmt-secondary-link-speed" : 6,
    "in-band-netmask" : 2,
    "ntp-tertiary-server" : "ntp-tertiary-server",
    "mgmt-mac" : "mgmt-mac",
    "force" : true,
    "mgmt-lacp-mode" : "off",
    "mgmt-link-speed" : 1,
    "mgmt-dot1x-status" : "mgmt-dot1x-status",
    "ntp-secondary-server" : "ntp-secondary-server",
    "timezone" : "timezone",
    "enable-host-ports" : true,
    "mgmt-ip" : "mgmt-ip",
    "api.switch-name" : "api.switch-name",
    "location-id" : 9,
    "mgmt-lag-capable" : true,
    "mgmt-netmask-ip6" : 5,
    "in-band-ip6" : "in-band-ip6",
    "banner" : "banner",
    "mgmt-ip-assignment" : "none",
    "ntp" : true,
    "loopback-ip" : "loopback-ip",
    "eula_timestamp" : "eula_timestamp",
    "mgmt-lag" : "disable",
    "dns-secondary-ip" : "dns-secondary-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 switch-setup-show-response
Up
put /switch-setup
(updateSetup)

Consumes

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

Request body

body switch-setup-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SwitchStatusSettings

Up
get /switch-status-settings
(showHwStatsSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 switch-status-settings-show-response
Up
put /switch-status-settings
(updateHwStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SwitchStatuses

Up
get /switch-statuses
(showHwStatuses)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "end-time" : "end-time",
    "units" : "degrees-C",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "name" : "name",
    "interval" : 6,
    "state" : "ok",
    "time" : "time",
    "value" : "value"
  }, {
    "older-than" : 1,
    "start-time" : "start-time",
    "within-last" : 5,
    "end-time" : "end-time",
    "units" : "degrees-C",
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 0,
    "name" : "name",
    "interval" : 6,
    "state" : "ok",
    "time" : "time",
    "value" : "value"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success switch-status-show-response

SwitchVnics

Up
post /switch-vnics
(createSwitchVnic)

Consumes

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

Request body

body switch-vnic-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /switch-vnics/{nic}
(deleteSwitchVnicByVnic)

Path parameters

nic (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /switch-vnics/{nic}
(showSwitchVnicByVnic)

Path parameters

nic (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "sriov-vf" : true,
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 5,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : true,
    "netmask2" : 6
  }, {
    "sriov-vf" : true,
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 5,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : 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 switch-vnic-show-response
Up
get /switch-vnics
(showSwitchVnics)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "sriov-vf" : true,
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 5,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : true,
    "netmask2" : 6
  }, {
    "sriov-vf" : true,
    "assignment2" : "none",
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 5,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 5,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : 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 switch-vnic-show-response
Up
put /switch-vnics/{nic}
(updateSwitchVnicByVnic)

Path parameters

nic (required)
Path Parameter

Consumes

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

Request body

body switch-vnic-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SyslogTlsCertInfos

Up
get /syslog-tls-cert-infos
(showSyslogTlsCertInfos)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "valid-to" : "valid-to",
    "cert-type" : "ca",
    "serial-number" : 0,
    "subject" : "subject",
    "api.switch-name" : "api.switch-name",
    "issuer" : "issuer",
    "status" : "status",
    "valid-from" : "valid-from"
  }, {
    "valid-to" : "valid-to",
    "cert-type" : "ca",
    "serial-number" : 0,
    "subject" : "subject",
    "api.switch-name" : "api.switch-name",
    "issuer" : "issuer",
    "status" : "status",
    "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 syslog-tls-cert-info-show-response

SyslogTlsCertRequests

Up
post /syslog-tls-cert-requests
(createSyslogTlsCertRequest)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SyslogTlsCerts

Up
post /syslog-tls-certs/clear
(clearSyslogTlsCert)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /syslog-tls-certs/import
(importSyslogTlsCert)

Consumes

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

Request body

body syslog-tls-cert-import (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /syslog-tls-certs
(showSyslogTlsCerts)

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success syslog-tls-cert-show-response

System

Up
post /system/reboot
(rebootSystem)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SystemDiagnosticsHwLimits

Up
get /system-diagnostics-hw-limits
(showSysDiagHwLimits)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "l3_intf_vlan_split_egress" : 0,
    "l3_mem_entries" : 1,
    "l3info_max_route" : 5,
    "ecap_max_entries" : 9,
    "vcap_max_entries" : 3,
    "api.switch-name" : "api.switch-name",
    "l3_max_ecmp_mode" : 6,
    "l2_mem_entries" : 7,
    "icap_max_entries" : 7,
    "lpm_scaling_enable" : 2,
    "l3info_max_host" : 2,
    "l3_alpm_enable" : 1,
    "l2xmsg_mode" : 1,
    "ipv6_lpm_128b_enable" : 4,
    "num_ipv6_lpm_128b_entries" : 5
  }, {
    "l3_intf_vlan_split_egress" : 0,
    "l3_mem_entries" : 1,
    "l3info_max_route" : 5,
    "ecap_max_entries" : 9,
    "vcap_max_entries" : 3,
    "api.switch-name" : "api.switch-name",
    "l3_max_ecmp_mode" : 6,
    "l2_mem_entries" : 7,
    "icap_max_entries" : 7,
    "lpm_scaling_enable" : 2,
    "l3info_max_host" : 2,
    "l3_alpm_enable" : 1,
    "l2xmsg_mode" : 1,
    "ipv6_lpm_128b_enable" : 4,
    "num_ipv6_lpm_128b_entries" : 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 system-diagnostics-hw-limits-show-response

SystemSettings

Up
get /system-settings
(showSysSetting)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lossless-mode" : true,
    "proxy-conn-retry-interval" : 1,
    "multiple-tunnel-next-hops" : true,
    "manage-wake-on-lan" : true,
    "hybrid-mode" : true,
    "memory-tracker" : true,
    "reactivate-mac" : true,
    "ephy-rxlos-poll-interval" : 7,
    "optimize-datapath" : "disable",
    "single-pass-flood" : true,
    "qsfp28-port-mode" : "none",
    "single-pass-l2-known-multicast" : true,
    "usb-port" : true,
    "xcvr-oir-debug-port" : "xcvr-oir-debug-port",
    "l3-use-host-table" : true,
    "manage-broadcast" : true,
    "proxy-conn-max-retry" : 6,
    "linkscan-interval" : 5,
    "offline-notification-new-thread" : true,
    "flow-tracker-enable" : true,
    "routing-over-vlags" : true,
    "fastpath-bfd" : true,
    "vle-tracking-timeout" : "vle-tracking-timeout",
    "host-refresh" : true,
    "nvos-debug-logging" : true,
    "hash-inner-ip-over-gre" : true,
    "xcvr-link-debug" : true,
    "hash-suppress-unidir-fields" : true,
    "linkscan-mode" : "software",
    "cosq-weight-auto" : true,
    "batch-move-mac-hw-group-for-vlan-only" : true,
    "v6-vrrp-validate" : true,
    "sfp28-port-mode" : "48x25G",
    "uplink-oversubscription-action" : "default",
    "symmetric-hash" : true,
    "cpu-class-enable" : true,
    "lldp" : true,
    "policy-based-routing" : true,
    "source-mac-miss" : "to-cpu",
    "bcm-interrupt-timeout" : 2,
    "api.switch-name" : "api.switch-name",
    "proxy-conn-retry" : true,
    "auto-trunk" : true,
    "cos-8-and-9-queue" : true,
    "reactivate-vxlan-tunnel-mac" : true,
    "snoop-query-stagger" : true,
    "optimize-rxlos" : true,
    "igmp-snoop" : true,
    "auto-host-bundle" : true,
    "port-cos-drop-stats-interval" : 0,
    "optimize-arps" : true,
    "optimize-nd" : true,
    "single-pass-riot" : true,
    "pfc-buffer-limit" : "pfc-buffer-limit",
    "manage-unknown-unicast" : true,
    "manage-l2-uuc-drop" : true,
    "cluster-active-active-routing" : true,
    "bcm-ctr-thread-freq" : 5,
    "prioritize-rx-reasons" : true,
    "block-loops" : true
  }, {
    "lossless-mode" : true,
    "proxy-conn-retry-interval" : 1,
    "multiple-tunnel-next-hops" : true,
    "manage-wake-on-lan" : true,
    "hybrid-mode" : true,
    "memory-tracker" : true,
    "reactivate-mac" : true,
    "ephy-rxlos-poll-interval" : 7,
    "optimize-datapath" : "disable",
    "single-pass-flood" : true,
    "qsfp28-port-mode" : "none",
    "single-pass-l2-known-multicast" : true,
    "usb-port" : true,
    "xcvr-oir-debug-port" : "xcvr-oir-debug-port",
    "l3-use-host-table" : true,
    "manage-broadcast" : true,
    "proxy-conn-max-retry" : 6,
    "linkscan-interval" : 5,
    "offline-notification-new-thread" : true,
    "flow-tracker-enable" : true,
    "routing-over-vlags" : true,
    "fastpath-bfd" : true,
    "vle-tracking-timeout" : "vle-tracking-timeout",
    "host-refresh" : true,
    "nvos-debug-logging" : true,
    "hash-inner-ip-over-gre" : true,
    "xcvr-link-debug" : true,
    "hash-suppress-unidir-fields" : true,
    "linkscan-mode" : "software",
    "cosq-weight-auto" : true,
    "batch-move-mac-hw-group-for-vlan-only" : true,
    "v6-vrrp-validate" : true,
    "sfp28-port-mode" : "48x25G",
    "uplink-oversubscription-action" : "default",
    "symmetric-hash" : true,
    "cpu-class-enable" : true,
    "lldp" : true,
    "policy-based-routing" : true,
    "source-mac-miss" : "to-cpu",
    "bcm-interrupt-timeout" : 2,
    "api.switch-name" : "api.switch-name",
    "proxy-conn-retry" : true,
    "auto-trunk" : true,
    "cos-8-and-9-queue" : true,
    "reactivate-vxlan-tunnel-mac" : true,
    "snoop-query-stagger" : true,
    "optimize-rxlos" : true,
    "igmp-snoop" : true,
    "auto-host-bundle" : true,
    "port-cos-drop-stats-interval" : 0,
    "optimize-arps" : true,
    "optimize-nd" : true,
    "single-pass-riot" : true,
    "pfc-buffer-limit" : "pfc-buffer-limit",
    "manage-unknown-unicast" : true,
    "manage-l2-uuc-drop" : true,
    "cluster-active-active-routing" : true,
    "bcm-ctr-thread-freq" : 5,
    "prioritize-rx-reasons" : true,
    "block-loops" : 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 system-settings-show-response
Up
put /system-settings
(updateSysSetting)

Consumes

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

Request body

body system-settings-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SystemState

Up
get /system-state
(showSystemState)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "system-state" : "system-state",
    "api.switch-name" : "api.switch-name"
  }, {
    "system-state" : "system-state",
    "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 system-state-show-response
Up
put /system-state
(updateSystemState)

Consumes

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

Request body

body system-state-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SystemStats

Up
get /system-stats
(showSystemStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "cpu-avg" : 6,
    "used-mem" : 5,
    "used-swap-val" : 7,
    "start-time" : "start-time",
    "within-last" : 1,
    "cpu-sys" : 2,
    "end-time" : "end-time",
    "paging" : 9,
    "cpu-total" : 0,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "uptime" : 1,
    "duration" : 7,
    "used-mem-val" : 5,
    "cpu-user" : 3,
    "cpu-idle" : 4,
    "interval" : 1,
    "used-swap" : 2,
    "time" : "time"
  }, {
    "older-than" : 1,
    "cpu-avg" : 6,
    "used-mem" : 5,
    "used-swap-val" : 7,
    "start-time" : "start-time",
    "within-last" : 1,
    "cpu-sys" : 2,
    "end-time" : "end-time",
    "paging" : 9,
    "cpu-total" : 0,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "uptime" : 1,
    "duration" : 7,
    "used-mem-val" : 5,
    "cpu-user" : 3,
    "cpu-idle" : 4,
    "interval" : 1,
    "used-swap" : 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 system-stats-show-response

SystemStatsHistories

Up
get /system-stats-histories/average-show/{over-last}
(avgShowSystemStatsHistory)

Path parameters

over-last (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mem-used" : 0,
    "cpu-used" : 6,
    "cpu-peak" : 1,
    "time" : "time",
    "api.switch-name" : "api.switch-name",
    "over-last" : 5
  }, {
    "mem-used" : 0,
    "cpu-used" : 6,
    "cpu-peak" : 1,
    "time" : "time",
    "api.switch-name" : "api.switch-name",
    "over-last" : 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 system-stats-history-show-response
Up
get /system-stats-histories
(showSystemStatsHistories)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mem-used" : 0,
    "cpu-used" : 6,
    "cpu-peak" : 1,
    "time" : "time",
    "api.switch-name" : "api.switch-name",
    "over-last" : 5
  }, {
    "mem-used" : 0,
    "cpu-used" : 6,
    "cpu-peak" : 1,
    "time" : "time",
    "api.switch-name" : "api.switch-name",
    "over-last" : 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 system-stats-history-show-response

SystemStatsHistorySettings

Up
get /system-stats-history-settings
(showSystemStatsHistorySettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "read-interval" : 0,
    "enable" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "read-interval" : 0,
    "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 system-stats-history-settings-show-response
Up
put /system-stats-history-settings
(updateSystemStatsHistorySettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

SystemStatsSettings

Up
get /system-stats-settings
(showSystemStatsSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 system-stats-settings-show-response
Up
put /system-stats-settings
(updateSystemStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Topologies

Up
post /topologies/{name}/links
(addTopologyTopologyLinkByTopologyName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body topology-link-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /topologies/{name}/vles
(addTopologyVleByTopologyName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body topology-vle-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /topologies/{name}/vlinks
(addTopologyVlinkByTopologyName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body topology-vlink-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /topologies
(createTopology)

Consumes

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

Request body

body topology-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /topologies/{name}
(deleteTopologyByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /topologies/import
(importTopologyByUsage1)

Consumes

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

Request body

body topology-import-1 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /topologies/{name}/links/node1={node1},node1-port={node1-port},node2={node2},node2-port={node2-port}
(removeTopologyTopologyLinkByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
node1 (required)
Path Parameter
node1-port (required)
Path Parameter
node2 (required)
Path Parameter
node2-port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /topologies/{name}/vles/vle-name={vle-name}
(removeTopologyVleByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vle-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /topologies/{name}/vlinks/vlink-name={vlink-name}
(removeTopologyVlinkByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vlink-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /topologies
(showTopologies)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "enable" : true,
    "name" : "name",
    "vle_name_size" : 6,
    "vle_name" : "vle_name",
    "vflow_name" : "vflow_name",
    "type" : "vflow",
    "api.switch-name" : "api.switch-name",
    "vlink_name_size" : 0
  }, {
    "enable" : true,
    "name" : "name",
    "vle_name_size" : 6,
    "vle_name" : "vle_name",
    "vflow_name" : "vflow_name",
    "type" : "vflow",
    "api.switch-name" : "api.switch-name",
    "vlink_name_size" : 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 topology-show-response
Up
get /topologies/{name}
(showTopologyByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "enable" : true,
    "name" : "name",
    "vle_name_size" : 6,
    "vle_name" : "vle_name",
    "vflow_name" : "vflow_name",
    "type" : "vflow",
    "api.switch-name" : "api.switch-name",
    "vlink_name_size" : 0
  }, {
    "enable" : true,
    "name" : "name",
    "vle_name_size" : 6,
    "vle_name" : "vle_name",
    "vflow_name" : "vflow_name",
    "type" : "vflow",
    "api.switch-name" : "api.switch-name",
    "vlink_name_size" : 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 topology-show-response
Up
get /topologies/{name}/nodes/node={node},local-port={local-port},peer-node={peer-node},remote-port={remote-port}
(showTopologyTopoNodesByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
node (required)
Path Parameter
local-port (required)
Path Parameter
peer-node (required)
Path Parameter
remote-port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "local-port" : 0,
    "node" : 1,
    "enable" : true,
    "remote-port" : 6,
    "api.switch-name" : "api.switch-name",
    "peer-node" : 5
  }, {
    "local-port" : 0,
    "node" : 1,
    "enable" : true,
    "remote-port" : 6,
    "api.switch-name" : "api.switch-name",
    "peer-node" : 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 topology-node-show-response
Up
get /topologies/{name}/nodes
(showTopologyTopoNodesByTopologyName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "local-port" : 0,
    "node" : 1,
    "enable" : true,
    "remote-port" : 6,
    "api.switch-name" : "api.switch-name",
    "peer-node" : 5
  }, {
    "local-port" : 0,
    "node" : 1,
    "enable" : true,
    "remote-port" : 6,
    "api.switch-name" : "api.switch-name",
    "peer-node" : 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 topology-node-show-response
Up
get /topologies/{name}/links/node1={node1},node1-port={node1-port},node2={node2},node2-port={node2-port}
(showTopologyTopologyLinksByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
node1 (required)
Path Parameter
node1-port (required)
Path Parameter
node2 (required)
Path Parameter
node2-port (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "node2" : 6,
    "enable" : true,
    "node2-port" : 5,
    "id" : "id",
    "in-path" : "in-path",
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node1-port" : 1,
    "in-use" : true
  }, {
    "node2" : 6,
    "enable" : true,
    "node2-port" : 5,
    "id" : "id",
    "in-path" : "in-path",
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node1-port" : 1,
    "in-use" : 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 topology-link-show-response
Up
get /topologies/{name}/links
(showTopologyTopologyLinksByTopologyName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "node2" : 6,
    "enable" : true,
    "node2-port" : 5,
    "id" : "id",
    "in-path" : "in-path",
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node1-port" : 1,
    "in-use" : true
  }, {
    "node2" : 6,
    "enable" : true,
    "node2-port" : 5,
    "id" : "id",
    "in-path" : "in-path",
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node1-port" : 1,
    "in-use" : 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 topology-link-show-response
Up
get /topologies/{name}/vles/vle-name={vle-name}
(showTopologyVlesByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vle-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 5,
    "node2" : 6,
    "vlan" : 1,
    "vle-name" : "vle-name",
    "node-1-port" : 5,
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node-2-port" : 2
  }, {
    "vxlan" : 5,
    "node2" : 6,
    "vlan" : 1,
    "vle-name" : "vle-name",
    "node-1-port" : 5,
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node-2-port" : 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 topology-vle-show-response
Up
get /topologies/{name}/vles
(showTopologyVlesByTopologyName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 5,
    "node2" : 6,
    "vlan" : 1,
    "vle-name" : "vle-name",
    "node-1-port" : 5,
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node-2-port" : 2
  }, {
    "vxlan" : 5,
    "node2" : 6,
    "vlan" : 1,
    "vle-name" : "vle-name",
    "node-1-port" : 5,
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node-2-port" : 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 topology-vle-show-response
Up
get /topologies/{name}/vlinks/vlink-name={vlink-name}
(showTopologyVlinksByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vlink-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "endpoint1" : "endpoint1",
    "endpoint2" : "endpoint2",
    "api.switch-name" : "api.switch-name",
    "vlink-name" : "vlink-name"
  }, {
    "endpoint1" : "endpoint1",
    "endpoint2" : "endpoint2",
    "api.switch-name" : "api.switch-name",
    "vlink-name" : "vlink-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 topology-vlink-show-response
Up
get /topologies/{name}/vlinks
(showTopologyVlinksByTopologyName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "endpoint1" : "endpoint1",
    "endpoint2" : "endpoint2",
    "api.switch-name" : "api.switch-name",
    "vlink-name" : "vlink-name"
  }, {
    "endpoint1" : "endpoint1",
    "endpoint2" : "endpoint2",
    "api.switch-name" : "api.switch-name",
    "vlink-name" : "vlink-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 topology-vlink-show-response
Up
put /topologies/{name}
(updateTopologyByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body topology-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /topologies/{name}/links/node1={node1},node1-port={node1-port},node2={node2},node2-port={node2-port}
(updateTopologyTopologyLinkByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
node1 (required)
Path Parameter
node1-port (required)
Path Parameter
node2 (required)
Path Parameter
node2-port (required)
Path Parameter

Consumes

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

Request body

body topology-link-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "node2" : 6,
    "enable" : true,
    "node2-port" : 5,
    "id" : "id",
    "in-path" : "in-path",
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node1-port" : 1,
    "in-use" : true
  }, {
    "node2" : 6,
    "enable" : true,
    "node2-port" : 5,
    "id" : "id",
    "in-path" : "in-path",
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node1-port" : 1,
    "in-use" : 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 topology-link-show-response
Up
put /topologies/{name}/vles/vle-name={vle-name}
(updateTopologyVleByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vle-name (required)
Path Parameter

Consumes

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

Request body

body topology-vle-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 5,
    "node2" : 6,
    "vlan" : 1,
    "vle-name" : "vle-name",
    "node-1-port" : 5,
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node-2-port" : 2
  }, {
    "vxlan" : 5,
    "node2" : 6,
    "vlan" : 1,
    "vle-name" : "vle-name",
    "node-1-port" : 5,
    "api.switch-name" : "api.switch-name",
    "node1" : 0,
    "node-2-port" : 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 topology-vle-show-response
Up
put /topologies/{name}/vlinks/vlink-name={vlink-name}
(updateTopologyVlinkByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vlink-name (required)
Path Parameter

Consumes

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

Request body

body topology-vlink-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "endpoint1" : "endpoint1",
    "endpoint2" : "endpoint2",
    "api.switch-name" : "api.switch-name",
    "vlink-name" : "vlink-name"
  }, {
    "endpoint1" : "endpoint1",
    "endpoint2" : "endpoint2",
    "api.switch-name" : "api.switch-name",
    "vlink-name" : "vlink-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 topology-vlink-show-response

TransactionNodes

Up
get /transaction-nodes
(showXactNodes)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "fabric-changeid" : "fabric-changeid",
    "local-tid" : 0,
    "cluster-changeid" : "cluster-changeid",
    "fabric-tid" : 1,
    "name" : "name",
    "id" : 6,
    "api.switch-name" : "api.switch-name",
    "cluster-tid" : 5
  }, {
    "fabric-changeid" : "fabric-changeid",
    "local-tid" : 0,
    "cluster-changeid" : "cluster-changeid",
    "fabric-tid" : 1,
    "name" : "name",
    "id" : 6,
    "api.switch-name" : "api.switch-name",
    "cluster-tid" : 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 transaction-node-show-response

TransactionSettings

Up
get /transaction-settings
(showXactSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "auto-recover-retry-time" : 0,
    "auto-recover" : true,
    "allow-offline-cluster-nodes" : true,
    "reserve-retry-maximum" : 6,
    "reserve-retry-interval-maximum" : 1,
    "max-local-xact-log-entries" : 5,
    "allow-overlapping-parallel-commands" : true,
    "failover-persistent" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "auto-recover-retry-time" : 0,
    "auto-recover" : true,
    "allow-offline-cluster-nodes" : true,
    "reserve-retry-maximum" : 6,
    "reserve-retry-interval-maximum" : 1,
    "max-local-xact-log-entries" : 5,
    "allow-overlapping-parallel-commands" : true,
    "failover-persistent" : 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 transaction-settings-show-response
Up
put /transaction-settings
(updateXactSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Transactions

Up
post /transactions/cluster-divergence-fix
(clusterDivergenceFixXactLog)

Consumes

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

Request body

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /transactions/log-file-truncate-to
(logFileTruncateXactLog)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /transactions/rollback-to
(rollbackXactLog)

Consumes

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

Request body

body transaction-rollback-to (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /transactions/rollforward-to
(rollforwardXactLog)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /transactions
(showXactLogs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "start-time" : 5,
    "local-command" : "local-command",
    "end-time" : 6,
    "start-tid" : 1,
    "trunc_tid" : 7,
    "changeid" : "changeid",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "undo-command" : "undo-command",
    "command" : "command",
    "transaction-scope" : "local",
    "failure" : "failure",
    "remote-node" : 2,
    "state" : "start",
    "end-tid" : 5
  }, {
    "start-time" : 5,
    "local-command" : "local-command",
    "end-time" : 6,
    "start-tid" : 1,
    "trunc_tid" : 7,
    "changeid" : "changeid",
    "api.switch-name" : "api.switch-name",
    "tid" : 0,
    "undo-command" : "undo-command",
    "command" : "command",
    "transaction-scope" : "local",
    "failure" : "failure",
    "remote-node" : 2,
    "state" : "start",
    "end-tid" : 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 transaction-show-response

TrunkStats

Up
get /trunk-stats/clear
(clearTrunkStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "trunk-id" : "trunk-id",
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 4,
    "name" : "name",
    "interval" : 1,
    "time" : "time",
    "obits" : 6
  }, {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "trunk-id" : "trunk-id",
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 4,
    "name" : "name",
    "interval" : 1,
    "time" : "time",
    "obits" : 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 trunk-stats-show-response
Up
get /trunk-stats
(showTrunkStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "trunk-id" : "trunk-id",
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 4,
    "name" : "name",
    "interval" : 1,
    "time" : "time",
    "obits" : 6
  }, {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "trunk-id" : "trunk-id",
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 4,
    "name" : "name",
    "interval" : 1,
    "time" : "time",
    "obits" : 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 trunk-stats-show-response
Up
get /trunk-stats/name/{name}
(showTrunkStatsByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "trunk-id" : "trunk-id",
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 4,
    "name" : "name",
    "interval" : 1,
    "time" : "time",
    "obits" : 6
  }, {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "trunk-id" : "trunk-id",
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 4,
    "name" : "name",
    "interval" : 1,
    "time" : "time",
    "obits" : 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 trunk-stats-show-response
Up
get /trunk-stats/trunk-id/{trunk-id}
(showTrunkStatsByPortNum)

Path parameters

trunk-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "trunk-id" : "trunk-id",
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 4,
    "name" : "name",
    "interval" : 1,
    "time" : "time",
    "obits" : 6
  }, {
    "iPauseFs" : 1,
    "older-than" : 2,
    "port-speed" : 0,
    "within-last" : 6,
    "HER-bytes" : 9,
    "description" : "description",
    "iUpkts" : 5,
    "Rx-bw-th-exceed-count" : 7,
    "bezel-port" : "bezel-port",
    "oPkts" : 3,
    "oUpkts" : 8,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 1,
    "oCongDrops" : 7,
    "iCongDrops" : 4,
    "ibits" : 5,
    "obytes" : 9,
    "iMpkts" : 7,
    "ierrs" : 9,
    "trunk-id" : "trunk-id",
    "oMpkts" : 2,
    "start-time" : "start-time",
    "HER-bits" : 6,
    "end-time" : "end-time",
    "ibytes" : 1,
    "Tx-bw-th-exceed-count" : 9,
    "odiscards" : 1,
    "counter" : 6,
    "HER-pkts" : 6,
    "oBpkts" : 3,
    "idiscards" : 5,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 4,
    "name" : "name",
    "interval" : 1,
    "time" : "time",
    "obits" : 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 trunk-stats-show-response

Trunks

Up
post /trunks
(createTrunkConfig)

Consumes

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

Request body

body trunk-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /trunks/description/{description}
(deleteTrunkConfigByDescription)

Path parameters

description (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /trunks/trunk-id/{trunk-id}
(deleteTrunkConfigById)

Path parameters

trunk-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /trunks/name/{name}
(deleteTrunkConfigByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /trunks/description/{description}
(showTrunkConfigByDescription)

Path parameters

description (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "trunk-id" : 0,
    "rswitch" : 9,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 7,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 1,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 6,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "stp-port-cost" : 5,
    "config" : "10m"
  }, {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "trunk-id" : 0,
    "rswitch" : 9,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 7,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 1,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 6,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "stp-port-cost" : 5,
    "config" : "10m"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success trunk-show-response
Up
get /trunks/trunk-id/{trunk-id}
(showTrunkConfigById)

Path parameters

trunk-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "trunk-id" : 0,
    "rswitch" : 9,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 7,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 1,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 6,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "stp-port-cost" : 5,
    "config" : "10m"
  }, {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "trunk-id" : 0,
    "rswitch" : 9,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 7,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 1,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 6,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "stp-port-cost" : 5,
    "config" : "10m"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success trunk-show-response
Up
get /trunks/name/{name}
(showTrunkConfigByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "trunk-id" : 0,
    "rswitch" : 9,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 7,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 1,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 6,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "stp-port-cost" : 5,
    "config" : "10m"
  }, {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "trunk-id" : 0,
    "rswitch" : 9,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 7,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 1,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 6,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "stp-port-cost" : 5,
    "config" : "10m"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success trunk-show-response
Up
get /trunks/ports/{ports}
(showTrunkConfigByPorts)

Path parameters

ports (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "trunk-id" : 0,
    "rswitch" : 9,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 7,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 1,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 6,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "stp-port-cost" : 5,
    "config" : "10m"
  }, {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "trunk-id" : 0,
    "rswitch" : 9,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 7,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 1,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 6,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "stp-port-cost" : 5,
    "config" : "10m"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success trunk-show-response
Up
get /trunks
(showTrunkConfigs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "trunk-id" : 0,
    "rswitch" : 9,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 7,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 1,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 6,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "stp-port-cost" : 5,
    "config" : "10m"
  }, {
    "lacp-timeout" : "slow",
    "port-mac-address" : "port-mac-address",
    "fec" : "fec",
    "rport" : 2,
    "in_use" : true,
    "broadcast-level" : "broadcast-level",
    "rswitch-ip" : "rswitch-ip",
    "reflect" : "reflect",
    "trunk-hw-id" : 5,
    "unknown-ucast-level" : "unknown-ucast-level",
    "enable" : "enable",
    "eth-mode" : "1000base-x",
    "rswitch-default-vlan" : 3,
    "loopback" : "no-loopback",
    "trunk-id" : 0,
    "rswitch" : 9,
    "pause" : true,
    "bw-bps" : 1,
    "hash-mode" : "enhanced",
    "lacp-fallback-timeout" : 1,
    "name" : "name",
    "stp-port-priority" : 2,
    "unknown-mcast-level" : "unknown-mcast-level",
    "rswitch-mac" : "rswitch-mac",
    "vxlan-termination" : "vxlan-termination",
    "lacp-fallback" : "bundle",
    "lldp" : true,
    "status" : "phy-up",
    "updown_time" : 4,
    "defer-bringup" : true,
    "jumbo" : "jumbo",
    "local-switching" : "local-switching",
    "vle-id" : "vle-id",
    "description" : "description",
    "lacp-individual" : "lacp-individual",
    "lport" : 7,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "speed" : 6,
    "switch" : 7,
    "routing" : true,
    "egress-rate-limit" : 1,
    "allowed-tpid" : "vlan",
    "lacp-priority" : 1,
    "rem-rswitch-port-mac" : "rem-rswitch-port-mac",
    "dscp-map" : "dscp-map",
    "host-enable" : true,
    "vlag-id" : "vlag-id",
    "cluster-port" : true,
    "receive-only" : "mirror-only",
    "lacp-mode" : "off",
    "fabric-guard" : true,
    "rhost" : "rhost",
    "send-port" : 6,
    "loop-vlans" : "loop-vlans",
    "edge-switch" : true,
    "autoneg" : "autoneg",
    "stp-port-cost" : 5,
    "config" : "10m"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success trunk-show-response
Up
put /trunks/description/{description}
(updateTrunkConfigByDescriptionByUsage1)

Path parameters

description (required)
Path Parameter

Consumes

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

Request body

body trunk-modify-1 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /trunks/trunk-id/{trunk-id}
(updateTrunkConfigByIdByUsage1)

Path parameters

trunk-id (required)
Path Parameter

Consumes

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

Request body

body trunk-modify-1 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /trunks/name/{name}
(updateTrunkConfigByNameByUsage1)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body trunk-modify-1 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

TunnelHistories

Up
get /tunnel-histories
(showTunnelHistories)

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "reason" : "save",
    "local-ip" : "local-ip",
    "within-last" : 1,
    "last-reason" : "save",
    "nh-egress-id" : 7,
    "bfd-state" : "unknown",
    "interface-mac" : "interface-mac",
    "type" : "ip-in-ip",
    "since-start" : true,
    "route-info" : "route-info",
    "ecmp-nexthops" : true,
    "id" : "id",
    "state" : "init",
    "bfd" : true,
    "start-time" : "start-time",
    "last-caller" : "vxlan",
    "count" : 4,
    "active" : true,
    "auto-tunnel" : true,
    "interface-vlan" : 5,
    "vle_tunnel" : true,
    "vrouter-name" : "vrouter-name",
    "next-hop-mac" : "next-hop-mac",
    "tunnelID" : 5,
    "flood-nexthop" : true,
    "name" : "name",
    "interval" : 1,
    "next-hop" : "next-hop",
    "peer-vrouter-name" : "peer-vrouter-name",
    "bd" : "bd",
    "tunnel-if-name" : "tunnel-if-name",
    "ecmp-group" : 2,
    "nexthop-vlan" : 0,
    "peer-bfd-state" : "unknown",
    "changes" : "changes",
    "flood-nh-vlan" : 9,
    "error" : "error",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "nexthop-bd" : "nexthop-bd",
    "duration" : 7,
    "flood-nh-mac" : "flood-nh-mac",
    "mac-learning" : true,
    "scope" : "scope",
    "vnet-id" : "vnet-id",
    "remote-ip" : "remote-ip",
    "vrid" : 1,
    "end-time" : "end-time",
    "vrouter-hw-if-id" : "vrouter-hw-if-id",
    "flood-nh-port" : 3,
    "using-vxlan-loopback" : true,
    "flood-nh-ip" : "flood-nh-ip",
    "remote-switch" : 6,
    "flood-nh-egress-id" : 2,
    "caller" : "vxlan",
    "time" : "time"
  }, {
    "older-than" : 1,
    "reason" : "save",
    "local-ip" : "local-ip",
    "within-last" : 1,
    "last-reason" : "save",
    "nh-egress-id" : 7,
    "bfd-state" : "unknown",
    "interface-mac" : "interface-mac",
    "type" : "ip-in-ip",
    "since-start" : true,
    "route-info" : "route-info",
    "ecmp-nexthops" : true,
    "id" : "id",
    "state" : "init",
    "bfd" : true,
    "start-time" : "start-time",
    "last-caller" : "vxlan",
    "count" : 4,
    "active" : true,
    "auto-tunnel" : true,
    "interface-vlan" : 5,
    "vle_tunnel" : true,
    "vrouter-name" : "vrouter-name",
    "next-hop-mac" : "next-hop-mac",
    "tunnelID" : 5,
    "flood-nexthop" : true,
    "name" : "name",
    "interval" : 1,
    "next-hop" : "next-hop",
    "peer-vrouter-name" : "peer-vrouter-name",
    "bd" : "bd",
    "tunnel-if-name" : "tunnel-if-name",
    "ecmp-group" : 2,
    "nexthop-vlan" : 0,
    "peer-bfd-state" : "unknown",
    "changes" : "changes",
    "flood-nh-vlan" : 9,
    "error" : "error",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "nexthop-bd" : "nexthop-bd",
    "duration" : 7,
    "flood-nh-mac" : "flood-nh-mac",
    "mac-learning" : true,
    "scope" : "scope",
    "vnet-id" : "vnet-id",
    "remote-ip" : "remote-ip",
    "vrid" : 1,
    "end-time" : "end-time",
    "vrouter-hw-if-id" : "vrouter-hw-if-id",
    "flood-nh-port" : 3,
    "using-vxlan-loopback" : true,
    "flood-nh-ip" : "flood-nh-ip",
    "remote-switch" : 6,
    "flood-nh-egress-id" : 2,
    "caller" : "vxlan",
    "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 tunnel-history-show-response
Up
get /tunnel-histories/{name}
(showTunnelHistoryByTunnelName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "reason" : "save",
    "local-ip" : "local-ip",
    "within-last" : 1,
    "last-reason" : "save",
    "nh-egress-id" : 7,
    "bfd-state" : "unknown",
    "interface-mac" : "interface-mac",
    "type" : "ip-in-ip",
    "since-start" : true,
    "route-info" : "route-info",
    "ecmp-nexthops" : true,
    "id" : "id",
    "state" : "init",
    "bfd" : true,
    "start-time" : "start-time",
    "last-caller" : "vxlan",
    "count" : 4,
    "active" : true,
    "auto-tunnel" : true,
    "interface-vlan" : 5,
    "vle_tunnel" : true,
    "vrouter-name" : "vrouter-name",
    "next-hop-mac" : "next-hop-mac",
    "tunnelID" : 5,
    "flood-nexthop" : true,
    "name" : "name",
    "interval" : 1,
    "next-hop" : "next-hop",
    "peer-vrouter-name" : "peer-vrouter-name",
    "bd" : "bd",
    "tunnel-if-name" : "tunnel-if-name",
    "ecmp-group" : 2,
    "nexthop-vlan" : 0,
    "peer-bfd-state" : "unknown",
    "changes" : "changes",
    "flood-nh-vlan" : 9,
    "error" : "error",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "nexthop-bd" : "nexthop-bd",
    "duration" : 7,
    "flood-nh-mac" : "flood-nh-mac",
    "mac-learning" : true,
    "scope" : "scope",
    "vnet-id" : "vnet-id",
    "remote-ip" : "remote-ip",
    "vrid" : 1,
    "end-time" : "end-time",
    "vrouter-hw-if-id" : "vrouter-hw-if-id",
    "flood-nh-port" : 3,
    "using-vxlan-loopback" : true,
    "flood-nh-ip" : "flood-nh-ip",
    "remote-switch" : 6,
    "flood-nh-egress-id" : 2,
    "caller" : "vxlan",
    "time" : "time"
  }, {
    "older-than" : 1,
    "reason" : "save",
    "local-ip" : "local-ip",
    "within-last" : 1,
    "last-reason" : "save",
    "nh-egress-id" : 7,
    "bfd-state" : "unknown",
    "interface-mac" : "interface-mac",
    "type" : "ip-in-ip",
    "since-start" : true,
    "route-info" : "route-info",
    "ecmp-nexthops" : true,
    "id" : "id",
    "state" : "init",
    "bfd" : true,
    "start-time" : "start-time",
    "last-caller" : "vxlan",
    "count" : 4,
    "active" : true,
    "auto-tunnel" : true,
    "interface-vlan" : 5,
    "vle_tunnel" : true,
    "vrouter-name" : "vrouter-name",
    "next-hop-mac" : "next-hop-mac",
    "tunnelID" : 5,
    "flood-nexthop" : true,
    "name" : "name",
    "interval" : 1,
    "next-hop" : "next-hop",
    "peer-vrouter-name" : "peer-vrouter-name",
    "bd" : "bd",
    "tunnel-if-name" : "tunnel-if-name",
    "ecmp-group" : 2,
    "nexthop-vlan" : 0,
    "peer-bfd-state" : "unknown",
    "changes" : "changes",
    "flood-nh-vlan" : 9,
    "error" : "error",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "nexthop-bd" : "nexthop-bd",
    "duration" : 7,
    "flood-nh-mac" : "flood-nh-mac",
    "mac-learning" : true,
    "scope" : "scope",
    "vnet-id" : "vnet-id",
    "remote-ip" : "remote-ip",
    "vrid" : 1,
    "end-time" : "end-time",
    "vrouter-hw-if-id" : "vrouter-hw-if-id",
    "flood-nh-port" : 3,
    "using-vxlan-loopback" : true,
    "flood-nh-ip" : "flood-nh-ip",
    "remote-switch" : 6,
    "flood-nh-egress-id" : 2,
    "caller" : "vxlan",
    "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 tunnel-history-show-response

TunnelHistorySettings

Up
get /tunnel-history-settings
(showTunnelHistorySettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "disk-space" : 0,
    "enable" : true,
    "api.switch-name" : "api.switch-name",
    "log-file-count" : 6
  }, {
    "disk-space" : 0,
    "enable" : true,
    "api.switch-name" : "api.switch-name",
    "log-file-count" : 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 tunnel-history-settings-show-response
Up
put /tunnel-history-settings
(updateTunnelHistorySettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

TunnelStats

Up
post /tunnel-stats/clear
(clearTunnelStatsByUsage1)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /tunnel-stats
(showTunnelStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 4,
    "older-than" : 6,
    "within-last" : 6,
    "HER-bytes" : 6,
    "sw-opkts" : 1,
    "iUpkts" : 5,
    "oPkts" : 6,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 1,
    "oerrs" : 4,
    "oCongDrops" : 3,
    "iCongDrops" : 5,
    "ibits" : 1,
    "obytes" : 6,
    "sw-odrops" : 7,
    "iMpkts" : 1,
    "ierrs" : 9,
    "sw-idrops" : 6,
    "oMpkts" : 7,
    "start-time" : "start-time",
    "HER-bits" : 3,
    "end-time" : "end-time",
    "ibytes" : 6,
    "odiscards" : 2,
    "counter" : 0,
    "HER-pkts" : 1,
    "oBpkts" : 2,
    "idiscards" : 9,
    "mtu-errs" : 7,
    "iBpkts" : 5,
    "oPauseFs" : 9,
    "tunnel-name" : "tunnel-name",
    "sw-inpkts" : 1,
    "interval" : 2,
    "time" : "time",
    "obits" : 8
  }, {
    "iPauseFs" : 4,
    "older-than" : 6,
    "within-last" : 6,
    "HER-bytes" : 6,
    "sw-opkts" : 1,
    "iUpkts" : 5,
    "oPkts" : 6,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 1,
    "oerrs" : 4,
    "oCongDrops" : 3,
    "iCongDrops" : 5,
    "ibits" : 1,
    "obytes" : 6,
    "sw-odrops" : 7,
    "iMpkts" : 1,
    "ierrs" : 9,
    "sw-idrops" : 6,
    "oMpkts" : 7,
    "start-time" : "start-time",
    "HER-bits" : 3,
    "end-time" : "end-time",
    "ibytes" : 6,
    "odiscards" : 2,
    "counter" : 0,
    "HER-pkts" : 1,
    "oBpkts" : 2,
    "idiscards" : 9,
    "mtu-errs" : 7,
    "iBpkts" : 5,
    "oPauseFs" : 9,
    "tunnel-name" : "tunnel-name",
    "sw-inpkts" : 1,
    "interval" : 2,
    "time" : "time",
    "obits" : 8
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success tunnel-stats-show-response
Up
get /tunnel-stats/{tunnel-name}
(showTunnelStatsByTunnelName)

Path parameters

tunnel-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 4,
    "older-than" : 6,
    "within-last" : 6,
    "HER-bytes" : 6,
    "sw-opkts" : 1,
    "iUpkts" : 5,
    "oPkts" : 6,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 1,
    "oerrs" : 4,
    "oCongDrops" : 3,
    "iCongDrops" : 5,
    "ibits" : 1,
    "obytes" : 6,
    "sw-odrops" : 7,
    "iMpkts" : 1,
    "ierrs" : 9,
    "sw-idrops" : 6,
    "oMpkts" : 7,
    "start-time" : "start-time",
    "HER-bits" : 3,
    "end-time" : "end-time",
    "ibytes" : 6,
    "odiscards" : 2,
    "counter" : 0,
    "HER-pkts" : 1,
    "oBpkts" : 2,
    "idiscards" : 9,
    "mtu-errs" : 7,
    "iBpkts" : 5,
    "oPauseFs" : 9,
    "tunnel-name" : "tunnel-name",
    "sw-inpkts" : 1,
    "interval" : 2,
    "time" : "time",
    "obits" : 8
  }, {
    "iPauseFs" : 4,
    "older-than" : 6,
    "within-last" : 6,
    "HER-bytes" : 6,
    "sw-opkts" : 1,
    "iUpkts" : 5,
    "oPkts" : 6,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 1,
    "oerrs" : 4,
    "oCongDrops" : 3,
    "iCongDrops" : 5,
    "ibits" : 1,
    "obytes" : 6,
    "sw-odrops" : 7,
    "iMpkts" : 1,
    "ierrs" : 9,
    "sw-idrops" : 6,
    "oMpkts" : 7,
    "start-time" : "start-time",
    "HER-bits" : 3,
    "end-time" : "end-time",
    "ibytes" : 6,
    "odiscards" : 2,
    "counter" : 0,
    "HER-pkts" : 1,
    "oBpkts" : 2,
    "idiscards" : 9,
    "mtu-errs" : 7,
    "iBpkts" : 5,
    "oPauseFs" : 9,
    "tunnel-name" : "tunnel-name",
    "sw-inpkts" : 1,
    "interval" : 2,
    "time" : "time",
    "obits" : 8
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success tunnel-stats-show-response

TunnelStatsSettings

Up
get /tunnel-stats-settings
(showTunnelStatsSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 tunnel-stats-settings-show-response
Up
put /tunnel-stats-settings
(updateTunnelStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Tunnels

Up
post /tunnels/{name}/vxlans
(addGreTunnelVxlanByGreTunnelName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body tunnel-vxlan-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /tunnels
(createGreTunnel)

Consumes

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

Request body

body tunnel-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /tunnels/{name}
(deleteGreTunnelByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /tunnels/{name}/vxlans/{vxlan}
(removeGreTunnelVxlanByNameByVxlan)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /tunnels/{name}
(showGreTunnelByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "peer-vrouter-name" : "peer-vrouter-name",
    "local-ip" : "local-ip",
    "tunnel-if-name" : "tunnel-if-name",
    "ecmp-group" : 3,
    "peer-bfd-state" : "unknown",
    "nexthop-vlan" : 2,
    "nh-egress-id" : 5,
    "flood-nh-vlan" : 5,
    "bfd-state" : "unknown",
    "interface-mac" : "interface-mac",
    "type" : "ip-in-ip",
    "ports" : "ports",
    "error" : "error",
    "api.switch-name" : "api.switch-name",
    "nexthop-bd" : "nexthop-bd",
    "flood-nh-mac" : "flood-nh-mac",
    "mac-learning" : true,
    "route-info" : "route-info",
    "ecmp-nexthops" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "state" : "init",
    "id" : "id",
    "remote-ip" : "remote-ip",
    "vrid" : 0,
    "bfd" : true,
    "vrouter-hw-if-id" : "vrouter-hw-if-id",
    "active" : true,
    "flood-nh-port" : 2,
    "using-vxlan-loopback" : true,
    "auto-tunnel" : true,
    "interface-vlan" : 1,
    "flood-nh-ip" : "flood-nh-ip",
    "vle_tunnel" : true,
    "remote-switch" : 9,
    "flood-nh-egress-id" : 7,
    "vrouter-name" : "vrouter-name",
    "tunnelID" : 6,
    "flood-nexthop" : true,
    "next-hop-mac" : "next-hop-mac",
    "name" : "name",
    "next-hop" : "next-hop"
  }, {
    "bd" : "bd",
    "peer-vrouter-name" : "peer-vrouter-name",
    "local-ip" : "local-ip",
    "tunnel-if-name" : "tunnel-if-name",
    "ecmp-group" : 3,
    "peer-bfd-state" : "unknown",
    "nexthop-vlan" : 2,
    "nh-egress-id" : 5,
    "flood-nh-vlan" : 5,
    "bfd-state" : "unknown",
    "interface-mac" : "interface-mac",
    "type" : "ip-in-ip",
    "ports" : "ports",
    "error" : "error",
    "api.switch-name" : "api.switch-name",
    "nexthop-bd" : "nexthop-bd",
    "flood-nh-mac" : "flood-nh-mac",
    "mac-learning" : true,
    "route-info" : "route-info",
    "ecmp-nexthops" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "state" : "init",
    "id" : "id",
    "remote-ip" : "remote-ip",
    "vrid" : 0,
    "bfd" : true,
    "vrouter-hw-if-id" : "vrouter-hw-if-id",
    "active" : true,
    "flood-nh-port" : 2,
    "using-vxlan-loopback" : true,
    "auto-tunnel" : true,
    "interface-vlan" : 1,
    "flood-nh-ip" : "flood-nh-ip",
    "vle_tunnel" : true,
    "remote-switch" : 9,
    "flood-nh-egress-id" : 7,
    "vrouter-name" : "vrouter-name",
    "tunnelID" : 6,
    "flood-nexthop" : true,
    "next-hop-mac" : "next-hop-mac",
    "name" : "name",
    "next-hop" : "next-hop"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success tunnel-show-response
Up
get /tunnels/{name}/vxlans/{vxlan}
(showGreTunnelVxlanByNameByVxlan)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "hw_update_pending" : true,
    "bd_deactivated" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "vxlan" : 0,
    "hw_update_pending" : true,
    "bd_deactivated" : 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 tunnel-vxlan-show-response
Up
get /tunnels/{name}/vxlans
(showGreTunnelVxlansByGreTunnelName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "hw_update_pending" : true,
    "bd_deactivated" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "vxlan" : 0,
    "hw_update_pending" : true,
    "bd_deactivated" : 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 tunnel-vxlan-show-response
Up
get /tunnels
(showGreTunnels)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "peer-vrouter-name" : "peer-vrouter-name",
    "local-ip" : "local-ip",
    "tunnel-if-name" : "tunnel-if-name",
    "ecmp-group" : 3,
    "peer-bfd-state" : "unknown",
    "nexthop-vlan" : 2,
    "nh-egress-id" : 5,
    "flood-nh-vlan" : 5,
    "bfd-state" : "unknown",
    "interface-mac" : "interface-mac",
    "type" : "ip-in-ip",
    "ports" : "ports",
    "error" : "error",
    "api.switch-name" : "api.switch-name",
    "nexthop-bd" : "nexthop-bd",
    "flood-nh-mac" : "flood-nh-mac",
    "mac-learning" : true,
    "route-info" : "route-info",
    "ecmp-nexthops" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "state" : "init",
    "id" : "id",
    "remote-ip" : "remote-ip",
    "vrid" : 0,
    "bfd" : true,
    "vrouter-hw-if-id" : "vrouter-hw-if-id",
    "active" : true,
    "flood-nh-port" : 2,
    "using-vxlan-loopback" : true,
    "auto-tunnel" : true,
    "interface-vlan" : 1,
    "flood-nh-ip" : "flood-nh-ip",
    "vle_tunnel" : true,
    "remote-switch" : 9,
    "flood-nh-egress-id" : 7,
    "vrouter-name" : "vrouter-name",
    "tunnelID" : 6,
    "flood-nexthop" : true,
    "next-hop-mac" : "next-hop-mac",
    "name" : "name",
    "next-hop" : "next-hop"
  }, {
    "bd" : "bd",
    "peer-vrouter-name" : "peer-vrouter-name",
    "local-ip" : "local-ip",
    "tunnel-if-name" : "tunnel-if-name",
    "ecmp-group" : 3,
    "peer-bfd-state" : "unknown",
    "nexthop-vlan" : 2,
    "nh-egress-id" : 5,
    "flood-nh-vlan" : 5,
    "bfd-state" : "unknown",
    "interface-mac" : "interface-mac",
    "type" : "ip-in-ip",
    "ports" : "ports",
    "error" : "error",
    "api.switch-name" : "api.switch-name",
    "nexthop-bd" : "nexthop-bd",
    "flood-nh-mac" : "flood-nh-mac",
    "mac-learning" : true,
    "route-info" : "route-info",
    "ecmp-nexthops" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "state" : "init",
    "id" : "id",
    "remote-ip" : "remote-ip",
    "vrid" : 0,
    "bfd" : true,
    "vrouter-hw-if-id" : "vrouter-hw-if-id",
    "active" : true,
    "flood-nh-port" : 2,
    "using-vxlan-loopback" : true,
    "auto-tunnel" : true,
    "interface-vlan" : 1,
    "flood-nh-ip" : "flood-nh-ip",
    "vle_tunnel" : true,
    "remote-switch" : 9,
    "flood-nh-egress-id" : 7,
    "vrouter-name" : "vrouter-name",
    "tunnelID" : 6,
    "flood-nexthop" : true,
    "next-hop-mac" : "next-hop-mac",
    "name" : "name",
    "next-hop" : "next-hop"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success tunnel-show-response
Up
put /tunnels/{name}
(updateGreTunnelByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body tunnel-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Udfs

Up
post /udfs
(createUdf)

Consumes

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

Request body

body udf-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /udfs/{name}
(deleteUdfByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /udfs/{name}
(showUdfByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "offset" : 0,
    "scope" : "local",
    "name" : "name",
    "length" : 6,
    "header" : "packet-start",
    "api.switch-name" : "api.switch-name"
  }, {
    "offset" : 0,
    "scope" : "local",
    "name" : "name",
    "length" : 6,
    "header" : "packet-start",
    "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 udf-show-response
Up
get /udfs
(showUdfs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "offset" : 0,
    "scope" : "local",
    "name" : "name",
    "length" : 6,
    "header" : "packet-start",
    "api.switch-name" : "api.switch-name"
  }, {
    "offset" : 0,
    "scope" : "local",
    "name" : "name",
    "length" : 6,
    "header" : "packet-start",
    "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 udf-show-response
Up
put /udfs/{name}
(updateUdfByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body udf-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

UplinkGroupPort

Up
post /uplink-group-port/add
(addUplinkPortGroup)

Consumes

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

Request body

body uplink-group-port-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /uplink-group-port/remove
(removeUplinkPortGroup)

Consumes

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

Request body

body uplink-group-port-remove (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /uplink-group-port/oversubscription-state-show
(showUplinkOversubsStateUplinkPortGroup)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "downlink-bw" : 0,
    "uplink-bw" : 6,
    "uplink-oversubscription" : true,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "downlink-bw" : 0,
    "uplink-bw" : 6,
    "uplink-oversubscription" : true,
    "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 uplink-group-port-show-response
Up
get /uplink-group-port
(showUplinkPortGroup)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "downlink-bw" : 0,
    "uplink-bw" : 6,
    "uplink-oversubscription" : true,
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "downlink-bw" : 0,
    "uplink-bw" : 6,
    "uplink-oversubscription" : true,
    "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 uplink-group-port-show-response

Users

Up
post /users/{user-name}/roles
(addUserRoleRefByUserName)

Path parameters

user-name (required)
Path Parameter

Consumes

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

Request body

body user-role-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /users
(createUser)

Consumes

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

Request body

body user-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /users/{name}
(deleteUserByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /users/{user-name}/roles/{role-id}
(removeUserRoleRefByNameById)

Path parameters

user-name (required)
Path Parameter
role-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /users/password-set
(setPasswordUser)

Consumes

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

Request body

body user-password-set (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /users/{name}
(showUserByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "minimum-pw-length" : 1,
    "server" : "server",
    "key-bits" : 5,
    "key-auth" : true,
    "file-private-key" : "file-private-key",
    "login-fail-count" : 6,
    "file-public-key" : "file-public-key",
    "type" : "netvisor",
    "api.switch-name" : "api.switch-name",
    "lock-account" : true,
    "pass-auth" : true,
    "uid" : 0,
    "pub-key" : "pub-key",
    "key-type" : "rsa",
    "scope" : "local",
    "name" : "name"
  }, {
    "minimum-pw-length" : 1,
    "server" : "server",
    "key-bits" : 5,
    "key-auth" : true,
    "file-private-key" : "file-private-key",
    "login-fail-count" : 6,
    "file-public-key" : "file-public-key",
    "type" : "netvisor",
    "api.switch-name" : "api.switch-name",
    "lock-account" : true,
    "pass-auth" : true,
    "uid" : 0,
    "pub-key" : "pub-key",
    "key-type" : "rsa",
    "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 user-show-response
Up
get /users/{user-name}/roles/{role-id}
(showUserRoleRefByNameById)

Path parameters

user-name (required)
Path Parameter
role-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "role-id" : "role-id",
    "api.switch-name" : "api.switch-name"
  }, {
    "role-id" : "role-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 user-role-show-response
Up
get /users/{user-name}/roles
(showUserRoleRefsByUserName)

Path parameters

user-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "role-id" : "role-id",
    "api.switch-name" : "api.switch-name"
  }, {
    "role-id" : "role-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 user-role-show-response
Up
get /users
(showUsers)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "minimum-pw-length" : 1,
    "server" : "server",
    "key-bits" : 5,
    "key-auth" : true,
    "file-private-key" : "file-private-key",
    "login-fail-count" : 6,
    "file-public-key" : "file-public-key",
    "type" : "netvisor",
    "api.switch-name" : "api.switch-name",
    "lock-account" : true,
    "pass-auth" : true,
    "uid" : 0,
    "pub-key" : "pub-key",
    "key-type" : "rsa",
    "scope" : "local",
    "name" : "name"
  }, {
    "minimum-pw-length" : 1,
    "server" : "server",
    "key-bits" : 5,
    "key-auth" : true,
    "file-private-key" : "file-private-key",
    "login-fail-count" : 6,
    "file-public-key" : "file-public-key",
    "type" : "netvisor",
    "api.switch-name" : "api.switch-name",
    "lock-account" : true,
    "pass-auth" : true,
    "uid" : 0,
    "pub-key" : "pub-key",
    "key-type" : "rsa",
    "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 user-show-response
Up
post /users/ssh-keygen-clear
(sshKeygenClearUser)

Consumes

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

Request body

body user-ssh-keygen-clear (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /users/ssh-keygen-create
(sshKeygenCreateUser)

Consumes

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

Request body

body user-ssh-keygen-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /users/ssh-keygen-export
(sshKeygenExportUser)

Consumes

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

Request body

body user-ssh-keygen-export (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /users/ssh-keygen-import
(sshKeygenImportUser)

Consumes

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

Request body

body user-ssh-keygen-import (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /users/ssh-keygen-show
(sshKeygenShowUser)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "minimum-pw-length" : 1,
    "server" : "server",
    "key-bits" : 5,
    "key-auth" : true,
    "file-private-key" : "file-private-key",
    "login-fail-count" : 6,
    "file-public-key" : "file-public-key",
    "type" : "netvisor",
    "api.switch-name" : "api.switch-name",
    "lock-account" : true,
    "pass-auth" : true,
    "uid" : 0,
    "pub-key" : "pub-key",
    "key-type" : "rsa",
    "scope" : "local",
    "name" : "name"
  }, {
    "minimum-pw-length" : 1,
    "server" : "server",
    "key-bits" : 5,
    "key-auth" : true,
    "file-private-key" : "file-private-key",
    "login-fail-count" : 6,
    "file-public-key" : "file-public-key",
    "type" : "netvisor",
    "api.switch-name" : "api.switch-name",
    "lock-account" : true,
    "pass-auth" : true,
    "uid" : 0,
    "pub-key" : "pub-key",
    "key-type" : "rsa",
    "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 user-show-response
Up
put /users/{name}
(updateUserByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body user-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VcenterConnections

Up
post /vcenter-connections
(createVcenterRplugin)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vcenter-connections/{name}
(deleteVcenterRpluginByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vcenter-connections/{name}
(showVcenterRpluginByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "connected-time" : "connected-time",
    "vlans" : "vlans",
    "enable" : true,
    "network-provisioning" : "none",
    "name" : "name",
    "host" : "host",
    "state" : "init",
    "api.switch-name" : "api.switch-name",
    "user" : "user",
    "connection-error" : "connection-error"
  }, {
    "connected-time" : "connected-time",
    "vlans" : "vlans",
    "enable" : true,
    "network-provisioning" : "none",
    "name" : "name",
    "host" : "host",
    "state" : "init",
    "api.switch-name" : "api.switch-name",
    "user" : "user",
    "connection-error" : "connection-error"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vcenter-connection-show-response
Up
get /vcenter-connections
(showVcenterRplugins)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "connected-time" : "connected-time",
    "vlans" : "vlans",
    "enable" : true,
    "network-provisioning" : "none",
    "name" : "name",
    "host" : "host",
    "state" : "init",
    "api.switch-name" : "api.switch-name",
    "user" : "user",
    "connection-error" : "connection-error"
  }, {
    "connected-time" : "connected-time",
    "vlans" : "vlans",
    "enable" : true,
    "network-provisioning" : "none",
    "name" : "name",
    "host" : "host",
    "state" : "init",
    "api.switch-name" : "api.switch-name",
    "user" : "user",
    "connection-error" : "connection-error"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vcenter-connection-show-response
Up
put /vcenter-connections/{name}
(updateVcenterRpluginByName)

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VflowClasses

Up
post /vflow-classes
(createVflowClass)

Consumes

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

Request body

body vflow-class-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vflow-classes/{name}
(deleteVflowClassByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vflow-classes/{name}
(showVflowClassByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "cos" : 0,
    "scope" : "local",
    "name" : "name",
    "type" : "system",
    "priority" : 6,
    "api.switch-name" : "api.switch-name"
  }, {
    "cos" : 0,
    "scope" : "local",
    "name" : "name",
    "type" : "system",
    "priority" : 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 vflow-class-show-response
Up
get /vflow-classes
(showVflowClasses)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "cos" : 0,
    "scope" : "local",
    "name" : "name",
    "type" : "system",
    "priority" : 6,
    "api.switch-name" : "api.switch-name"
  }, {
    "cos" : 0,
    "scope" : "local",
    "name" : "name",
    "type" : "system",
    "priority" : 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 vflow-class-show-response

VflowMgmtStats

Up
post /vflow-mgmt-stats/clear
(clearVflowMgmtStats)

Consumes

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

Request body

body vflow-mgmt-stats-clear (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vflow-mgmt-stats
(showVflowMgmtStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 vflow-mgmt-stats-show-response
Up
get /vflow-mgmt-stats/{name}
(showVflowMgmtStatsByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 vflow-mgmt-stats-show-response

VflowSettings

Up
get /vflow-settings
(showVflowSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "enable-user-defined-flow" : true,
    "vxlan-analytics" : true,
    "longlived-tcp-conn-stats" : true,
    "api.switch-name" : "api.switch-name",
    "inflight-vxlan-analytics" : true
  }, {
    "enable-user-defined-flow" : true,
    "vxlan-analytics" : true,
    "longlived-tcp-conn-stats" : true,
    "api.switch-name" : "api.switch-name",
    "inflight-vxlan-analytics" : 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 vflow-settings-show-response
Up
put /vflow-settings
(updateVflowSettings)

Consumes

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

Request body

body vflow-settings-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VflowSkipStats

Up
post /vflow-skip-stats/clear
(clearVflowSkipStatsByUsage1)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vflow-skip-stats
(showVflowSkipStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "l2-to-cpu-check" : 5,
    "mcast-miss" : 2,
    "intsw" : 6,
    "sw-tunnel" : 7,
    "dmac-miss" : 1,
    "l2-to-cpu" : 5,
    "l3-to-cpu" : 9,
    "api.switch-name" : "api.switch-name",
    "ttl" : 1,
    "l3-miss" : 2,
    "name" : "name",
    "smac-miss" : 4,
    "smac-copy-to-cpu" : 3,
    "fwd-pkt" : 7,
    "others" : 0
  }, {
    "l2-to-cpu-check" : 5,
    "mcast-miss" : 2,
    "intsw" : 6,
    "sw-tunnel" : 7,
    "dmac-miss" : 1,
    "l2-to-cpu" : 5,
    "l3-to-cpu" : 9,
    "api.switch-name" : "api.switch-name",
    "ttl" : 1,
    "l3-miss" : 2,
    "name" : "name",
    "smac-miss" : 4,
    "smac-copy-to-cpu" : 3,
    "fwd-pkt" : 7,
    "others" : 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 vflow-skip-stats-show-response
Up
get /vflow-skip-stats/{name}
(showVflowSkipStatsByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "l2-to-cpu-check" : 5,
    "mcast-miss" : 2,
    "intsw" : 6,
    "sw-tunnel" : 7,
    "dmac-miss" : 1,
    "l2-to-cpu" : 5,
    "l3-to-cpu" : 9,
    "api.switch-name" : "api.switch-name",
    "ttl" : 1,
    "l3-miss" : 2,
    "name" : "name",
    "smac-miss" : 4,
    "smac-copy-to-cpu" : 3,
    "fwd-pkt" : 7,
    "others" : 0
  }, {
    "l2-to-cpu-check" : 5,
    "mcast-miss" : 2,
    "intsw" : 6,
    "sw-tunnel" : 7,
    "dmac-miss" : 1,
    "l2-to-cpu" : 5,
    "l3-to-cpu" : 9,
    "api.switch-name" : "api.switch-name",
    "ttl" : 1,
    "l3-miss" : 2,
    "name" : "name",
    "smac-miss" : 4,
    "smac-copy-to-cpu" : 3,
    "fwd-pkt" : 7,
    "others" : 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 vflow-skip-stats-show-response

VflowStats

Up
post /vflow-stats/clear
(clearVflowStat)

Consumes

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

Request body

body vflow-stats-clear (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vflow-stats/{name}
(showVflowStatByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 vflow-stats-show-response
Up
get /vflow-stats
(showVflowStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 vflow-stats-show-response

VflowStatsSettings

Up
get /vflow-stats-settings
(showVflowStatsSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 vflow-stats-settings-show-response
Up
put /vflow-stats-settings
(updateVflowStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VflowTableProfiles

Up
get /vflow-table-profiles/{profile}
(showVflowTblProfileByType)

Path parameters

profile (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "enable" : true,
    "profile" : "application",
    "flow-slices-used" : 1,
    "flow-capacity" : 0,
    "comment" : "comment",
    "flow-slices-needed" : 6,
    "hw-tbl" : "switch-main",
    "api.switch-name" : "api.switch-name",
    "configurable" : true
  }, {
    "enable" : true,
    "profile" : "application",
    "flow-slices-used" : 1,
    "flow-capacity" : 0,
    "comment" : "comment",
    "flow-slices-needed" : 6,
    "hw-tbl" : "switch-main",
    "api.switch-name" : "api.switch-name",
    "configurable" : 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 vflow-table-profile-show-response
Up
get /vflow-table-profiles
(showVflowTblProfiles)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "enable" : true,
    "profile" : "application",
    "flow-slices-used" : 1,
    "flow-capacity" : 0,
    "comment" : "comment",
    "flow-slices-needed" : 6,
    "hw-tbl" : "switch-main",
    "api.switch-name" : "api.switch-name",
    "configurable" : true
  }, {
    "enable" : true,
    "profile" : "application",
    "flow-slices-used" : 1,
    "flow-capacity" : 0,
    "comment" : "comment",
    "flow-slices-needed" : 6,
    "hw-tbl" : "switch-main",
    "api.switch-name" : "api.switch-name",
    "configurable" : 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 vflow-table-profile-show-response
Up
put /vflow-table-profiles/{profile}
(updateVflowTblProfileByType)

Path parameters

profile (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VflowTables

Up
get /vflow-tables/id/{id}
(showVflowTblById)

Path parameters

id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "capability" : "none",
    "flow-tbl-bank" : "flow-tbl-bank",
    "flow-used" : 6,
    "flow-profile" : "application",
    "flow-max-per-group" : 0,
    "name" : "name",
    "flow-tbl-slices" : 1,
    "id" : "id",
    "api.switch-name" : "api.switch-name"
  }, {
    "capability" : "none",
    "flow-tbl-bank" : "flow-tbl-bank",
    "flow-used" : 6,
    "flow-profile" : "application",
    "flow-max-per-group" : 0,
    "name" : "name",
    "flow-tbl-slices" : 1,
    "id" : "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 vflow-table-show-response
Up
get /vflow-tables/name/{name}
(showVflowTblByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "capability" : "none",
    "flow-tbl-bank" : "flow-tbl-bank",
    "flow-used" : 6,
    "flow-profile" : "application",
    "flow-max-per-group" : 0,
    "name" : "name",
    "flow-tbl-slices" : 1,
    "id" : "id",
    "api.switch-name" : "api.switch-name"
  }, {
    "capability" : "none",
    "flow-tbl-bank" : "flow-tbl-bank",
    "flow-used" : 6,
    "flow-profile" : "application",
    "flow-max-per-group" : 0,
    "name" : "name",
    "flow-tbl-slices" : 1,
    "id" : "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 vflow-table-show-response
Up
get /vflow-tables
(showVflowTbls)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "capability" : "none",
    "flow-tbl-bank" : "flow-tbl-bank",
    "flow-used" : 6,
    "flow-profile" : "application",
    "flow-max-per-group" : 0,
    "name" : "name",
    "flow-tbl-slices" : 1,
    "id" : "id",
    "api.switch-name" : "api.switch-name"
  }, {
    "capability" : "none",
    "flow-tbl-bank" : "flow-tbl-bank",
    "flow-used" : 6,
    "flow-profile" : "application",
    "flow-max-per-group" : 0,
    "name" : "name",
    "flow-tbl-slices" : 1,
    "id" : "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 vflow-table-show-response

Vflows

Up
post /vflows
(createVflow)

Consumes

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

Request body

body vflow-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vflows/id/{id}
(deleteVflowById)

Path parameters

id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vflows/name/{name}
(deleteVflowByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vflows/mgmt-show
(showMgmtVflow)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dur" : 9,
    "dscp-start" : 7,
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "metadata" : 2,
    "ingress-tunnel" : "ingress-tunnel",
    "src-port-mask" : "src-port-mask",
    "flow-cb" : "default-cb",
    "bw-min" : 6,
    "dropped" : true,
    "type" : "ofp",
    "tracking" : "disable",
    "dscp" : 6,
    "enable" : true,
    "action" : "none",
    "id" : "id",
    "if" : "mgmt",
    "vxlan" : 7,
    "flow-class" : "flow-class",
    "metadata-mask" : 2,
    "ether-type" : "0x800",
    "topology" : "topology",
    "vrf" : "vrf",
    "inner-vlan" : 1,
    "vxlan-proto" : 6,
    "egress-tunnel" : "egress-tunnel",
    "bw-max" : 8,
    "src-port-end" : 1,
    "phy-dst-port" : 7,
    "burst-size" : 9,
    "transparency" : "enable",
    "mirror-id" : "mirror-id",
    "action-value" : 6,
    "local-subnet" : true,
    "l3-class-id" : 1,
    "dst-vpg" : "dst-vpg",
    "udf-data1" : "udf-data1",
    "udf-data2" : "udf-data2",
    "fwding-type" : "vlan",
    "bd" : "bd",
    "udf-data3" : "udf-data3",
    "api.switch-name" : "api.switch-name",
    "tracking-status" : "unknown",
    "override-sys-flows" : true,
    "vlan" : 0,
    "action-to-ports-value" : "action-to-ports-value",
    "udf-data3-mask" : "udf-data3-mask",
    "dscp-end" : 1,
    "tos" : 1,
    "dst-port-end" : 6,
    "src-ip-mask" : "src-ip-mask",
    "bidir-vpg-1" : "bidir-vpg-1",
    "bidir-vpg-2" : "bidir-vpg-2",
    "action-set-mac-value" : "action-set-mac-value",
    "src-port" : 1,
    "dst-port" : 2,
    "udf-name2" : "udf-name2",
    "udf-name1" : "udf-name1",
    "precedence" : 4,
    "dst-port-mask" : "dst-port-mask",
    "udf-name3" : "udf-name3",
    "src-mac" : "src-mac",
    "dst-mac-mask" : "dst-mac-mask",
    "log-stats" : true,
    "stp-state" : "Disabled",
    "vlan-pri" : 9,
    "cpu-class" : "cpu-class",
    "action-value1" : 3,
    "hw-stats" : true,
    "vrouter-name" : "vrouter-name",
    "proto" : 5,
    "name" : "name",
    "table-name" : "table-name",
    "udf-data1-mask" : "udf-data1-mask",
    "action-to-next-hop-ip-value" : "action-to-next-hop-ip-value",
    "internal-pri" : "internal-pri",
    "src-mac-mask" : "src-mac-mask",
    "tos-end" : 5,
    "hidden" : true,
    "stats-interval" : 3,
    "description" : "description",
    "tos-start" : 4,
    "udf-data2-mask" : "udf-data2-mask",
    "vxlan-ether-type" : "0x800",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "dscp-map" : "dscp-map",
    "out-port" : "out-port",
    "dst-mac" : "dst-mac",
    "from-tunnel-decap" : "off",
    "packet-res" : "l2-unicast",
    "ttl" : 5,
    "dst-ip-mask" : "dst-ip-mask",
    "inner-vlan-pri" : 9,
    "tcp-flags" : "fin",
    "src-vpg" : "src-vpg",
    "in-port" : "in-port",
    "vpn_id" : "vpn_id",
    "action-to-ecmp-group-value" : "action-to-ecmp-group-value"
  }, {
    "dur" : 9,
    "dscp-start" : 7,
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "metadata" : 2,
    "ingress-tunnel" : "ingress-tunnel",
    "src-port-mask" : "src-port-mask",
    "flow-cb" : "default-cb",
    "bw-min" : 6,
    "dropped" : true,
    "type" : "ofp",
    "tracking" : "disable",
    "dscp" : 6,
    "enable" : true,
    "action" : "none",
    "id" : "id",
    "if" : "mgmt",
    "vxlan" : 7,
    "flow-class" : "flow-class",
    "metadata-mask" : 2,
    "ether-type" : "0x800",
    "topology" : "topology",
    "vrf" : "vrf",
    "inner-vlan" : 1,
    "vxlan-proto" : 6,
    "egress-tunnel" : "egress-tunnel",
    "bw-max" : 8,
    "src-port-end" : 1,
    "phy-dst-port" : 7,
    "burst-size" : 9,
    "transparency" : "enable",
    "mirror-id" : "mirror-id",
    "action-value" : 6,
    "local-subnet" : true,
    "l3-class-id" : 1,
    "dst-vpg" : "dst-vpg",
    "udf-data1" : "udf-data1",
    "udf-data2" : "udf-data2",
    "fwding-type" : "vlan",
    "bd" : "bd",
    "udf-data3" : "udf-data3",
    "api.switch-name" : "api.switch-name",
    "tracking-status" : "unknown",
    "override-sys-flows" : true,
    "vlan" : 0,
    "action-to-ports-value" : "action-to-ports-value",
    "udf-data3-mask" : "udf-data3-mask",
    "dscp-end" : 1,
    "tos" : 1,
    "dst-port-end" : 6,
    "src-ip-mask" : "src-ip-mask",
    "bidir-vpg-1" : "bidir-vpg-1",
    "bidir-vpg-2" : "bidir-vpg-2",
    "action-set-mac-value" : "action-set-mac-value",
    "src-port" : 1,
    "dst-port" : 2,
    "udf-name2" : "udf-name2",
    "udf-name1" : "udf-name1",
    "precedence" : 4,
    "dst-port-mask" : "dst-port-mask",
    "udf-name3" : "udf-name3",
    "src-mac" : "src-mac",
    "dst-mac-mask" : "dst-mac-mask",
    "log-stats" : true,
    "stp-state" : "Disabled",
    "vlan-pri" : 9,
    "cpu-class" : "cpu-class",
    "action-value1" : 3,
    "hw-stats" : true,
    "vrouter-name" : "vrouter-name",
    "proto" : 5,
    "name" : "name",
    "table-name" : "table-name",
    "udf-data1-mask" : "udf-data1-mask",
    "action-to-next-hop-ip-value" : "action-to-next-hop-ip-value",
    "internal-pri" : "internal-pri",
    "src-mac-mask" : "src-mac-mask",
    "tos-end" : 5,
    "hidden" : true,
    "stats-interval" : 3,
    "description" : "description",
    "tos-start" : 4,
    "udf-data2-mask" : "udf-data2-mask",
    "vxlan-ether-type" : "0x800",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "dscp-map" : "dscp-map",
    "out-port" : "out-port",
    "dst-mac" : "dst-mac",
    "from-tunnel-decap" : "off",
    "packet-res" : "l2-unicast",
    "ttl" : 5,
    "dst-ip-mask" : "dst-ip-mask",
    "inner-vlan-pri" : 9,
    "tcp-flags" : "fin",
    "src-vpg" : "src-vpg",
    "in-port" : "in-port",
    "vpn_id" : "vpn_id",
    "action-to-ecmp-group-value" : "action-to-ecmp-group-value"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vflow-show-response
Up
get /vflows/id/{id}
(showVflowById)

Path parameters

id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dur" : 9,
    "dscp-start" : 7,
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "metadata" : 2,
    "ingress-tunnel" : "ingress-tunnel",
    "src-port-mask" : "src-port-mask",
    "flow-cb" : "default-cb",
    "bw-min" : 6,
    "dropped" : true,
    "type" : "ofp",
    "tracking" : "disable",
    "dscp" : 6,
    "enable" : true,
    "action" : "none",
    "id" : "id",
    "if" : "mgmt",
    "vxlan" : 7,
    "flow-class" : "flow-class",
    "metadata-mask" : 2,
    "ether-type" : "0x800",
    "topology" : "topology",
    "vrf" : "vrf",
    "inner-vlan" : 1,
    "vxlan-proto" : 6,
    "egress-tunnel" : "egress-tunnel",
    "bw-max" : 8,
    "src-port-end" : 1,
    "phy-dst-port" : 7,
    "burst-size" : 9,
    "transparency" : "enable",
    "mirror-id" : "mirror-id",
    "action-value" : 6,
    "local-subnet" : true,
    "l3-class-id" : 1,
    "dst-vpg" : "dst-vpg",
    "udf-data1" : "udf-data1",
    "udf-data2" : "udf-data2",
    "fwding-type" : "vlan",
    "bd" : "bd",
    "udf-data3" : "udf-data3",
    "api.switch-name" : "api.switch-name",
    "tracking-status" : "unknown",
    "override-sys-flows" : true,
    "vlan" : 0,
    "action-to-ports-value" : "action-to-ports-value",
    "udf-data3-mask" : "udf-data3-mask",
    "dscp-end" : 1,
    "tos" : 1,
    "dst-port-end" : 6,
    "src-ip-mask" : "src-ip-mask",
    "bidir-vpg-1" : "bidir-vpg-1",
    "bidir-vpg-2" : "bidir-vpg-2",
    "action-set-mac-value" : "action-set-mac-value",
    "src-port" : 1,
    "dst-port" : 2,
    "udf-name2" : "udf-name2",
    "udf-name1" : "udf-name1",
    "precedence" : 4,
    "dst-port-mask" : "dst-port-mask",
    "udf-name3" : "udf-name3",
    "src-mac" : "src-mac",
    "dst-mac-mask" : "dst-mac-mask",
    "log-stats" : true,
    "stp-state" : "Disabled",
    "vlan-pri" : 9,
    "cpu-class" : "cpu-class",
    "action-value1" : 3,
    "hw-stats" : true,
    "vrouter-name" : "vrouter-name",
    "proto" : 5,
    "name" : "name",
    "table-name" : "table-name",
    "udf-data1-mask" : "udf-data1-mask",
    "action-to-next-hop-ip-value" : "action-to-next-hop-ip-value",
    "internal-pri" : "internal-pri",
    "src-mac-mask" : "src-mac-mask",
    "tos-end" : 5,
    "hidden" : true,
    "stats-interval" : 3,
    "description" : "description",
    "tos-start" : 4,
    "udf-data2-mask" : "udf-data2-mask",
    "vxlan-ether-type" : "0x800",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "dscp-map" : "dscp-map",
    "out-port" : "out-port",
    "dst-mac" : "dst-mac",
    "from-tunnel-decap" : "off",
    "packet-res" : "l2-unicast",
    "ttl" : 5,
    "dst-ip-mask" : "dst-ip-mask",
    "inner-vlan-pri" : 9,
    "tcp-flags" : "fin",
    "src-vpg" : "src-vpg",
    "in-port" : "in-port",
    "vpn_id" : "vpn_id",
    "action-to-ecmp-group-value" : "action-to-ecmp-group-value"
  }, {
    "dur" : 9,
    "dscp-start" : 7,
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "metadata" : 2,
    "ingress-tunnel" : "ingress-tunnel",
    "src-port-mask" : "src-port-mask",
    "flow-cb" : "default-cb",
    "bw-min" : 6,
    "dropped" : true,
    "type" : "ofp",
    "tracking" : "disable",
    "dscp" : 6,
    "enable" : true,
    "action" : "none",
    "id" : "id",
    "if" : "mgmt",
    "vxlan" : 7,
    "flow-class" : "flow-class",
    "metadata-mask" : 2,
    "ether-type" : "0x800",
    "topology" : "topology",
    "vrf" : "vrf",
    "inner-vlan" : 1,
    "vxlan-proto" : 6,
    "egress-tunnel" : "egress-tunnel",
    "bw-max" : 8,
    "src-port-end" : 1,
    "phy-dst-port" : 7,
    "burst-size" : 9,
    "transparency" : "enable",
    "mirror-id" : "mirror-id",
    "action-value" : 6,
    "local-subnet" : true,
    "l3-class-id" : 1,
    "dst-vpg" : "dst-vpg",
    "udf-data1" : "udf-data1",
    "udf-data2" : "udf-data2",
    "fwding-type" : "vlan",
    "bd" : "bd",
    "udf-data3" : "udf-data3",
    "api.switch-name" : "api.switch-name",
    "tracking-status" : "unknown",
    "override-sys-flows" : true,
    "vlan" : 0,
    "action-to-ports-value" : "action-to-ports-value",
    "udf-data3-mask" : "udf-data3-mask",
    "dscp-end" : 1,
    "tos" : 1,
    "dst-port-end" : 6,
    "src-ip-mask" : "src-ip-mask",
    "bidir-vpg-1" : "bidir-vpg-1",
    "bidir-vpg-2" : "bidir-vpg-2",
    "action-set-mac-value" : "action-set-mac-value",
    "src-port" : 1,
    "dst-port" : 2,
    "udf-name2" : "udf-name2",
    "udf-name1" : "udf-name1",
    "precedence" : 4,
    "dst-port-mask" : "dst-port-mask",
    "udf-name3" : "udf-name3",
    "src-mac" : "src-mac",
    "dst-mac-mask" : "dst-mac-mask",
    "log-stats" : true,
    "stp-state" : "Disabled",
    "vlan-pri" : 9,
    "cpu-class" : "cpu-class",
    "action-value1" : 3,
    "hw-stats" : true,
    "vrouter-name" : "vrouter-name",
    "proto" : 5,
    "name" : "name",
    "table-name" : "table-name",
    "udf-data1-mask" : "udf-data1-mask",
    "action-to-next-hop-ip-value" : "action-to-next-hop-ip-value",
    "internal-pri" : "internal-pri",
    "src-mac-mask" : "src-mac-mask",
    "tos-end" : 5,
    "hidden" : true,
    "stats-interval" : 3,
    "description" : "description",
    "tos-start" : 4,
    "udf-data2-mask" : "udf-data2-mask",
    "vxlan-ether-type" : "0x800",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "dscp-map" : "dscp-map",
    "out-port" : "out-port",
    "dst-mac" : "dst-mac",
    "from-tunnel-decap" : "off",
    "packet-res" : "l2-unicast",
    "ttl" : 5,
    "dst-ip-mask" : "dst-ip-mask",
    "inner-vlan-pri" : 9,
    "tcp-flags" : "fin",
    "src-vpg" : "src-vpg",
    "in-port" : "in-port",
    "vpn_id" : "vpn_id",
    "action-to-ecmp-group-value" : "action-to-ecmp-group-value"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vflow-show-response
Up
get /vflows/name/{name}
(showVflowByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dur" : 9,
    "dscp-start" : 7,
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "metadata" : 2,
    "ingress-tunnel" : "ingress-tunnel",
    "src-port-mask" : "src-port-mask",
    "flow-cb" : "default-cb",
    "bw-min" : 6,
    "dropped" : true,
    "type" : "ofp",
    "tracking" : "disable",
    "dscp" : 6,
    "enable" : true,
    "action" : "none",
    "id" : "id",
    "if" : "mgmt",
    "vxlan" : 7,
    "flow-class" : "flow-class",
    "metadata-mask" : 2,
    "ether-type" : "0x800",
    "topology" : "topology",
    "vrf" : "vrf",
    "inner-vlan" : 1,
    "vxlan-proto" : 6,
    "egress-tunnel" : "egress-tunnel",
    "bw-max" : 8,
    "src-port-end" : 1,
    "phy-dst-port" : 7,
    "burst-size" : 9,
    "transparency" : "enable",
    "mirror-id" : "mirror-id",
    "action-value" : 6,
    "local-subnet" : true,
    "l3-class-id" : 1,
    "dst-vpg" : "dst-vpg",
    "udf-data1" : "udf-data1",
    "udf-data2" : "udf-data2",
    "fwding-type" : "vlan",
    "bd" : "bd",
    "udf-data3" : "udf-data3",
    "api.switch-name" : "api.switch-name",
    "tracking-status" : "unknown",
    "override-sys-flows" : true,
    "vlan" : 0,
    "action-to-ports-value" : "action-to-ports-value",
    "udf-data3-mask" : "udf-data3-mask",
    "dscp-end" : 1,
    "tos" : 1,
    "dst-port-end" : 6,
    "src-ip-mask" : "src-ip-mask",
    "bidir-vpg-1" : "bidir-vpg-1",
    "bidir-vpg-2" : "bidir-vpg-2",
    "action-set-mac-value" : "action-set-mac-value",
    "src-port" : 1,
    "dst-port" : 2,
    "udf-name2" : "udf-name2",
    "udf-name1" : "udf-name1",
    "precedence" : 4,
    "dst-port-mask" : "dst-port-mask",
    "udf-name3" : "udf-name3",
    "src-mac" : "src-mac",
    "dst-mac-mask" : "dst-mac-mask",
    "log-stats" : true,
    "stp-state" : "Disabled",
    "vlan-pri" : 9,
    "cpu-class" : "cpu-class",
    "action-value1" : 3,
    "hw-stats" : true,
    "vrouter-name" : "vrouter-name",
    "proto" : 5,
    "name" : "name",
    "table-name" : "table-name",
    "udf-data1-mask" : "udf-data1-mask",
    "action-to-next-hop-ip-value" : "action-to-next-hop-ip-value",
    "internal-pri" : "internal-pri",
    "src-mac-mask" : "src-mac-mask",
    "tos-end" : 5,
    "hidden" : true,
    "stats-interval" : 3,
    "description" : "description",
    "tos-start" : 4,
    "udf-data2-mask" : "udf-data2-mask",
    "vxlan-ether-type" : "0x800",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "dscp-map" : "dscp-map",
    "out-port" : "out-port",
    "dst-mac" : "dst-mac",
    "from-tunnel-decap" : "off",
    "packet-res" : "l2-unicast",
    "ttl" : 5,
    "dst-ip-mask" : "dst-ip-mask",
    "inner-vlan-pri" : 9,
    "tcp-flags" : "fin",
    "src-vpg" : "src-vpg",
    "in-port" : "in-port",
    "vpn_id" : "vpn_id",
    "action-to-ecmp-group-value" : "action-to-ecmp-group-value"
  }, {
    "dur" : 9,
    "dscp-start" : 7,
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "metadata" : 2,
    "ingress-tunnel" : "ingress-tunnel",
    "src-port-mask" : "src-port-mask",
    "flow-cb" : "default-cb",
    "bw-min" : 6,
    "dropped" : true,
    "type" : "ofp",
    "tracking" : "disable",
    "dscp" : 6,
    "enable" : true,
    "action" : "none",
    "id" : "id",
    "if" : "mgmt",
    "vxlan" : 7,
    "flow-class" : "flow-class",
    "metadata-mask" : 2,
    "ether-type" : "0x800",
    "topology" : "topology",
    "vrf" : "vrf",
    "inner-vlan" : 1,
    "vxlan-proto" : 6,
    "egress-tunnel" : "egress-tunnel",
    "bw-max" : 8,
    "src-port-end" : 1,
    "phy-dst-port" : 7,
    "burst-size" : 9,
    "transparency" : "enable",
    "mirror-id" : "mirror-id",
    "action-value" : 6,
    "local-subnet" : true,
    "l3-class-id" : 1,
    "dst-vpg" : "dst-vpg",
    "udf-data1" : "udf-data1",
    "udf-data2" : "udf-data2",
    "fwding-type" : "vlan",
    "bd" : "bd",
    "udf-data3" : "udf-data3",
    "api.switch-name" : "api.switch-name",
    "tracking-status" : "unknown",
    "override-sys-flows" : true,
    "vlan" : 0,
    "action-to-ports-value" : "action-to-ports-value",
    "udf-data3-mask" : "udf-data3-mask",
    "dscp-end" : 1,
    "tos" : 1,
    "dst-port-end" : 6,
    "src-ip-mask" : "src-ip-mask",
    "bidir-vpg-1" : "bidir-vpg-1",
    "bidir-vpg-2" : "bidir-vpg-2",
    "action-set-mac-value" : "action-set-mac-value",
    "src-port" : 1,
    "dst-port" : 2,
    "udf-name2" : "udf-name2",
    "udf-name1" : "udf-name1",
    "precedence" : 4,
    "dst-port-mask" : "dst-port-mask",
    "udf-name3" : "udf-name3",
    "src-mac" : "src-mac",
    "dst-mac-mask" : "dst-mac-mask",
    "log-stats" : true,
    "stp-state" : "Disabled",
    "vlan-pri" : 9,
    "cpu-class" : "cpu-class",
    "action-value1" : 3,
    "hw-stats" : true,
    "vrouter-name" : "vrouter-name",
    "proto" : 5,
    "name" : "name",
    "table-name" : "table-name",
    "udf-data1-mask" : "udf-data1-mask",
    "action-to-next-hop-ip-value" : "action-to-next-hop-ip-value",
    "internal-pri" : "internal-pri",
    "src-mac-mask" : "src-mac-mask",
    "tos-end" : 5,
    "hidden" : true,
    "stats-interval" : 3,
    "description" : "description",
    "tos-start" : 4,
    "udf-data2-mask" : "udf-data2-mask",
    "vxlan-ether-type" : "0x800",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "dscp-map" : "dscp-map",
    "out-port" : "out-port",
    "dst-mac" : "dst-mac",
    "from-tunnel-decap" : "off",
    "packet-res" : "l2-unicast",
    "ttl" : 5,
    "dst-ip-mask" : "dst-ip-mask",
    "inner-vlan-pri" : 9,
    "tcp-flags" : "fin",
    "src-vpg" : "src-vpg",
    "in-port" : "in-port",
    "vpn_id" : "vpn_id",
    "action-to-ecmp-group-value" : "action-to-ecmp-group-value"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vflow-show-response
Up
get /vflows
(showVflows)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "dur" : 9,
    "dscp-start" : 7,
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "metadata" : 2,
    "ingress-tunnel" : "ingress-tunnel",
    "src-port-mask" : "src-port-mask",
    "flow-cb" : "default-cb",
    "bw-min" : 6,
    "dropped" : true,
    "type" : "ofp",
    "tracking" : "disable",
    "dscp" : 6,
    "enable" : true,
    "action" : "none",
    "id" : "id",
    "if" : "mgmt",
    "vxlan" : 7,
    "flow-class" : "flow-class",
    "metadata-mask" : 2,
    "ether-type" : "0x800",
    "topology" : "topology",
    "vrf" : "vrf",
    "inner-vlan" : 1,
    "vxlan-proto" : 6,
    "egress-tunnel" : "egress-tunnel",
    "bw-max" : 8,
    "src-port-end" : 1,
    "phy-dst-port" : 7,
    "burst-size" : 9,
    "transparency" : "enable",
    "mirror-id" : "mirror-id",
    "action-value" : 6,
    "local-subnet" : true,
    "l3-class-id" : 1,
    "dst-vpg" : "dst-vpg",
    "udf-data1" : "udf-data1",
    "udf-data2" : "udf-data2",
    "fwding-type" : "vlan",
    "bd" : "bd",
    "udf-data3" : "udf-data3",
    "api.switch-name" : "api.switch-name",
    "tracking-status" : "unknown",
    "override-sys-flows" : true,
    "vlan" : 0,
    "action-to-ports-value" : "action-to-ports-value",
    "udf-data3-mask" : "udf-data3-mask",
    "dscp-end" : 1,
    "tos" : 1,
    "dst-port-end" : 6,
    "src-ip-mask" : "src-ip-mask",
    "bidir-vpg-1" : "bidir-vpg-1",
    "bidir-vpg-2" : "bidir-vpg-2",
    "action-set-mac-value" : "action-set-mac-value",
    "src-port" : 1,
    "dst-port" : 2,
    "udf-name2" : "udf-name2",
    "udf-name1" : "udf-name1",
    "precedence" : 4,
    "dst-port-mask" : "dst-port-mask",
    "udf-name3" : "udf-name3",
    "src-mac" : "src-mac",
    "dst-mac-mask" : "dst-mac-mask",
    "log-stats" : true,
    "stp-state" : "Disabled",
    "vlan-pri" : 9,
    "cpu-class" : "cpu-class",
    "action-value1" : 3,
    "hw-stats" : true,
    "vrouter-name" : "vrouter-name",
    "proto" : 5,
    "name" : "name",
    "table-name" : "table-name",
    "udf-data1-mask" : "udf-data1-mask",
    "action-to-next-hop-ip-value" : "action-to-next-hop-ip-value",
    "internal-pri" : "internal-pri",
    "src-mac-mask" : "src-mac-mask",
    "tos-end" : 5,
    "hidden" : true,
    "stats-interval" : 3,
    "description" : "description",
    "tos-start" : 4,
    "udf-data2-mask" : "udf-data2-mask",
    "vxlan-ether-type" : "0x800",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "dscp-map" : "dscp-map",
    "out-port" : "out-port",
    "dst-mac" : "dst-mac",
    "from-tunnel-decap" : "off",
    "packet-res" : "l2-unicast",
    "ttl" : 5,
    "dst-ip-mask" : "dst-ip-mask",
    "inner-vlan-pri" : 9,
    "tcp-flags" : "fin",
    "src-vpg" : "src-vpg",
    "in-port" : "in-port",
    "vpn_id" : "vpn_id",
    "action-to-ecmp-group-value" : "action-to-ecmp-group-value"
  }, {
    "dur" : 9,
    "dscp-start" : 7,
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "metadata" : 2,
    "ingress-tunnel" : "ingress-tunnel",
    "src-port-mask" : "src-port-mask",
    "flow-cb" : "default-cb",
    "bw-min" : 6,
    "dropped" : true,
    "type" : "ofp",
    "tracking" : "disable",
    "dscp" : 6,
    "enable" : true,
    "action" : "none",
    "id" : "id",
    "if" : "mgmt",
    "vxlan" : 7,
    "flow-class" : "flow-class",
    "metadata-mask" : 2,
    "ether-type" : "0x800",
    "topology" : "topology",
    "vrf" : "vrf",
    "inner-vlan" : 1,
    "vxlan-proto" : 6,
    "egress-tunnel" : "egress-tunnel",
    "bw-max" : 8,
    "src-port-end" : 1,
    "phy-dst-port" : 7,
    "burst-size" : 9,
    "transparency" : "enable",
    "mirror-id" : "mirror-id",
    "action-value" : 6,
    "local-subnet" : true,
    "l3-class-id" : 1,
    "dst-vpg" : "dst-vpg",
    "udf-data1" : "udf-data1",
    "udf-data2" : "udf-data2",
    "fwding-type" : "vlan",
    "bd" : "bd",
    "udf-data3" : "udf-data3",
    "api.switch-name" : "api.switch-name",
    "tracking-status" : "unknown",
    "override-sys-flows" : true,
    "vlan" : 0,
    "action-to-ports-value" : "action-to-ports-value",
    "udf-data3-mask" : "udf-data3-mask",
    "dscp-end" : 1,
    "tos" : 1,
    "dst-port-end" : 6,
    "src-ip-mask" : "src-ip-mask",
    "bidir-vpg-1" : "bidir-vpg-1",
    "bidir-vpg-2" : "bidir-vpg-2",
    "action-set-mac-value" : "action-set-mac-value",
    "src-port" : 1,
    "dst-port" : 2,
    "udf-name2" : "udf-name2",
    "udf-name1" : "udf-name1",
    "precedence" : 4,
    "dst-port-mask" : "dst-port-mask",
    "udf-name3" : "udf-name3",
    "src-mac" : "src-mac",
    "dst-mac-mask" : "dst-mac-mask",
    "log-stats" : true,
    "stp-state" : "Disabled",
    "vlan-pri" : 9,
    "cpu-class" : "cpu-class",
    "action-value1" : 3,
    "hw-stats" : true,
    "vrouter-name" : "vrouter-name",
    "proto" : 5,
    "name" : "name",
    "table-name" : "table-name",
    "udf-data1-mask" : "udf-data1-mask",
    "action-to-next-hop-ip-value" : "action-to-next-hop-ip-value",
    "internal-pri" : "internal-pri",
    "src-mac-mask" : "src-mac-mask",
    "tos-end" : 5,
    "hidden" : true,
    "stats-interval" : 3,
    "description" : "description",
    "tos-start" : 4,
    "udf-data2-mask" : "udf-data2-mask",
    "vxlan-ether-type" : "0x800",
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "dscp-map" : "dscp-map",
    "out-port" : "out-port",
    "dst-mac" : "dst-mac",
    "from-tunnel-decap" : "off",
    "packet-res" : "l2-unicast",
    "ttl" : 5,
    "dst-ip-mask" : "dst-ip-mask",
    "inner-vlan-pri" : 9,
    "tcp-flags" : "fin",
    "src-vpg" : "src-vpg",
    "in-port" : "in-port",
    "vpn_id" : "vpn_id",
    "action-to-ecmp-group-value" : "action-to-ecmp-group-value"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vflow-show-response
Up
put /vflows/{name}
(updateVflowByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body vflow-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VlagStats

Up
get /vlag-stats/clear
(clearVlagStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 6,
    "older-than" : 6,
    "port-speed" : 0,
    "within-last" : 1,
    "HER-bytes" : 6,
    "iUpkts" : 5,
    "oPkts" : 9,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 7,
    "oCongDrops" : 2,
    "iCongDrops" : 7,
    "ibits" : 5,
    "obytes" : 5,
    "iMpkts" : 1,
    "ierrs" : 4,
    "oMpkts" : 9,
    "start-time" : "start-time",
    "HER-bits" : 8,
    "end-time" : "end-time",
    "ibytes" : 1,
    "odiscards" : 4,
    "counter" : 6,
    "HER-pkts" : 1,
    "oBpkts" : 7,
    "idiscards" : 1,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 3,
    "name" : "name",
    "interval" : 3,
    "time" : "time",
    "obits" : 9
  }, {
    "iPauseFs" : 6,
    "older-than" : 6,
    "port-speed" : 0,
    "within-last" : 1,
    "HER-bytes" : 6,
    "iUpkts" : 5,
    "oPkts" : 9,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 7,
    "oCongDrops" : 2,
    "iCongDrops" : 7,
    "ibits" : 5,
    "obytes" : 5,
    "iMpkts" : 1,
    "ierrs" : 4,
    "oMpkts" : 9,
    "start-time" : "start-time",
    "HER-bits" : 8,
    "end-time" : "end-time",
    "ibytes" : 1,
    "odiscards" : 4,
    "counter" : 6,
    "HER-pkts" : 1,
    "oBpkts" : 7,
    "idiscards" : 1,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 3,
    "name" : "name",
    "interval" : 3,
    "time" : "time",
    "obits" : 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 vlag-stats-show-response
Up
get /vlag-stats
(showVlagStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 6,
    "older-than" : 6,
    "port-speed" : 0,
    "within-last" : 1,
    "HER-bytes" : 6,
    "iUpkts" : 5,
    "oPkts" : 9,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 7,
    "oCongDrops" : 2,
    "iCongDrops" : 7,
    "ibits" : 5,
    "obytes" : 5,
    "iMpkts" : 1,
    "ierrs" : 4,
    "oMpkts" : 9,
    "start-time" : "start-time",
    "HER-bits" : 8,
    "end-time" : "end-time",
    "ibytes" : 1,
    "odiscards" : 4,
    "counter" : 6,
    "HER-pkts" : 1,
    "oBpkts" : 7,
    "idiscards" : 1,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 3,
    "name" : "name",
    "interval" : 3,
    "time" : "time",
    "obits" : 9
  }, {
    "iPauseFs" : 6,
    "older-than" : 6,
    "port-speed" : 0,
    "within-last" : 1,
    "HER-bytes" : 6,
    "iUpkts" : 5,
    "oPkts" : 9,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 7,
    "oCongDrops" : 2,
    "iCongDrops" : 7,
    "ibits" : 5,
    "obytes" : 5,
    "iMpkts" : 1,
    "ierrs" : 4,
    "oMpkts" : 9,
    "start-time" : "start-time",
    "HER-bits" : 8,
    "end-time" : "end-time",
    "ibytes" : 1,
    "odiscards" : 4,
    "counter" : 6,
    "HER-pkts" : 1,
    "oBpkts" : 7,
    "idiscards" : 1,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 3,
    "name" : "name",
    "interval" : 3,
    "time" : "time",
    "obits" : 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 vlag-stats-show-response
Up
get /vlag-stats/{name}
(showVlagStatsByVlagName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 6,
    "older-than" : 6,
    "port-speed" : 0,
    "within-last" : 1,
    "HER-bytes" : 6,
    "iUpkts" : 5,
    "oPkts" : 9,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 7,
    "oCongDrops" : 2,
    "iCongDrops" : 7,
    "ibits" : 5,
    "obytes" : 5,
    "iMpkts" : 1,
    "ierrs" : 4,
    "oMpkts" : 9,
    "start-time" : "start-time",
    "HER-bits" : 8,
    "end-time" : "end-time",
    "ibytes" : 1,
    "odiscards" : 4,
    "counter" : 6,
    "HER-pkts" : 1,
    "oBpkts" : 7,
    "idiscards" : 1,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 3,
    "name" : "name",
    "interval" : 3,
    "time" : "time",
    "obits" : 9
  }, {
    "iPauseFs" : 6,
    "older-than" : 6,
    "port-speed" : 0,
    "within-last" : 1,
    "HER-bytes" : 6,
    "iUpkts" : 5,
    "oPkts" : 9,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 7,
    "oCongDrops" : 2,
    "iCongDrops" : 7,
    "ibits" : 5,
    "obytes" : 5,
    "iMpkts" : 1,
    "ierrs" : 4,
    "oMpkts" : 9,
    "start-time" : "start-time",
    "HER-bits" : 8,
    "end-time" : "end-time",
    "ibytes" : 1,
    "odiscards" : 4,
    "counter" : 6,
    "HER-pkts" : 1,
    "oBpkts" : 7,
    "idiscards" : 1,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "oPauseFs" : 3,
    "name" : "name",
    "interval" : 3,
    "time" : "time",
    "obits" : 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 vlag-stats-show-response

Vlags

Up
post /vlags
(createVlag)

Consumes

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

Request body

body vlag-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlags/{name}
(deleteVlagByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlags/{name}
(showVlagByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lacp-system-id" : 5,
    "lacp-timeout" : "slow",
    "lacp-individual" : "lacp-individual",
    "lacp-mode" : "off",
    "api.switch-name" : "api.switch-name",
    "switch" : 6,
    "mode" : "active-standby",
    "failover-move-L2" : true,
    "lacp-port-priority" : 7,
    "port" : 0,
    "peer-state" : "enabled",
    "lacp-fallback-timeout" : 2,
    "name" : "name",
    "id" : "id",
    "local-state" : "enabled",
    "lacp-fallback" : "bundle",
    "peer-switch" : 9,
    "status" : "peer-down",
    "lacp-key" : 1,
    "peer-port" : 5,
    "cluster-id" : "cluster-id"
  }, {
    "lacp-system-id" : 5,
    "lacp-timeout" : "slow",
    "lacp-individual" : "lacp-individual",
    "lacp-mode" : "off",
    "api.switch-name" : "api.switch-name",
    "switch" : 6,
    "mode" : "active-standby",
    "failover-move-L2" : true,
    "lacp-port-priority" : 7,
    "port" : 0,
    "peer-state" : "enabled",
    "lacp-fallback-timeout" : 2,
    "name" : "name",
    "id" : "id",
    "local-state" : "enabled",
    "lacp-fallback" : "bundle",
    "peer-switch" : 9,
    "status" : "peer-down",
    "lacp-key" : 1,
    "peer-port" : 5,
    "cluster-id" : "cluster-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 vlag-show-response
Up
get /vlags
(showVlags)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "lacp-system-id" : 5,
    "lacp-timeout" : "slow",
    "lacp-individual" : "lacp-individual",
    "lacp-mode" : "off",
    "api.switch-name" : "api.switch-name",
    "switch" : 6,
    "mode" : "active-standby",
    "failover-move-L2" : true,
    "lacp-port-priority" : 7,
    "port" : 0,
    "peer-state" : "enabled",
    "lacp-fallback-timeout" : 2,
    "name" : "name",
    "id" : "id",
    "local-state" : "enabled",
    "lacp-fallback" : "bundle",
    "peer-switch" : 9,
    "status" : "peer-down",
    "lacp-key" : 1,
    "peer-port" : 5,
    "cluster-id" : "cluster-id"
  }, {
    "lacp-system-id" : 5,
    "lacp-timeout" : "slow",
    "lacp-individual" : "lacp-individual",
    "lacp-mode" : "off",
    "api.switch-name" : "api.switch-name",
    "switch" : 6,
    "mode" : "active-standby",
    "failover-move-L2" : true,
    "lacp-port-priority" : 7,
    "port" : 0,
    "peer-state" : "enabled",
    "lacp-fallback-timeout" : 2,
    "name" : "name",
    "id" : "id",
    "local-state" : "enabled",
    "lacp-fallback" : "bundle",
    "peer-switch" : 9,
    "status" : "peer-down",
    "lacp-key" : 1,
    "peer-port" : 5,
    "cluster-id" : "cluster-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 vlag-show-response
Up
put /vlags/{name}
(updateVlagByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body vlag-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VlanStats

Up
post /vlan-stats/clear
(clearVlanStatsByUsage1)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlan-stats
(showVlanStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "older-than" : 6,
    "start-time" : "start-time",
    "within-last" : 7,
    "odrops-bytes" : 7,
    "end-time" : "end-time",
    "ibytes" : 5,
    "odrops-pkts" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "idrops-bytes" : 7,
    "idrops-pkts" : 9,
    "vlan" : 0,
    "public-vlan" : 1,
    "opkts" : 4,
    "ibits" : 5,
    "interval" : 1,
    "obytes" : 3,
    "time" : "time",
    "ipkts" : 2,
    "obits" : 2
  }, {
    "vxlan" : 6,
    "older-than" : 6,
    "start-time" : "start-time",
    "within-last" : 7,
    "odrops-bytes" : 7,
    "end-time" : "end-time",
    "ibytes" : 5,
    "odrops-pkts" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "idrops-bytes" : 7,
    "idrops-pkts" : 9,
    "vlan" : 0,
    "public-vlan" : 1,
    "opkts" : 4,
    "ibits" : 5,
    "interval" : 1,
    "obytes" : 3,
    "time" : "time",
    "ipkts" : 2,
    "obits" : 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 vlan-stats-show-response
Up
get /vlan-stats/vlan/{vlan}
(showVlanStatsByVlanId)

Path parameters

vlan (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "older-than" : 6,
    "start-time" : "start-time",
    "within-last" : 7,
    "odrops-bytes" : 7,
    "end-time" : "end-time",
    "ibytes" : 5,
    "odrops-pkts" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "idrops-bytes" : 7,
    "idrops-pkts" : 9,
    "vlan" : 0,
    "public-vlan" : 1,
    "opkts" : 4,
    "ibits" : 5,
    "interval" : 1,
    "obytes" : 3,
    "time" : "time",
    "ipkts" : 2,
    "obits" : 2
  }, {
    "vxlan" : 6,
    "older-than" : 6,
    "start-time" : "start-time",
    "within-last" : 7,
    "odrops-bytes" : 7,
    "end-time" : "end-time",
    "ibytes" : 5,
    "odrops-pkts" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "idrops-bytes" : 7,
    "idrops-pkts" : 9,
    "vlan" : 0,
    "public-vlan" : 1,
    "opkts" : 4,
    "ibits" : 5,
    "interval" : 1,
    "obytes" : 3,
    "time" : "time",
    "ipkts" : 2,
    "obits" : 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 vlan-stats-show-response
Up
get /vlan-stats/vnet/{vnet}
(showVlanStatsByVnet)

Path parameters

vnet (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 6,
    "older-than" : 6,
    "start-time" : "start-time",
    "within-last" : 7,
    "odrops-bytes" : 7,
    "end-time" : "end-time",
    "ibytes" : 5,
    "odrops-pkts" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "idrops-bytes" : 7,
    "idrops-pkts" : 9,
    "vlan" : 0,
    "public-vlan" : 1,
    "opkts" : 4,
    "ibits" : 5,
    "interval" : 1,
    "obytes" : 3,
    "time" : "time",
    "ipkts" : 2,
    "obits" : 2
  }, {
    "vxlan" : 6,
    "older-than" : 6,
    "start-time" : "start-time",
    "within-last" : 7,
    "odrops-bytes" : 7,
    "end-time" : "end-time",
    "ibytes" : 5,
    "odrops-pkts" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "idrops-bytes" : 7,
    "idrops-pkts" : 9,
    "vlan" : 0,
    "public-vlan" : 1,
    "opkts" : 4,
    "ibits" : 5,
    "interval" : 1,
    "obytes" : 3,
    "time" : "time",
    "ipkts" : 2,
    "obits" : 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 vlan-stats-show-response

VlanStatsSettings

Up
get /vlan-stats-settings
(showVlanStatsSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 vlan-stats-settings-show-response
Up
put /vlan-stats-settings
(updateVlanStatsSettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Vlans

Up
post /vlans/id={id},vnet-id={vnet-id}/ports
(addVlanVlanPortByPrimaryKeyAllIdent)

Path parameters

id (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Request body

body vlan-port-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/range={range},vnet-id={vnet-id}/ports
(addVlanVlanPortByPrimaryKeyAllRange)

Path parameters

range (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Request body

body vlan-port-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/vlan-id/{vlan-id}/ports
(addVlanVlanPortByVlanIdent)

Path parameters

vlan-id (required)
Path Parameter

Consumes

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

Request body

body vlan-port-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/vlan-range/{vlan-range}/ports
(addVlanVlanPortByVlanRange)

Path parameters

vlan-range (required)
Path Parameter

Consumes

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

Request body

body vlan-port-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans
(createVlan)

Consumes

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

Request body

body vlan-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/id/{id}
(deleteVlanByIdent)

Path parameters

id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/id={id},vnet-id={vnet-id}
(deleteVlanByPrimaryKeyAllIdent)

Path parameters

id (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/range={range},vnet-id={vnet-id}
(deleteVlanByPrimaryKeyAllRange)

Path parameters

range (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/range/{range}
(deleteVlanByRange)

Path parameters

range (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/vlan-id/{vlan-id}/ports/{ports}
(removeVlanVlanPortByIdentByPmap)

Path parameters

vlan-id (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/vlan-id/{vlan-id}/ports/port-desc/{port-desc}
(removeVlanVlanPortByIdentByPortDesc)

Path parameters

vlan-id (required)
Path Parameter
port-desc (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/id={id},vnet-id={vnet-id}/ports
(removeVlanVlanPortByPrimaryKeyAllIdent)

Path parameters

id (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Request body

body vlan-port-remove (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/id={id},vnet-id={vnet-id}/ports/{ports}
(removeVlanVlanPortByPrimaryKeyAllIdentByPmap)

Path parameters

id (required)
Path Parameter
vnet-id (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/id={id},vnet-id={vnet-id}/ports/port-desc/{port-desc}
(removeVlanVlanPortByPrimaryKeyAllIdentByPortDesc)

Path parameters

id (required)
Path Parameter
vnet-id (required)
Path Parameter
port-desc (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/range={range},vnet-id={vnet-id}/ports
(removeVlanVlanPortByPrimaryKeyAllRange)

Path parameters

range (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Request body

body vlan-port-remove (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/range={range},vnet-id={vnet-id}/ports/{ports}
(removeVlanVlanPortByPrimaryKeyAllRangeByPmap)

Path parameters

range (required)
Path Parameter
vnet-id (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/range={range},vnet-id={vnet-id}/ports/port-desc/{port-desc}
(removeVlanVlanPortByPrimaryKeyAllRangeByPortDesc)

Path parameters

range (required)
Path Parameter
vnet-id (required)
Path Parameter
port-desc (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/vlan-range/{vlan-range}/ports/{ports}
(removeVlanVlanPortByRangeByPmap)

Path parameters

vlan-range (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/vlan-range/{vlan-range}/ports/port-desc/{port-desc}
(removeVlanVlanPortByRangeByPortDesc)

Path parameters

vlan-range (required)
Path Parameter
port-desc (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/id/{id}
(showVlanByIdent)

Path parameters

id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "repl-vtep" : "repl-vtep",
    "hw-member-ports" : "hw-member-ports",
    "flags" : "fabric",
    "description" : "description",
    "type" : "public",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "active-edge-ports" : "active-edge-ports",
    "auto-vxlan" : true,
    "ports-specified" : true,
    "vxlan-mode" : "standard",
    "stats" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "public-vlan" : 5,
    "replicators" : "replicators",
    "id" : 0,
    "send-ports" : "send-ports",
    "untagged-ports" : "untagged-ports",
    "vxlan" : 5,
    "topology" : "topology",
    "active" : true,
    "port-desc" : "port-desc",
    "vrg-id" : "vrg-id",
    "hw-vpn" : 6,
    "hw-mcast-group" : 1,
    "untagged-port-desc" : "untagged-port-desc",
    "vxlan-hybrid-mode" : "standard"
  }, {
    "repl-vtep" : "repl-vtep",
    "hw-member-ports" : "hw-member-ports",
    "flags" : "fabric",
    "description" : "description",
    "type" : "public",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "active-edge-ports" : "active-edge-ports",
    "auto-vxlan" : true,
    "ports-specified" : true,
    "vxlan-mode" : "standard",
    "stats" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "public-vlan" : 5,
    "replicators" : "replicators",
    "id" : 0,
    "send-ports" : "send-ports",
    "untagged-ports" : "untagged-ports",
    "vxlan" : 5,
    "topology" : "topology",
    "active" : true,
    "port-desc" : "port-desc",
    "vrg-id" : "vrg-id",
    "hw-vpn" : 6,
    "hw-mcast-group" : 1,
    "untagged-port-desc" : "untagged-port-desc",
    "vxlan-hybrid-mode" : "standard"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-show-response
Up
get /vlans/id={id},vnet-id={vnet-id}
(showVlanByPrimaryKeyAllIdent)

Path parameters

id (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "repl-vtep" : "repl-vtep",
    "hw-member-ports" : "hw-member-ports",
    "flags" : "fabric",
    "description" : "description",
    "type" : "public",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "active-edge-ports" : "active-edge-ports",
    "auto-vxlan" : true,
    "ports-specified" : true,
    "vxlan-mode" : "standard",
    "stats" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "public-vlan" : 5,
    "replicators" : "replicators",
    "id" : 0,
    "send-ports" : "send-ports",
    "untagged-ports" : "untagged-ports",
    "vxlan" : 5,
    "topology" : "topology",
    "active" : true,
    "port-desc" : "port-desc",
    "vrg-id" : "vrg-id",
    "hw-vpn" : 6,
    "hw-mcast-group" : 1,
    "untagged-port-desc" : "untagged-port-desc",
    "vxlan-hybrid-mode" : "standard"
  }, {
    "repl-vtep" : "repl-vtep",
    "hw-member-ports" : "hw-member-ports",
    "flags" : "fabric",
    "description" : "description",
    "type" : "public",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "active-edge-ports" : "active-edge-ports",
    "auto-vxlan" : true,
    "ports-specified" : true,
    "vxlan-mode" : "standard",
    "stats" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "public-vlan" : 5,
    "replicators" : "replicators",
    "id" : 0,
    "send-ports" : "send-ports",
    "untagged-ports" : "untagged-ports",
    "vxlan" : 5,
    "topology" : "topology",
    "active" : true,
    "port-desc" : "port-desc",
    "vrg-id" : "vrg-id",
    "hw-vpn" : 6,
    "hw-mcast-group" : 1,
    "untagged-port-desc" : "untagged-port-desc",
    "vxlan-hybrid-mode" : "standard"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-show-response
Up
get /vlans/range={range},vnet-id={vnet-id}
(showVlanByPrimaryKeyAllRange)

Path parameters

range (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "repl-vtep" : "repl-vtep",
    "hw-member-ports" : "hw-member-ports",
    "flags" : "fabric",
    "description" : "description",
    "type" : "public",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "active-edge-ports" : "active-edge-ports",
    "auto-vxlan" : true,
    "ports-specified" : true,
    "vxlan-mode" : "standard",
    "stats" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "public-vlan" : 5,
    "replicators" : "replicators",
    "id" : 0,
    "send-ports" : "send-ports",
    "untagged-ports" : "untagged-ports",
    "vxlan" : 5,
    "topology" : "topology",
    "active" : true,
    "port-desc" : "port-desc",
    "vrg-id" : "vrg-id",
    "hw-vpn" : 6,
    "hw-mcast-group" : 1,
    "untagged-port-desc" : "untagged-port-desc",
    "vxlan-hybrid-mode" : "standard"
  }, {
    "repl-vtep" : "repl-vtep",
    "hw-member-ports" : "hw-member-ports",
    "flags" : "fabric",
    "description" : "description",
    "type" : "public",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "active-edge-ports" : "active-edge-ports",
    "auto-vxlan" : true,
    "ports-specified" : true,
    "vxlan-mode" : "standard",
    "stats" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "public-vlan" : 5,
    "replicators" : "replicators",
    "id" : 0,
    "send-ports" : "send-ports",
    "untagged-ports" : "untagged-ports",
    "vxlan" : 5,
    "topology" : "topology",
    "active" : true,
    "port-desc" : "port-desc",
    "vrg-id" : "vrg-id",
    "hw-vpn" : 6,
    "hw-mcast-group" : 1,
    "untagged-port-desc" : "untagged-port-desc",
    "vxlan-hybrid-mode" : "standard"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-show-response
Up
get /vlans/range/{range}
(showVlanByRange)

Path parameters

range (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "repl-vtep" : "repl-vtep",
    "hw-member-ports" : "hw-member-ports",
    "flags" : "fabric",
    "description" : "description",
    "type" : "public",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "active-edge-ports" : "active-edge-ports",
    "auto-vxlan" : true,
    "ports-specified" : true,
    "vxlan-mode" : "standard",
    "stats" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "public-vlan" : 5,
    "replicators" : "replicators",
    "id" : 0,
    "send-ports" : "send-ports",
    "untagged-ports" : "untagged-ports",
    "vxlan" : 5,
    "topology" : "topology",
    "active" : true,
    "port-desc" : "port-desc",
    "vrg-id" : "vrg-id",
    "hw-vpn" : 6,
    "hw-mcast-group" : 1,
    "untagged-port-desc" : "untagged-port-desc",
    "vxlan-hybrid-mode" : "standard"
  }, {
    "repl-vtep" : "repl-vtep",
    "hw-member-ports" : "hw-member-ports",
    "flags" : "fabric",
    "description" : "description",
    "type" : "public",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "active-edge-ports" : "active-edge-ports",
    "auto-vxlan" : true,
    "ports-specified" : true,
    "vxlan-mode" : "standard",
    "stats" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "public-vlan" : 5,
    "replicators" : "replicators",
    "id" : 0,
    "send-ports" : "send-ports",
    "untagged-ports" : "untagged-ports",
    "vxlan" : 5,
    "topology" : "topology",
    "active" : true,
    "port-desc" : "port-desc",
    "vrg-id" : "vrg-id",
    "hw-vpn" : 6,
    "hw-mcast-group" : 1,
    "untagged-port-desc" : "untagged-port-desc",
    "vxlan-hybrid-mode" : "standard"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-show-response
Up
get /vlans/vlan-id/{vlan-id}/ports/{ports}
(showVlanVlanPortByIdentByPmap)

Path parameters

vlan-id (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/vlan-id/{vlan-id}/ports/port-desc/{port-desc}
(showVlanVlanPortByIdentByPortDesc)

Path parameters

vlan-id (required)
Path Parameter
port-desc (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/id={id},vnet-id={vnet-id}/ports
(showVlanVlanPortByPrimaryKeyAllIdent)

Path parameters

id (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/id={id},vnet-id={vnet-id}/ports/{ports}
(showVlanVlanPortByPrimaryKeyAllIdentByPmap)

Path parameters

id (required)
Path Parameter
vnet-id (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/id={id},vnet-id={vnet-id}/ports/port-desc/{port-desc}
(showVlanVlanPortByPrimaryKeyAllIdentByPortDesc)

Path parameters

id (required)
Path Parameter
vnet-id (required)
Path Parameter
port-desc (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/id={id},vnet-id={vnet-id}/ports/ports={ports}
(showVlanVlanPortByPrimaryKeyAllIdentSublist)

Path parameters

id (required)
Path Parameter
vnet-id (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/range={range},vnet-id={vnet-id}/ports
(showVlanVlanPortByPrimaryKeyAllRange)

Path parameters

range (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/range={range},vnet-id={vnet-id}/ports/{ports}
(showVlanVlanPortByPrimaryKeyAllRangeByPmap)

Path parameters

range (required)
Path Parameter
vnet-id (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/range={range},vnet-id={vnet-id}/ports/port-desc/{port-desc}
(showVlanVlanPortByPrimaryKeyAllRangeByPortDesc)

Path parameters

range (required)
Path Parameter
vnet-id (required)
Path Parameter
port-desc (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/range={range},vnet-id={vnet-id}/ports/ports={ports}
(showVlanVlanPortByPrimaryKeyAllRangeSublist)

Path parameters

range (required)
Path Parameter
vnet-id (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/vlan-range/{vlan-range}/ports/{ports}
(showVlanVlanPortByRangeByPmap)

Path parameters

vlan-range (required)
Path Parameter
ports (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/vlan-range/{vlan-range}/ports/port-desc/{port-desc}
(showVlanVlanPortByRangeByPortDesc)

Path parameters

vlan-range (required)
Path Parameter
port-desc (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/vlan-id/{vlan-id}/ports
(showVlanVlanPortsByVlanIdent)

Path parameters

vlan-id (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans/vlan-range/{vlan-range}/ports
(showVlanVlanPortsByVlanRange)

Path parameters

vlan-range (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-port-show-response
Up
get /vlans
(showVlans)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "repl-vtep" : "repl-vtep",
    "hw-member-ports" : "hw-member-ports",
    "flags" : "fabric",
    "description" : "description",
    "type" : "public",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "active-edge-ports" : "active-edge-ports",
    "auto-vxlan" : true,
    "ports-specified" : true,
    "vxlan-mode" : "standard",
    "stats" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "public-vlan" : 5,
    "replicators" : "replicators",
    "id" : 0,
    "send-ports" : "send-ports",
    "untagged-ports" : "untagged-ports",
    "vxlan" : 5,
    "topology" : "topology",
    "active" : true,
    "port-desc" : "port-desc",
    "vrg-id" : "vrg-id",
    "hw-vpn" : 6,
    "hw-mcast-group" : 1,
    "untagged-port-desc" : "untagged-port-desc",
    "vxlan-hybrid-mode" : "standard"
  }, {
    "repl-vtep" : "repl-vtep",
    "hw-member-ports" : "hw-member-ports",
    "flags" : "fabric",
    "description" : "description",
    "type" : "public",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "active-edge-ports" : "active-edge-ports",
    "auto-vxlan" : true,
    "ports-specified" : true,
    "vxlan-mode" : "standard",
    "stats" : true,
    "scope" : "local",
    "vnet-id" : "vnet-id",
    "public-vlan" : 5,
    "replicators" : "replicators",
    "id" : 0,
    "send-ports" : "send-ports",
    "untagged-ports" : "untagged-ports",
    "vxlan" : 5,
    "topology" : "topology",
    "active" : true,
    "port-desc" : "port-desc",
    "vrg-id" : "vrg-id",
    "hw-vpn" : 6,
    "hw-mcast-group" : 1,
    "untagged-port-desc" : "untagged-port-desc",
    "vxlan-hybrid-mode" : "standard"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vlan-show-response
Up
put /vlans/id/{id}
(updateVlanByIdent)

Path parameters

id (required)
Path Parameter

Consumes

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

Request body

body vlan-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vlans/id={id},vnet-id={vnet-id}
(updateVlanByPrimaryKeyAllIdent)

Path parameters

id (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Request body

body vlan-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VleStats

Up
post /vle-stats/clear
(clearVleStats)

Consumes

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

Request body

body vle-stats-clear (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vle-stats
(showVleStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 6,
    "older-than" : 6,
    "within-last" : 1,
    "HER-bytes" : 6,
    "iUpkts" : 5,
    "oPkts" : 9,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 7,
    "oCongDrops" : 2,
    "iCongDrops" : 7,
    "ibits" : 5,
    "vle-name" : "vle-name",
    "obytes" : 5,
    "iMpkts" : 1,
    "ierrs" : 4,
    "oMpkts" : 9,
    "start-time" : "start-time",
    "HER-bits" : 8,
    "end-time" : "end-time",
    "ibytes" : 1,
    "odiscards" : 4,
    "counter" : 6,
    "HER-pkts" : 1,
    "oBpkts" : 7,
    "idiscards" : 1,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "port" : 0,
    "oPauseFs" : 3,
    "interval" : 3,
    "time" : "time",
    "obits" : 9
  }, {
    "iPauseFs" : 6,
    "older-than" : 6,
    "within-last" : 1,
    "HER-bytes" : 6,
    "iUpkts" : 5,
    "oPkts" : 9,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 7,
    "oCongDrops" : 2,
    "iCongDrops" : 7,
    "ibits" : 5,
    "vle-name" : "vle-name",
    "obytes" : 5,
    "iMpkts" : 1,
    "ierrs" : 4,
    "oMpkts" : 9,
    "start-time" : "start-time",
    "HER-bits" : 8,
    "end-time" : "end-time",
    "ibytes" : 1,
    "odiscards" : 4,
    "counter" : 6,
    "HER-pkts" : 1,
    "oBpkts" : 7,
    "idiscards" : 1,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "port" : 0,
    "oPauseFs" : 3,
    "interval" : 3,
    "time" : "time",
    "obits" : 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 vle-stats-show-response
Up
get /vle-stats/{vle-name}
(showVleStatsByVleName)

Path parameters

vle-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "iPauseFs" : 6,
    "older-than" : 6,
    "within-last" : 1,
    "HER-bytes" : 6,
    "iUpkts" : 5,
    "oPkts" : 9,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 7,
    "oCongDrops" : 2,
    "iCongDrops" : 7,
    "ibits" : 5,
    "vle-name" : "vle-name",
    "obytes" : 5,
    "iMpkts" : 1,
    "ierrs" : 4,
    "oMpkts" : 9,
    "start-time" : "start-time",
    "HER-bits" : 8,
    "end-time" : "end-time",
    "ibytes" : 1,
    "odiscards" : 4,
    "counter" : 6,
    "HER-pkts" : 1,
    "oBpkts" : 7,
    "idiscards" : 1,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "port" : 0,
    "oPauseFs" : 3,
    "interval" : 3,
    "time" : "time",
    "obits" : 9
  }, {
    "iPauseFs" : 6,
    "older-than" : 6,
    "within-last" : 1,
    "HER-bytes" : 6,
    "iUpkts" : 5,
    "oPkts" : 9,
    "oUpkts" : 9,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 6,
    "oerrs" : 7,
    "oCongDrops" : 2,
    "iCongDrops" : 7,
    "ibits" : 5,
    "vle-name" : "vle-name",
    "obytes" : 5,
    "iMpkts" : 1,
    "ierrs" : 4,
    "oMpkts" : 9,
    "start-time" : "start-time",
    "HER-bits" : 8,
    "end-time" : "end-time",
    "ibytes" : 1,
    "odiscards" : 4,
    "counter" : 6,
    "HER-pkts" : 1,
    "oBpkts" : 7,
    "idiscards" : 1,
    "mtu-errs" : 1,
    "iBpkts" : 2,
    "port" : 0,
    "oPauseFs" : 3,
    "interval" : 3,
    "time" : "time",
    "obits" : 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 vle-stats-show-response

VleTransparent

Up
get /vle-transparent
(showVleTransparent)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mode" : "enable",
    "api.switch-name" : "api.switch-name"
  }, {
    "mode" : "enable",
    "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 vle-transparent-show-response
Up
put /vle-transparent
(updateVleTransparent)

Consumes

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

Request body

body vle-transparent-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VleTransparentPort

Up
post /vle-transparent-port/add
(addVleTransparentPort)

Consumes

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

Request body

body vle-transparent-port-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vle-transparent-port/remove
(removeVleTransparentPort)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vle-transparent-port
(showVleTransparentPort)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port" : "port",
    "api.switch-name" : "api.switch-name"
  }, {
    "port" : "port",
    "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 vle-transparent-port-show-response

Vles

Up
post /vles
(createVle)

Consumes

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

Request body

body vle-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vles/{name}
(deleteVleByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vles/{name}
(showVleByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "topology" : "topology",
    "node-1" : 7,
    "node-2" : 5,
    "create-time" : "create-time",
    "api.switch-name" : "api.switch-name",
    "tracking" : true,
    "node2-name" : "node2-name",
    "node-2-port" : 2,
    "node-2-port-desc" : "node-2-port-desc",
    "node-1-port-desc" : "node-1-port-desc",
    "up-time" : 1,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "node1-name" : "node1-name",
    "elapsed-time" : 6,
    "tunnel-name" : "tunnel-name",
    "node-1-port" : 5,
    "id" : "id",
    "status" : "unknown",
    "ports-state" : "override"
  }, {
    "vxlan" : 0,
    "topology" : "topology",
    "node-1" : 7,
    "node-2" : 5,
    "create-time" : "create-time",
    "api.switch-name" : "api.switch-name",
    "tracking" : true,
    "node2-name" : "node2-name",
    "node-2-port" : 2,
    "node-2-port-desc" : "node-2-port-desc",
    "node-1-port-desc" : "node-1-port-desc",
    "up-time" : 1,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "node1-name" : "node1-name",
    "elapsed-time" : 6,
    "tunnel-name" : "tunnel-name",
    "node-1-port" : 5,
    "id" : "id",
    "status" : "unknown",
    "ports-state" : "override"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vle-show-response
Up
get /vles
(showVles)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "topology" : "topology",
    "node-1" : 7,
    "node-2" : 5,
    "create-time" : "create-time",
    "api.switch-name" : "api.switch-name",
    "tracking" : true,
    "node2-name" : "node2-name",
    "node-2-port" : 2,
    "node-2-port-desc" : "node-2-port-desc",
    "node-1-port-desc" : "node-1-port-desc",
    "up-time" : 1,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "node1-name" : "node1-name",
    "elapsed-time" : 6,
    "tunnel-name" : "tunnel-name",
    "node-1-port" : 5,
    "id" : "id",
    "status" : "unknown",
    "ports-state" : "override"
  }, {
    "vxlan" : 0,
    "topology" : "topology",
    "node-1" : 7,
    "node-2" : 5,
    "create-time" : "create-time",
    "api.switch-name" : "api.switch-name",
    "tracking" : true,
    "node2-name" : "node2-name",
    "node-2-port" : 2,
    "node-2-port-desc" : "node-2-port-desc",
    "node-1-port-desc" : "node-1-port-desc",
    "up-time" : 1,
    "name" : "name",
    "vnet-id" : "vnet-id",
    "node1-name" : "node1-name",
    "elapsed-time" : 6,
    "tunnel-name" : "tunnel-name",
    "node-1-port" : 5,
    "id" : "id",
    "status" : "unknown",
    "ports-state" : "override"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vle-show-response
Up
put /vles/{name}
(updateVleByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body vle-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VnetManagers

Up
post /vnet-managers/{vnet-manager-name}/interfaces
(addVnetMgrNicByVnetMgrVnmName)

Path parameters

vnet-manager-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnet-managers
(createVnetMgr)

Consumes

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

Request body

body vnet-manager-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnet-managers/{name}
(deleteVnetMgrByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnet-managers/migrate
(migrateVnetMgr)

Consumes

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

Request body

body vnet-manager-migrate (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnet-managers/{vnet-manager-name}/interfaces/l3-port/{l3-port}
(removeVnetMgrNicByVnmNameByL3port)

Path parameters

vnet-manager-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnet-managers/{vnet-manager-name}/interfaces/nic/{nic}
(removeVnetMgrNicByVnmNameByVnic)

Path parameters

vnet-manager-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnet-managers/ssh-host-key-show
(showSshHostKeyVnetMgr)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "template" : true,
    "failover-action" : "stop-old",
    "failover-controller" : 6,
    "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,
    "key" : "key",
    "gateway" : "gateway"
  }, {
    "template" : true,
    "failover-action" : "stop-old",
    "failover-controller" : 6,
    "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,
    "key" : "key",
    "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 vnet-manager-show-response
Up
get /vnet-managers/{name}
(showVnetMgrByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "template" : true,
    "failover-action" : "stop-old",
    "failover-controller" : 6,
    "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,
    "key" : "key",
    "gateway" : "gateway"
  }, {
    "template" : true,
    "failover-action" : "stop-old",
    "failover-controller" : 6,
    "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,
    "key" : "key",
    "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 vnet-manager-show-response
Up
get /vnet-managers/{vnet-manager-name}/interfaces/{nic}
(showVnetMgrNicByVnmNameByVnic)

Path parameters

vnet-manager-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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 vnet-manager-interface-show-response
Up
get /vnet-managers/{vnet-manager-name}/interfaces
(showVnetMgrNicsByVnetMgrVnmName)

Path parameters

vnet-manager-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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 vnet-manager-interface-show-response
Up
get /vnet-managers/{vnet-manager-name}/services/{if}
(showVnetMgrServiceByVnmNameByNic)

Path parameters

vnet-manager-name (required)
Path Parameter
if (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ssh" : true,
    "netconf" : true,
    "ntp" : true,
    "icmp" : true,
    "api.switch-name" : "api.switch-name",
    "if" : "if"
  }, {
    "ssh" : true,
    "netconf" : true,
    "ntp" : 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 vnet-manager-service-show-response
Up
get /vnet-managers/{vnet-manager-name}/services
(showVnetMgrServicesByVnetMgrVnmName)

Path parameters

vnet-manager-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ssh" : true,
    "netconf" : true,
    "ntp" : true,
    "icmp" : true,
    "api.switch-name" : "api.switch-name",
    "if" : "if"
  }, {
    "ssh" : true,
    "netconf" : true,
    "ntp" : 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 vnet-manager-service-show-response
Up
get /vnet-managers
(showVnetMgrs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "template" : true,
    "failover-action" : "stop-old",
    "failover-controller" : 6,
    "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,
    "key" : "key",
    "gateway" : "gateway"
  }, {
    "template" : true,
    "failover-action" : "stop-old",
    "failover-controller" : 6,
    "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,
    "key" : "key",
    "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 vnet-manager-show-response
Up
put /vnet-managers/{name}
(updateVnetMgrByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body vnet-manager-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnet-managers/{vnet-manager-name}/interfaces/{nic}
(updateVnetMgrNicByVnmNameByVnic)

Path parameters

vnet-manager-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 Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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" : 2,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vlan" : 5,
    "netmask" : 0,
    "linklocal" : "linklocal",
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 1,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 5,
    "vrrp-primary" : "vrrp-primary",
    "assignment" : "none",
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 9,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "vrrp-id" : 7,
    "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 vnet-manager-interface-show-response
Up
put /vnet-managers/{vnet-manager-name}/services/{if}
(updateVnetMgrServiceByVnmNameByNic)

Path parameters

vnet-manager-name (required)
Path Parameter
if (required)
Path Parameter

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ssh" : true,
    "netconf" : true,
    "ntp" : true,
    "icmp" : true,
    "api.switch-name" : "api.switch-name",
    "if" : "if"
  }, {
    "ssh" : true,
    "netconf" : true,
    "ntp" : 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 vnet-manager-service-show-response

VnetPublicVlans

Up
get /vnet-public-vlans
(showVnetPublicVlans)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 vnet-public-vlans-show-response
Up
put /vnet-public-vlans
(updateVnetPublicVlans)

Consumes

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

Request body

body vnet-public-vlans-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Vnets

Up
post /vnets/{vnet-name}/cli-alias
(addVnCmdAliasByVnName)

Path parameters

vnet-name (required)
Path Parameter

Consumes

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

Request body

body vnet-cli-alias-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnets/{vnet-name}/ports
(addVnPortByVnName)

Path parameters

vnet-name (required)
Path Parameter

Consumes

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

Request body

body vnet-port-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnets/{name}/tunnel-networks
(addVnTunnelNetworkByVnName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body vnet-tunnel-network-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnets
(createVn)

Consumes

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

Request body

body vnet-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnets/{name}
(deleteVnByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnets/{vnet-name}/cli-alias/{name}
(removeVnCmdAliasByNameByName)

Path parameters

vnet-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnets/{vnet-name}/ports/{ports}
(removeVnPortByNameByPmap)

Path parameters

vnet-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnets/{name}/tunnel-networks/netmask/{netmask}
(removeVnTunnelNetworkByNameByNetmask)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnets/{name}/tunnel-networks/network/{network}
(removeVnTunnelNetworkByNameByNetwork)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnets/{name}
(showVnByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "vxlan-end" : 9,
    "vlan-type" : "public",
    "admin" : 0,
    "global" : true,
    "num-bridge-domains" : 5,
    "vnet-mgr-storage-pool" : "vnet-mgr-storage-pool",
    "api.switch-name" : "api.switch-name",
    "managed-ports" : "managed-ports",
    "switch" : 1,
    "public-vlans" : "public-vlans",
    "vxlans" : 7,
    "scope" : "local",
    "shared-ports" : "shared-ports",
    "id" : "id",
    "admin_role" : "admin_role",
    "vnet_mgr_id" : "vnet_mgr_id",
    "create-vnet-mgr" : true,
    "vrg_created_by_vnet" : true,
    "vnet_mgr_zone_id" : "vnet_mgr_zone_id",
    "vrg-id" : "vrg-id",
    "vnet_mgr_location" : 6,
    "shared-port-vlans" : "shared-port-vlans",
    "num-private-vlans" : 2,
    "name" : "name",
    "config-admin" : true,
    "num-vlans" : 5,
    "vnet-mgr-name" : "vnet-mgr-name"
  }, {
    "vlans" : "vlans",
    "vxlan-end" : 9,
    "vlan-type" : "public",
    "admin" : 0,
    "global" : true,
    "num-bridge-domains" : 5,
    "vnet-mgr-storage-pool" : "vnet-mgr-storage-pool",
    "api.switch-name" : "api.switch-name",
    "managed-ports" : "managed-ports",
    "switch" : 1,
    "public-vlans" : "public-vlans",
    "vxlans" : 7,
    "scope" : "local",
    "shared-ports" : "shared-ports",
    "id" : "id",
    "admin_role" : "admin_role",
    "vnet_mgr_id" : "vnet_mgr_id",
    "create-vnet-mgr" : true,
    "vrg_created_by_vnet" : true,
    "vnet_mgr_zone_id" : "vnet_mgr_zone_id",
    "vrg-id" : "vrg-id",
    "vnet_mgr_location" : 6,
    "shared-port-vlans" : "shared-port-vlans",
    "num-private-vlans" : 2,
    "name" : "name",
    "config-admin" : true,
    "num-vlans" : 5,
    "vnet-mgr-name" : "vnet-mgr-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 vnet-show-response
Up
get /vnets/{vnet-name}/cli-alias/{name}
(showVnCmdAliasByNameByName)

Path parameters

vnet-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

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vnet-cli-alias-show-response
Up
get /vnets/{vnet-name}/cli-alias
(showVnCmdAliasByVnName)

Path parameters

vnet-name (required)
Path Parameter

Consumes

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

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vnet-cli-alias-show-response
Up
get /vnets/{vnet-name}/ports/{ports}
(showVnPortByNameByPmap)

Path parameters

vnet-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlans" : "vlans",
    "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 vnet-port-show-response
Up
get /vnets/{vnet-name}/ports
(showVnPortsByVnName)

Path parameters

vnet-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "vlans" : "vlans",
    "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 vnet-port-show-response
Up
get /vnets/{name}/tunnel-networks/netmask/{netmask}
(showVnTunnelNetworkByNameByNetmask)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "description" : "description",
    "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 vnet-tunnel-network-show-response
Up
get /vnets/{name}/tunnel-networks/network/{network}
(showVnTunnelNetworkByNameByNetwork)

Path parameters

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

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "description" : "description",
    "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 vnet-tunnel-network-show-response
Up
get /vnets/{name}/tunnel-networks
(showVnTunnelNetworksByVnName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "description" : "description",
    "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 vnet-tunnel-network-show-response
Up
get /vnets
(showVns)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : "vlans",
    "vxlan-end" : 9,
    "vlan-type" : "public",
    "admin" : 0,
    "global" : true,
    "num-bridge-domains" : 5,
    "vnet-mgr-storage-pool" : "vnet-mgr-storage-pool",
    "api.switch-name" : "api.switch-name",
    "managed-ports" : "managed-ports",
    "switch" : 1,
    "public-vlans" : "public-vlans",
    "vxlans" : 7,
    "scope" : "local",
    "shared-ports" : "shared-ports",
    "id" : "id",
    "admin_role" : "admin_role",
    "vnet_mgr_id" : "vnet_mgr_id",
    "create-vnet-mgr" : true,
    "vrg_created_by_vnet" : true,
    "vnet_mgr_zone_id" : "vnet_mgr_zone_id",
    "vrg-id" : "vrg-id",
    "vnet_mgr_location" : 6,
    "shared-port-vlans" : "shared-port-vlans",
    "num-private-vlans" : 2,
    "name" : "name",
    "config-admin" : true,
    "num-vlans" : 5,
    "vnet-mgr-name" : "vnet-mgr-name"
  }, {
    "vlans" : "vlans",
    "vxlan-end" : 9,
    "vlan-type" : "public",
    "admin" : 0,
    "global" : true,
    "num-bridge-domains" : 5,
    "vnet-mgr-storage-pool" : "vnet-mgr-storage-pool",
    "api.switch-name" : "api.switch-name",
    "managed-ports" : "managed-ports",
    "switch" : 1,
    "public-vlans" : "public-vlans",
    "vxlans" : 7,
    "scope" : "local",
    "shared-ports" : "shared-ports",
    "id" : "id",
    "admin_role" : "admin_role",
    "vnet_mgr_id" : "vnet_mgr_id",
    "create-vnet-mgr" : true,
    "vrg_created_by_vnet" : true,
    "vnet_mgr_zone_id" : "vnet_mgr_zone_id",
    "vrg-id" : "vrg-id",
    "vnet_mgr_location" : 6,
    "shared-port-vlans" : "shared-port-vlans",
    "num-private-vlans" : 2,
    "name" : "name",
    "config-admin" : true,
    "num-vlans" : 5,
    "vnet-mgr-name" : "vnet-mgr-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 vnet-show-response
Up
put /vnets/{name}
(updateVnByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Request body

body vnet-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vnets/{vnet-name}/cli-alias/{name}
(updateVnCmdAliasByNameByName)

Path parameters

vnet-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 vnet-cli-alias-modify (optional)
Body Parameter

Return type

Example data

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

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vnet-cli-alias-show-response
Up
put /vnets/{name}/tunnel-networks/netmask/{netmask}
(updateVnTunnelNetworkByNameByNetmask)

Path parameters

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

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "description" : "description",
    "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 vnet-tunnel-network-show-response
Up
put /vnets/{name}/tunnel-networks/network/{network}
(updateVnTunnelNetworkByNameByNetwork)

Path parameters

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

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "description" : "description",
    "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 vnet-tunnel-network-show-response

Vpgs

Up
post /vpgs/{vpg-name}/monitor-ports
(addVpgMonitorPortByVpgName)

Path parameters

vpg-name (required)
Path Parameter

Consumes

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

Request body

body vpg-monitor-port-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vpgs/{vpg-name}/ports
(addVpgPortByVpgName)

Path parameters

vpg-name (required)
Path Parameter

Consumes

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

Request body

body vpg-port-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vpgs
(createVpg)

Consumes

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

Request body

body vpg-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vpgs/{name}
(deleteVpgByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vpgs/{vpg-name}/monitor-ports/{monitor-ports}
(removeVpgMonitorPortByNameByMonitorPorts)

Path parameters

vpg-name (required)
Path Parameter
monitor-ports (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vpgs/{vpg-name}/ports/{ports}
(removeVpgPortByNameByPmap)

Path parameters

vpg-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vpgs/{vpg-name}/ports/port-desc/{port-desc}
(removeVpgPortByNameByPortDesc)

Path parameters

vpg-name (required)
Path Parameter
port-desc (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vpgs/{name}
(showVpgByName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vni" : 0,
    "vlan" : 6,
    "scope" : "scope",
    "monitor-ports" : "monitor-ports",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "port-desc" : "port-desc",
    "type" : "source",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "vni" : 0,
    "vlan" : 6,
    "scope" : "scope",
    "monitor-ports" : "monitor-ports",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "port-desc" : "port-desc",
    "type" : "source",
    "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 vpg-show-response
Up
get /vpgs/{vpg-name}/monitor-ports/{monitor-ports}
(showVpgMonitorPortByNameByMonitorPorts)

Path parameters

vpg-name (required)
Path Parameter
monitor-ports (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "monitor-ports" : "monitor-ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "monitor-ports" : "monitor-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 vpg-monitor-port-show-response
Up
get /vpgs/{vpg-name}/monitor-ports
(showVpgMonitorPortsByVpgName)

Path parameters

vpg-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "monitor-ports" : "monitor-ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "monitor-ports" : "monitor-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 vpg-monitor-port-show-response
Up
get /vpgs/{vpg-name}/ports/{ports}
(showVpgPortByNameByPmap)

Path parameters

vpg-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port-desc" : "port-desc",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "port-desc" : "port-desc",
    "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 vpg-port-show-response
Up
get /vpgs/{vpg-name}/ports/port-desc/{port-desc}
(showVpgPortByNameByPortDesc)

Path parameters

vpg-name (required)
Path Parameter
port-desc (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port-desc" : "port-desc",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "port-desc" : "port-desc",
    "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 vpg-port-show-response
Up
get /vpgs/{vpg-name}/ports
(showVpgPortsByVpgName)

Path parameters

vpg-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "port-desc" : "port-desc",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "port-desc" : "port-desc",
    "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 vpg-port-show-response
Up
get /vpgs
(showVpgs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vni" : 0,
    "vlan" : 6,
    "scope" : "scope",
    "monitor-ports" : "monitor-ports",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "port-desc" : "port-desc",
    "type" : "source",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name"
  }, {
    "vni" : 0,
    "vlan" : 6,
    "scope" : "scope",
    "monitor-ports" : "monitor-ports",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "port-desc" : "port-desc",
    "type" : "source",
    "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 vpg-show-response

VportHistories

Up
get /vport-histories
(showVportHistories)

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 8,
    "reason" : "activate",
    "within-last" : 9,
    "alt-owner-port" : 4,
    "last-reason" : "activate",
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 0,
    "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" : 6,
    "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" : 6,
    "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" : 8,
    "reason" : "activate",
    "within-last" : 9,
    "alt-owner-port" : 4,
    "last-reason" : "activate",
    "vnic-type" : "untagged",
    "since-start" : true,
    "hostname" : "hostname",
    "hit" : 6,
    "local-intf" : 3,
    "public-vlan" : 5,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 0,
    "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" : 6,
    "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" : 6,
    "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 vport-history-show-response

VportSettings

Up
get /vport-settings
(showVportSettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "excess-mac-move-protect-enable" : true,
    "excess-mac-move-queue-protect" : true,
    "retry-interval" : 9,
    "system-stats-max-memory" : 5,
    "vport-disk-space" : 0,
    "api.switch-name" : "api.switch-name",
    "stats-log-disk-space" : 5,
    "loop-prevent" : true,
    "stats-max-memory" : 6,
    "stats-log-enable" : true,
    "excess-ip-move-queue-protect" : true,
    "excess-ip-move-queue-state" : true,
    "excess-mac-move-queue-state" : true,
    "system-stats-log-interval" : 2,
    "stats-log-interval" : 1,
    "system-stats-log-disk-space" : 7,
    "system-stats-log-enable" : true,
    "excess-ip-move-protect-enable" : true
  }, {
    "excess-mac-move-protect-enable" : true,
    "excess-mac-move-queue-protect" : true,
    "retry-interval" : 9,
    "system-stats-max-memory" : 5,
    "vport-disk-space" : 0,
    "api.switch-name" : "api.switch-name",
    "stats-log-disk-space" : 5,
    "loop-prevent" : true,
    "stats-max-memory" : 6,
    "stats-log-enable" : true,
    "excess-ip-move-queue-protect" : true,
    "excess-ip-move-queue-state" : true,
    "excess-mac-move-queue-state" : true,
    "system-stats-log-interval" : 2,
    "stats-log-interval" : 1,
    "system-stats-log-disk-space" : 7,
    "system-stats-log-enable" : true,
    "excess-ip-move-protect-enable" : 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 vport-settings-show-response
Up
put /vport-settings
(updateVportSettings)

Consumes

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

Request body

body vport-settings-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VportStats

Up
post /vport-stats/report
(reportVportStats)

Consumes

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

Request body

body vport-stats-report (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vport-stats
(showVportStats)

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  }, {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vport-stats-show-response
Up
get /vport-stats/bd/{bd}
(showVportStatsByBrDom)

Path parameters

bd (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  }, {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vport-stats-show-response
Up
get /vport-stats/ip/{ip}
(showVportStatsByIp)

Path parameters

ip (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  }, {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vport-stats-show-response
Up
get /vport-stats/mac/{mac}
(showVportStatsByMac)

Path parameters

mac (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  }, {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vport-stats-show-response
Up
get /vport-stats/vlan/{vlan}
(showVportStatsByVlan)

Path parameters

vlan (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  }, {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vport-stats-show-response
Up
get /vport-stats/vnet/{vnet}
(showVportStatsByVnet)

Path parameters

vnet (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  }, {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vport-stats-show-response
Up
get /vport-stats/vxlan/{vxlan}
(showVportStatsByVxlan)

Path parameters

vxlan (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  }, {
    "older-than" : 1,
    "bd" : "bd",
    "within-last" : 6,
    "vs-type" : "none",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vnic-type" : "untagged",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "oerrs" : 2,
    "obytes" : 7,
    "ipkts" : 5,
    "vxlan" : 6,
    "ierrs" : 2,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "ibytes" : 1,
    "count" : 4,
    "odiscards" : 3,
    "idiscards" : 5,
    "opkts" : 9,
    "switch-id" : 7,
    "interval" : 1,
    "time" : "time",
    "entity" : "entity"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vport-stats-show-response

VportSystemStats

Up
post /vport-system-stats/report
(reportVportSystemStats)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vport-system-stats
(showVportSystemStats)

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "time" : "time"
  }, {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "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 vport-system-stats-show-response
Up
get /vport-system-stats/bd/{bd}
(showVportSystemStatsByBrDom)

Path parameters

bd (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "time" : "time"
  }, {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "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 vport-system-stats-show-response
Up
get /vport-system-stats/ip/{ip}
(showVportSystemStatsByIp)

Path parameters

ip (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "time" : "time"
  }, {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "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 vport-system-stats-show-response
Up
get /vport-system-stats/vlan/{vlan}
(showVportSystemStatsByVlan)

Path parameters

vlan (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "time" : "time"
  }, {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "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 vport-system-stats-show-response
Up
get /vport-system-stats/vnet/{vnet}
(showVportSystemStatsByVnet)

Path parameters

vnet (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "time" : "time"
  }, {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "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 vport-system-stats-show-response
Up
get /vport-system-stats/vxlan/{vxlan}
(showVportSystemStatsByVxlan)

Path parameters

vxlan (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "time" : "time"
  }, {
    "older-than" : 7,
    "bd" : "bd",
    "used-mem" : 2,
    "within-last" : 1,
    "cpu-sys" : 7,
    "cpu-total" : 1,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 1,
    "hostname" : "hostname",
    "vlan" : 0,
    "vxlan" : 6,
    "used-swap-val" : 3,
    "start-time" : "start-time",
    "end-time" : "end-time",
    "ip" : "ip",
    "count" : 5,
    "paging" : 2,
    "uptime" : 5,
    "used-mem-val" : 7,
    "cpu-user" : 4,
    "cpu-idle" : 1,
    "switch-id" : 1,
    "interval" : 6,
    "used-swap" : 9,
    "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 vport-system-stats-show-response

Vports

Up
post /vports
(createVport)

Consumes

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

Request body

body vport-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vports/mac={mac},vnet={vnet},bd={bd},vlan={vlan},vxlan={vxlan},ip={ip}
(deleteVportByUniqueKeyAll)

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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vports/mac={mac},vnet={vnet},bd={bd},vlan={vlan},vxlan={vxlan},ip={ip}
(showVportByUniqueKeyAll)

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 3,
    "local-intf" : 5,
    "public-vlan" : 1,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 5,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 2,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 6,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 1,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 4,
    "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" : 7,
    "intf" : 1,
    "alt-owner-state" : "active",
    "rem-intf" : 9,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 7,
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  }, {
    "alt-owner-port" : 7,
    "vnic-type" : "untagged",
    "hostname" : "hostname",
    "hit" : 3,
    "local-intf" : 5,
    "public-vlan" : 1,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 5,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 2,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 6,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 1,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 4,
    "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" : 7,
    "intf" : 1,
    "alt-owner-state" : "active",
    "rem-intf" : 9,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 7,
    "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 vport-show-response
Up
get /vports
(showVports)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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" : 3,
    "local-intf" : 5,
    "public-vlan" : 1,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 5,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 2,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 6,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 1,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 4,
    "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" : 7,
    "intf" : 1,
    "alt-owner-state" : "active",
    "rem-intf" : 9,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 7,
    "config" : "none",
    "entity" : "entity",
    "tunnel" : "tunnel"
  }, {
    "alt-owner-port" : 7,
    "vnic-type" : "untagged",
    "hostname" : "hostname",
    "hit" : 3,
    "local-intf" : 5,
    "public-vlan" : 1,
    "vxlan-lru" : "vxlan-lru",
    "state" : "active",
    "vxlan" : 6,
    "ip" : "ip",
    "create-time" : "create-time",
    "inner-vlan" : 5,
    "vswitch" : "vswitch",
    "peer-intf" : 5,
    "peer-state" : "active",
    "pg-vlans" : "pg-vlans",
    "svc-name" : "svc-name",
    "local-state" : "active",
    "status" : "phy-up",
    "migrate" : 2,
    "bd" : "bd",
    "last-seen-since" : "last-seen-since",
    "config-intf" : 6,
    "vs-type" : "none",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "num-ips" : 1,
    "rem-switch" : 1,
    "vnet" : "vnet",
    "peer-owner-state" : "active",
    "hw-flags" : "invalid-vlan",
    "hw-index" : 4,
    "alt-owner" : 2,
    "drops" : 4,
    "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" : 7,
    "intf" : 1,
    "alt-owner-state" : "active",
    "rem-intf" : 9,
    "last-seen" : "last-seen",
    "portgroup" : "portgroup",
    "rt-if" : "rt-if",
    "mc-index" : 7,
    "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 vport-show-response
Up
put /vports/mac={mac},vnet={vnet},bd={bd},vlan={vlan},vxlan={vxlan},ip={ip}
(updateVportByUniqueKeyAll)

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:

Request body

body vport-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VrfMroutes

Up
get /vrf-mroutes
(showVrfMroutes)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "vrid" : 1,
    "encap-id" : 7,
    "srcip" : "srcip",
    "bd" : "bd",
    "send-bd" : "send-bd",
    "hw-group-id" : "hw-group-id",
    "flags" : "Trunk",
    "srcip-mask" : 5,
    "type" : "<*",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "send-vlan" : 2,
    "vlan" : 6,
    "group-mask" : 5,
    "vnet-id" : "vnet-id",
    "group" : "group"
  }, {
    "vxlan" : 0,
    "vrid" : 1,
    "encap-id" : 7,
    "srcip" : "srcip",
    "bd" : "bd",
    "send-bd" : "send-bd",
    "hw-group-id" : "hw-group-id",
    "flags" : "Trunk",
    "srcip-mask" : 5,
    "type" : "<*",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "send-vlan" : 2,
    "vlan" : 6,
    "group-mask" : 5,
    "vnet-id" : "vnet-id",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrf-mroute-show-response

VrfMulticast

Up
get /vrf-multicast
(showDistributedMulticast)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "enable" : true,
    "scope" : "local",
    "api.switch-name" : "api.switch-name"
  }, {
    "enable" : true,
    "scope" : "local",
    "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 vrf-multicast-show-response
Up
put /vrf-multicast
(updateDistributedMulticast)

Consumes

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

Request body

body vrf-multicast-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VrfMulticastFlood

Up
get /vrf-multicast-flood
(showDistributedMulticastFlood)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "enable" : true,
    "scope" : "local",
    "api.switch-name" : "api.switch-name"
  }, {
    "enable" : true,
    "scope" : "local",
    "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 vrf-multicast-flood-show-response
Up
put /vrf-multicast-flood
(updateDistributedMulticastFlood)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VrfMulticastIgmp

Up
get /vrf-multicast-igmp
(showDistributedMulticastIgmp)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "use-table" : true,
    "scope" : "local",
    "api.switch-name" : "api.switch-name"
  }, {
    "use-table" : true,
    "scope" : "local",
    "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 vrf-multicast-igmp-show-response
Up
put /vrf-multicast-igmp
(updateDistributedMulticastIgmp)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Vrfs

Up
post /vrfs/name={name},vnet-id={vnet-id}/routes
(addVrfVrfRouteByUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Request body

body vrf-route-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrfs
(createVrf)

Consumes

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

Request body

body vrf-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrfs/name={name},vnet-id={vnet-id}
(deleteVrfByUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrfs/name={name},vnet-id={vnet-id}/routes
(removeVrfVrfRouteByUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Request body

body vrf-route-remove (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrfs/name={name},vnet-id={vnet-id}
(showVrfByUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrf-gw2-ip6" : "vrf-gw2-ip6",
    "vnet_name" : "vnet_name",
    "vrf-gw" : "vrf-gw",
    "vrf-gw2" : "vrf-gw2",
    "flags" : "subnet",
    "active" : true,
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "enable" : true,
    "anycast-mac-for-forwarding" : true,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "anycast-mac" : "anycast-mac",
    "l3-vni" : 6,
    "vrf-gw-ip6" : "vrf-gw-ip6",
    "hw-router-mac" : "hw-router-mac",
    "hw-vrid" : 0
  }, {
    "vrf-gw2-ip6" : "vrf-gw2-ip6",
    "vnet_name" : "vnet_name",
    "vrf-gw" : "vrf-gw",
    "vrf-gw2" : "vrf-gw2",
    "flags" : "subnet",
    "active" : true,
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "enable" : true,
    "anycast-mac-for-forwarding" : true,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "anycast-mac" : "anycast-mac",
    "l3-vni" : 6,
    "vrf-gw-ip6" : "vrf-gw-ip6",
    "hw-router-mac" : "hw-router-mac",
    "hw-vrid" : 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 vrf-show-response
Up
get /vrfs/name={name},vnet-id={vnet-id}/routes
(showVrfVrfRouteByUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "scope" : "scope",
    "active" : true,
    "router-mac" : "router-mac",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "scope" : "scope",
    "active" : true,
    "router-mac" : "router-mac",
    "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 vrf-route-show-response
Up
get /vrfs/name={name},vnet-id={vnet-id}/routes/network={network},netmask={netmask},gateway-ip={gateway-ip}
(showVrfVrfRouteByUniqueKeyAllSublist)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
gateway-ip (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "scope" : "scope",
    "active" : true,
    "router-mac" : "router-mac",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "scope" : "scope",
    "active" : true,
    "router-mac" : "router-mac",
    "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 vrf-route-show-response
Up
get /vrfs
(showVrfs)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrf-gw2-ip6" : "vrf-gw2-ip6",
    "vnet_name" : "vnet_name",
    "vrf-gw" : "vrf-gw",
    "vrf-gw2" : "vrf-gw2",
    "flags" : "subnet",
    "active" : true,
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "enable" : true,
    "anycast-mac-for-forwarding" : true,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "anycast-mac" : "anycast-mac",
    "l3-vni" : 6,
    "vrf-gw-ip6" : "vrf-gw-ip6",
    "hw-router-mac" : "hw-router-mac",
    "hw-vrid" : 0
  }, {
    "vrf-gw2-ip6" : "vrf-gw2-ip6",
    "vnet_name" : "vnet_name",
    "vrf-gw" : "vrf-gw",
    "vrf-gw2" : "vrf-gw2",
    "flags" : "subnet",
    "active" : true,
    "description" : "description",
    "api.switch-name" : "api.switch-name",
    "enable" : true,
    "anycast-mac-for-forwarding" : true,
    "scope" : "local",
    "name" : "name",
    "vnet-id" : "vnet-id",
    "anycast-mac" : "anycast-mac",
    "l3-vni" : 6,
    "vrf-gw-ip6" : "vrf-gw-ip6",
    "hw-router-mac" : "hw-router-mac",
    "hw-vrid" : 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 vrf-show-response
Up
put /vrfs/name={name},vnet-id={vnet-id}
(updateVrfByUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vnet-id (required)
Path Parameter

Consumes

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

Request body

body vrf-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VrouterCachedRoutes

Up
get /vrouter-cached-routes
(showCachedRoutes)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 0,
    "vxlan" : 5,
    "bd" : "bd",
    "vlan" : 1,
    "prelen" : 6,
    "age-in-seconds" : 2,
    "ip" : "ip",
    "vnet-id" : "vnet-id",
    "index" : 5,
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop"
  }, {
    "vrid" : 0,
    "vxlan" : 5,
    "bd" : "bd",
    "vlan" : 1,
    "prelen" : 6,
    "age-in-seconds" : 2,
    "ip" : "ip",
    "vnet-id" : "vnet-id",
    "index" : 5,
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-cached-routes-show-response

VrouterEcmpCachedRoutes

Up
get /vrouter-ecmp-cached-routes
(showEcmpCachedRoutes)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 0,
    "vlan" : 1,
    "prelen" : 6,
    "age-in-seconds" : 5,
    "ip" : "ip",
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop"
  }, {
    "vrid" : 0,
    "vlan" : 1,
    "prelen" : 6,
    "age-in-seconds" : 5,
    "ip" : "ip",
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-ecmp-cached-routes-show-response

VrouterEcmpGroups

Up
get /vrouter-ecmp-groups
(showEcmpGroups)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 0,
    "ecmp-group" : 5,
    "nexthop_ip" : "nexthop_ip",
    "ecmp-ref-count" : 1,
    "api.switch-name" : "api.switch-name",
    "nexthop_count" : 6,
    "hash-type" : "static-fixed"
  }, {
    "vrid" : 0,
    "ecmp-group" : 5,
    "nexthop_ip" : "nexthop_ip",
    "ecmp-ref-count" : 1,
    "api.switch-name" : "api.switch-name",
    "nexthop_count" : 6,
    "hash-type" : "static-fixed"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-ecmp-group-show-response

VrouterFibArps

Up
get /vrouter-fib-arps
(showHwArps)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 0,
    "egress-id" : 5,
    "bd" : "bd",
    "vlan" : 6,
    "ip" : "ip",
    "flags" : "ECMP",
    "vnet-id" : "vnet-id",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "if-id" : 1,
    "mac" : "mac"
  }, {
    "vrid" : 0,
    "egress-id" : 5,
    "bd" : "bd",
    "vlan" : 6,
    "ip" : "ip",
    "flags" : "ECMP",
    "vnet-id" : "vnet-id",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "if-id" : 1,
    "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 vrouter-fib-arps-show-response

VrouterFibRoutes

Up
get /vrouter-fib-routes
(showHwRoutes)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 0,
    "if-ip" : "if-ip",
    "bd" : "bd",
    "intf-id" : 5,
    "prelen" : 6,
    "ecmp-group" : 2,
    "ip" : "ip",
    "flags" : "ECMP",
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop",
    "egress-id" : 7,
    "vlan" : 1,
    "port" : 5,
    "nexthop-mac" : "nexthop-mac",
    "vnet-id" : "vnet-id",
    "state" : "up"
  }, {
    "vrid" : 0,
    "if-ip" : "if-ip",
    "bd" : "bd",
    "intf-id" : 5,
    "prelen" : 6,
    "ecmp-group" : 2,
    "ip" : "ip",
    "flags" : "ECMP",
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop",
    "egress-id" : 7,
    "vlan" : 1,
    "port" : 5,
    "nexthop-mac" : "nexthop-mac",
    "vnet-id" : "vnet-id",
    "state" : "up"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-fib-routes-show-response

VrouterLogs

Up
post /vrouter-logs/clear
(clearVrouterProtoLog)

Consumes

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

Request body

body vrouter-log-clear (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouter-logs/{vrouter-name}
(showVrouterProtoLogs)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "protocol" : "zebra",
    "vrouter-name" : "vrouter-name",
    "api.switch-name" : "api.switch-name"
  }, {
    "protocol" : "zebra",
    "vrouter-name" : "vrouter-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 vrouter-log-show-response

VrouterMfibRoutes

Up
get /vrouter-mfib-routes
(showHwMroutes)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 6,
    "encap-id" : 2,
    "srcip" : "srcip",
    "bd" : "bd",
    "send-bd" : "send-bd",
    "hw-group-id" : "hw-group-id",
    "flags" : "Trunk",
    "srcip-mask" : 1,
    "type" : "<*",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "send-vlan" : 5,
    "vlan" : 0,
    "group-mask" : 5,
    "vnet-id" : "vnet-id",
    "group" : "group"
  }, {
    "vrid" : 6,
    "encap-id" : 2,
    "srcip" : "srcip",
    "bd" : "bd",
    "send-bd" : "send-bd",
    "hw-group-id" : "hw-group-id",
    "flags" : "Trunk",
    "srcip-mask" : 1,
    "type" : "<*",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "send-vlan" : 5,
    "vlan" : 0,
    "group-mask" : 5,
    "vnet-id" : "vnet-id",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-mfib-routes-show-response

VrouterMribRoutes

Up
get /vrouter-mrib-routes/srcip={srcip},group={group},vlan={vlan}
(showMribRouteByUniqueKeyAll)

Path parameters

srcip (required)
Path Parameter
group (required)
Path Parameter
vlan (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 6,
    "srcip" : "srcip",
    "vlan" : 0,
    "vnic-vlan" : 1,
    "vnic" : "vnic",
    "hw-group-id" : "hw-group-id",
    "flags" : "in-hw",
    "type" : "<*",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  }, {
    "vrid" : 6,
    "srcip" : "srcip",
    "vlan" : 0,
    "vnic-vlan" : 1,
    "vnic" : "vnic",
    "hw-group-id" : "hw-group-id",
    "flags" : "in-hw",
    "type" : "<*",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-mrib-routes-show-response
Up
get /vrouter-mrib-routes
(showMribRoutes)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 6,
    "srcip" : "srcip",
    "vlan" : 0,
    "vnic-vlan" : 1,
    "vnic" : "vnic",
    "hw-group-id" : "hw-group-id",
    "flags" : "in-hw",
    "type" : "<*",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  }, {
    "vrid" : 6,
    "srcip" : "srcip",
    "vlan" : 0,
    "vnic-vlan" : 1,
    "vnic" : "vnic",
    "hw-group-id" : "hw-group-id",
    "flags" : "in-hw",
    "type" : "<*",
    "ports" : "ports",
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-mrib-routes-show-response

VrouterRibHistories

Up
get /vrouter-rib-histories
(showRibHistories)

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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "reason" : "save",
    "bd" : "bd",
    "within-last" : 1,
    "prelen" : 6,
    "ecmp-group" : 5,
    "changes" : "changes",
    "flags" : "ECMP",
    "last-reason" : "save",
    "number-of-nexthops" : 3,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 4,
    "vlan" : 0,
    "ecmp-nexthops" : true,
    "vnet-id" : "vnet-id",
    "vrid" : 9,
    "start-time" : "start-time",
    "intf-id" : 2,
    "last-caller" : "init",
    "end-time" : "end-time",
    "ip" : "ip",
    "intf-ip" : "intf-ip",
    "count" : 2,
    "nexthop" : "nexthop",
    "egress-id" : 5,
    "number-of-tunnels" : 7,
    "caller" : "init",
    "address-type" : "IPv4",
    "interval" : 7,
    "time" : "time",
    "nexthops-in-hw" : 1
  }, {
    "older-than" : 1,
    "reason" : "save",
    "bd" : "bd",
    "within-last" : 1,
    "prelen" : 6,
    "ecmp-group" : 5,
    "changes" : "changes",
    "flags" : "ECMP",
    "last-reason" : "save",
    "number-of-nexthops" : 3,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 4,
    "vlan" : 0,
    "ecmp-nexthops" : true,
    "vnet-id" : "vnet-id",
    "vrid" : 9,
    "start-time" : "start-time",
    "intf-id" : 2,
    "last-caller" : "init",
    "end-time" : "end-time",
    "ip" : "ip",
    "intf-ip" : "intf-ip",
    "count" : 2,
    "nexthop" : "nexthop",
    "egress-id" : 5,
    "number-of-tunnels" : 7,
    "caller" : "init",
    "address-type" : "IPv4",
    "interval" : 7,
    "time" : "time",
    "nexthops-in-hw" : 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 vrouter-rib-history-show-response
Up
get /vrouter-rib-histories/ip={ip},prelen={prelen},nexthop={nexthop},vnet-id={vnet-id},bd={bd},vlan={vlan}
(showRibHistoryByUniqueKeyAll)

Path parameters

ip (required)
Path Parameter
prelen (required)
Path Parameter
nexthop (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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "reason" : "save",
    "bd" : "bd",
    "within-last" : 1,
    "prelen" : 6,
    "ecmp-group" : 5,
    "changes" : "changes",
    "flags" : "ECMP",
    "last-reason" : "save",
    "number-of-nexthops" : 3,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 4,
    "vlan" : 0,
    "ecmp-nexthops" : true,
    "vnet-id" : "vnet-id",
    "vrid" : 9,
    "start-time" : "start-time",
    "intf-id" : 2,
    "last-caller" : "init",
    "end-time" : "end-time",
    "ip" : "ip",
    "intf-ip" : "intf-ip",
    "count" : 2,
    "nexthop" : "nexthop",
    "egress-id" : 5,
    "number-of-tunnels" : 7,
    "caller" : "init",
    "address-type" : "IPv4",
    "interval" : 7,
    "time" : "time",
    "nexthops-in-hw" : 1
  }, {
    "older-than" : 1,
    "reason" : "save",
    "bd" : "bd",
    "within-last" : 1,
    "prelen" : 6,
    "ecmp-group" : 5,
    "changes" : "changes",
    "flags" : "ECMP",
    "last-reason" : "save",
    "number-of-nexthops" : 3,
    "api.switch-name" : "api.switch-name",
    "since-start" : true,
    "duration" : 4,
    "vlan" : 0,
    "ecmp-nexthops" : true,
    "vnet-id" : "vnet-id",
    "vrid" : 9,
    "start-time" : "start-time",
    "intf-id" : 2,
    "last-caller" : "init",
    "end-time" : "end-time",
    "ip" : "ip",
    "intf-ip" : "intf-ip",
    "count" : 2,
    "nexthop" : "nexthop",
    "egress-id" : 5,
    "number-of-tunnels" : 7,
    "caller" : "init",
    "address-type" : "IPv4",
    "interval" : 7,
    "time" : "time",
    "nexthops-in-hw" : 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 vrouter-rib-history-show-response

VrouterRibHistorySettings

Up
get /vrouter-rib-history-settings
(showRibHistorySettings)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "disk-space" : 0,
    "enable" : true,
    "api.switch-name" : "api.switch-name",
    "log-file-count" : 6
  }, {
    "disk-space" : 0,
    "enable" : true,
    "api.switch-name" : "api.switch-name",
    "log-file-count" : 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 vrouter-rib-history-settings-show-response
Up
put /vrouter-rib-history-settings
(updateRibHistorySettings)

Consumes

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

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VrouterRibRoutes

Up
get /vrouter-rib-routes/lookup/vrid={vrid},ip={ip}
(lookupRibRouteByVridIp)

Path parameters

vrid (required)
Path Parameter
ip (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 1,
    "bd" : "bd",
    "intf-id" : 7,
    "prelen" : 0,
    "ecmp-group" : 9,
    "ip" : "ip",
    "flags" : "ECMP",
    "intf-ip" : "intf-ip",
    "number-of-nexthops" : 5,
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop",
    "number-of-tunnels" : 2,
    "egress-id" : 3,
    "address-type" : "IPv4",
    "vlan" : 6,
    "ecmp-nexthops" : true,
    "vnet-id" : "vnet-id",
    "nexthops-in-hw" : 5
  }, {
    "vrid" : 1,
    "bd" : "bd",
    "intf-id" : 7,
    "prelen" : 0,
    "ecmp-group" : 9,
    "ip" : "ip",
    "flags" : "ECMP",
    "intf-ip" : "intf-ip",
    "number-of-nexthops" : 5,
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop",
    "number-of-tunnels" : 2,
    "egress-id" : 3,
    "address-type" : "IPv4",
    "vlan" : 6,
    "ecmp-nexthops" : true,
    "vnet-id" : "vnet-id",
    "nexthops-in-hw" : 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 vrouter-rib-routes-show-response
Up
get /vrouter-rib-routes/ip={ip},prelen={prelen},nexthop={nexthop},vnet-id={vnet-id},bd={bd},vlan={vlan}
(showRibRouteByUniqueKeyAll)

Path parameters

ip (required)
Path Parameter
prelen (required)
Path Parameter
nexthop (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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 1,
    "bd" : "bd",
    "intf-id" : 7,
    "prelen" : 0,
    "ecmp-group" : 9,
    "ip" : "ip",
    "flags" : "ECMP",
    "intf-ip" : "intf-ip",
    "number-of-nexthops" : 5,
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop",
    "number-of-tunnels" : 2,
    "egress-id" : 3,
    "address-type" : "IPv4",
    "vlan" : 6,
    "ecmp-nexthops" : true,
    "vnet-id" : "vnet-id",
    "nexthops-in-hw" : 5
  }, {
    "vrid" : 1,
    "bd" : "bd",
    "intf-id" : 7,
    "prelen" : 0,
    "ecmp-group" : 9,
    "ip" : "ip",
    "flags" : "ECMP",
    "intf-ip" : "intf-ip",
    "number-of-nexthops" : 5,
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop",
    "number-of-tunnels" : 2,
    "egress-id" : 3,
    "address-type" : "IPv4",
    "vlan" : 6,
    "ecmp-nexthops" : true,
    "vnet-id" : "vnet-id",
    "nexthops-in-hw" : 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 vrouter-rib-routes-show-response
Up
get /vrouter-rib-routes
(showRibRoutes)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vrid" : 1,
    "bd" : "bd",
    "intf-id" : 7,
    "prelen" : 0,
    "ecmp-group" : 9,
    "ip" : "ip",
    "flags" : "ECMP",
    "intf-ip" : "intf-ip",
    "number-of-nexthops" : 5,
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop",
    "number-of-tunnels" : 2,
    "egress-id" : 3,
    "address-type" : "IPv4",
    "vlan" : 6,
    "ecmp-nexthops" : true,
    "vnet-id" : "vnet-id",
    "nexthops-in-hw" : 5
  }, {
    "vrid" : 1,
    "bd" : "bd",
    "intf-id" : 7,
    "prelen" : 0,
    "ecmp-group" : 9,
    "ip" : "ip",
    "flags" : "ECMP",
    "intf-ip" : "intf-ip",
    "number-of-nexthops" : 5,
    "api.switch-name" : "api.switch-name",
    "nexthop" : "nexthop",
    "number-of-tunnels" : 2,
    "egress-id" : 3,
    "address-type" : "IPv4",
    "vlan" : 6,
    "ecmp-nexthops" : true,
    "vnet-id" : "vnet-id",
    "nexthops-in-hw" : 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 vrouter-rib-routes-show-response

VrouterRoutesStats

Up
get /vrouter-routes-stats
(showRouteStats)

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "fib-current-routes" : 6,
    "rib-current-routes" : 1,
    "fib-max-routes" : 0,
    "hw-overflow" : 3,
    "ecmp-cached-routes" : 2,
    "hw-add-fail" : 2,
    "api.switch-name" : "api.switch-name",
    "nexthop-arp-fail" : 9,
    "peak-ecmp-cached-routes" : 7,
    "vrouter-name" : "vrouter-name",
    "peak-cached-routes" : 5,
    "cached-routes" : 5,
    "ecmp-hw-group-fail" : 4
  }, {
    "fib-current-routes" : 6,
    "rib-current-routes" : 1,
    "fib-max-routes" : 0,
    "hw-overflow" : 3,
    "ecmp-cached-routes" : 2,
    "hw-add-fail" : 2,
    "api.switch-name" : "api.switch-name",
    "nexthop-arp-fail" : 9,
    "peak-ecmp-cached-routes" : 7,
    "vrouter-name" : "vrouter-name",
    "peak-cached-routes" : 5,
    "cached-routes" : 5,
    "ecmp-hw-group-fail" : 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 vrouter-routes-stats-show-response

Vrouters

Up
post /vrouters/{vrouter-name}/interface-config-raprefixes
(addVrouterAdvPrefixByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgp-aggregate-addresses
(addVrouterBgpAggrAddrByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgps
(addVrouterBgpByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-bgp-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/community-lists
(addVrouterBgpCommunityListByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgp-networks
(addVrouterBgpNetworkByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-bgp-network-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/igmp-static-joins
(addVrouterIgmpStaticJoinByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/loopback-interfaces
(addVrouterLoopbackByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/mac-lists
(addVrouterMacListByVrouterVnmNameUsage1)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-mac-list-add-1 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/interfaces
(addVrouterNicByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-interface-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/interface-configs
(addVrouterNicConfigByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/interface-ips
(addVrouterNicIpByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-interface-ip-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/ospf6s
(addVrouterOspf6ByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-ospf6-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/ospf-areas
(addVrouterOspfAreaByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-ospf-area-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/ospfs
(addVrouterOspfByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-ospf-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/packet-relays
(addVrouterPacketRelayByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-packet-relay-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/pim-rps
(addVrouterPimRpByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-pim-rp-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/pim-ssm-maps
(addVrouterPimSsmMapByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-pim-ssm-map-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/pim-ssm-ranges
(addVrouterPimSsmRangeByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/prefix-lists
(addVrouterPrefixListByVrouterVnmNameUsage2)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/rips
(addVrouterRipByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-rip-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/route-maps
(addVrouterRouteMapByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-route-map-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/static-bfds
(addVrouterStaticBfdByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-static-bfd-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/static-routes
(addVrouterStaticRouteByVrouterVnmNameUsage1)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/vrfs
(addVrouterVrouterVrfByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

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

Request body

body vrouter-vrf-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bfd-flapcounts/clear
(clearVrouterBfdNeighborFlapcountClearAllByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bfd-neighbor-flapcounts/clear
(clearVrouterBfdNeighborFlapcountClearNgbrByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters
(createVrouterByUsage4)

Consumes

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

Request body

body vrouter-create-4 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{name}
(deleteVrouterByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/migrate
(migrateVrouter)

Consumes

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

Request body

body vrouter-migrate (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgp-neighbors/no-shutdown
(noShutdownVrouterBgpNeighborByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/evpn-bgp-neighbors/no-shutdown
(noShutdownVrouterEvpnBgpNeighborByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/interface-config-raprefixes/v6-ra-prefix/{v6-ra-prefix}
(removeVrouterAdvPrefixByVnmNameByV6Prefix)

Path parameters

vrouter-name (required)
Path Parameter
v6-ra-prefix (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/interface-config-raprefixes/nic/{nic}
(removeVrouterAdvPrefixByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgp-aggregate-addresses/network={network},netmask={netmask},vrf={vrf}
(removeVrouterBgpAggrAddrByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgps/l3-port/{l3-port}
(removeVrouterBgpByVnmNameByL3Port)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgps/neighbor/{neighbor}
(removeVrouterBgpByVnmNameByNeighbor)

Path parameters

vrouter-name (required)
Path Parameter
neighbor (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgps/vrf/{vrf}
(removeVrouterBgpByVnmNameByVrf)

Path parameters

vrouter-name (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/community-lists/style={style},name={name},action={action},community-attribute={community-attribute}
(removeVrouterBgpCommunityListByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
style (required)
Path Parameter
name (required)
Path Parameter
action (required)
Path Parameter
community-attribute (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgp-networks/network={network},netmask={netmask},vrf={vrf}
(removeVrouterBgpNetworkByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/igmp-static-joins/{name}
(removeVrouterIgmpStaticJoinByVnmNameByName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/loopback-interfaces/{index}
(removeVrouterLoopbackByVnmNameByIndex)

Path parameters

vrouter-name (required)
Path Parameter
index (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/mac-lists/name={name},seq={seq}
(removeVrouterMacListByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
name (required)
Path Parameter
seq (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/interfaces/l3-port/{l3-port}
(removeVrouterNicByVnmNameByL3port)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/interfaces/nic/{nic}
(removeVrouterNicByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/interface-configs/l3-port/{l3-port}
(removeVrouterNicConfigByVnmNameByL3Port)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/interface-configs/nic/{nic}
(removeVrouterNicConfigByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/interface-ips/nic={nic},ip={ip},vrf={vrf}
(removeVrouterNicIpByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
nic (required)
Path Parameter
ip (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/ospf6s/{nic}
(removeVrouterOspf6ByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/ospf-areas/{area}
(removeVrouterOspfAreaByVnmNameByArea)

Path parameters

vrouter-name (required)
Path Parameter
area (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/ospfs/network={network},vrf={vrf}
(removeVrouterOspfByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/packet-relays/forward-proto={forward-proto},forward-ip={forward-ip},nic={nic}
(removeVrouterPacketRelayByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
forward-proto (required)
Path Parameter
forward-ip (required)
Path Parameter
nic (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/pim-rps/rp-address={rp-address},group={group},netmask={netmask}
(removeVrouterPimRpByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
rp-address (required)
Path Parameter
group (required)
Path Parameter
netmask (required)
Path Parameter

Consumes

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

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/pim-ssm-maps/id={id},group={group},source={source}
(removeVrouterPimSsmMapByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
id (required)
Path Parameter
group (required)
Path Parameter
source (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/pim-ssm-ranges/id={id},group={group},netmask={netmask}
(removeVrouterPimSsmRangeByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
id (required)
Path Parameter
group (required)
Path Parameter
netmask (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/prefix-lists/name={name},seq={seq}
(removeVrouterPrefixListByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
name (required)
Path Parameter
seq (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/rips/{network}
(removeVrouterRipByVnmNameByNetwork)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/route-maps/name={name},seq={seq}
(removeVrouterRouteMapByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
name (required)
Path Parameter
seq (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/static-bfds/src-ip={src-ip},dst-ip={dst-ip},vrf={vrf}
(removeVrouterStaticBfdByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
src-ip (required)
Path Parameter
dst-ip (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/static-routes/network={network},netmask={netmask},gateway-ip={gateway-ip},interface={interface},vrf={vrf}
(removeVrouterStaticRouteByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
gateway-ip (required)
Path Parameter
interface (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/vrfs/{vrf}
(removeVrouterVrouterVrfByVnmNameByVrfName)

Path parameters

vrouter-name (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgp-neighbors/reset-all
(resetAllVrouterBgpNeighborByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/evpn-bgp-neighbors/reset-all
(resetAllVrouterEvpnBgpNeighborByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgp-neighbors/reset
(resetVrouterBgpNeighborByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/evpn-bgp-neighbors/reset
(resetVrouterEvpnBgpNeighborByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/interface-config-raprefixes/v6-ra-prefix/{v6-ra-prefix}
(showVrouterAdvPrefixByVnmNameByV6Prefix)

Path parameters

vrouter-name (required)
Path Parameter
v6-ra-prefix (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "v6-ra-prefix" : "v6-ra-prefix",
    "prefix-netmask" : 0,
    "nic" : "nic",
    "autoconf" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "v6-ra-prefix" : "v6-ra-prefix",
    "prefix-netmask" : 0,
    "nic" : "nic",
    "autoconf" : 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 vrouter-interface-config-raprefix-show-response
Up
get /vrouters/{vrouter-name}/interface-config-raprefixes/nic/{nic}
(showVrouterAdvPrefixByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "v6-ra-prefix" : "v6-ra-prefix",
    "prefix-netmask" : 0,
    "nic" : "nic",
    "autoconf" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "v6-ra-prefix" : "v6-ra-prefix",
    "prefix-netmask" : 0,
    "nic" : "nic",
    "autoconf" : 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 vrouter-interface-config-raprefix-show-response
Up
get /vrouters/{vrouter-name}/interface-config-raprefixes
(showVrouterAdvPrefixesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "v6-ra-prefix" : "v6-ra-prefix",
    "prefix-netmask" : 0,
    "nic" : "nic",
    "autoconf" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "v6-ra-prefix" : "v6-ra-prefix",
    "prefix-netmask" : 0,
    "nic" : "nic",
    "autoconf" : 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 vrouter-interface-config-raprefix-show-response
Up
get /vrouters/{vrouter-name}/bfd-neighbors
(showVrouterBfdNeighborsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "local-discr" : 1,
    "remote-router" : "remote-router",
    "out-addr" : "out-addr",
    "tx-int" : 2,
    "multiplier" : 6,
    "flap-count" : 5,
    "vrf" : "vrf",
    "up/down" : "up/down",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "rx-int" : 7,
    "cumulative-count" : 9,
    "holdown" : 0,
    "remote-discr" : 5,
    "state" : "unknown",
    "last-clear-time" : "last-clear-time"
  }, {
    "local-discr" : 1,
    "remote-router" : "remote-router",
    "out-addr" : "out-addr",
    "tx-int" : 2,
    "multiplier" : 6,
    "flap-count" : 5,
    "vrf" : "vrf",
    "up/down" : "up/down",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "rx-int" : 7,
    "cumulative-count" : 9,
    "holdown" : 0,
    "remote-discr" : 5,
    "state" : "unknown",
    "last-clear-time" : "last-clear-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 vrouter-bfd-neighbor-show-response
Up
get /vrouters/{vrouter-name}/bgp-aggregate-addresses/network={network},netmask={netmask},vrf={vrf}
(showVrouterBgpAggrAddrsByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "route-map" : "route-map",
    "netmask" : 0,
    "origin" : "none",
    "as-set" : true,
    "matching-MED-only" : true,
    "vrf" : "vrf",
    "suppress-map" : "suppress-map",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "summary-only" : true
  }, {
    "route-map" : "route-map",
    "netmask" : 0,
    "origin" : "none",
    "as-set" : true,
    "matching-MED-only" : true,
    "vrf" : "vrf",
    "suppress-map" : "suppress-map",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "summary-only" : 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 vrouter-bgp-aggregate-address-show-response
Up
get /vrouters/{vrouter-name}/bgp-aggregate-addresses
(showVrouterBgpAggrAddrsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "route-map" : "route-map",
    "netmask" : 0,
    "origin" : "none",
    "as-set" : true,
    "matching-MED-only" : true,
    "vrf" : "vrf",
    "suppress-map" : "suppress-map",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "summary-only" : true
  }, {
    "route-map" : "route-map",
    "netmask" : 0,
    "origin" : "none",
    "as-set" : true,
    "matching-MED-only" : true,
    "vrf" : "vrf",
    "suppress-map" : "suppress-map",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "summary-only" : 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 vrouter-bgp-aggregate-address-show-response
Up
get /vrouters/{vrouter-name}/bgp-path-lists
(showVrouterBgpAspathsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "api.switch-name" : "api.switch-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 vrouter-bgp-path-list-show-response
Up
get /vrouters/{vrouter-name}/bgps/l3-port/{l3-port}
(showVrouterBgpByVnmNameByL3Port)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : true
  }, {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : 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 vrouter-bgp-show-response
Up
get /vrouters/{vrouter-name}/bgps/neighbor/{neighbor}
(showVrouterBgpByVnmNameByNeighbor)

Path parameters

vrouter-name (required)
Path Parameter
neighbor (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : true
  }, {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : 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 vrouter-bgp-show-response
Up
get /vrouters/{vrouter-name}/bgps/vrf/{vrf}
(showVrouterBgpByVnmNameByVrf)

Path parameters

vrouter-name (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : true
  }, {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : 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 vrouter-bgp-show-response
Up
get /vrouters/{vrouter-name}/community-lists/style={style},name={name},action={action},community-attribute={community-attribute}
(showVrouterBgpCommunityListsByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
style (required)
Path Parameter
name (required)
Path Parameter
action (required)
Path Parameter
community-attribute (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "community-attribute" : "community-attribute",
    "name" : "name",
    "action" : "permit",
    "style" : "standard",
    "api.switch-name" : "api.switch-name"
  }, {
    "community-attribute" : "community-attribute",
    "name" : "name",
    "action" : "permit",
    "style" : "standard",
    "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 vrouter-community-list-show-response
Up
get /vrouters/{vrouter-name}/community-lists
(showVrouterBgpCommunityListsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "community-attribute" : "community-attribute",
    "name" : "name",
    "action" : "permit",
    "style" : "standard",
    "api.switch-name" : "api.switch-name"
  }, {
    "community-attribute" : "community-attribute",
    "name" : "name",
    "action" : "permit",
    "style" : "standard",
    "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 vrouter-community-list-show-response
Up
get /vrouters/{vrouter-name}/bgp-neighbors/neighbor/{neighbor}
(showVrouterBgpNeighborByVnmNameByNeighbor)

Path parameters

vrouter-name (required)
Path Parameter
neighbor (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  }, {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-bgp-neighbor-show-response
Up
get /vrouters/{vrouter-name}/bgp-neighbors/nic/{nic}
(showVrouterBgpNeighborByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  }, {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-bgp-neighbor-show-response
Up
get /vrouters/{vrouter-name}/bgp-neighbor-details/neighbor/{neighbor}
(showVrouterBgpNeighborDetailByVnmNameByNeighbor)

Path parameters

vrouter-name (required)
Path Parameter
neighbor (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "keepalive" : 6,
    "nic" : "nic",
    "start-due" : 1,
    "remote-as" : 7,
    "update-sent" : 7,
    "api.switch-name" : "api.switch-name",
    "comm-attr-send-ipv6" : "both",
    "comm-attr-send-ipv4" : "both",
    "remote-id" : "remote-id",
    "open-sent" : 1,
    "l3-port" : 5,
    "last-read" : "last-read",
    "state" : "idle",
    "keepalive-rcvd" : 2,
    "holdtime" : 0,
    "keepalive-sent" : 3,
    "local-as" : 4,
    "conn-established" : 1,
    "min-adv" : 1,
    "prefix-accepted-ipv4" : 4,
    "prefix-accepted-ipv6" : 7,
    "vrf" : "vrf",
    "open-rcvd" : 5,
    "neighbor" : "neighbor",
    "conn-dropped" : 1,
    "up-for" : "up-for",
    "notif-rcvd" : 2,
    "update-rcvd" : 9,
    "notif-sent" : 5,
    "last-reset" : "last-reset",
    "connect-due" : 6
  }, {
    "keepalive" : 6,
    "nic" : "nic",
    "start-due" : 1,
    "remote-as" : 7,
    "update-sent" : 7,
    "api.switch-name" : "api.switch-name",
    "comm-attr-send-ipv6" : "both",
    "comm-attr-send-ipv4" : "both",
    "remote-id" : "remote-id",
    "open-sent" : 1,
    "l3-port" : 5,
    "last-read" : "last-read",
    "state" : "idle",
    "keepalive-rcvd" : 2,
    "holdtime" : 0,
    "keepalive-sent" : 3,
    "local-as" : 4,
    "conn-established" : 1,
    "min-adv" : 1,
    "prefix-accepted-ipv4" : 4,
    "prefix-accepted-ipv6" : 7,
    "vrf" : "vrf",
    "open-rcvd" : 5,
    "neighbor" : "neighbor",
    "conn-dropped" : 1,
    "up-for" : "up-for",
    "notif-rcvd" : 2,
    "update-rcvd" : 9,
    "notif-sent" : 5,
    "last-reset" : "last-reset",
    "connect-due" : 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 vrouter-bgp-neighbor-detail-show-response
Up
get /vrouters/{vrouter-name}/bgp-neighbor-details/nic/{nic}
(showVrouterBgpNeighborDetailByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "keepalive" : 6,
    "nic" : "nic",
    "start-due" : 1,
    "remote-as" : 7,
    "update-sent" : 7,
    "api.switch-name" : "api.switch-name",
    "comm-attr-send-ipv6" : "both",
    "comm-attr-send-ipv4" : "both",
    "remote-id" : "remote-id",
    "open-sent" : 1,
    "l3-port" : 5,
    "last-read" : "last-read",
    "state" : "idle",
    "keepalive-rcvd" : 2,
    "holdtime" : 0,
    "keepalive-sent" : 3,
    "local-as" : 4,
    "conn-established" : 1,
    "min-adv" : 1,
    "prefix-accepted-ipv4" : 4,
    "prefix-accepted-ipv6" : 7,
    "vrf" : "vrf",
    "open-rcvd" : 5,
    "neighbor" : "neighbor",
    "conn-dropped" : 1,
    "up-for" : "up-for",
    "notif-rcvd" : 2,
    "update-rcvd" : 9,
    "notif-sent" : 5,
    "last-reset" : "last-reset",
    "connect-due" : 6
  }, {
    "keepalive" : 6,
    "nic" : "nic",
    "start-due" : 1,
    "remote-as" : 7,
    "update-sent" : 7,
    "api.switch-name" : "api.switch-name",
    "comm-attr-send-ipv6" : "both",
    "comm-attr-send-ipv4" : "both",
    "remote-id" : "remote-id",
    "open-sent" : 1,
    "l3-port" : 5,
    "last-read" : "last-read",
    "state" : "idle",
    "keepalive-rcvd" : 2,
    "holdtime" : 0,
    "keepalive-sent" : 3,
    "local-as" : 4,
    "conn-established" : 1,
    "min-adv" : 1,
    "prefix-accepted-ipv4" : 4,
    "prefix-accepted-ipv6" : 7,
    "vrf" : "vrf",
    "open-rcvd" : 5,
    "neighbor" : "neighbor",
    "conn-dropped" : 1,
    "up-for" : "up-for",
    "notif-rcvd" : 2,
    "update-rcvd" : 9,
    "notif-sent" : 5,
    "last-reset" : "last-reset",
    "connect-due" : 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 vrouter-bgp-neighbor-detail-show-response
Up
get /vrouters/{vrouter-name}/bgp-neighbor-details
(showVrouterBgpNeighborDetailsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "keepalive" : 6,
    "nic" : "nic",
    "start-due" : 1,
    "remote-as" : 7,
    "update-sent" : 7,
    "api.switch-name" : "api.switch-name",
    "comm-attr-send-ipv6" : "both",
    "comm-attr-send-ipv4" : "both",
    "remote-id" : "remote-id",
    "open-sent" : 1,
    "l3-port" : 5,
    "last-read" : "last-read",
    "state" : "idle",
    "keepalive-rcvd" : 2,
    "holdtime" : 0,
    "keepalive-sent" : 3,
    "local-as" : 4,
    "conn-established" : 1,
    "min-adv" : 1,
    "prefix-accepted-ipv4" : 4,
    "prefix-accepted-ipv6" : 7,
    "vrf" : "vrf",
    "open-rcvd" : 5,
    "neighbor" : "neighbor",
    "conn-dropped" : 1,
    "up-for" : "up-for",
    "notif-rcvd" : 2,
    "update-rcvd" : 9,
    "notif-sent" : 5,
    "last-reset" : "last-reset",
    "connect-due" : 6
  }, {
    "keepalive" : 6,
    "nic" : "nic",
    "start-due" : 1,
    "remote-as" : 7,
    "update-sent" : 7,
    "api.switch-name" : "api.switch-name",
    "comm-attr-send-ipv6" : "both",
    "comm-attr-send-ipv4" : "both",
    "remote-id" : "remote-id",
    "open-sent" : 1,
    "l3-port" : 5,
    "last-read" : "last-read",
    "state" : "idle",
    "keepalive-rcvd" : 2,
    "holdtime" : 0,
    "keepalive-sent" : 3,
    "local-as" : 4,
    "conn-established" : 1,
    "min-adv" : 1,
    "prefix-accepted-ipv4" : 4,
    "prefix-accepted-ipv6" : 7,
    "vrf" : "vrf",
    "open-rcvd" : 5,
    "neighbor" : "neighbor",
    "conn-dropped" : 1,
    "up-for" : "up-for",
    "notif-rcvd" : 2,
    "update-rcvd" : 9,
    "notif-sent" : 5,
    "last-reset" : "last-reset",
    "connect-due" : 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 vrouter-bgp-neighbor-detail-show-response
Up
get /vrouters/{vrouter-name}/bgp-neighbor-faileds
(showVrouterBgpNeighborFailedsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "reason" : "reason",
    "l3-port" : 1,
    "remote-router" : "remote-router",
    "estd-cnt" : 0,
    "reset-time" : "reset-time",
    "nic" : "nic",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "drop-cnt" : 6
  }, {
    "reason" : "reason",
    "l3-port" : 1,
    "remote-router" : "remote-router",
    "estd-cnt" : 0,
    "reset-time" : "reset-time",
    "nic" : "nic",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "drop-cnt" : 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 vrouter-bgp-neighbor-failed-show-response
Up
get /vrouters/{vrouter-name}/bgp-neighbors
(showVrouterBgpNeighborsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  }, {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-bgp-neighbor-show-response
Up
get /vrouters/{vrouter-name}/bgp-networks/network={network},netmask={netmask},vrf={vrf}
(showVrouterBgpNetworksByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "vrf" : "vrf",
    "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 vrouter-bgp-network-show-response
Up
get /vrouters/{vrouter-name}/bgp-networks
(showVrouterBgpNetworksByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "vrf" : "vrf",
    "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 vrouter-bgp-network-show-response
Up
get /vrouters/{vrouter-name}/bgps
(showVrouterBgpsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : true
  }, {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : 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 vrouter-bgp-show-response
Up
get /vrouters/{name}
(showVrouterByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "evpn-border" : true,
    "bgp-default-shutdown" : true,
    "ospf-spf-consec-delay" : 1,
    "evpn-dup-addr-freeze" : 5,
    "type" : "vnet-mgr",
    "no-bgp-redist-ospf-route-map" : true,
    "ospf-spf-delay" : 7,
    "ospf-redist-connected-route-map" : "ospf-redist-connected-route-map",
    "ospf6-spf-delay" : 5,
    "bgp-bestpath-as-path" : "ignore",
    "ospf-default-info-originate-metric" : 6,
    "storage-pool" : "storage-pool",
    "bgp-distance-internal" : 1,
    "bgp-ibgp-multipath" : 3,
    "router-id" : "router-id",
    "ospf-redist-connected-metric-type" : "1",
    "bgp-redist-rip-metric" : 9,
    "ip-snmp" : true,
    "ospf-snmp" : true,
    "state" : "disable",
    "id" : "id",
    "rip-redistribute" : "static",
    "ospf-redist-static-metric" : 6,
    "hw-router-mac" : "hw-router-mac",
    "ospf-snmp-notification" : true,
    "hw-vrid" : 0,
    "ospf-redist-bgp-route-map" : "ospf-redist-bgp-route-map",
    "ospf-default-information" : "none",
    "bgp-distance-local" : 6,
    "bgp-snmp" : true,
    "ospf-redist-static-route-map" : "ospf-redist-static-route-map",
    "bgp-graceful-shutdown" : true,
    "ospf-distance-local" : 1,
    "bgp-redistribute" : "static",
    "ospf6-snmp-notification" : true,
    "vrf" : "vrf",
    "ospf-redist-rip-metric-type" : "1",
    "evpn-dup-addr-moves-duration" : 5,
    "bgp-holdtime" : 1,
    "no-bgp-redist-connected-route-map" : true,
    "ospf-redist-connected-metric" : 8,
    "router-type" : "software",
    "vnet-service" : true,
    "evpn-dup-addr-max-moves" : 1,
    "bgp-redist-connected-route-map" : "bgp-redist-connected-route-map",
    "name" : "name",
    "bgp-dampening" : true,
    "router-ipstack" : "quagga",
    "bgp-redist-static-metric" : 2,
    "template" : true,
    "ospf-spf-max-delay" : 4,
    "ospf-redistribute" : "static",
    "fabric-comm" : true,
    "ospf-redist-bgp-metric-type" : "1",
    "ospf-default-info-originate-metric-type" : "1",
    "ospf-default-info-originate-route-map" : "ospf-default-info-originate-route-map",
    "bgp-cluster-id" : "bgp-cluster-id",
    "hw-vrrp-id" : 3,
    "api.switch-name" : "api.switch-name",
    "bgp-redist-ospf-route-map" : "bgp-redist-ospf-route-map",
    "ospf6-spf-max-delay" : 9,
    "vnet" : "vnet",
    "ospf-distance-internal" : 6,
    "bgp-keepalive-interval" : 7,
    "ospf-redist-static-metric-type" : "1",
    "bgp-global-nh-preference" : "none",
    "bgp-snmp-notification" : true,
    "proto-routing" : "bgp",
    "scope" : "local",
    "ospf-redist-rip-metric" : 9,
    "ospf-distance-external" : 3,
    "bgp-distance-external" : 1,
    "bgp-max-paths" : 6,
    "bgp-redist-connected-metric" : 7,
    "ospf-bfd-all-if" : true,
    "ospf6-snmp" : true,
    "evpn-export-all-leaked-networks" : "permit",
    "bgp-update-delay-strict" : 4,
    "ospf-stub-router-on-startup" : true,
    "bgp-network-import-check" : true,
    "failover-action" : "stop-old",
    "bgp-delayed-startup" : 2,
    "bgp-redist-ospf-metric" : 3,
    "failover-controller" : 6,
    "bgp-as" : 5,
    "ospf-redist-bgp-metric" : 6,
    "ospf-stub-router-on-startup-period" : 2,
    "bgp-redist-static-route-map" : "bgp-redist-static-route-map",
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "ospf6-spf-consecu-delay" : 9,
    "no-bgp-redist-static-route-map" : true,
    "cluster-active-active-routing" : true,
    "location" : 6,
    "vrrp-track-port" : "vrrp-track-port",
    "gateway" : "gateway"
  }, {
    "evpn-border" : true,
    "bgp-default-shutdown" : true,
    "ospf-spf-consec-delay" : 1,
    "evpn-dup-addr-freeze" : 5,
    "type" : "vnet-mgr",
    "no-bgp-redist-ospf-route-map" : true,
    "ospf-spf-delay" : 7,
    "ospf-redist-connected-route-map" : "ospf-redist-connected-route-map",
    "ospf6-spf-delay" : 5,
    "bgp-bestpath-as-path" : "ignore",
    "ospf-default-info-originate-metric" : 6,
    "storage-pool" : "storage-pool",
    "bgp-distance-internal" : 1,
    "bgp-ibgp-multipath" : 3,
    "router-id" : "router-id",
    "ospf-redist-connected-metric-type" : "1",
    "bgp-redist-rip-metric" : 9,
    "ip-snmp" : true,
    "ospf-snmp" : true,
    "state" : "disable",
    "id" : "id",
    "rip-redistribute" : "static",
    "ospf-redist-static-metric" : 6,
    "hw-router-mac" : "hw-router-mac",
    "ospf-snmp-notification" : true,
    "hw-vrid" : 0,
    "ospf-redist-bgp-route-map" : "ospf-redist-bgp-route-map",
    "ospf-default-information" : "none",
    "bgp-distance-local" : 6,
    "bgp-snmp" : true,
    "ospf-redist-static-route-map" : "ospf-redist-static-route-map",
    "bgp-graceful-shutdown" : true,
    "ospf-distance-local" : 1,
    "bgp-redistribute" : "static",
    "ospf6-snmp-notification" : true,
    "vrf" : "vrf",
    "ospf-redist-rip-metric-type" : "1",
    "evpn-dup-addr-moves-duration" : 5,
    "bgp-holdtime" : 1,
    "no-bgp-redist-connected-route-map" : true,
    "ospf-redist-connected-metric" : 8,
    "router-type" : "software",
    "vnet-service" : true,
    "evpn-dup-addr-max-moves" : 1,
    "bgp-redist-connected-route-map" : "bgp-redist-connected-route-map",
    "name" : "name",
    "bgp-dampening" : true,
    "router-ipstack" : "quagga",
    "bgp-redist-static-metric" : 2,
    "template" : true,
    "ospf-spf-max-delay" : 4,
    "ospf-redistribute" : "static",
    "fabric-comm" : true,
    "ospf-redist-bgp-metric-type" : "1",
    "ospf-default-info-originate-metric-type" : "1",
    "ospf-default-info-originate-route-map" : "ospf-default-info-originate-route-map",
    "bgp-cluster-id" : "bgp-cluster-id",
    "hw-vrrp-id" : 3,
    "api.switch-name" : "api.switch-name",
    "bgp-redist-ospf-route-map" : "bgp-redist-ospf-route-map",
    "ospf6-spf-max-delay" : 9,
    "vnet" : "vnet",
    "ospf-distance-internal" : 6,
    "bgp-keepalive-interval" : 7,
    "ospf-redist-static-metric-type" : "1",
    "bgp-global-nh-preference" : "none",
    "bgp-snmp-notification" : true,
    "proto-routing" : "bgp",
    "scope" : "local",
    "ospf-redist-rip-metric" : 9,
    "ospf-distance-external" : 3,
    "bgp-distance-external" : 1,
    "bgp-max-paths" : 6,
    "bgp-redist-connected-metric" : 7,
    "ospf-bfd-all-if" : true,
    "ospf6-snmp" : true,
    "evpn-export-all-leaked-networks" : "permit",
    "bgp-update-delay-strict" : 4,
    "ospf-stub-router-on-startup" : true,
    "bgp-network-import-check" : true,
    "failover-action" : "stop-old",
    "bgp-delayed-startup" : 2,
    "bgp-redist-ospf-metric" : 3,
    "failover-controller" : 6,
    "bgp-as" : 5,
    "ospf-redist-bgp-metric" : 6,
    "ospf-stub-router-on-startup-period" : 2,
    "bgp-redist-static-route-map" : "bgp-redist-static-route-map",
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "ospf6-spf-consecu-delay" : 9,
    "no-bgp-redist-static-route-map" : true,
    "cluster-active-active-routing" : true,
    "location" : 6,
    "vrrp-track-port" : "vrrp-track-port",
    "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 vrouter-show-response
Up
get /vrouters/{name}/evpn-arp-caches
(showVrouterEvpnArpCachesByVrouterVnmName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vni" : 0,
    "remote-vtep" : "remote-vtep",
    "local-seq" : 6,
    "ip" : "ip",
    "remote-seq" : 1,
    "state" : "state",
    "type" : "type",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  }, {
    "vni" : 0,
    "remote-vtep" : "remote-vtep",
    "local-seq" : 6,
    "ip" : "ip",
    "remote-seq" : 1,
    "state" : "state",
    "type" : "type",
    "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 vrouter-evpn-arp-cache-show-response
Up
get /vrouters/{vrouter-name}/evpn-bgp-neighbors/neighbor/{neighbor}
(showVrouterEvpnBgpNeighborByVnmNameByNeighbor)

Path parameters

vrouter-name (required)
Path Parameter
neighbor (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  }, {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-evpn-bgp-neighbor-show-response
Up
get /vrouters/{vrouter-name}/evpn-bgp-neighbors/nic/{nic}
(showVrouterEvpnBgpNeighborByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  }, {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-evpn-bgp-neighbor-show-response
Up
get /vrouters/{vrouter-name}/evpn-bgp-neighbors
(showVrouterEvpnBgpNeighborsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  }, {
    "ver" : 5,
    "msg_rcvd" : 5,
    "remote-router" : "remote-router",
    "nic" : "nic",
    "description" : "description",
    "vrf" : "vrf",
    "up/down" : "up/down",
    "remote-as" : 7,
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "inQ" : 6,
    "tblver" : 0,
    "l3-port" : 9,
    "msg_sent" : 2,
    "outQ" : 1,
    "state/pfxrcd" : "state/pfxrcd"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-evpn-bgp-neighbor-show-response
Up
get /vrouters/{vrouter-name}/evpn-duplicate-macs
(showVrouterEvpnDupMacsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "host-mac" : "host-mac",
    "api.switch-name" : "api.switch-name",
    "seq" : 0
  }, {
    "host-mac" : "host-mac",
    "api.switch-name" : "api.switch-name",
    "seq" : 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 vrouter-evpn-duplicate-mac-show-response
Up
get /vrouters/{vrouter-name}/evpn-bgp-neighbor-summaries
(showVrouterEvpnNeighborSummariesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "Tb/Ver" : 9,
    "ver" : 0,
    "as" : 7,
    "msg-rcvd" : 1,
    "pfxrcd" : 6,
    "OutQ" : 2,
    "state" : "state",
    "msg-sent" : 5,
    "up/down" : "up/down",
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "InQ" : 5
  }, {
    "Tb/Ver" : 9,
    "ver" : 0,
    "as" : 7,
    "msg-rcvd" : 1,
    "pfxrcd" : 6,
    "OutQ" : 2,
    "state" : "state",
    "msg-sent" : 5,
    "up/down" : "up/down",
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "InQ" : 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 vrouter-evpn-bgp-neighbor-summary-show-response
Up
get /vrouters/{vrouter-name}/evpn-bgp-routes
(showVrouterEvpnRoutesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ip" : "ip",
    "origin" : "origin",
    "as-path" : "as-path",
    "weight" : 5,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vni" : "vni",
    "rd" : "rd",
    "locprf" : 1,
    "netmask" : 0,
    "metric" : 6,
    "extended-community" : "extended-community",
    "route-type" : "2",
    "best-route" : true,
    "next-hop" : "next-hop"
  }, {
    "ip" : "ip",
    "origin" : "origin",
    "as-path" : "as-path",
    "weight" : 5,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "vni" : "vni",
    "rd" : "rd",
    "locprf" : 1,
    "netmask" : 0,
    "metric" : 6,
    "extended-community" : "extended-community",
    "route-type" : "2",
    "best-route" : true,
    "next-hop" : "next-hop"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-evpn-bgp-routes-show-response
Up
get /vrouters/{vrouter-name}/evpn-vni-macs
(showVrouterEvpnVniMacsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vni" : 0,
    "vlan" : 6,
    "local-seq" : 1,
    "remote-seq" : 5,
    "intf/remote-vtep" : "intf/remote-vtep",
    "type" : "type",
    "api.switch-name" : "api.switch-name",
    "mac" : "mac"
  }, {
    "vni" : 0,
    "vlan" : 6,
    "local-seq" : 1,
    "remote-seq" : 5,
    "intf/remote-vtep" : "intf/remote-vtep",
    "type" : "type",
    "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 vrouter-evpn-vni-mac-show-response
Up
get /vrouters/{vrouter-name}/evpn-bgp-vnis
(showVrouterEvpnVnisByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vni" : 0,
    "rd" : "rd",
    "export-rt" : "export-rt",
    "import-rt" : "import-rt",
    "type" : "type",
    "api.switch-name" : "api.switch-name"
  }, {
    "vni" : 0,
    "rd" : "rd",
    "export-rt" : "export-rt",
    "import-rt" : "import-rt",
    "type" : "type",
    "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 vrouter-evpn-bgp-vni-show-response
Up
get /vrouters/{vrouter-name}/igmp-static-joins/{name}
(showVrouterIgmpStaticJoinByVnmNameByName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "group-ip" : "group-ip",
    "source-ip" : "source-ip",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name"
  }, {
    "name" : "name",
    "group-ip" : "group-ip",
    "source-ip" : "source-ip",
    "interface" : "interface",
    "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 vrouter-igmp-static-join-show-response
Up
get /vrouters/{vrouter-name}/igmp-static-joins
(showVrouterIgmpStaticJoinsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "group-ip" : "group-ip",
    "source-ip" : "source-ip",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name"
  }, {
    "name" : "name",
    "group-ip" : "group-ip",
    "source-ip" : "source-ip",
    "interface" : "interface",
    "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 vrouter-igmp-static-join-show-response
Up
get /vrouters/{vrouter-name}/routes-multicasts/{source}
(showVrouterIpMrouteByVnmNameBySource)

Path parameters

vrouter-name (required)
Path Parameter
source (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "output" : "output",
    "oVifI" : 6,
    "input" : "input",
    "proto" : "rip",
    "source" : "source",
    "api.switch-name" : "api.switch-name",
    "ttl" : 1,
    "group" : "group",
    "iVifI" : 0,
    "uptime" : "uptime"
  }, {
    "output" : "output",
    "oVifI" : 6,
    "input" : "input",
    "proto" : "rip",
    "source" : "source",
    "api.switch-name" : "api.switch-name",
    "ttl" : 1,
    "group" : "group",
    "iVifI" : 0,
    "uptime" : "uptime"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-routes-multicast-show-response
Up
get /vrouters/{vrouter-name}/routes-multicasts
(showVrouterIpMroutesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "output" : "output",
    "oVifI" : 6,
    "input" : "input",
    "proto" : "rip",
    "source" : "source",
    "api.switch-name" : "api.switch-name",
    "ttl" : 1,
    "group" : "group",
    "iVifI" : 0,
    "uptime" : "uptime"
  }, {
    "output" : "output",
    "oVifI" : 6,
    "input" : "input",
    "proto" : "rip",
    "source" : "source",
    "api.switch-name" : "api.switch-name",
    "ttl" : 1,
    "group" : "group",
    "iVifI" : 0,
    "uptime" : "uptime"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-routes-multicast-show-response
Up
get /vrouters/{vrouter-name}/routes/{network}
(showVrouterIpRouteByVnmNameByNetwork)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "distance" : 6,
    "netmask" : 0,
    "metric" : 1,
    "vrf" : "vrf",
    "next-hop" : "next-hop",
    "interface" : "interface",
    "type" : "rip",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "distance" : 6,
    "netmask" : 0,
    "metric" : 1,
    "vrf" : "vrf",
    "next-hop" : "next-hop",
    "interface" : "interface",
    "type" : "rip",
    "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 vrouter-routes-show-response
Up
get /vrouters/{vrouter-name}/routes
(showVrouterIpRoutesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "distance" : 6,
    "netmask" : 0,
    "metric" : 1,
    "vrf" : "vrf",
    "next-hop" : "next-hop",
    "interface" : "interface",
    "type" : "rip",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "distance" : 6,
    "netmask" : 0,
    "metric" : 1,
    "vrf" : "vrf",
    "next-hop" : "next-hop",
    "interface" : "interface",
    "type" : "rip",
    "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 vrouter-routes-show-response
Up
get /vrouters/{vrouter-name}/loopback-interfaces/{index}
(showVrouterLoopbackByVnmNameByIndex)

Path parameters

vrouter-name (required)
Path Parameter
index (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ip" : "ip",
    "index" : 0,
    "router-if" : "router-if",
    "api.switch-name" : "api.switch-name"
  }, {
    "ip" : "ip",
    "index" : 0,
    "router-if" : "router-if",
    "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 vrouter-loopback-interface-show-response
Up
get /vrouters/{vrouter-name}/loopback-interfaces
(showVrouterLoopbacksByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ip" : "ip",
    "index" : 0,
    "router-if" : "router-if",
    "api.switch-name" : "api.switch-name"
  }, {
    "ip" : "ip",
    "index" : 0,
    "router-if" : "router-if",
    "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 vrouter-loopback-interface-show-response
Up
get /vrouters/{vrouter-name}/mac-lists/name={name},seq={seq}
(showVrouterMacListsByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
name (required)
Path Parameter
seq (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "action" : "permit",
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 0,
    "mac" : "mac"
  }, {
    "name" : "name",
    "action" : "permit",
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 0,
    "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 vrouter-mac-list-show-response
Up
get /vrouters/{vrouter-name}/mac-lists
(showVrouterMacListsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "action" : "permit",
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 0,
    "mac" : "mac"
  }, {
    "name" : "name",
    "action" : "permit",
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 0,
    "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 vrouter-mac-list-show-response
Up
get /vrouters/{vrouter-name}/multicast-igmp-groups
(showVrouterMulticastIgmpGroupsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "timer" : 6,
    "if-name" : "if-name",
    "vif" : 0,
    "address" : "address",
    "reporter" : "reporter",
    "api.switch-name" : "api.switch-name"
  }, {
    "timer" : 6,
    "if-name" : "if-name",
    "vif" : 0,
    "address" : "address",
    "reporter" : "reporter",
    "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 vrouter-multicast-igmp-group-show-response
Up
get /vrouters/{vrouter-name}/multicast-routes
(showVrouterMulticastKernelCachesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "parent" : 0,
    "oif-bitmap" : 1,
    "incoming-if" : "incoming-if",
    "outgoing-ifs" : "outgoing-ifs",
    "transit-vlan" : 6,
    "source" : "source",
    "remote-source" : true,
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  }, {
    "parent" : 0,
    "oif-bitmap" : 1,
    "incoming-if" : "incoming-if",
    "outgoing-ifs" : "outgoing-ifs",
    "transit-vlan" : 6,
    "source" : "source",
    "remote-source" : true,
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-multicast-route-show-response
Up
get /vrouters/{vrouter-name}/interfaces/l3-port/{l3-port}
(showVrouterNicByVnmNameByL3port)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "sriov-vf" : true,
    "assignment2" : "none",
    "fabric-nic" : true,
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 9,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "l3-port" : 0,
    "vlan" : 2,
    "netmask" : 6,
    "linklocal" : "linklocal",
    "pim" : true,
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 5,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 7,
    "pim-dr-priority" : 3,
    "vrrp-primary" : "vrrp-primary",
    "pim-cluster" : true,
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 4,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "mtu" : 5,
    "vrrp-id" : 2,
    "is-primary" : true,
    "priority-tag" : true,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : true,
    "netmask2" : 1
  }, {
    "sriov-vf" : true,
    "assignment2" : "none",
    "fabric-nic" : true,
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 9,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "l3-port" : 0,
    "vlan" : 2,
    "netmask" : 6,
    "linklocal" : "linklocal",
    "pim" : true,
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 5,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 7,
    "pim-dr-priority" : 3,
    "vrrp-primary" : "vrrp-primary",
    "pim-cluster" : true,
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 4,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "mtu" : 5,
    "vrrp-id" : 2,
    "is-primary" : true,
    "priority-tag" : true,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : true,
    "netmask2" : 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 vrouter-interface-show-response
Up
get /vrouters/{vrouter-name}/interfaces/nic/{nic}
(showVrouterNicByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "sriov-vf" : true,
    "assignment2" : "none",
    "fabric-nic" : true,
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 9,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "l3-port" : 0,
    "vlan" : 2,
    "netmask" : 6,
    "linklocal" : "linklocal",
    "pim" : true,
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 5,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 7,
    "pim-dr-priority" : 3,
    "vrrp-primary" : "vrrp-primary",
    "pim-cluster" : true,
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 4,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "mtu" : 5,
    "vrrp-id" : 2,
    "is-primary" : true,
    "priority-tag" : true,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : true,
    "netmask2" : 1
  }, {
    "sriov-vf" : true,
    "assignment2" : "none",
    "fabric-nic" : true,
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 9,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "l3-port" : 0,
    "vlan" : 2,
    "netmask" : 6,
    "linklocal" : "linklocal",
    "pim" : true,
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 5,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 7,
    "pim-dr-priority" : 3,
    "vrrp-primary" : "vrrp-primary",
    "pim-cluster" : true,
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 4,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "mtu" : 5,
    "vrrp-id" : 2,
    "is-primary" : true,
    "priority-tag" : true,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : true,
    "netmask2" : 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 vrouter-interface-show-response
Up
get /vrouters/{vrouter-name}/interface-configs/l3-port/{l3-port}
(showVrouterNicConfigByVnmNameByL3Port)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ospf-cost" : 2,
    "bfd-min-rx" : 3,
    "ospf-network-type" : "default",
    "ospf-passive-if" : true,
    "nic" : "nic",
    "ospf-priority" : 5,
    "bfd-interval" : 9,
    "vrf" : "vrf",
    "ospf-msg-digest-id" : 7,
    "ospf-bfd" : "default",
    "api.switch-name" : "api.switch-name",
    "suppress-ra" : true,
    "ospf-auth-key" : "ospf-auth-key",
    "l3-port" : 0,
    "ospf-hello-interval" : 6,
    "ra-interval" : 4,
    "ra-lifetime" : 7,
    "bfd-multiplier" : 2,
    "ospf-dead-interval" : 1,
    "ospf-retransmit-interval" : 5,
    "ospf-msg-digest-key" : "ospf-msg-digest-key"
  }, {
    "ospf-cost" : 2,
    "bfd-min-rx" : 3,
    "ospf-network-type" : "default",
    "ospf-passive-if" : true,
    "nic" : "nic",
    "ospf-priority" : 5,
    "bfd-interval" : 9,
    "vrf" : "vrf",
    "ospf-msg-digest-id" : 7,
    "ospf-bfd" : "default",
    "api.switch-name" : "api.switch-name",
    "suppress-ra" : true,
    "ospf-auth-key" : "ospf-auth-key",
    "l3-port" : 0,
    "ospf-hello-interval" : 6,
    "ra-interval" : 4,
    "ra-lifetime" : 7,
    "bfd-multiplier" : 2,
    "ospf-dead-interval" : 1,
    "ospf-retransmit-interval" : 5,
    "ospf-msg-digest-key" : "ospf-msg-digest-key"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-interface-config-show-response
Up
get /vrouters/{vrouter-name}/interface-configs/nic/{nic}
(showVrouterNicConfigByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ospf-cost" : 2,
    "bfd-min-rx" : 3,
    "ospf-network-type" : "default",
    "ospf-passive-if" : true,
    "nic" : "nic",
    "ospf-priority" : 5,
    "bfd-interval" : 9,
    "vrf" : "vrf",
    "ospf-msg-digest-id" : 7,
    "ospf-bfd" : "default",
    "api.switch-name" : "api.switch-name",
    "suppress-ra" : true,
    "ospf-auth-key" : "ospf-auth-key",
    "l3-port" : 0,
    "ospf-hello-interval" : 6,
    "ra-interval" : 4,
    "ra-lifetime" : 7,
    "bfd-multiplier" : 2,
    "ospf-dead-interval" : 1,
    "ospf-retransmit-interval" : 5,
    "ospf-msg-digest-key" : "ospf-msg-digest-key"
  }, {
    "ospf-cost" : 2,
    "bfd-min-rx" : 3,
    "ospf-network-type" : "default",
    "ospf-passive-if" : true,
    "nic" : "nic",
    "ospf-priority" : 5,
    "bfd-interval" : 9,
    "vrf" : "vrf",
    "ospf-msg-digest-id" : 7,
    "ospf-bfd" : "default",
    "api.switch-name" : "api.switch-name",
    "suppress-ra" : true,
    "ospf-auth-key" : "ospf-auth-key",
    "l3-port" : 0,
    "ospf-hello-interval" : 6,
    "ra-interval" : 4,
    "ra-lifetime" : 7,
    "bfd-multiplier" : 2,
    "ospf-dead-interval" : 1,
    "ospf-retransmit-interval" : 5,
    "ospf-msg-digest-key" : "ospf-msg-digest-key"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-interface-config-show-response
Up
get /vrouters/{vrouter-name}/interface-configs
(showVrouterNicConfigsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ospf-cost" : 2,
    "bfd-min-rx" : 3,
    "ospf-network-type" : "default",
    "ospf-passive-if" : true,
    "nic" : "nic",
    "ospf-priority" : 5,
    "bfd-interval" : 9,
    "vrf" : "vrf",
    "ospf-msg-digest-id" : 7,
    "ospf-bfd" : "default",
    "api.switch-name" : "api.switch-name",
    "suppress-ra" : true,
    "ospf-auth-key" : "ospf-auth-key",
    "l3-port" : 0,
    "ospf-hello-interval" : 6,
    "ra-interval" : 4,
    "ra-lifetime" : 7,
    "bfd-multiplier" : 2,
    "ospf-dead-interval" : 1,
    "ospf-retransmit-interval" : 5,
    "ospf-msg-digest-key" : "ospf-msg-digest-key"
  }, {
    "ospf-cost" : 2,
    "bfd-min-rx" : 3,
    "ospf-network-type" : "default",
    "ospf-passive-if" : true,
    "nic" : "nic",
    "ospf-priority" : 5,
    "bfd-interval" : 9,
    "vrf" : "vrf",
    "ospf-msg-digest-id" : 7,
    "ospf-bfd" : "default",
    "api.switch-name" : "api.switch-name",
    "suppress-ra" : true,
    "ospf-auth-key" : "ospf-auth-key",
    "l3-port" : 0,
    "ospf-hello-interval" : 6,
    "ra-interval" : 4,
    "ra-lifetime" : 7,
    "bfd-multiplier" : 2,
    "ospf-dead-interval" : 1,
    "ospf-retransmit-interval" : 5,
    "ospf-msg-digest-key" : "ospf-msg-digest-key"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-interface-config-show-response
Up
get /vrouters/{vrouter-name}/interface-ips/nic={nic},ip={ip},vrf={vrf}
(showVrouterNicIpsByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
nic (required)
Path Parameter
ip (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "netmask" : 0,
    "assignment" : "none",
    "ip" : "ip",
    "flags" : "duplicate",
    "vnet-id" : "vnet-id",
    "nic" : "nic",
    "vrf" : "vrf",
    "type" : "primary",
    "api.switch-name" : "api.switch-name"
  }, {
    "bd" : "bd",
    "netmask" : 0,
    "assignment" : "none",
    "ip" : "ip",
    "flags" : "duplicate",
    "vnet-id" : "vnet-id",
    "nic" : "nic",
    "vrf" : "vrf",
    "type" : "primary",
    "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 vrouter-interface-ip-show-response
Up
get /vrouters/{vrouter-name}/interface-ips
(showVrouterNicIpsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "netmask" : 0,
    "assignment" : "none",
    "ip" : "ip",
    "flags" : "duplicate",
    "vnet-id" : "vnet-id",
    "nic" : "nic",
    "vrf" : "vrf",
    "type" : "primary",
    "api.switch-name" : "api.switch-name"
  }, {
    "bd" : "bd",
    "netmask" : 0,
    "assignment" : "none",
    "ip" : "ip",
    "flags" : "duplicate",
    "vnet-id" : "vnet-id",
    "nic" : "nic",
    "vrf" : "vrf",
    "type" : "primary",
    "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 vrouter-interface-ip-show-response
Up
get /vrouters/{vrouter-name}/interfaces
(showVrouterNicsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "sriov-vf" : true,
    "assignment2" : "none",
    "fabric-nic" : true,
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 9,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "l3-port" : 0,
    "vlan" : 2,
    "netmask" : 6,
    "linklocal" : "linklocal",
    "pim" : true,
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 5,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 7,
    "pim-dr-priority" : 3,
    "vrrp-primary" : "vrrp-primary",
    "pim-cluster" : true,
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 4,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "mtu" : 5,
    "vrrp-id" : 2,
    "is-primary" : true,
    "priority-tag" : true,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : true,
    "netmask2" : 1
  }, {
    "sriov-vf" : true,
    "assignment2" : "none",
    "fabric-nic" : true,
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 9,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "l3-port" : 0,
    "vlan" : 2,
    "netmask" : 6,
    "linklocal" : "linklocal",
    "pim" : true,
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 5,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 7,
    "pim-dr-priority" : 3,
    "vrrp-primary" : "vrrp-primary",
    "pim-cluster" : true,
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 4,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "mtu" : 5,
    "vrrp-id" : 2,
    "is-primary" : true,
    "priority-tag" : true,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : true,
    "netmask2" : 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 vrouter-interface-show-response
Up
get /vrouters/{vrouter-name}/ospf6s/{nic}
(showVrouterOspf6ByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "nic" : "nic",
    "vrf" : "vrf",
    "ospf6-area" : "ospf6-area",
    "api.switch-name" : "api.switch-name"
  }, {
    "nic" : "nic",
    "vrf" : "vrf",
    "ospf6-area" : "ospf6-area",
    "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 vrouter-ospf6-show-response
Up
get /vrouters/{vrouter-name}/ospf6-interfaces/{nic}
(showVrouterOspf6InterfaceByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "area" : "area",
    "cost" : 1,
    "bdr-id" : "bdr-id",
    "nic" : "nic",
    "dead" : 5,
    "vrf" : "vrf",
    "priority" : 6,
    "nic-state" : "down",
    "api.switch-name" : "api.switch-name",
    "ip6" : "ip6",
    "mtu" : 0,
    "retransmit" : 2,
    "dr-id" : "dr-id",
    "ls-update" : 9,
    "link-local-ip" : "link-local-ip",
    "l3-port" : 4,
    "ls-ack" : 3,
    "if-scoped-lsa" : 7,
    "state" : "down",
    "hello" : 5,
    "mtu-mismatch-detection" : true,
    "netmask-ip6" : 2
  }, {
    "area" : "area",
    "cost" : 1,
    "bdr-id" : "bdr-id",
    "nic" : "nic",
    "dead" : 5,
    "vrf" : "vrf",
    "priority" : 6,
    "nic-state" : "down",
    "api.switch-name" : "api.switch-name",
    "ip6" : "ip6",
    "mtu" : 0,
    "retransmit" : 2,
    "dr-id" : "dr-id",
    "ls-update" : 9,
    "link-local-ip" : "link-local-ip",
    "l3-port" : 4,
    "ls-ack" : 3,
    "if-scoped-lsa" : 7,
    "state" : "down",
    "hello" : 5,
    "mtu-mismatch-detection" : true,
    "netmask-ip6" : 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 vrouter-ospf6-interface-show-response
Up
get /vrouters/{vrouter-name}/ospf6-interfaces
(showVrouterOspf6InterfacesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "area" : "area",
    "cost" : 1,
    "bdr-id" : "bdr-id",
    "nic" : "nic",
    "dead" : 5,
    "vrf" : "vrf",
    "priority" : 6,
    "nic-state" : "down",
    "api.switch-name" : "api.switch-name",
    "ip6" : "ip6",
    "mtu" : 0,
    "retransmit" : 2,
    "dr-id" : "dr-id",
    "ls-update" : 9,
    "link-local-ip" : "link-local-ip",
    "l3-port" : 4,
    "ls-ack" : 3,
    "if-scoped-lsa" : 7,
    "state" : "down",
    "hello" : 5,
    "mtu-mismatch-detection" : true,
    "netmask-ip6" : 2
  }, {
    "area" : "area",
    "cost" : 1,
    "bdr-id" : "bdr-id",
    "nic" : "nic",
    "dead" : 5,
    "vrf" : "vrf",
    "priority" : 6,
    "nic-state" : "down",
    "api.switch-name" : "api.switch-name",
    "ip6" : "ip6",
    "mtu" : 0,
    "retransmit" : 2,
    "dr-id" : "dr-id",
    "ls-update" : 9,
    "link-local-ip" : "link-local-ip",
    "l3-port" : 4,
    "ls-ack" : 3,
    "if-scoped-lsa" : 7,
    "state" : "down",
    "hello" : 5,
    "mtu-mismatch-detection" : true,
    "netmask-ip6" : 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 vrouter-ospf6-interface-show-response
Up
get /vrouters/{vrouter-name}/ospf6-neighbors
(showVrouterOspf6NeighborsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "duration" : "duration",
    "l3-port" : 1,
    "address" : "address",
    "vlan" : 6,
    "dead-time" : "dead-time",
    "pri" : 0,
    "neighbor-rid" : "neighbor-rid",
    "vrf" : "vrf",
    "state" : "state",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name"
  }, {
    "duration" : "duration",
    "l3-port" : 1,
    "address" : "address",
    "vlan" : 6,
    "dead-time" : "dead-time",
    "pri" : 0,
    "neighbor-rid" : "neighbor-rid",
    "vrf" : "vrf",
    "state" : "state",
    "interface" : "interface",
    "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 vrouter-ospf6-neighbor-show-response
Up
get /vrouters/{vrouter-name}/ospf6s
(showVrouterOspf6sByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "nic" : "nic",
    "vrf" : "vrf",
    "ospf6-area" : "ospf6-area",
    "api.switch-name" : "api.switch-name"
  }, {
    "nic" : "nic",
    "vrf" : "vrf",
    "ospf6-area" : "ospf6-area",
    "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 vrouter-ospf6-show-response
Up
get /vrouters/{vrouter-name}/ospf-areas/{area}
(showVrouterOspfAreaByVnmNameByArea)

Path parameters

vrouter-name (required)
Path Parameter
area (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "area" : 0,
    "stub-type" : "none",
    "prefix-list-out" : "prefix-list-out",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "prefix-list-in" : "prefix-list-in"
  }, {
    "area" : 0,
    "stub-type" : "none",
    "prefix-list-out" : "prefix-list-out",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "prefix-list-in" : "prefix-list-in"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-ospf-area-show-response
Up
get /vrouters/{vrouter-name}/ospf-areas
(showVrouterOspfAreasByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "area" : 0,
    "stub-type" : "none",
    "prefix-list-out" : "prefix-list-out",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "prefix-list-in" : "prefix-list-in"
  }, {
    "area" : 0,
    "stub-type" : "none",
    "prefix-list-out" : "prefix-list-out",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "prefix-list-in" : "prefix-list-in"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-ospf-area-show-response
Up
get /vrouters/{vrouter-name}/ospf-interfaces/{nic}
(showVrouterOspfInterfaceByVnmNameByVnic)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "broadcast" : "broadcast",
    "nic" : "nic",
    "dead" : 2,
    "api.switch-name" : "api.switch-name",
    "dr-id" : "dr-id",
    "l3-port" : 2,
    "bdr-ip" : "bdr-ip",
    "netmask" : 0,
    "router-id" : "router-id",
    "state" : "down",
    "area" : "area",
    "cost" : 5,
    "ip" : "ip",
    "bdr-id" : "bdr-id",
    "adjacent" : 3,
    "vrf" : "vrf",
    "priority" : 1,
    "nic-state" : "down",
    "neighbor" : 9,
    "mtu" : 6,
    "retransmit" : 7,
    "network-type" : "point-to-point",
    "dr-ip" : "dr-ip",
    "hello" : 5,
    "hello-due" : "hello-due",
    "mtu-mismatch-detection" : true
  }, {
    "broadcast" : "broadcast",
    "nic" : "nic",
    "dead" : 2,
    "api.switch-name" : "api.switch-name",
    "dr-id" : "dr-id",
    "l3-port" : 2,
    "bdr-ip" : "bdr-ip",
    "netmask" : 0,
    "router-id" : "router-id",
    "state" : "down",
    "area" : "area",
    "cost" : 5,
    "ip" : "ip",
    "bdr-id" : "bdr-id",
    "adjacent" : 3,
    "vrf" : "vrf",
    "priority" : 1,
    "nic-state" : "down",
    "neighbor" : 9,
    "mtu" : 6,
    "retransmit" : 7,
    "network-type" : "point-to-point",
    "dr-ip" : "dr-ip",
    "hello" : 5,
    "hello-due" : "hello-due",
    "mtu-mismatch-detection" : 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 vrouter-ospf-interface-show-response
Up
get /vrouters/{vrouter-name}/ospf-interfaces
(showVrouterOspfInterfacesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "broadcast" : "broadcast",
    "nic" : "nic",
    "dead" : 2,
    "api.switch-name" : "api.switch-name",
    "dr-id" : "dr-id",
    "l3-port" : 2,
    "bdr-ip" : "bdr-ip",
    "netmask" : 0,
    "router-id" : "router-id",
    "state" : "down",
    "area" : "area",
    "cost" : 5,
    "ip" : "ip",
    "bdr-id" : "bdr-id",
    "adjacent" : 3,
    "vrf" : "vrf",
    "priority" : 1,
    "nic-state" : "down",
    "neighbor" : 9,
    "mtu" : 6,
    "retransmit" : 7,
    "network-type" : "point-to-point",
    "dr-ip" : "dr-ip",
    "hello" : 5,
    "hello-due" : "hello-due",
    "mtu-mismatch-detection" : true
  }, {
    "broadcast" : "broadcast",
    "nic" : "nic",
    "dead" : 2,
    "api.switch-name" : "api.switch-name",
    "dr-id" : "dr-id",
    "l3-port" : 2,
    "bdr-ip" : "bdr-ip",
    "netmask" : 0,
    "router-id" : "router-id",
    "state" : "down",
    "area" : "area",
    "cost" : 5,
    "ip" : "ip",
    "bdr-id" : "bdr-id",
    "adjacent" : 3,
    "vrf" : "vrf",
    "priority" : 1,
    "nic-state" : "down",
    "neighbor" : 9,
    "mtu" : 6,
    "retransmit" : 7,
    "network-type" : "point-to-point",
    "dr-ip" : "dr-ip",
    "hello" : 5,
    "hello-due" : "hello-due",
    "mtu-mismatch-detection" : 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 vrouter-ospf-interface-show-response
Up
get /vrouters/{vrouter-name}/ospf-neighbors
(showVrouterOspfNeighborsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "l3-port" : 1,
    "address" : "address",
    "vlan" : 6,
    "dead-time" : "dead-time",
    "pri" : 0,
    "State" : "State",
    "vrf" : "vrf",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor"
  }, {
    "l3-port" : 1,
    "address" : "address",
    "vlan" : 6,
    "dead-time" : "dead-time",
    "pri" : 0,
    "State" : "State",
    "vrf" : "vrf",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-ospf-neighbor-show-response
Up
get /vrouters/{vrouter-name}/ospfs/network={network},vrf={vrf}
(showVrouterOspfsByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ospf-area" : 6,
    "netmask" : 0,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "ospf-area" : 6,
    "netmask" : 0,
    "vrf" : "vrf",
    "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 vrouter-ospf-show-response
Up
get /vrouters/{vrouter-name}/ospfs
(showVrouterOspfsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ospf-area" : 6,
    "netmask" : 0,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "ospf-area" : 6,
    "netmask" : 0,
    "vrf" : "vrf",
    "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 vrouter-ospf-show-response
Up
get /vrouters/{vrouter-name}/packet-relays/forward-proto={forward-proto},forward-ip={forward-ip},nic={nic}
(showVrouterPacketRelaysByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
forward-proto (required)
Path Parameter
forward-ip (required)
Path Parameter
nic (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "forward-proto" : "dhcp",
    "nic" : "nic",
    "forward-ip" : "forward-ip",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name"
  }, {
    "forward-proto" : "dhcp",
    "nic" : "nic",
    "forward-ip" : "forward-ip",
    "vrf" : "vrf",
    "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 vrouter-packet-relay-show-response
Up
get /vrouters/{vrouter-name}/packet-relays
(showVrouterPacketRelaysByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "forward-proto" : "dhcp",
    "nic" : "nic",
    "forward-ip" : "forward-ip",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name"
  }, {
    "forward-proto" : "dhcp",
    "nic" : "nic",
    "forward-ip" : "forward-ip",
    "vrf" : "vrf",
    "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 vrouter-packet-relay-show-response
Up
get /vrouters/{vrouter-name}/pim-configs/hello-interval/{hello-interval}
(showVrouterPimConfigByVnmNameByHelloInterval)

Path parameters

vrouter-name (required)
Path Parameter
hello-interval (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "api.switch-name" : "api.switch-name"
  }, {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "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 vrouter-pim-config-show-response
Up
get /vrouters/{vrouter-name}/pim-configs/querier-timeout/{querier-timeout}
(showVrouterPimConfigByVnmNameByQuerierTimeout)

Path parameters

vrouter-name (required)
Path Parameter
querier-timeout (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "api.switch-name" : "api.switch-name"
  }, {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "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 vrouter-pim-config-show-response
Up
get /vrouters/{vrouter-name}/pim-configs/query-interval/{query-interval}
(showVrouterPimConfigByVnmNameByQueryInterval)

Path parameters

vrouter-name (required)
Path Parameter
query-interval (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "api.switch-name" : "api.switch-name"
  }, {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "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 vrouter-pim-config-show-response
Up
get /vrouters/{vrouter-name}/pim-configs
(showVrouterPimConfigsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "api.switch-name" : "api.switch-name"
  }, {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "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 vrouter-pim-config-show-response
Up
get /vrouters/{vrouter-name}/pim-interfaces
(showVrouterPimInterfacesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlan-id" : 6,
    "name" : "name",
    "index" : 0,
    "if-state" : "down",
    "api.switch-name" : "api.switch-name",
    "local-address" : "local-address"
  }, {
    "vlan-id" : 6,
    "name" : "name",
    "index" : 0,
    "if-state" : "down",
    "api.switch-name" : "api.switch-name",
    "local-address" : "local-address"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-pim-interface-show-response
Up
get /vrouters/{vrouter-name}/pim-joins
(showVrouterPimJoinsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "incoming" : 0,
    "pruned-ifs" : "pruned-ifs",
    "upstream" : "upstream",
    "mrt-state" : "spt",
    "incoming-if" : "incoming-if",
    "rs-timer" : 5,
    "jp-timer" : 1,
    "leaf-ifs" : "leaf-ifs",
    "source" : "source",
    "pruned-bitmap" : 7,
    "asserted-bitmap" : 9,
    "entry-timer" : 3,
    "api.switch-name" : "api.switch-name",
    "oifs-bitmap" : 5,
    "outgoing-ifs" : "outgoing-ifs",
    "leaves-bitmap" : 6,
    "joined-bitmap" : 2,
    "joined-ifs" : "joined-ifs",
    "asserted-ifs" : "asserted-ifs",
    "group" : "group"
  }, {
    "incoming" : 0,
    "pruned-ifs" : "pruned-ifs",
    "upstream" : "upstream",
    "mrt-state" : "spt",
    "incoming-if" : "incoming-if",
    "rs-timer" : 5,
    "jp-timer" : 1,
    "leaf-ifs" : "leaf-ifs",
    "source" : "source",
    "pruned-bitmap" : 7,
    "asserted-bitmap" : 9,
    "entry-timer" : 3,
    "api.switch-name" : "api.switch-name",
    "oifs-bitmap" : 5,
    "outgoing-ifs" : "outgoing-ifs",
    "leaves-bitmap" : 6,
    "joined-bitmap" : 2,
    "joined-ifs" : "joined-ifs",
    "asserted-ifs" : "asserted-ifs",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-pim-join-show-response
Up
get /vrouters/{vrouter-name}/pim-neighbors
(showVrouterPimNeighborsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "timer" : "timer",
    "address" : "address",
    "holdt" : "holdt",
    "dr-priority" : 0,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "gen-id" : "gen-id",
    "uptime" : "uptime"
  }, {
    "timer" : "timer",
    "address" : "address",
    "holdt" : "holdt",
    "dr-priority" : 0,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "neighbor" : "neighbor",
    "gen-id" : "gen-id",
    "uptime" : "uptime"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-pim-neighbor-show-response
Up
get /vrouters/{vrouter-name}/pim-rps/rp-address={rp-address},group={group},netmask={netmask}
(showVrouterPimRpsByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
rp-address (required)
Path Parameter
group (required)
Path Parameter
netmask (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "rp-address" : "rp-address",
    "netmask" : 0,
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  }, {
    "rp-address" : "rp-address",
    "netmask" : 0,
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-pim-rp-show-response
Up
get /vrouters/{vrouter-name}/pim-rps
(showVrouterPimRpsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "rp-address" : "rp-address",
    "netmask" : 0,
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  }, {
    "rp-address" : "rp-address",
    "netmask" : 0,
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-pim-rp-show-response
Up
get /vrouters/{vrouter-name}/pim-ssm-maps/id={id},group={group},source={source}
(showVrouterPimSsmMapsByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
id (required)
Path Parameter
group (required)
Path Parameter
source (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "id" : 0,
    "source" : "source",
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  }, {
    "id" : 0,
    "source" : "source",
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-pim-ssm-map-show-response
Up
get /vrouters/{vrouter-name}/pim-ssm-maps
(showVrouterPimSsmMapsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "id" : 0,
    "source" : "source",
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  }, {
    "id" : 0,
    "source" : "source",
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-pim-ssm-map-show-response
Up
get /vrouters/{vrouter-name}/pim-ssm-ranges/id={id},group={group},netmask={netmask}
(showVrouterPimSsmRangesByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
id (required)
Path Parameter
group (required)
Path Parameter
netmask (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 6,
    "id" : 0,
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  }, {
    "netmask" : 6,
    "id" : 0,
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-pim-ssm-range-show-response
Up
get /vrouters/{vrouter-name}/pim-ssm-ranges
(showVrouterPimSsmRangesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 6,
    "id" : 0,
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  }, {
    "netmask" : 6,
    "id" : 0,
    "api.switch-name" : "api.switch-name",
    "group" : "group"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-pim-ssm-range-show-response
Up
get /vrouters/{vrouter-name}/prefix-lists/name={name},seq={seq}
(showVrouterPrefixListsByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
name (required)
Path Parameter
seq (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 6,
    "min-prefix-len" : 1,
    "prefix" : "prefix",
    "anyv6" : true,
    "name" : "name",
    "action" : "permit",
    "max-prefix-len" : 5,
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 0
  }, {
    "netmask" : 6,
    "min-prefix-len" : 1,
    "prefix" : "prefix",
    "anyv6" : true,
    "name" : "name",
    "action" : "permit",
    "max-prefix-len" : 5,
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 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 vrouter-prefix-list-show-response
Up
get /vrouters/{vrouter-name}/prefix-lists
(showVrouterPrefixListsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 6,
    "min-prefix-len" : 1,
    "prefix" : "prefix",
    "anyv6" : true,
    "name" : "name",
    "action" : "permit",
    "max-prefix-len" : 5,
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 0
  }, {
    "netmask" : 6,
    "min-prefix-len" : 1,
    "prefix" : "prefix",
    "anyv6" : true,
    "name" : "name",
    "action" : "permit",
    "max-prefix-len" : 5,
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 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 vrouter-prefix-list-show-response
Up
get /vrouters/{vrouter-name}/rips/{network}
(showVrouterRipByVnmNameByNetwork)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "vrf" : "vrf",
    "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 vrouter-rip-show-response
Up
get /vrouters/{vrouter-name}/rip-routes/{network}
(showVrouterRipRoutesByVnmNameByNetwork)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "metric" : 6,
    "source" : "source",
    "tag" : 1,
    "vrf" : "vrf",
    "next-hop" : "next-hop",
    "attribute" : "normal",
    "type" : "rip",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "metric" : 6,
    "source" : "source",
    "tag" : 1,
    "vrf" : "vrf",
    "next-hop" : "next-hop",
    "attribute" : "normal",
    "type" : "rip",
    "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 vrouter-rip-routes-show-response
Up
get /vrouters/{vrouter-name}/rip-routes
(showVrouterRipRoutesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "metric" : 6,
    "source" : "source",
    "tag" : 1,
    "vrf" : "vrf",
    "next-hop" : "next-hop",
    "attribute" : "normal",
    "type" : "rip",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "metric" : 6,
    "source" : "source",
    "tag" : 1,
    "vrf" : "vrf",
    "next-hop" : "next-hop",
    "attribute" : "normal",
    "type" : "rip",
    "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 vrouter-rip-routes-show-response
Up
get /vrouters/{vrouter-name}/rips
(showVrouterRipsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "vrf" : "vrf",
    "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 vrouter-rip-show-response
Up
get /vrouters/{vrouter-name}/route-maps/name={name},seq={seq}
(showVrouterRouteMapsByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
name (required)
Path Parameter
seq (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "match-mac" : "match-mac",
    "match-evpn-vni" : 1,
    "extended_comm_soo" : "extended_comm_soo",
    "exact-match" : true,
    "ipv6-nh-prefer-global" : "none",
    "metric-type" : "none",
    "origin" : "none",
    "as-path-prepend-last-as" : 5,
    "match-prefix" : "match-prefix",
    "match-evpn-default-route" : "none",
    "api.switch-name" : "api.switch-name",
    "match-evpn-route-type" : "none",
    "community-attribute" : "unset",
    "action" : "permit",
    "match-evpn-rd" : "match-evpn-rd",
    "seq" : 0,
    "community-attribute-generic" : "community-attribute-generic",
    "additive" : true,
    "metric" : 6,
    "local-pref" : 5,
    "name" : "name",
    "as-path-exclude" : "as-path-exclude",
    "as-path-prepend" : "as-path-prepend",
    "match-community" : "match-community",
    "comm-list-del" : "comm-list-del"
  }, {
    "match-mac" : "match-mac",
    "match-evpn-vni" : 1,
    "extended_comm_soo" : "extended_comm_soo",
    "exact-match" : true,
    "ipv6-nh-prefer-global" : "none",
    "metric-type" : "none",
    "origin" : "none",
    "as-path-prepend-last-as" : 5,
    "match-prefix" : "match-prefix",
    "match-evpn-default-route" : "none",
    "api.switch-name" : "api.switch-name",
    "match-evpn-route-type" : "none",
    "community-attribute" : "unset",
    "action" : "permit",
    "match-evpn-rd" : "match-evpn-rd",
    "seq" : 0,
    "community-attribute-generic" : "community-attribute-generic",
    "additive" : true,
    "metric" : 6,
    "local-pref" : 5,
    "name" : "name",
    "as-path-exclude" : "as-path-exclude",
    "as-path-prepend" : "as-path-prepend",
    "match-community" : "match-community",
    "comm-list-del" : "comm-list-del"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-route-map-show-response
Up
get /vrouters/{vrouter-name}/route-maps
(showVrouterRouteMapsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "match-mac" : "match-mac",
    "match-evpn-vni" : 1,
    "extended_comm_soo" : "extended_comm_soo",
    "exact-match" : true,
    "ipv6-nh-prefer-global" : "none",
    "metric-type" : "none",
    "origin" : "none",
    "as-path-prepend-last-as" : 5,
    "match-prefix" : "match-prefix",
    "match-evpn-default-route" : "none",
    "api.switch-name" : "api.switch-name",
    "match-evpn-route-type" : "none",
    "community-attribute" : "unset",
    "action" : "permit",
    "match-evpn-rd" : "match-evpn-rd",
    "seq" : 0,
    "community-attribute-generic" : "community-attribute-generic",
    "additive" : true,
    "metric" : 6,
    "local-pref" : 5,
    "name" : "name",
    "as-path-exclude" : "as-path-exclude",
    "as-path-prepend" : "as-path-prepend",
    "match-community" : "match-community",
    "comm-list-del" : "comm-list-del"
  }, {
    "match-mac" : "match-mac",
    "match-evpn-vni" : 1,
    "extended_comm_soo" : "extended_comm_soo",
    "exact-match" : true,
    "ipv6-nh-prefer-global" : "none",
    "metric-type" : "none",
    "origin" : "none",
    "as-path-prepend-last-as" : 5,
    "match-prefix" : "match-prefix",
    "match-evpn-default-route" : "none",
    "api.switch-name" : "api.switch-name",
    "match-evpn-route-type" : "none",
    "community-attribute" : "unset",
    "action" : "permit",
    "match-evpn-rd" : "match-evpn-rd",
    "seq" : 0,
    "community-attribute-generic" : "community-attribute-generic",
    "additive" : true,
    "metric" : 6,
    "local-pref" : 5,
    "name" : "name",
    "as-path-exclude" : "as-path-exclude",
    "as-path-prepend" : "as-path-prepend",
    "match-community" : "match-community",
    "comm-list-del" : "comm-list-del"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-route-map-show-response
Up
get /vrouters/{vrouter-name}/static-bfds/src-ip={src-ip},dst-ip={dst-ip},vrf={vrf}
(showVrouterStaticBfdsByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
src-ip (required)
Path Parameter
dst-ip (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "vrf" : "vrf",
    "type" : "single-hop",
    "api.switch-name" : "api.switch-name"
  }, {
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "vrf" : "vrf",
    "type" : "single-hop",
    "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 vrouter-static-bfd-show-response
Up
get /vrouters/{vrouter-name}/static-bfds
(showVrouterStaticBfdsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "vrf" : "vrf",
    "type" : "single-hop",
    "api.switch-name" : "api.switch-name"
  }, {
    "src-ip" : "src-ip",
    "dst-ip" : "dst-ip",
    "vrf" : "vrf",
    "type" : "single-hop",
    "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 vrouter-static-bfd-show-response
Up
get /vrouters/{vrouter-name}/static-routes/network={network},netmask={netmask},gateway-ip={gateway-ip},interface={interface},vrf={vrf}
(showVrouterStaticRoutesByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
gateway-ip (required)
Path Parameter
interface (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "drop" : true,
    "bfd" : "single-hop",
    "bfd-dst-ip" : "bfd-dst-ip",
    "distance" : 6,
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "vrf" : "vrf",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "bfd-src-ip" : "bfd-src-ip",
    "network" : "network"
  }, {
    "drop" : true,
    "bfd" : "single-hop",
    "bfd-dst-ip" : "bfd-dst-ip",
    "distance" : 6,
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "vrf" : "vrf",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "bfd-src-ip" : "bfd-src-ip",
    "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 vrouter-static-route-show-response
Up
get /vrouters/{vrouter-name}/static-routes
(showVrouterStaticRoutesByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "drop" : true,
    "bfd" : "single-hop",
    "bfd-dst-ip" : "bfd-dst-ip",
    "distance" : 6,
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "vrf" : "vrf",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "bfd-src-ip" : "bfd-src-ip",
    "network" : "network"
  }, {
    "drop" : true,
    "bfd" : "single-hop",
    "bfd-dst-ip" : "bfd-dst-ip",
    "distance" : 6,
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "vrf" : "vrf",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "bfd-src-ip" : "bfd-src-ip",
    "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 vrouter-static-route-show-response
Up
get /vrouters/{vrouter-name}/vrfs/{vrf}
(showVrouterVrouterVrfByVnmNameByVrfName)

Path parameters

vrouter-name (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bgp-default-shutdown" : true,
    "bgp-cluster-id" : "bgp-cluster-id",
    "api.switch-name" : "api.switch-name",
    "bgp-redist-ospf-route-map" : "bgp-redist-ospf-route-map",
    "no-bgp-redist-ospf-route-map" : true,
    "bgp-keepalive-interval" : 9,
    "bgp-bestpath-as-path" : "ignore",
    "bgp-distance-internal" : 4,
    "bgp-global-nh-preference" : "none",
    "bgp-ibgp-multipath" : 1,
    "router-id" : "router-id",
    "bgp-redist-rip-metric" : 5,
    "bgp-distance-external" : 2,
    "hw-vrid" : 0,
    "bgp-max-paths" : 1,
    "bgp-distance-local" : 7,
    "bgp-redist-connected-metric" : 1,
    "bgp-update-delay-strict" : 7,
    "bgp-graceful-shutdown" : true,
    "bgp-redistribute" : "static",
    "bgp-delayed-startup" : 2,
    "vrf" : "vrf",
    "bgp-redist-ospf-metric" : 5,
    "bgp-as" : 1,
    "bgp-holdtime" : 3,
    "no-bgp-redist-connected-route-map" : true,
    "bgp-redist-static-route-map" : "bgp-redist-static-route-map",
    "no-bgp-redist-static-route-map" : true,
    "bgp-redist-connected-route-map" : "bgp-redist-connected-route-map",
    "bgp-dampening" : true,
    "bgp-redist-static-metric" : 6
  }, {
    "bgp-default-shutdown" : true,
    "bgp-cluster-id" : "bgp-cluster-id",
    "api.switch-name" : "api.switch-name",
    "bgp-redist-ospf-route-map" : "bgp-redist-ospf-route-map",
    "no-bgp-redist-ospf-route-map" : true,
    "bgp-keepalive-interval" : 9,
    "bgp-bestpath-as-path" : "ignore",
    "bgp-distance-internal" : 4,
    "bgp-global-nh-preference" : "none",
    "bgp-ibgp-multipath" : 1,
    "router-id" : "router-id",
    "bgp-redist-rip-metric" : 5,
    "bgp-distance-external" : 2,
    "hw-vrid" : 0,
    "bgp-max-paths" : 1,
    "bgp-distance-local" : 7,
    "bgp-redist-connected-metric" : 1,
    "bgp-update-delay-strict" : 7,
    "bgp-graceful-shutdown" : true,
    "bgp-redistribute" : "static",
    "bgp-delayed-startup" : 2,
    "vrf" : "vrf",
    "bgp-redist-ospf-metric" : 5,
    "bgp-as" : 1,
    "bgp-holdtime" : 3,
    "no-bgp-redist-connected-route-map" : true,
    "bgp-redist-static-route-map" : "bgp-redist-static-route-map",
    "no-bgp-redist-static-route-map" : true,
    "bgp-redist-connected-route-map" : "bgp-redist-connected-route-map",
    "bgp-dampening" : true,
    "bgp-redist-static-metric" : 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 vrouter-vrf-show-response
Up
get /vrouters/{vrouter-name}/vrfs
(showVrouterVrouterVrfsByVrouterVnmName)

Path parameters

vrouter-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bgp-default-shutdown" : true,
    "bgp-cluster-id" : "bgp-cluster-id",
    "api.switch-name" : "api.switch-name",
    "bgp-redist-ospf-route-map" : "bgp-redist-ospf-route-map",
    "no-bgp-redist-ospf-route-map" : true,
    "bgp-keepalive-interval" : 9,
    "bgp-bestpath-as-path" : "ignore",
    "bgp-distance-internal" : 4,
    "bgp-global-nh-preference" : "none",
    "bgp-ibgp-multipath" : 1,
    "router-id" : "router-id",
    "bgp-redist-rip-metric" : 5,
    "bgp-distance-external" : 2,
    "hw-vrid" : 0,
    "bgp-max-paths" : 1,
    "bgp-distance-local" : 7,
    "bgp-redist-connected-metric" : 1,
    "bgp-update-delay-strict" : 7,
    "bgp-graceful-shutdown" : true,
    "bgp-redistribute" : "static",
    "bgp-delayed-startup" : 2,
    "vrf" : "vrf",
    "bgp-redist-ospf-metric" : 5,
    "bgp-as" : 1,
    "bgp-holdtime" : 3,
    "no-bgp-redist-connected-route-map" : true,
    "bgp-redist-static-route-map" : "bgp-redist-static-route-map",
    "no-bgp-redist-static-route-map" : true,
    "bgp-redist-connected-route-map" : "bgp-redist-connected-route-map",
    "bgp-dampening" : true,
    "bgp-redist-static-metric" : 6
  }, {
    "bgp-default-shutdown" : true,
    "bgp-cluster-id" : "bgp-cluster-id",
    "api.switch-name" : "api.switch-name",
    "bgp-redist-ospf-route-map" : "bgp-redist-ospf-route-map",
    "no-bgp-redist-ospf-route-map" : true,
    "bgp-keepalive-interval" : 9,
    "bgp-bestpath-as-path" : "ignore",
    "bgp-distance-internal" : 4,
    "bgp-global-nh-preference" : "none",
    "bgp-ibgp-multipath" : 1,
    "router-id" : "router-id",
    "bgp-redist-rip-metric" : 5,
    "bgp-distance-external" : 2,
    "hw-vrid" : 0,
    "bgp-max-paths" : 1,
    "bgp-distance-local" : 7,
    "bgp-redist-connected-metric" : 1,
    "bgp-update-delay-strict" : 7,
    "bgp-graceful-shutdown" : true,
    "bgp-redistribute" : "static",
    "bgp-delayed-startup" : 2,
    "vrf" : "vrf",
    "bgp-redist-ospf-metric" : 5,
    "bgp-as" : 1,
    "bgp-holdtime" : 3,
    "no-bgp-redist-connected-route-map" : true,
    "bgp-redist-static-route-map" : "bgp-redist-static-route-map",
    "no-bgp-redist-static-route-map" : true,
    "bgp-redist-connected-route-map" : "bgp-redist-connected-route-map",
    "bgp-dampening" : true,
    "bgp-redist-static-metric" : 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 vrouter-vrf-show-response
Up
get /vrouters
(showVrouters)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "evpn-border" : true,
    "bgp-default-shutdown" : true,
    "ospf-spf-consec-delay" : 1,
    "evpn-dup-addr-freeze" : 5,
    "type" : "vnet-mgr",
    "no-bgp-redist-ospf-route-map" : true,
    "ospf-spf-delay" : 7,
    "ospf-redist-connected-route-map" : "ospf-redist-connected-route-map",
    "ospf6-spf-delay" : 5,
    "bgp-bestpath-as-path" : "ignore",
    "ospf-default-info-originate-metric" : 6,
    "storage-pool" : "storage-pool",
    "bgp-distance-internal" : 1,
    "bgp-ibgp-multipath" : 3,
    "router-id" : "router-id",
    "ospf-redist-connected-metric-type" : "1",
    "bgp-redist-rip-metric" : 9,
    "ip-snmp" : true,
    "ospf-snmp" : true,
    "state" : "disable",
    "id" : "id",
    "rip-redistribute" : "static",
    "ospf-redist-static-metric" : 6,
    "hw-router-mac" : "hw-router-mac",
    "ospf-snmp-notification" : true,
    "hw-vrid" : 0,
    "ospf-redist-bgp-route-map" : "ospf-redist-bgp-route-map",
    "ospf-default-information" : "none",
    "bgp-distance-local" : 6,
    "bgp-snmp" : true,
    "ospf-redist-static-route-map" : "ospf-redist-static-route-map",
    "bgp-graceful-shutdown" : true,
    "ospf-distance-local" : 1,
    "bgp-redistribute" : "static",
    "ospf6-snmp-notification" : true,
    "vrf" : "vrf",
    "ospf-redist-rip-metric-type" : "1",
    "evpn-dup-addr-moves-duration" : 5,
    "bgp-holdtime" : 1,
    "no-bgp-redist-connected-route-map" : true,
    "ospf-redist-connected-metric" : 8,
    "router-type" : "software",
    "vnet-service" : true,
    "evpn-dup-addr-max-moves" : 1,
    "bgp-redist-connected-route-map" : "bgp-redist-connected-route-map",
    "name" : "name",
    "bgp-dampening" : true,
    "router-ipstack" : "quagga",
    "bgp-redist-static-metric" : 2,
    "template" : true,
    "ospf-spf-max-delay" : 4,
    "ospf-redistribute" : "static",
    "fabric-comm" : true,
    "ospf-redist-bgp-metric-type" : "1",
    "ospf-default-info-originate-metric-type" : "1",
    "ospf-default-info-originate-route-map" : "ospf-default-info-originate-route-map",
    "bgp-cluster-id" : "bgp-cluster-id",
    "hw-vrrp-id" : 3,
    "api.switch-name" : "api.switch-name",
    "bgp-redist-ospf-route-map" : "bgp-redist-ospf-route-map",
    "ospf6-spf-max-delay" : 9,
    "vnet" : "vnet",
    "ospf-distance-internal" : 6,
    "bgp-keepalive-interval" : 7,
    "ospf-redist-static-metric-type" : "1",
    "bgp-global-nh-preference" : "none",
    "bgp-snmp-notification" : true,
    "proto-routing" : "bgp",
    "scope" : "local",
    "ospf-redist-rip-metric" : 9,
    "ospf-distance-external" : 3,
    "bgp-distance-external" : 1,
    "bgp-max-paths" : 6,
    "bgp-redist-connected-metric" : 7,
    "ospf-bfd-all-if" : true,
    "ospf6-snmp" : true,
    "evpn-export-all-leaked-networks" : "permit",
    "bgp-update-delay-strict" : 4,
    "ospf-stub-router-on-startup" : true,
    "bgp-network-import-check" : true,
    "failover-action" : "stop-old",
    "bgp-delayed-startup" : 2,
    "bgp-redist-ospf-metric" : 3,
    "failover-controller" : 6,
    "bgp-as" : 5,
    "ospf-redist-bgp-metric" : 6,
    "ospf-stub-router-on-startup-period" : 2,
    "bgp-redist-static-route-map" : "bgp-redist-static-route-map",
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "ospf6-spf-consecu-delay" : 9,
    "no-bgp-redist-static-route-map" : true,
    "cluster-active-active-routing" : true,
    "location" : 6,
    "vrrp-track-port" : "vrrp-track-port",
    "gateway" : "gateway"
  }, {
    "evpn-border" : true,
    "bgp-default-shutdown" : true,
    "ospf-spf-consec-delay" : 1,
    "evpn-dup-addr-freeze" : 5,
    "type" : "vnet-mgr",
    "no-bgp-redist-ospf-route-map" : true,
    "ospf-spf-delay" : 7,
    "ospf-redist-connected-route-map" : "ospf-redist-connected-route-map",
    "ospf6-spf-delay" : 5,
    "bgp-bestpath-as-path" : "ignore",
    "ospf-default-info-originate-metric" : 6,
    "storage-pool" : "storage-pool",
    "bgp-distance-internal" : 1,
    "bgp-ibgp-multipath" : 3,
    "router-id" : "router-id",
    "ospf-redist-connected-metric-type" : "1",
    "bgp-redist-rip-metric" : 9,
    "ip-snmp" : true,
    "ospf-snmp" : true,
    "state" : "disable",
    "id" : "id",
    "rip-redistribute" : "static",
    "ospf-redist-static-metric" : 6,
    "hw-router-mac" : "hw-router-mac",
    "ospf-snmp-notification" : true,
    "hw-vrid" : 0,
    "ospf-redist-bgp-route-map" : "ospf-redist-bgp-route-map",
    "ospf-default-information" : "none",
    "bgp-distance-local" : 6,
    "bgp-snmp" : true,
    "ospf-redist-static-route-map" : "ospf-redist-static-route-map",
    "bgp-graceful-shutdown" : true,
    "ospf-distance-local" : 1,
    "bgp-redistribute" : "static",
    "ospf6-snmp-notification" : true,
    "vrf" : "vrf",
    "ospf-redist-rip-metric-type" : "1",
    "evpn-dup-addr-moves-duration" : 5,
    "bgp-holdtime" : 1,
    "no-bgp-redist-connected-route-map" : true,
    "ospf-redist-connected-metric" : 8,
    "router-type" : "software",
    "vnet-service" : true,
    "evpn-dup-addr-max-moves" : 1,
    "bgp-redist-connected-route-map" : "bgp-redist-connected-route-map",
    "name" : "name",
    "bgp-dampening" : true,
    "router-ipstack" : "quagga",
    "bgp-redist-static-metric" : 2,
    "template" : true,
    "ospf-spf-max-delay" : 4,
    "ospf-redistribute" : "static",
    "fabric-comm" : true,
    "ospf-redist-bgp-metric-type" : "1",
    "ospf-default-info-originate-metric-type" : "1",
    "ospf-default-info-originate-route-map" : "ospf-default-info-originate-route-map",
    "bgp-cluster-id" : "bgp-cluster-id",
    "hw-vrrp-id" : 3,
    "api.switch-name" : "api.switch-name",
    "bgp-redist-ospf-route-map" : "bgp-redist-ospf-route-map",
    "ospf6-spf-max-delay" : 9,
    "vnet" : "vnet",
    "ospf-distance-internal" : 6,
    "bgp-keepalive-interval" : 7,
    "ospf-redist-static-metric-type" : "1",
    "bgp-global-nh-preference" : "none",
    "bgp-snmp-notification" : true,
    "proto-routing" : "bgp",
    "scope" : "local",
    "ospf-redist-rip-metric" : 9,
    "ospf-distance-external" : 3,
    "bgp-distance-external" : 1,
    "bgp-max-paths" : 6,
    "bgp-redist-connected-metric" : 7,
    "ospf-bfd-all-if" : true,
    "ospf6-snmp" : true,
    "evpn-export-all-leaked-networks" : "permit",
    "bgp-update-delay-strict" : 4,
    "ospf-stub-router-on-startup" : true,
    "bgp-network-import-check" : true,
    "failover-action" : "stop-old",
    "bgp-delayed-startup" : 2,
    "bgp-redist-ospf-metric" : 3,
    "failover-controller" : 6,
    "bgp-as" : 5,
    "ospf-redist-bgp-metric" : 6,
    "ospf-stub-router-on-startup-period" : 2,
    "bgp-redist-static-route-map" : "bgp-redist-static-route-map",
    "shared-vnet-mgr" : "shared-vnet-mgr",
    "ospf6-spf-consecu-delay" : 9,
    "no-bgp-redist-static-route-map" : true,
    "cluster-active-active-routing" : true,
    "location" : 6,
    "vrrp-track-port" : "vrrp-track-port",
    "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 vrouter-show-response
Up
post /vrouters/{vrouter-name}/bgp-neighbors/shutdown
(shutdownVrouterBgpNeighborByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/evpn-bgp-neighbors/shutdown
(shutdownVrouterEvpnBgpNeighborByVrouterVnmName)

Path parameters

vrouter-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

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/bgp-aggregate-addresses/network={network},netmask={netmask},vrf={vrf}
(updateVrouterBgpAggrAddrByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "route-map" : "route-map",
    "netmask" : 0,
    "origin" : "none",
    "as-set" : true,
    "matching-MED-only" : true,
    "vrf" : "vrf",
    "suppress-map" : "suppress-map",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "summary-only" : true
  }, {
    "route-map" : "route-map",
    "netmask" : 0,
    "origin" : "none",
    "as-set" : true,
    "matching-MED-only" : true,
    "vrf" : "vrf",
    "suppress-map" : "suppress-map",
    "api.switch-name" : "api.switch-name",
    "network" : "network",
    "summary-only" : 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 vrouter-bgp-aggregate-address-show-response
Up
put /vrouters/{vrouter-name}/bgps/l3-port/{l3-port}
(updateVrouterBgpByVnmNameByL3Port)

Path parameters

vrouter-name (required)
Path Parameter
l3-port (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vrouter-bgp-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : true
  }, {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : 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 vrouter-bgp-show-response
Up
put /vrouters/{vrouter-name}/bgps/neighbor/{neighbor}
(updateVrouterBgpByVnmNameByNeighbor)

Path parameters

vrouter-name (required)
Path Parameter
neighbor (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vrouter-bgp-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : true
  }, {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : 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 vrouter-bgp-show-response
Up
put /vrouters/{vrouter-name}/bgps/vrf/{vrf}
(updateVrouterBgpByVnmNameByVrf)

Path parameters

vrouter-name (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vrouter-bgp-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : true
  }, {
    "update-source-interface" : "update-source-interface",
    "as-override" : true,
    "prepend" : true,
    "send-community" : true,
    "route-map-in" : "route-map-in",
    "advertisement-interval" : 4,
    "description" : "description",
    "remote-as" : 9,
    "allowas-in-occurrences" : 2,
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "ebgp-multihop" : 1,
    "prefix-list-in" : "prefix-list-in",
    "l3-port" : 0,
    "unnumbered-interop" : true,
    "max-prefix-warn-only" : true,
    "max-prefix" : 5,
    "neighbor-keepalive-interval" : 5,
    "allowas-in" : true,
    "route-map-out" : "route-map-out",
    "allowas-in-origin" : true,
    "prefix-list-out" : "prefix-list-out",
    "local-as" : 3,
    "soft-reconfig-inbound" : true,
    "bfd" : true,
    "next-hop-self" : true,
    "weight" : 6,
    "vrf" : "vrf",
    "replace-as" : true,
    "neighbor" : "neighbor",
    "bfd-multihop" : true,
    "neighbor-holdtime" : 2,
    "connect-retry-interval" : 7,
    "route-reflector-client" : true,
    "multi-protocol" : "ipv4-unicast",
    "default-originate" : true,
    "update-source" : "update-source",
    "override-capability" : 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 vrouter-bgp-show-response
Up
put /vrouters/{name}
(updateVrouterByVnmName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vrouter-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vrouters/{vrouter-name}/mac-lists/name={name},seq={seq}
(updateVrouterMacListByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
name (required)
Path Parameter
seq (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vrouter-mac-list-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "action" : "permit",
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 0,
    "mac" : "mac"
  }, {
    "name" : "name",
    "action" : "permit",
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 0,
    "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 vrouter-mac-list-show-response
Up
put /vrouters/{vrouter-name}/interfaces/{nic}
(updateVrouterNicByVnmNameByVnic)

Path parameters

vrouter-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 vrouter-interface-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "sriov-vf" : true,
    "assignment2" : "none",
    "fabric-nic" : true,
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 9,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "l3-port" : 0,
    "vlan" : 2,
    "netmask" : 6,
    "linklocal" : "linklocal",
    "pim" : true,
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 5,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 7,
    "pim-dr-priority" : 3,
    "vrrp-primary" : "vrrp-primary",
    "pim-cluster" : true,
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 4,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "mtu" : 5,
    "vrrp-id" : 2,
    "is-primary" : true,
    "priority-tag" : true,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : true,
    "netmask2" : 1
  }, {
    "sriov-vf" : true,
    "assignment2" : "none",
    "fabric-nic" : true,
    "bd" : "bd",
    "if-nat-realm" : "internal",
    "is-primary2" : true,
    "secondary-macs" : "secondary-macs",
    "mirror-traffic" : true,
    "pim-vlag-vlan" : true,
    "vlan-type" : "public",
    "nic" : "nic",
    "sec-addresses" : 9,
    "nic-config" : true,
    "api.switch-name" : "api.switch-name",
    "mac" : "mac",
    "l3-port" : 0,
    "vlan" : 2,
    "netmask" : 6,
    "linklocal" : "linklocal",
    "pim" : true,
    "vrrp-state" : "slave",
    "alias-on" : "alias-on",
    "public-vlan" : 5,
    "vnet-id" : "vnet-id",
    "exclusive" : true,
    "assignment-linklocal" : "none",
    "if" : "mgmt",
    "vrrp-preempt-mode" : "disable",
    "vrrp-priority" : 7,
    "pim-dr-priority" : 3,
    "vrrp-primary" : "vrrp-primary",
    "pim-cluster" : true,
    "ip" : "ip",
    "ip2" : "ip2",
    "vrf" : "vrf",
    "vrrp-adv-int" : 4,
    "nic-state" : "down",
    "is-vip" : true,
    "wake-on-lan" : true,
    "mtu" : 5,
    "vrrp-id" : 2,
    "is-primary" : true,
    "priority-tag" : true,
    "vm-nic-type" : "e1000",
    "ipv6-unnumbered" : true,
    "netmask2" : 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 vrouter-interface-show-response
Up
put /vrouters/{vrouter-name}/interface-configs/l3-port/{l3-port}
(updateVrouterNicConfigByVnmNameByL3Port)

Path parameters

vrouter-name (required)
Path Parameter
l3-port (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ospf-cost" : 2,
    "bfd-min-rx" : 3,
    "ospf-network-type" : "default",
    "ospf-passive-if" : true,
    "nic" : "nic",
    "ospf-priority" : 5,
    "bfd-interval" : 9,
    "vrf" : "vrf",
    "ospf-msg-digest-id" : 7,
    "ospf-bfd" : "default",
    "api.switch-name" : "api.switch-name",
    "suppress-ra" : true,
    "ospf-auth-key" : "ospf-auth-key",
    "l3-port" : 0,
    "ospf-hello-interval" : 6,
    "ra-interval" : 4,
    "ra-lifetime" : 7,
    "bfd-multiplier" : 2,
    "ospf-dead-interval" : 1,
    "ospf-retransmit-interval" : 5,
    "ospf-msg-digest-key" : "ospf-msg-digest-key"
  }, {
    "ospf-cost" : 2,
    "bfd-min-rx" : 3,
    "ospf-network-type" : "default",
    "ospf-passive-if" : true,
    "nic" : "nic",
    "ospf-priority" : 5,
    "bfd-interval" : 9,
    "vrf" : "vrf",
    "ospf-msg-digest-id" : 7,
    "ospf-bfd" : "default",
    "api.switch-name" : "api.switch-name",
    "suppress-ra" : true,
    "ospf-auth-key" : "ospf-auth-key",
    "l3-port" : 0,
    "ospf-hello-interval" : 6,
    "ra-interval" : 4,
    "ra-lifetime" : 7,
    "bfd-multiplier" : 2,
    "ospf-dead-interval" : 1,
    "ospf-retransmit-interval" : 5,
    "ospf-msg-digest-key" : "ospf-msg-digest-key"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-interface-config-show-response
Up
put /vrouters/{vrouter-name}/interface-configs/nic/{nic}
(updateVrouterNicConfigByVnmNameByVnic)

Path parameters

vrouter-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 Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "ospf-cost" : 2,
    "bfd-min-rx" : 3,
    "ospf-network-type" : "default",
    "ospf-passive-if" : true,
    "nic" : "nic",
    "ospf-priority" : 5,
    "bfd-interval" : 9,
    "vrf" : "vrf",
    "ospf-msg-digest-id" : 7,
    "ospf-bfd" : "default",
    "api.switch-name" : "api.switch-name",
    "suppress-ra" : true,
    "ospf-auth-key" : "ospf-auth-key",
    "l3-port" : 0,
    "ospf-hello-interval" : 6,
    "ra-interval" : 4,
    "ra-lifetime" : 7,
    "bfd-multiplier" : 2,
    "ospf-dead-interval" : 1,
    "ospf-retransmit-interval" : 5,
    "ospf-msg-digest-key" : "ospf-msg-digest-key"
  }, {
    "ospf-cost" : 2,
    "bfd-min-rx" : 3,
    "ospf-network-type" : "default",
    "ospf-passive-if" : true,
    "nic" : "nic",
    "ospf-priority" : 5,
    "bfd-interval" : 9,
    "vrf" : "vrf",
    "ospf-msg-digest-id" : 7,
    "ospf-bfd" : "default",
    "api.switch-name" : "api.switch-name",
    "suppress-ra" : true,
    "ospf-auth-key" : "ospf-auth-key",
    "l3-port" : 0,
    "ospf-hello-interval" : 6,
    "ra-interval" : 4,
    "ra-lifetime" : 7,
    "bfd-multiplier" : 2,
    "ospf-dead-interval" : 1,
    "ospf-retransmit-interval" : 5,
    "ospf-msg-digest-key" : "ospf-msg-digest-key"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-interface-config-show-response
Up
put /vrouters/{vrouter-name}/ospf-areas/{area}
(updateVrouterOspfAreaByVnmNameByArea)

Path parameters

vrouter-name (required)
Path Parameter
area (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vrouter-ospf-area-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "area" : 0,
    "stub-type" : "none",
    "prefix-list-out" : "prefix-list-out",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "prefix-list-in" : "prefix-list-in"
  }, {
    "area" : 0,
    "stub-type" : "none",
    "prefix-list-out" : "prefix-list-out",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "prefix-list-in" : "prefix-list-in"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-ospf-area-show-response
Up
put /vrouters/{vrouter-name}/pim-configs/hello-interval/{hello-interval}
(updateVrouterPimConfigByVnmNameByHelloInterval)

Path parameters

vrouter-name (required)
Path Parameter
hello-interval (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "api.switch-name" : "api.switch-name"
  }, {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "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 vrouter-pim-config-show-response
Up
put /vrouters/{vrouter-name}/pim-configs/querier-timeout/{querier-timeout}
(updateVrouterPimConfigByVnmNameByQuerierTimeout)

Path parameters

vrouter-name (required)
Path Parameter
querier-timeout (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "api.switch-name" : "api.switch-name"
  }, {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "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 vrouter-pim-config-show-response
Up
put /vrouters/{vrouter-name}/pim-configs/query-interval/{query-interval}
(updateVrouterPimConfigByVnmNameByQueryInterval)

Path parameters

vrouter-name (required)
Path Parameter
query-interval (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "api.switch-name" : "api.switch-name"
  }, {
    "querier-timeout" : 6,
    "hello-interval" : 0,
    "query-interval" : 1,
    "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 vrouter-pim-config-show-response
Up
put /vrouters/{vrouter-name}/prefix-lists/name={name},seq={seq}
(updateVrouterPrefixListByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
name (required)
Path Parameter
seq (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 6,
    "min-prefix-len" : 1,
    "prefix" : "prefix",
    "anyv6" : true,
    "name" : "name",
    "action" : "permit",
    "max-prefix-len" : 5,
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 0
  }, {
    "netmask" : 6,
    "min-prefix-len" : 1,
    "prefix" : "prefix",
    "anyv6" : true,
    "name" : "name",
    "action" : "permit",
    "max-prefix-len" : 5,
    "api.switch-name" : "api.switch-name",
    "any" : true,
    "seq" : 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 vrouter-prefix-list-show-response
Up
put /vrouters/{vrouter-name}/route-maps/name={name},seq={seq}
(updateVrouterRouteMapByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
name (required)
Path Parameter
seq (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vrouter-route-map-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "match-mac" : "match-mac",
    "match-evpn-vni" : 1,
    "extended_comm_soo" : "extended_comm_soo",
    "exact-match" : true,
    "ipv6-nh-prefer-global" : "none",
    "metric-type" : "none",
    "origin" : "none",
    "as-path-prepend-last-as" : 5,
    "match-prefix" : "match-prefix",
    "match-evpn-default-route" : "none",
    "api.switch-name" : "api.switch-name",
    "match-evpn-route-type" : "none",
    "community-attribute" : "unset",
    "action" : "permit",
    "match-evpn-rd" : "match-evpn-rd",
    "seq" : 0,
    "community-attribute-generic" : "community-attribute-generic",
    "additive" : true,
    "metric" : 6,
    "local-pref" : 5,
    "name" : "name",
    "as-path-exclude" : "as-path-exclude",
    "as-path-prepend" : "as-path-prepend",
    "match-community" : "match-community",
    "comm-list-del" : "comm-list-del"
  }, {
    "match-mac" : "match-mac",
    "match-evpn-vni" : 1,
    "extended_comm_soo" : "extended_comm_soo",
    "exact-match" : true,
    "ipv6-nh-prefer-global" : "none",
    "metric-type" : "none",
    "origin" : "none",
    "as-path-prepend-last-as" : 5,
    "match-prefix" : "match-prefix",
    "match-evpn-default-route" : "none",
    "api.switch-name" : "api.switch-name",
    "match-evpn-route-type" : "none",
    "community-attribute" : "unset",
    "action" : "permit",
    "match-evpn-rd" : "match-evpn-rd",
    "seq" : 0,
    "community-attribute-generic" : "community-attribute-generic",
    "additive" : true,
    "metric" : 6,
    "local-pref" : 5,
    "name" : "name",
    "as-path-exclude" : "as-path-exclude",
    "as-path-prepend" : "as-path-prepend",
    "match-community" : "match-community",
    "comm-list-del" : "comm-list-del"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success vrouter-route-map-show-response
Up
put /vrouters/{vrouter-name}/static-routes/network={network},netmask={netmask},gateway-ip={gateway-ip},interface={interface},vrf={vrf}
(updateVrouterStaticRouteByVnmNameUniqueKeyAll)

Path parameters

vrouter-name (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
gateway-ip (required)
Path Parameter
interface (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "drop" : true,
    "bfd" : "single-hop",
    "bfd-dst-ip" : "bfd-dst-ip",
    "distance" : 6,
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "vrf" : "vrf",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "bfd-src-ip" : "bfd-src-ip",
    "network" : "network"
  }, {
    "drop" : true,
    "bfd" : "single-hop",
    "bfd-dst-ip" : "bfd-dst-ip",
    "distance" : 6,
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "vrf" : "vrf",
    "interface" : "interface",
    "api.switch-name" : "api.switch-name",
    "bfd-src-ip" : "bfd-src-ip",
    "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 vrouter-static-route-show-response
Up
put /vrouters/{vrouter-name}/vrfs/{vrf}
(updateVrouterVrouterVrfByVnmNameByVrfName)

Path parameters

vrouter-name (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vrouter-vrf-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bgp-default-shutdown" : true,
    "bgp-cluster-id" : "bgp-cluster-id",
    "api.switch-name" : "api.switch-name",
    "bgp-redist-ospf-route-map" : "bgp-redist-ospf-route-map",
    "no-bgp-redist-ospf-route-map" : true,
    "bgp-keepalive-interval" : 9,
    "bgp-bestpath-as-path" : "ignore",
    "bgp-distance-internal" : 4,
    "bgp-global-nh-preference" : "none",
    "bgp-ibgp-multipath" : 1,
    "router-id" : "router-id",
    "bgp-redist-rip-metric" : 5,
    "bgp-distance-external" : 2,
    "hw-vrid" : 0,
    "bgp-max-paths" : 1,
    "bgp-distance-local" : 7,
    "bgp-redist-connected-metric" : 1,
    "bgp-update-delay-strict" : 7,
    "bgp-graceful-shutdown" : true,
    "bgp-redistribute" : "static",
    "bgp-delayed-startup" : 2,
    "vrf" : "vrf",
    "bgp-redist-ospf-metric" : 5,
    "bgp-as" : 1,
    "bgp-holdtime" : 3,
    "no-bgp-redist-connected-route-map" : true,
    "bgp-redist-static-route-map" : "bgp-redist-static-route-map",
    "no-bgp-redist-static-route-map" : true,
    "bgp-redist-connected-route-map" : "bgp-redist-connected-route-map",
    "bgp-dampening" : true,
    "bgp-redist-static-metric" : 6
  }, {
    "bgp-default-shutdown" : true,
    "bgp-cluster-id" : "bgp-cluster-id",
    "api.switch-name" : "api.switch-name",
    "bgp-redist-ospf-route-map" : "bgp-redist-ospf-route-map",
    "no-bgp-redist-ospf-route-map" : true,
    "bgp-keepalive-interval" : 9,
    "bgp-bestpath-as-path" : "ignore",
    "bgp-distance-internal" : 4,
    "bgp-global-nh-preference" : "none",
    "bgp-ibgp-multipath" : 1,
    "router-id" : "router-id",
    "bgp-redist-rip-metric" : 5,
    "bgp-distance-external" : 2,
    "hw-vrid" : 0,
    "bgp-max-paths" : 1,
    "bgp-distance-local" : 7,
    "bgp-redist-connected-metric" : 1,
    "bgp-update-delay-strict" : 7,
    "bgp-graceful-shutdown" : true,
    "bgp-redistribute" : "static",
    "bgp-delayed-startup" : 2,
    "vrf" : "vrf",
    "bgp-redist-ospf-metric" : 5,
    "bgp-as" : 1,
    "bgp-holdtime" : 3,
    "no-bgp-redist-connected-route-map" : true,
    "bgp-redist-static-route-map" : "bgp-redist-static-route-map",
    "no-bgp-redist-static-route-map" : true,
    "bgp-redist-connected-route-map" : "bgp-redist-connected-route-map",
    "bgp-dampening" : true,
    "bgp-redist-static-metric" : 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 vrouter-vrf-show-response

Vsgs

Up
post /vsgs/{vsg-name}/networks
(addVsgVsgNetworkByVsgName)

Path parameters

vsg-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vsg-network-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vsgs/{name}/routes
(addVsgVsgRouteByVsgName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vsg-route-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vsgs/{vsg-name}/vrfs
(addVsgVsgVrfByVsgName)

Path parameters

vsg-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vsg-vrf-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vsgs
(createVsg)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vsg-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vsgs/{name}
(deleteVsgByName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vsgs/{vsg-name}/networks/vrf={vrf},vnet-id={vnet-id},subnet={subnet},network={network},netmask={netmask},network6={network6},netmask6={netmask6}
(removeVsgVsgNetworkByNameUniqueKeyAll)

Path parameters

vsg-name (required)
Path Parameter
vrf (required)
Path Parameter
vnet-id (required)
Path Parameter
subnet (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
network6 (required)
Path Parameter
netmask6 (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vsgs/{name}/routes/vrf={vrf},vnet-id={vnet-id},network={network},netmask={netmask},gateway-ip={gateway-ip}
(removeVsgVsgRouteByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vrf (required)
Path Parameter
vnet-id (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
gateway-ip (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vsgs/{vsg-name}/vrfs/vnet-id={vnet-id},vrf={vrf}
(removeVsgVsgVrfByNameUniqueKeyAll)

Path parameters

vsg-name (required)
Path Parameter
vnet-id (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vsgs/{name}
(showVsgByName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "description" : "description",
    "api.switch-name" : "api.switch-name"
  }, {
    "name" : "name",
    "description" : "description",
    "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 vsg-show-response
Up
get /vsgs/{vsg-name}/networks/vrf={vrf},vnet-id={vnet-id},subnet={subnet},network={network},netmask={netmask},network6={network6},netmask6={netmask6}
(showVsgVsgNetworksByNameUniqueKeyAll)

Path parameters

vsg-name (required)
Path Parameter
vrf (required)
Path Parameter
vnet-id (required)
Path Parameter
subnet (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
network6 (required)
Path Parameter
netmask6 (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "subnet" : "subnet",
    "network6" : "network6",
    "netmask" : 0,
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "netmask6" : 6,
    "network-state" : "init",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "subnet" : "subnet",
    "network6" : "network6",
    "netmask" : 0,
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "netmask6" : 6,
    "network-state" : "init",
    "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 vsg-network-show-response
Up
get /vsgs/{vsg-name}/networks
(showVsgVsgNetworksByVsgName)

Path parameters

vsg-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "subnet" : "subnet",
    "network6" : "network6",
    "netmask" : 0,
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "netmask6" : 6,
    "network-state" : "init",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "subnet" : "subnet",
    "network6" : "network6",
    "netmask" : 0,
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "netmask6" : 6,
    "network-state" : "init",
    "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 vsg-network-show-response
Up
get /vsgs/{name}/routes/vrf={vrf},vnet-id={vnet-id},network={network},netmask={netmask},gateway-ip={gateway-ip}
(showVsgVsgRoutesByNameUniqueKeyAll)

Path parameters

name (required)
Path Parameter
vrf (required)
Path Parameter
vnet-id (required)
Path Parameter
network (required)
Path Parameter
netmask (required)
Path Parameter
gateway-ip (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "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 vsg-route-show-response
Up
get /vsgs/{name}/routes
(showVsgVsgRoutesByVsgName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "api.switch-name" : "api.switch-name",
    "network" : "network"
  }, {
    "netmask" : 0,
    "gateway-ip" : "gateway-ip",
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "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 vsg-route-show-response
Up
get /vsgs/{vsg-name}/vrfs/vnet-id={vnet-id},vrf={vrf}
(showVsgVsgVrfsByNameUniqueKeyAll)

Path parameters

vsg-name (required)
Path Parameter
vnet-id (required)
Path Parameter
vrf (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "type" : "promiscuous",
    "api.switch-name" : "api.switch-name",
    "export-leaked-networks" : "none"
  }, {
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "type" : "promiscuous",
    "api.switch-name" : "api.switch-name",
    "export-leaked-networks" : "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 vsg-vrf-show-response
Up
get /vsgs/{vsg-name}/vrfs
(showVsgVsgVrfsByVsgName)

Path parameters

vsg-name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "type" : "promiscuous",
    "api.switch-name" : "api.switch-name",
    "export-leaked-networks" : "none"
  }, {
    "vnet-id" : "vnet-id",
    "vrf" : "vrf",
    "type" : "promiscuous",
    "api.switch-name" : "api.switch-name",
    "export-leaked-networks" : "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 vsg-vrf-show-response
Up
get /vsgs
(showVsgs)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "name" : "name",
    "description" : "description",
    "api.switch-name" : "api.switch-name"
  }, {
    "name" : "name",
    "description" : "description",
    "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 vsg-show-response
Up
put /vsgs/{name}
(updateVsgByName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vsg-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VtepAutoVlan

Up
get /vtep-auto-vlan
(showVtepAutoVlan)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vlans" : 0,
    "vlan-end" : 6,
    "api.switch-name" : "api.switch-name"
  }, {
    "vlans" : 0,
    "vlan-end" : 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 vtep-auto-vlan-show-response
Up
put /vtep-auto-vlan
(updateVtepAutoVlan)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vtep-auto-vlan-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VtepAutoVxlan

Up
get /vtep-auto-vxlan
(showVtepAutoVxlan)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlans" : 0,
    "vxlan-end" : 6,
    "api.switch-name" : "api.switch-name"
  }, {
    "vxlans" : 0,
    "vxlan-end" : 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 vtep-auto-vxlan-show-response
Up
put /vtep-auto-vxlan
(updateVtepAutoVxlan)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vtep-auto-vxlan-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

Vteps

Up
post /vteps/{name}/vxlans
(addVtepVxlanByVtepName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vtep-vxlan-add (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vteps
(createVtep)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vtep-create (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vteps/{name}
(deleteVtepByName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vteps/{name}/vxlans/{vxlan}
(removeVtepVxlanByNameByVxlan)

Path parameters

name (required)
Path Parameter
vxlan (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vteps/{name}
(showVtepByName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mac-learning" : true,
    "evpn-border" : true,
    "vrouter-name" : "vrouter-name",
    "scope" : "local",
    "ip" : "ip",
    "name" : "name",
    "description" : "description",
    "location" : 0,
    "api.switch-name" : "api.switch-name",
    "virtual-ip" : "virtual-ip",
    "mac" : "mac"
  }, {
    "mac-learning" : true,
    "evpn-border" : true,
    "vrouter-name" : "vrouter-name",
    "scope" : "local",
    "ip" : "ip",
    "name" : "name",
    "description" : "description",
    "location" : 0,
    "api.switch-name" : "api.switch-name",
    "virtual-ip" : "virtual-ip",
    "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 vtep-show-response
Up
get /vteps/{name}/vxlans/{vxlan}
(showVtepVxlanByNameByVxlan)

Path parameters

name (required)
Path Parameter
vxlan (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "hw_update_pending" : true,
    "bd_deactivated" : true,
    "isolated" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "vxlan" : 0,
    "hw_update_pending" : true,
    "bd_deactivated" : true,
    "isolated" : 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 vtep-vxlan-show-response
Up
get /vteps/{name}/vxlans
(showVtepVxlansByVtepName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "vxlan" : 0,
    "hw_update_pending" : true,
    "bd_deactivated" : true,
    "isolated" : true,
    "api.switch-name" : "api.switch-name"
  }, {
    "vxlan" : 0,
    "hw_update_pending" : true,
    "bd_deactivated" : true,
    "isolated" : 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 vtep-vxlan-show-response
Up
get /vteps
(showVteps)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "mac-learning" : true,
    "evpn-border" : true,
    "vrouter-name" : "vrouter-name",
    "scope" : "local",
    "ip" : "ip",
    "name" : "name",
    "description" : "description",
    "location" : 0,
    "api.switch-name" : "api.switch-name",
    "virtual-ip" : "virtual-ip",
    "mac" : "mac"
  }, {
    "mac-learning" : true,
    "evpn-border" : true,
    "vrouter-name" : "vrouter-name",
    "scope" : "local",
    "ip" : "ip",
    "name" : "name",
    "description" : "description",
    "location" : 0,
    "api.switch-name" : "api.switch-name",
    "virtual-ip" : "virtual-ip",
    "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 vtep-show-response
Up
put /vteps/{name}
(updateVtepByName)

Path parameters

name (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vtep-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VxlanDestPort

Up
get /vxlan-dest-port
(showVxlanDestPort)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "hw-config" : 6,
    "port" : 0,
    "api.switch-name" : "api.switch-name"
  }, {
    "hw-config" : 6,
    "port" : 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 vxlan-dest-port-show-response
Up
put /vxlan-dest-port
(updateVxlanDestPort)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body vxlan-dest-port-modify (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

VxlanStats

Up
post /vxlan-stats/clear
(clearVxlanStatsByUsage1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /vxlan-stats
(showVxlanStats)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "bd" : "bd",
    "start-time" : "start-time",
    "within-last" : 1,
    "vnid" : 0,
    "odrops-bytes" : 2,
    "end-time" : "end-time",
    "ibytes" : 6,
    "odrops-pkts" : 4,
    "api.switch-name" : "api.switch-name",
    "vxlan-name" : "vxlan-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 7,
    "idrops-bytes" : 5,
    "idrops-pkts" : 2,
    "vlan" : 6,
    "opkts" : 3,
    "ibits" : 1,
    "interval" : 1,
    "obytes" : 7,
    "time" : "time",
    "ipkts" : 5,
    "obits" : 9
  }, {
    "older-than" : 1,
    "bd" : "bd",
    "start-time" : "start-time",
    "within-last" : 1,
    "vnid" : 0,
    "odrops-bytes" : 2,
    "end-time" : "end-time",
    "ibytes" : 6,
    "odrops-pkts" : 4,
    "api.switch-name" : "api.switch-name",
    "vxlan-name" : "vxlan-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 7,
    "idrops-bytes" : 5,
    "idrops-pkts" : 2,
    "vlan" : 6,
    "opkts" : 3,
    "ibits" : 1,
    "interval" : 1,
    "obytes" : 7,
    "time" : "time",
    "ipkts" : 5,
    "obits" : 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 vxlan-stats-show-response
Up
get /vxlan-stats/{vnid}
(showVxlanStatsByVxlanVnid)

Path parameters

vnid (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "older-than" : 1,
    "bd" : "bd",
    "start-time" : "start-time",
    "within-last" : 1,
    "vnid" : 0,
    "odrops-bytes" : 2,
    "end-time" : "end-time",
    "ibytes" : 6,
    "odrops-pkts" : 4,
    "api.switch-name" : "api.switch-name",
    "vxlan-name" : "vxlan-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 7,
    "idrops-bytes" : 5,
    "idrops-pkts" : 2,
    "vlan" : 6,
    "opkts" : 3,
    "ibits" : 1,
    "interval" : 1,
    "obytes" : 7,
    "time" : "time",
    "ipkts" : 5,
    "obits" : 9
  }, {
    "older-than" : 1,
    "bd" : "bd",
    "start-time" : "start-time",
    "within-last" : 1,
    "vnid" : 0,
    "odrops-bytes" : 2,
    "end-time" : "end-time",
    "ibytes" : 6,
    "odrops-pkts" : 4,
    "api.switch-name" : "api.switch-name",
    "vxlan-name" : "vxlan-name",
    "since-start" : true,
    "vnet" : "vnet",
    "duration" : 7,
    "idrops-bytes" : 5,
    "idrops-pkts" : 2,
    "vlan" : 6,
    "opkts" : 3,
    "ibits" : 1,
    "interval" : 1,
    "obytes" : 7,
    "time" : "time",
    "ipkts" : 5,
    "obits" : 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 vxlan-stats-show-response

VxlanStatsSettings

Up
get /vxlan-stats-settings
(showVxlanStatsSettings)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "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 vxlan-stats-settings-show-response
Up
put /vxlan-stats-settings
(updateVxlanStatsSettings)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

WebCertInfos

Up
get /web-cert-infos
(showWebCertInfos)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "valid-to" : "valid-to",
    "cert-type" : "ca",
    "serial-number" : 0,
    "subject" : "subject",
    "api.switch-name" : "api.switch-name",
    "issuer" : "issuer",
    "status" : "status",
    "valid-from" : "valid-from"
  }, {
    "valid-to" : "valid-to",
    "cert-type" : "ca",
    "serial-number" : 0,
    "subject" : "subject",
    "api.switch-name" : "api.switch-name",
    "issuer" : "issuer",
    "status" : "status",
    "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 web-cert-info-show-response

WebCertRequests

Up
post /web-cert-requests
(createWebCertRequest)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /web-cert-requests
(showWebCertRequests)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "cert-request" : "cert-request",
    "api.switch-name" : "api.switch-name"
  }, {
    "cert-request" : "cert-request",
    "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 web-cert-request-show-response

WebCertSelfSigneds

Up
post /web-cert-self-signeds
(createWebCertSelfSigned)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

WebCerts

Up
post /web-certs/clear
(clearWebCert)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /web-certs/import
(importWebCertByUsage1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body web-cert-import-1 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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 /web-certs/upload
(uploadWebCertByUsage1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body web-cert-upload-1 (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "result" : [ {
    "code" : 5,
    "scope" : "local",
    "message" : "message",
    "api.switch-name" : "api.switch-name",
    "status" : "Success"
  }, {
    "code" : 5,
    "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

XactTruncates

Up
get /xact-truncates
(showXactTruncates)

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "result" : {
    "result" : [ {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    }, {
      "code" : 5,
      "scope" : "local",
      "message" : "message",
      "api.switch-name" : "api.switch-name",
      "status" : "Success"
    } ],
    "status" : "Success"
  },
  "data" : [ {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "time" : "time",
    "user" : "user"
  }, {
    "bd" : "bd",
    "code" : 1,
    "pid" : 6,
    "program" : "program",
    "api.switch-name" : "api.switch-name",
    "switch" : "switch",
    "starting-point" : 9,
    "duration" : 0,
    "vnet" : "vnet",
    "show-time" : "show-time",
    "vlan" : 5,
    "vxlan" : "vxlan",
    "remote_switch" : "remote_switch",
    "start-time" : "start-time",
    "level" : "critical",
    "end-time" : "end-time",
    "length" : 2,
    "message" : "message",
    "reverse" : true,
    "client-pid" : 7,
    "client-addr" : "client-addr",
    "args" : "args",
    "port" : 5,
    "name" : "name",
    "time" : "time",
    "user" : "user"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

success xact-truncate-show-response

Models

[ Jump to Methods ]

Table of Contents

  1. aaa-tacacs-create -
  2. aaa-tacacs-modify -
  3. aaa-tacacs-show -
  4. aaa-tacacs-show-response -
  5. access-list-create -
  6. access-list-ip-add -
  7. access-list-ip-show -
  8. access-list-ip-show-response -
  9. access-list-show -
  10. access-list-show-response -
  11. acl-ip-create -
  12. acl-ip-modify -
  13. acl-ip-show -
  14. acl-ip-show-response -
  15. acl-mac-create -
  16. acl-mac-modify -
  17. acl-mac-show -
  18. acl-mac-show-response -
  19. admin-cc-mode-modify -
  20. admin-cc-mode-show -
  21. admin-cc-mode-show-response -
  22. admin-crl-config-modify -
  23. admin-crl-config-show -
  24. admin-crl-config-show-response -
  25. admin-ipmi-modify -
  26. admin-ipmi-show -
  27. admin-ipmi-show-response -
  28. admin-service-modify -
  29. admin-service-show -
  30. admin-service-show-response -
  31. admin-session-timeout-modify -
  32. admin-session-timeout-show -
  33. admin-session-timeout-show-response -
  34. admin-sftp-modify -
  35. admin-sftp-modify-1 -
  36. admin-sftp-modify-2 -
  37. admin-sftp-modify-3 -
  38. admin-sftp-modify-4 -
  39. admin-sftp-modify-5 -
  40. admin-sftp-show -
  41. admin-sftp-show-response -
  42. admin-syslog-create -
  43. admin-syslog-match-add -
  44. admin-syslog-match-modify -
  45. admin-syslog-match-show -
  46. admin-syslog-match-show-response -
  47. admin-syslog-modify -
  48. admin-syslog-show -
  49. admin-syslog-show-response -
  50. alert-show -
  51. alert-show-response -
  52. api-install-install -
  53. bezel-portmap-show -
  54. bezel-portmap-show-response -
  55. bootenv-activate-and-reboot -
  56. bootenv-show -
  57. bootenv-show-response -
  58. bridge-domain-create -
  59. bridge-domain-modify -
  60. bridge-domain-port-add -
  61. bridge-domain-port-modify -
  62. bridge-domain-port-remove -
  63. bridge-domain-port-show -
  64. bridge-domain-port-show-response -
  65. bridge-domain-show -
  66. bridge-domain-show-response -
  67. cert-create -
  68. cert-expiration-alert-modify -
  69. cert-expiration-alert-show -
  70. cert-expiration-alert-show-response -
  71. cert-import -
  72. cert-import-1 -
  73. cert-request-create -
  74. cert-request-show -
  75. cert-request-show-response -
  76. cert-show -
  77. cert-show-response -
  78. cert-upload -
  79. cert-upload-1 -
  80. client-server-stats-clear -
  81. client-server-stats-show -
  82. client-server-stats-show-response -
  83. cluster-bringdown-modify -
  84. cluster-bringdown-show -
  85. cluster-bringdown-show-response -
  86. cluster-bringup-modify -
  87. cluster-bringup-show -
  88. cluster-bringup-show-response -
  89. cluster-create -
  90. cluster-membership-modify -
  91. cluster-membership-show -
  92. cluster-membership-show-response -
  93. cluster-modify -
  94. cluster-show -
  95. cluster-show-response -
  96. cluster-vrrp-optimize-modify -
  97. cluster-vrrp-optimize-show -
  98. cluster-vrrp-optimize-show-response -
  99. connection-clear -
  100. connection-latency-show -
  101. connection-latency-show-response -
  102. connection-show -
  103. connection-show-response -
  104. connection-stats-clear -
  105. connection-stats-settings-modify -
  106. connection-stats-settings-show -
  107. connection-stats-settings-show-response -
  108. connection-stats-show -
  109. connection-stats-show-response -
  110. control-stats-settings-modify -
  111. control-stats-settings-show -
  112. control-stats-settings-show-response -
  113. control-stats-show -
  114. control-stats-show-response -
  115. control-traffic-modify -
  116. control-traffic-show -
  117. control-traffic-show-response -
  118. dhcp-filter-create -
  119. dhcp-filter-modify -
  120. dhcp-filter-show -
  121. dhcp-filter-show-response -
  122. dhcp-lease-show -
  123. dhcp-lease-show-response -
  124. disk-library-image-add -
  125. disk-library-image-clone -
  126. disk-library-image-export -
  127. disk-library-image-import -
  128. disk-library-image-show -
  129. disk-library-image-show-response -
  130. disk-library-imports-show -
  131. disk-library-imports-show-response -
  132. disk-library-modify -
  133. disk-library-show -
  134. disk-library-show-response -
  135. dscp-map-create -
  136. dscp-map-pri-map-modify -
  137. dscp-map-pri-map-show -
  138. dscp-map-pri-map-show-response -
  139. dscp-map-show -
  140. dscp-map-show-response -
  141. eap-host-profile-create -
  142. eap-host-profile-modify -
  143. eap-host-profile-show -
  144. eap-host-profile-show-response -
  145. err-disable-clear-counters -
  146. err-disable-modify -
  147. err-disable-show -
  148. err-disable-show-response -
  149. eula-show -
  150. eula-show-response -
  151. evpn-check-show -
  152. evpn-check-show-response -
  153. fabric-anycast-mac-modify -
  154. fabric-anycast-mac-show -
  155. fabric-anycast-mac-show-response -
  156. fabric-comm-ports-modify -
  157. fabric-comm-ports-show -
  158. fabric-comm-ports-show-response -
  159. fabric-comm-vrouter-bgp-create -
  160. fabric-create -
  161. fabric-evpn-node-show -
  162. fabric-evpn-node-show-response -
  163. fabric-in-band-network-create -
  164. fabric-in-band-network-show -
  165. fabric-in-band-network-show-response -
  166. fabric-join -
  167. fabric-join-1 -
  168. fabric-join-2 -
  169. fabric-local-modify -
  170. fabric-node-evict -
  171. fabric-node-evict-1 -
  172. fabric-node-show -
  173. fabric-node-show-response -
  174. fabric-show -
  175. fabric-show-response -
  176. fabric-stats-show -
  177. fabric-stats-show-response -
  178. fabric-unjoin -
  179. fabric-upgrade-abort -
  180. fabric-upgrade-prepare-show -
  181. fabric-upgrade-show-response -
  182. fabric-upgrade-start -
  183. fabric-upgrade-status-show -
  184. fabric-upgrade-status-show-response -
  185. fabric-vnic-create -
  186. fabric-vnic-delete -
  187. fabric-vnic-modify -
  188. fabric-vnic-show -
  189. fabric-vnic-show-response -
  190. flow-table-show -
  191. flow-table-show-response -
  192. hog-violator-show -
  193. hog-violator-show-response -
  194. hog-violator-stats-show -
  195. hog-violator-stats-show-response -
  196. id-led-modify -
  197. id-led-show -
  198. id-led-show-response -
  199. igmp-querier-ip-modify -
  200. igmp-querier-ip-show -
  201. igmp-querier-ip-show-response -
  202. igmp-router-show -
  203. igmp-router-show-response -
  204. igmp-show -
  205. igmp-show-response -
  206. igmp-snooping-modify -
  207. igmp-snooping-show -
  208. igmp-snooping-show-response -
  209. igmp-static-group-create -
  210. igmp-static-group-show -
  211. igmp-static-group-show-response -
  212. igmp-static-source-create -
  213. igmp-static-source-show -
  214. igmp-static-source-show-response -
  215. igmp-stats-clear -
  216. igmp-stats-show -
  217. igmp-stats-show-response -
  218. igmp-switches-show -
  219. igmp-switches-show-response -
  220. inline-service-create -
  221. inline-service-modify -
  222. inline-service-show -
  223. inline-service-show-response -
  224. interface-stats-show -
  225. interface-stats-show-response -
  226. ip-pool-create -
  227. ip-pool-create-1 -
  228. ip-pool-modify -
  229. ip-pool-show -
  230. ip-pool-show-response -
  231. ipfix-collector-create -
  232. ipfix-collector-modify -
  233. ipfix-collector-show -
  234. ipfix-collector-show-response -
  235. ipfix-service-modify -
  236. ipfix-service-show -
  237. ipfix-service-show-response -
  238. ipv6security-raguard-create -
  239. ipv6security-raguard-modify -
  240. ipv6security-raguard-port-add -
  241. ipv6security-raguard-port-show -
  242. ipv6security-raguard-port-show-response -
  243. ipv6security-raguard-show -
  244. ipv6security-raguard-show-response -
  245. ipv6security-raguard-vlan-add -
  246. ipv6security-raguard-vlan-show -
  247. ipv6security-raguard-vlan-show-response -
  248. iso-library-image-export -
  249. iso-library-image-import -
  250. iso-library-image-show -
  251. iso-library-image-show-response -
  252. iso-library-modify -
  253. iso-library-show -
  254. iso-library-show-response -
  255. k8s-cluster-show -
  256. k8s-cluster-show-response -
  257. k8s-cni-show -
  258. k8s-cni-show-response -
  259. k8s-connection-create -
  260. k8s-connection-modify -
  261. k8s-connection-show -
  262. k8s-connection-show-response -
  263. k8s-connectivity-show -
  264. k8s-connectivity-show-response -
  265. k8s-daemonset-show -
  266. k8s-daemonset-show-response -
  267. k8s-deployment-show -
  268. k8s-deployment-show-response -
  269. k8s-endpoint-show -
  270. k8s-endpoint-show-response -
  271. k8s-impact-show -
  272. k8s-impact-show-response -
  273. k8s-ingress-show -
  274. k8s-ingress-show-response -
  275. k8s-network-show -
  276. k8s-network-show-response -
  277. k8s-node-show -
  278. k8s-node-show-response -
  279. k8s-pod-show -
  280. k8s-pod-show-response -
  281. k8s-service-show -
  282. k8s-service-show-response -
  283. k8s-show -
  284. k8s-show-response -
  285. k8s-trace-paths -
  286. k8s-trace-show-response -
  287. l2-check-show -
  288. l2-check-show-response -
  289. l2-history-show -
  290. l2-history-show-response -
  291. l2-setting-modify -
  292. l2-setting-show -
  293. l2-setting-show-response -
  294. l2-static-multicast-group-create -
  295. l2-static-multicast-group-port-add -
  296. l2-static-multicast-group-port-remove -
  297. l2-static-multicast-group-show -
  298. l2-static-multicast-group-show-response -
  299. l2-table-flush -
  300. l2-table-show -
  301. l2-table-show-response -
  302. l3-check-show -
  303. l3-check-show-response -
  304. l3-history-show -
  305. l3-history-show-response -
  306. l3-route-show -
  307. l3-route-show-response -
  308. l3-setting-modify -
  309. l3-setting-show -
  310. l3-setting-show-response -
  311. l3-table-show -
  312. l3-table-show-response -
  313. lacp-modify -
  314. lacp-port-stats-settings-modify -
  315. lacp-port-stats-settings-show -
  316. lacp-port-stats-settings-show-response -
  317. lacp-show -
  318. lacp-show-response -
  319. lldp-show -
  320. lldp-show-response -
  321. log-admin-audit-modify -
  322. log-admin-audit-show -
  323. log-admin-audit-show-response -
  324. log-alert-show -
  325. log-alert-show-response -
  326. log-archival-schedule-files-add -
  327. log-archival-schedule-files-remove -
  328. log-archival-schedule-modify -
  329. log-archival-schedule-modify-1 -
  330. log-archival-schedule-show -
  331. log-archival-schedule-show-response -
  332. log-archival-schedule-ssh-key-gen -
  333. log-archival-schedule-ssh-key-import -
  334. log-archival-schedule-ssh-key-show -
  335. log-archival-schedule-ssh-key-show-response -
  336. log-audit-exception-create -
  337. log-audit-exception-show -
  338. log-audit-exception-show-response -
  339. log-audit-show -
  340. log-audit-show-response -
  341. log-datetime-fmt-mode-modify -
  342. log-datetime-fmt-mode-show -
  343. log-datetime-fmt-mode-show-response -
  344. log-event-settings-modify -
  345. log-event-settings-show -
  346. log-event-settings-show-response -
  347. log-event-show -
  348. log-event-show-response -
  349. log-session-show -
  350. log-session-show-response -
  351. log-system-counters-reset -
  352. log-system-counters-show -
  353. log-system-counters-show-response -
  354. log-system-show -
  355. log-system-show-response -
  356. mac-limit-modify -
  357. mac-limit-show -
  358. mac-limit-show-response -
  359. mac-pool-show -
  360. mac-pool-show-response -
  361. mcast-show -
  362. mcast-show-response -
  363. mgmt-session-show -
  364. mgmt-session-show-response -
  365. mirror-create -
  366. mirror-modify -
  367. mirror-show -
  368. mirror-show-response -
  369. mld-router-show -
  370. mld-router-show-response -
  371. mld-show -
  372. mld-show-response -
  373. mld-snooping-modify -
  374. mld-snooping-show -
  375. mld-snooping-show-response -
  376. mld-static-group-create -
  377. mld-static-group-show -
  378. mld-static-group-show-response -
  379. mld-static-source-create -
  380. mld-static-source-show -
  381. mld-static-source-show-response -
  382. mld-stats-show -
  383. mld-stats-show-response -
  384. mld-switches-show -
  385. mld-switches-show-response -
  386. mst-config-create -
  387. mst-config-modify -
  388. mst-config-show -
  389. mst-config-show-response -
  390. node-show -
  391. node-show-response -
  392. nv-queue-mirror-modify -
  393. nv-queue-mirror-show -
  394. nv-queue-mirror-show-response -
  395. nv-queue-stats-clear -
  396. nv-queue-stats-settings-modify -
  397. nv-queue-stats-settings-show -
  398. nv-queue-stats-settings-show-response -
  399. nv-queue-stats-show -
  400. nv-queue-stats-show-response -
  401. object-location-modify -
  402. object-location-show -
  403. object-location-show-response -
  404. openvswitch-create -
  405. openvswitch-hwvtep-manager-add -
  406. openvswitch-hwvtep-manager-show -
  407. openvswitch-hwvtep-manager-show-response -
  408. openvswitch-interface-add -
  409. openvswitch-interface-modify -
  410. openvswitch-interface-show -
  411. openvswitch-interface-show-response -
  412. openvswitch-modify -
  413. openvswitch-rest-config-create -
  414. openvswitch-rest-config-show -
  415. openvswitch-rest-config-show-response -
  416. openvswitch-show -
  417. openvswitch-show-response -
  418. pn-script-run -
  419. pn-script-show -
  420. pn-script-show-response -
  421. pn-service-show-response -
  422. pn-service-status-show -
  423. port-association-create -
  424. port-association-modify -
  425. port-association-path-create -
  426. port-association-path-show -
  427. port-association-path-show-response -
  428. port-association-service-add -
  429. port-association-service-modify -
  430. port-association-service-show -
  431. port-association-service-show-response -
  432. port-association-show -
  433. port-association-show-response -
  434. port-buffer-settings-modify -
  435. port-buffer-settings-show -
  436. port-buffer-settings-show-response -
  437. port-buffer-show -
  438. port-buffer-show-response -
  439. port-bw-threshold-alert-modify -
  440. port-bw-threshold-alert-show -
  441. port-bw-threshold-alert-show-response -
  442. port-bw-threshold-mon-int-modify -
  443. port-bw-threshold-mon-int-show -
  444. port-bw-threshold-mon-int-show-response -
  445. port-config-modify -
  446. port-config-modify-1 -
  447. port-config-show -
  448. port-config-show-response -
  449. port-cos-bw-modify -
  450. port-cos-bw-show -
  451. port-cos-bw-show-response -
  452. port-cos-rate-setting-modify -
  453. port-cos-rate-setting-show -
  454. port-cos-rate-setting-show-response -
  455. port-cos-stats-clear -
  456. port-cos-stats-settings-modify -
  457. port-cos-stats-settings-show -
  458. port-cos-stats-settings-show-response -
  459. port-cos-stats-show -
  460. port-cos-stats-show-response -
  461. port-cos-weight-modify -
  462. port-cos-weight-show -
  463. port-cos-weight-show-response -
  464. port-egress-show -
  465. port-egress-show-response -
  466. port-fec-stats-settings-modify -
  467. port-fec-stats-settings-show -
  468. port-fec-stats-settings-show-response -
  469. port-force-linkup-add -
  470. port-force-linkup-remove -
  471. port-force-linkup-show -
  472. port-force-linkup-show-response -
  473. port-group-show -
  474. port-group-show-response -
  475. port-lacp-modify -
  476. port-lacp-show -
  477. port-lacp-show-response -
  478. port-lacp-stats-clear -
  479. port-lacp-stats-show -
  480. port-lacp-stats-show-response -
  481. port-lldp-modify -
  482. port-lldp-show -
  483. port-lldp-show-response -
  484. port-lpmode-recover -
  485. port-pfc-create -
  486. port-pfc-modify -
  487. port-pfc-show -
  488. port-pfc-show-response -
  489. port-pfc-stats-clear -
  490. port-pfc-stats-settings-modify -
  491. port-pfc-stats-settings-show -
  492. port-pfc-stats-settings-show-response -
  493. port-pfc-stats-show -
  494. port-pfc-stats-show-response -
  495. port-phy-show -
  496. port-phy-show-response -
  497. port-show -
  498. port-show-response -
  499. port-stats-clear -
  500. port-stats-settings-modify -
  501. port-stats-settings-show -
  502. port-stats-settings-show-response -
  503. port-stats-show -
  504. port-stats-show-response -
  505. port-stats-snmp-show -
  506. port-stats-snmp-show-response -
  507. port-storm-control-modify -
  508. port-storm-control-show -
  509. port-storm-control-show-response -
  510. port-vlan-add -
  511. port-vlan-remove -
  512. port-vlan-show -
  513. port-vlan-show-response -
  514. port-vnet-show -
  515. port-vnet-show-response -
  516. port-xcvr-memory-show -
  517. port-xcvr-memory-show-response -
  518. port-xcvr-show -
  519. port-xcvr-show-response -
  520. prefix-list-create -
  521. prefix-list-network-add -
  522. prefix-list-network-show -
  523. prefix-list-network-show-response -
  524. prefix-list-show -
  525. prefix-list-show-response -
  526. ptp-modify -
  527. ptp-show -
  528. ptp-show-response -
  529. result -
  530. result-list -
  531. role-create -
  532. role-modify -
  533. role-show -
  534. role-show-response -
  535. service-heartbeat-create -
  536. service-heartbeat-modify -
  537. service-heartbeat-show -
  538. service-heartbeat-show-response -
  539. service-stats-clear -
  540. service-stats-show -
  541. service-stats-show-response -
  542. sflow-collector-create -
  543. sflow-collector-modify -
  544. sflow-collector-show -
  545. sflow-collector-show-response -
  546. sflow-create -
  547. sflow-modify -
  548. sflow-port-add -
  549. sflow-port-show -
  550. sflow-port-show-response -
  551. sflow-show -
  552. sflow-show-response -
  553. sflow-thread-binding-show -
  554. sflow-thread-binding-show-response -
  555. snmp-community-create -
  556. snmp-community-modify -
  557. snmp-community-show -
  558. snmp-community-show-response -
  559. snmp-engineid-modify -
  560. snmp-engineid-show -
  561. snmp-engineid-show-response -
  562. snmp-show -
  563. snmp-show-response -
  564. snmp-system-clear -
  565. snmp-system-modify -
  566. snmp-system-show -
  567. snmp-system-show-response -
  568. snmp-trap-enable-modify -
  569. snmp-trap-enable-show -
  570. snmp-trap-enable-show-response -
  571. snmp-trap-sink-create -
  572. snmp-trap-sink-show -
  573. snmp-trap-sink-show-response -
  574. snmp-user-create -
  575. snmp-user-modify -
  576. snmp-user-show -
  577. snmp-user-show-response -
  578. snmp-v3-trap-sink-create -
  579. snmp-v3-trap-sink-show -
  580. snmp-v3-trap-sink-show-response -
  581. snmp-vacm-create -
  582. snmp-vacm-modify -
  583. snmp-vacm-show -
  584. snmp-vacm-show-response -
  585. software-license-import-product-ids -
  586. software-license-install -
  587. software-license-show -
  588. software-license-show-response -
  589. software-show -
  590. software-show-response -
  591. software-upgrade -
  592. software-upgrade-1 -
  593. software-upgrade-2 -
  594. software-upgrade-3 -
  595. software-upgrade-instant-status-show -
  596. software-upgrade-instant-status-show-response -
  597. software-upgrade-status-show -
  598. software-upgrade-status-show-response -
  599. static-arp-create -
  600. static-arp-create-1 -
  601. static-arp-show -
  602. static-arp-show-response -
  603. static-ecmp-group-create -
  604. static-ecmp-group-modify -
  605. static-ecmp-group-nh-add -
  606. static-ecmp-group-nh-show -
  607. static-ecmp-group-nh-show-response -
  608. static-ecmp-group-show -
  609. static-ecmp-group-show-response -
  610. storage-device-free -
  611. storage-device-show -
  612. storage-device-show-response -
  613. storage-pool-create -
  614. storage-pool-device-add -
  615. storage-pool-device-replace -
  616. storage-pool-device-show -
  617. storage-pool-device-show-response -
  618. storage-pool-modify -
  619. storage-pool-show -
  620. storage-pool-show-response -
  621. storage-stats-show -
  622. storage-stats-show-response -
  623. stp-modify -
  624. stp-port-event-show -
  625. stp-port-event-show-response -
  626. stp-port-modify -
  627. stp-port-show -
  628. stp-port-show-response -
  629. stp-port-state-show -
  630. stp-port-state-show-response -
  631. stp-show -
  632. stp-show-response -
  633. stp-state-show -
  634. stp-state-show-response -
  635. subnet-create -
  636. subnet-modify -
  637. subnet-show -
  638. subnet-show-response -
  639. switch-boot-solaris -
  640. switch-config-copy-to-import -
  641. switch-config-export -
  642. switch-config-import -
  643. switch-config-show -
  644. switch-config-show-response -
  645. switch-group-create -
  646. switch-group-member-add -
  647. switch-group-member-show -
  648. switch-group-member-show-response -
  649. switch-group-modify -
  650. switch-group-show -
  651. switch-group-show-response -
  652. switch-info-show -
  653. switch-info-show-response -
  654. switch-mode-modify -
  655. switch-mode-show -
  656. switch-mode-show-response -
  657. switch-nic-info-show -
  658. switch-nic-info-show-response -
  659. switch-nic-stats-settings-modify -
  660. switch-nic-stats-settings-show -
  661. switch-nic-stats-settings-show-response -
  662. switch-nic-stats-show -
  663. switch-nic-stats-show-response -
  664. switch-route-create -
  665. switch-route-modify -
  666. switch-route-show -
  667. switch-route-show-response -
  668. switch-setup-modify -
  669. switch-setup-show -
  670. switch-setup-show-response -
  671. switch-status-settings-modify -
  672. switch-status-settings-show -
  673. switch-status-settings-show-response -
  674. switch-status-show -
  675. switch-status-show-response -
  676. switch-vnic-create -
  677. switch-vnic-modify -
  678. switch-vnic-show -
  679. switch-vnic-show-response -
  680. syslog-tls-cert-import -
  681. syslog-tls-cert-info-show -
  682. syslog-tls-cert-info-show-response -
  683. syslog-tls-cert-request-create -
  684. syslog-tls-cert-show -
  685. syslog-tls-cert-show-response -
  686. system-diagnostics-hw-limits-show -
  687. system-diagnostics-hw-limits-show-response -
  688. system-settings-modify -
  689. system-settings-show -
  690. system-settings-show-response -
  691. system-state-modify -
  692. system-state-show -
  693. system-state-show-response -
  694. system-stats-history-settings-modify -
  695. system-stats-history-settings-show -
  696. system-stats-history-settings-show-response -
  697. system-stats-history-show -
  698. system-stats-history-show-response -
  699. system-stats-settings-modify -
  700. system-stats-settings-show -
  701. system-stats-settings-show-response -
  702. system-stats-show -
  703. system-stats-show-response -
  704. topology-create -
  705. topology-import -
  706. topology-import-1 -
  707. topology-link-add -
  708. topology-link-modify -
  709. topology-link-show -
  710. topology-link-show-response -
  711. topology-modify -
  712. topology-node-show -
  713. topology-node-show-response -
  714. topology-show -
  715. topology-show-response -
  716. topology-vle-add -
  717. topology-vle-modify -
  718. topology-vle-show -
  719. topology-vle-show-response -
  720. topology-vlink-add -
  721. topology-vlink-modify -
  722. topology-vlink-show -
  723. topology-vlink-show-response -
  724. transaction-log-file-truncate-to -
  725. transaction-node-show -
  726. transaction-node-show-response -
  727. transaction-rollback-to -
  728. transaction-rollforward-to -
  729. transaction-settings-modify -
  730. transaction-settings-show -
  731. transaction-settings-show-response -
  732. transaction-show -
  733. transaction-show-response -
  734. trunk-create -
  735. trunk-modify -
  736. trunk-modify-1 -
  737. trunk-show -
  738. trunk-show-response -
  739. trunk-stats-show -
  740. trunk-stats-show-response -
  741. tunnel-create -
  742. tunnel-history-settings-modify -
  743. tunnel-history-settings-show -
  744. tunnel-history-settings-show-response -
  745. tunnel-history-show -
  746. tunnel-history-show-response -
  747. tunnel-modify -
  748. tunnel-show -
  749. tunnel-show-response -
  750. tunnel-stats-clear -
  751. tunnel-stats-settings-modify -
  752. tunnel-stats-settings-show -
  753. tunnel-stats-settings-show-response -
  754. tunnel-stats-show -
  755. tunnel-stats-show-response -
  756. tunnel-vxlan-add -
  757. tunnel-vxlan-show -
  758. tunnel-vxlan-show-response -
  759. udf-create -
  760. udf-modify -
  761. udf-show -
  762. udf-show-response -
  763. uplink-group-port-add -
  764. uplink-group-port-remove -
  765. uplink-group-port-show -
  766. uplink-group-port-show-response -
  767. user-create -
  768. user-modify -
  769. user-password-set -
  770. user-role-add -
  771. user-role-show -
  772. user-role-show-response -
  773. user-show -
  774. user-show-response -
  775. user-ssh-keygen-clear -
  776. user-ssh-keygen-create -
  777. user-ssh-keygen-export -
  778. user-ssh-keygen-import -
  779. vcenter-connection-create -
  780. vcenter-connection-modify -
  781. vcenter-connection-show -
  782. vcenter-connection-show-response -
  783. vflow-class-create -
  784. vflow-class-show -
  785. vflow-class-show-response -
  786. vflow-create -
  787. vflow-mgmt-stats-clear -
  788. vflow-mgmt-stats-show -
  789. vflow-mgmt-stats-show-response -
  790. vflow-modify -
  791. vflow-settings-modify -
  792. vflow-settings-show -
  793. vflow-settings-show-response -
  794. vflow-show -
  795. vflow-show-response -
  796. vflow-skip-stats-clear -
  797. vflow-skip-stats-show -
  798. vflow-skip-stats-show-response -
  799. vflow-stats-clear -
  800. vflow-stats-settings-modify -
  801. vflow-stats-settings-show -
  802. vflow-stats-settings-show-response -
  803. vflow-stats-show -
  804. vflow-stats-show-response -
  805. vflow-table-profile-modify -
  806. vflow-table-profile-show -
  807. vflow-table-profile-show-response -
  808. vflow-table-show -
  809. vflow-table-show-response -
  810. vlag-create -
  811. vlag-modify -
  812. vlag-show -
  813. vlag-show-response -
  814. vlag-stats-show -
  815. vlag-stats-show-response -
  816. vlan-create -
  817. vlan-create-1 -
  818. vlan-modify -
  819. vlan-port-add -
  820. vlan-port-remove -
  821. vlan-port-show -
  822. vlan-port-show-response -
  823. vlan-show -
  824. vlan-show-response -
  825. vlan-stats-clear -
  826. vlan-stats-settings-modify -
  827. vlan-stats-settings-show -
  828. vlan-stats-settings-show-response -
  829. vlan-stats-show -
  830. vlan-stats-show-response -
  831. vle-create -
  832. vle-modify -
  833. vle-show -
  834. vle-show-response -
  835. vle-stats-clear -
  836. vle-stats-show -
  837. vle-stats-show-response -
  838. vle-transparent-modify -
  839. vle-transparent-port-add -
  840. vle-transparent-port-remove -
  841. vle-transparent-port-show -
  842. vle-transparent-port-show-response -
  843. vle-transparent-show -
  844. vle-transparent-show-response -
  845. vnet-cli-alias-add -
  846. vnet-cli-alias-modify -
  847. vnet-cli-alias-show -
  848. vnet-cli-alias-show-response -
  849. vnet-create -
  850. vnet-manager-create -
  851. vnet-manager-interface-add -
  852. vnet-manager-interface-modify -
  853. vnet-manager-interface-show -
  854. vnet-manager-interface-show-response -
  855. vnet-manager-migrate -
  856. vnet-manager-modify -
  857. vnet-manager-service-modify -
  858. vnet-manager-service-show -
  859. vnet-manager-service-show-response -
  860. vnet-manager-show -
  861. vnet-manager-show-response -
  862. vnet-modify -
  863. vnet-port-add -
  864. vnet-port-show -
  865. vnet-port-show-response -
  866. vnet-public-vlans-modify -
  867. vnet-public-vlans-show -
  868. vnet-public-vlans-show-response -
  869. vnet-show -
  870. vnet-show-response -
  871. vnet-tunnel-network-add -
  872. vnet-tunnel-network-modify -
  873. vnet-tunnel-network-show -
  874. vnet-tunnel-network-show-response -
  875. vpg-create -
  876. vpg-monitor-port-add -
  877. vpg-monitor-port-show -
  878. vpg-monitor-port-show-response -
  879. vpg-port-add -
  880. vpg-port-show -
  881. vpg-port-show-response -
  882. vpg-show -
  883. vpg-show-response -
  884. vport-create -
  885. vport-history-show -
  886. vport-history-show-response -
  887. vport-modify -
  888. vport-settings-modify -
  889. vport-settings-show -
  890. vport-settings-show-response -
  891. vport-show -
  892. vport-show-response -
  893. vport-stats-report -
  894. vport-stats-show -
  895. vport-stats-show-response -
  896. vport-system-stats-report -
  897. vport-system-stats-show -
  898. vport-system-stats-show-response -
  899. vrf-create -
  900. vrf-modify -
  901. vrf-mroute-show -
  902. vrf-mroute-show-response -
  903. vrf-multicast-flood-modify -
  904. vrf-multicast-flood-show -
  905. vrf-multicast-flood-show-response -
  906. vrf-multicast-igmp-modify -
  907. vrf-multicast-igmp-show -
  908. vrf-multicast-igmp-show-response -
  909. vrf-multicast-modify -
  910. vrf-multicast-show -
  911. vrf-multicast-show-response -
  912. vrf-route-add -
  913. vrf-route-remove -
  914. vrf-route-show -
  915. vrf-route-show-response -
  916. vrf-show -
  917. vrf-show-response -
  918. vrouter-bfd-flapcount-clear -
  919. vrouter-bfd-neighbor-flapcount-clear -
  920. vrouter-bfd-neighbor-show -
  921. vrouter-bfd-neighbor-show-response -
  922. vrouter-bgp-add -
  923. vrouter-bgp-aggregate-address-add -
  924. vrouter-bgp-aggregate-address-modify -
  925. vrouter-bgp-aggregate-address-show -
  926. vrouter-bgp-aggregate-address-show-response -
  927. vrouter-bgp-modify -
  928. vrouter-bgp-neighbor-detail-show -
  929. vrouter-bgp-neighbor-detail-show-response -
  930. vrouter-bgp-neighbor-failed-show -
  931. vrouter-bgp-neighbor-failed-show-response -
  932. vrouter-bgp-neighbor-no-shutdown -
  933. vrouter-bgp-neighbor-reset -
  934. vrouter-bgp-neighbor-reset-all -
  935. vrouter-bgp-neighbor-show -
  936. vrouter-bgp-neighbor-show-response -
  937. vrouter-bgp-neighbor-shutdown -
  938. vrouter-bgp-network-add -
  939. vrouter-bgp-network-show -
  940. vrouter-bgp-network-show-response -
  941. vrouter-bgp-path-list-show -
  942. vrouter-bgp-path-list-show-response -
  943. vrouter-bgp-show -
  944. vrouter-bgp-show-response -
  945. vrouter-cached-routes-show -
  946. vrouter-cached-routes-show-response -
  947. vrouter-community-list-add -
  948. vrouter-community-list-show -
  949. vrouter-community-list-show-response -
  950. vrouter-create-1 -
  951. vrouter-create-2 -
  952. vrouter-create-3 -
  953. vrouter-create-4 -
  954. vrouter-ecmp-cached-routes-show -
  955. vrouter-ecmp-cached-routes-show-response -
  956. vrouter-ecmp-group-show -
  957. vrouter-ecmp-group-show-response -
  958. vrouter-evpn-arp-cache-show -
  959. vrouter-evpn-arp-cache-show-response -
  960. vrouter-evpn-bgp-neighbor-no-shutdown -
  961. vrouter-evpn-bgp-neighbor-reset -
  962. vrouter-evpn-bgp-neighbor-reset-all -
  963. vrouter-evpn-bgp-neighbor-show -
  964. vrouter-evpn-bgp-neighbor-show-response -
  965. vrouter-evpn-bgp-neighbor-shutdown -
  966. vrouter-evpn-bgp-neighbor-summary-show -
  967. vrouter-evpn-bgp-neighbor-summary-show-response -
  968. vrouter-evpn-bgp-routes-show -
  969. vrouter-evpn-bgp-routes-show-response -
  970. vrouter-evpn-bgp-vni-show -
  971. vrouter-evpn-bgp-vni-show-response -
  972. vrouter-evpn-duplicate-mac-show -
  973. vrouter-evpn-duplicate-mac-show-response -
  974. vrouter-evpn-vni-mac-show -
  975. vrouter-evpn-vni-mac-show-response -
  976. vrouter-fib-arps-show -
  977. vrouter-fib-arps-show-response -
  978. vrouter-fib-routes-show -
  979. vrouter-fib-routes-show-response -
  980. vrouter-igmp-static-join-add -
  981. vrouter-igmp-static-join-show -
  982. vrouter-igmp-static-join-show-response -
  983. vrouter-interface-add -
  984. vrouter-interface-config-add -
  985. vrouter-interface-config-modify -
  986. vrouter-interface-config-raprefix-add -
  987. vrouter-interface-config-raprefix-show -
  988. vrouter-interface-config-raprefix-show-response -
  989. vrouter-interface-config-show -
  990. vrouter-interface-config-show-response -
  991. vrouter-interface-ip-add -
  992. vrouter-interface-ip-show -
  993. vrouter-interface-ip-show-response -
  994. vrouter-interface-modify -
  995. vrouter-interface-show -
  996. vrouter-interface-show-response -
  997. vrouter-log-clear -
  998. vrouter-log-show -
  999. vrouter-log-show-response -
  1000. vrouter-loopback-interface-add -
  1001. vrouter-loopback-interface-show -
  1002. vrouter-loopback-interface-show-response -
  1003. vrouter-mac-list-add -
  1004. vrouter-mac-list-add-1 -
  1005. vrouter-mac-list-modify -
  1006. vrouter-mac-list-show -
  1007. vrouter-mac-list-show-response -
  1008. vrouter-mfib-routes-show -
  1009. vrouter-mfib-routes-show-response -
  1010. vrouter-migrate -
  1011. vrouter-modify -
  1012. vrouter-mrib-routes-show -
  1013. vrouter-mrib-routes-show-response -
  1014. vrouter-multicast-igmp-group-show -
  1015. vrouter-multicast-igmp-group-show-response -
  1016. vrouter-multicast-route-show -
  1017. vrouter-multicast-route-show-response -
  1018. vrouter-ospf-add -
  1019. vrouter-ospf-area-add -
  1020. vrouter-ospf-area-modify -
  1021. vrouter-ospf-area-show -
  1022. vrouter-ospf-area-show-response -
  1023. vrouter-ospf-interface-show -
  1024. vrouter-ospf-interface-show-response -
  1025. vrouter-ospf-neighbor-show -
  1026. vrouter-ospf-neighbor-show-response -
  1027. vrouter-ospf-show -
  1028. vrouter-ospf-show-response -
  1029. vrouter-ospf6-add -
  1030. vrouter-ospf6-interface-show -
  1031. vrouter-ospf6-interface-show-response -
  1032. vrouter-ospf6-neighbor-show -
  1033. vrouter-ospf6-neighbor-show-response -
  1034. vrouter-ospf6-show -
  1035. vrouter-ospf6-show-response -
  1036. vrouter-packet-relay-add -
  1037. vrouter-packet-relay-show -
  1038. vrouter-packet-relay-show-response -
  1039. vrouter-pim-config-show -
  1040. vrouter-pim-config-show-response -
  1041. vrouter-pim-interface-show -
  1042. vrouter-pim-interface-show-response -
  1043. vrouter-pim-join-show -
  1044. vrouter-pim-join-show-response -
  1045. vrouter-pim-neighbor-show -
  1046. vrouter-pim-neighbor-show-response -
  1047. vrouter-pim-rp-add -
  1048. vrouter-pim-rp-show -
  1049. vrouter-pim-rp-show-response -
  1050. vrouter-pim-ssm-map-add -
  1051. vrouter-pim-ssm-map-show -
  1052. vrouter-pim-ssm-map-show-response -
  1053. vrouter-pim-ssm-range-add -
  1054. vrouter-pim-ssm-range-show -
  1055. vrouter-pim-ssm-range-show-response -
  1056. vrouter-prefix-list-add -
  1057. vrouter-prefix-list-add-1 -
  1058. vrouter-prefix-list-add-2 -
  1059. vrouter-prefix-list-modify -
  1060. vrouter-prefix-list-show -
  1061. vrouter-prefix-list-show-response -
  1062. vrouter-rib-history-settings-modify -
  1063. vrouter-rib-history-settings-show -
  1064. vrouter-rib-history-settings-show-response -
  1065. vrouter-rib-history-show -
  1066. vrouter-rib-history-show-response -
  1067. vrouter-rib-routes-show -
  1068. vrouter-rib-routes-show-response -
  1069. vrouter-rip-add -
  1070. vrouter-rip-routes-show -
  1071. vrouter-rip-routes-show-response -
  1072. vrouter-rip-show -
  1073. vrouter-rip-show-response -
  1074. vrouter-route-map-add -
  1075. vrouter-route-map-modify -
  1076. vrouter-route-map-show -
  1077. vrouter-route-map-show-response -
  1078. vrouter-routes-multicast-show -
  1079. vrouter-routes-multicast-show-response -
  1080. vrouter-routes-show -
  1081. vrouter-routes-show-response -
  1082. vrouter-routes-stats-show -
  1083. vrouter-routes-stats-show-response -
  1084. vrouter-show -
  1085. vrouter-show-response -
  1086. vrouter-static-bfd-add -
  1087. vrouter-static-bfd-show -
  1088. vrouter-static-bfd-show-response -
  1089. vrouter-static-route-add -
  1090. vrouter-static-route-add-1 -
  1091. vrouter-static-route-modify -
  1092. vrouter-static-route-show -
  1093. vrouter-static-route-show-response -
  1094. vrouter-vrf-add -
  1095. vrouter-vrf-modify -
  1096. vrouter-vrf-show -
  1097. vrouter-vrf-show-response -
  1098. vsg-create -
  1099. vsg-modify -
  1100. vsg-network-add -
  1101. vsg-network-show -
  1102. vsg-network-show-response -
  1103. vsg-route-add -
  1104. vsg-route-show -
  1105. vsg-route-show-response -
  1106. vsg-show -
  1107. vsg-show-response -
  1108. vsg-vrf-add -
  1109. vsg-vrf-show -
  1110. vsg-vrf-show-response -
  1111. vtep-auto-vlan-modify -
  1112. vtep-auto-vlan-show -
  1113. vtep-auto-vlan-show-response -
  1114. vtep-auto-vxlan-modify -
  1115. vtep-auto-vxlan-show -
  1116. vtep-auto-vxlan-show-response -
  1117. vtep-create -
  1118. vtep-modify -
  1119. vtep-show -
  1120. vtep-show-response -
  1121. vtep-vxlan-add -
  1122. vtep-vxlan-show -
  1123. vtep-vxlan-show-response -
  1124. vxlan-dest-port-modify -
  1125. vxlan-dest-port-show -
  1126. vxlan-dest-port-show-response -
  1127. vxlan-stats-clear -
  1128. vxlan-stats-settings-modify -
  1129. vxlan-stats-settings-show -
  1130. vxlan-stats-settings-show-response -
  1131. vxlan-stats-show -
  1132. vxlan-stats-show-response -
  1133. web-cert-import -
  1134. web-cert-import-1 -
  1135. web-cert-info-show -
  1136. web-cert-info-show-response -
  1137. web-cert-request-show -
  1138. web-cert-request-show-response -
  1139. web-cert-self-signed-create -
  1140. web-cert-upload -
  1141. web-cert-upload-1 -
  1142. xact-truncate-show -
  1143. xact-truncate-show-response -

aaa-tacacs-create - Up

creates a TACACS+ configuration
name
String desc=name for TACACS+ config:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=scope of TACACS+
Enum:
local
fabric
server
String desc=TACACS+ server string:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
port (optional)
Integer desc=TACACS+ communication port:type=uint16:default=49 format: int32
secret (optional)
String desc=shared secret for TACACS+:password=true
timeout (optional)
Long desc=number of seconds before communication times out:type=uint32:default=10 format: int64
priority (optional)
Integer desc=priority for TACACs+ format: int32
service (optional)
String desc=TACACS+ service name string:default=shell:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
authen (optional)
Boolean desc=use authentication or no authentication:default=true
authen-local (optional)
Boolean desc=authentication overrides local users
authen-method (optional)
String desc=authentication method - PAP,CHAP(default),MS-CHAP:type=enum:default=chap
Enum:
pap
chap
ms-chap
sess-acct (optional)
Boolean desc=session accounting
cmd-acct (optional)
Boolean desc=command accounting
acct-local (optional)
Boolean desc=accounting for local users
sess-author (optional)
Boolean desc=authorization sessions:default=true
cmd-author (optional)
Boolean desc=command authorization
author-local (optional)
Boolean desc=authorization for local users
service-shell (optional)
String desc=TACACS+ service name string for shell commands:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
service-vtysh (optional)
String desc=TACACS+ service name string for vtysh commands:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

aaa-tacacs-modify - Up

modify a TACACS+ configuration
scope (optional)
String desc=scope of TACACS+
Enum:
local
fabric
server (optional)
String desc=TACACS+ server string:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
port (optional)
Integer desc=TACACS+ communication port:type=uint16:default=49 format: int32
secret (optional)
String desc=shared secret for TACACS+:password=true
timeout (optional)
Long desc=number of seconds before communication times out:type=uint32:default=10 format: int64
priority (optional)
Integer desc=priority for TACACs+ format: int32
service (optional)
String desc=TACACS+ service name string:default=shell:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
authen (optional)
Boolean desc=use authentication or no authentication:default=true
authen-local (optional)
Boolean desc=authentication overrides local users
authen-method (optional)
String desc=authentication method - PAP,CHAP(default),MS-CHAP:type=enum:default=chap
Enum:
pap
chap
ms-chap
sess-acct (optional)
Boolean desc=session accounting
cmd-acct (optional)
Boolean desc=command accounting
acct-local (optional)
Boolean desc=accounting for local users
sess-author (optional)
Boolean desc=authorization sessions:default=true
cmd-author (optional)
Boolean desc=command authorization
author-local (optional)
Boolean desc=authorization for local users
service-shell (optional)
String desc=TACACS+ service name string for shell commands:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
service-vtysh (optional)
String desc=TACACS+ service name string for vtysh commands:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

aaa-tacacs-show - Up

display TACACS+ configuration
api.switch-name (optional)
name
String desc=name for TACACS+ config
scope (optional)
String desc=scope of TACACS+
Enum:
local
fabric
server (optional)
String desc=TACACS+ server string
port (optional)
Integer desc=TACACS+ communication port:type=uint16 format: int32
timeout (optional)
Long desc=number of seconds before communication times out:type=uint32 format: int64
priority (optional)
Integer desc=priority for TACACs+ format: int32
status (optional)
String desc=status of a TACACS+ server:filter=false
service (optional)
String desc=TACACS+ service name string
timed-out (optional)
Boolean desc=server timed out
error-start (optional)
String desc=time of first error:date=yyyy-mm-ddThh:mm:ss
num-errors (optional)
Long desc=number of errors:type=uint64 format: int64
errors-logged (optional)
Boolean desc=errors logged
authen (optional)
Boolean desc=use authentication or no authentication
authen-local (optional)
Boolean desc=authentication overrides local users
authen-method (optional)
String desc=authentication method - PAP,CHAP(default),MS-CHAP:type=enum
Enum:
pap
chap
ms-chap
sess-acct (optional)
Boolean desc=session accounting
cmd-acct (optional)
Boolean desc=command accounting
acct-local (optional)
Boolean desc=accounting for local users
sess-author (optional)
Boolean desc=authorization sessions
cmd-author (optional)
Boolean desc=command authorization
author-local (optional)
Boolean desc=authorization for local users
service-shell (optional)
String desc=TACACS+ service name string for shell commands
service-vtysh (optional)
String desc=TACACS+ service name string for vtysh commands

aaa-tacacs-show-response - Up

access-list-create - Up

create an access list
name
String desc=Access List Name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=scope - local or fabric
Enum:
local
fabric

access-list-ip-add - Up

Add IPs associated with access list
ip (optional)
String desc=IP associated with the access list:type=IPv4 or IPv6 address

access-list-ip-show - Up

Show IPs associated with access list
api.switch-name (optional)
ip
String desc=IP associated with the access list:type=IPv4 or IPv6 address

access-list-ip-show-response - Up

access-list-show - Up

display access lists
api.switch-name (optional)
name
String desc=Access List Name
scope (optional)
String desc=scope - local or fabric
Enum:
local
fabric

access-list-show-response - Up

acl-ip-create - Up

create an IP ACL
name
String desc=name of the ACL:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
action
String desc=action for the ACL - permit or deny:type=enum
Enum:
permit
deny
scope
String desc=scope of ACL - local or fabric
Enum:
local
fabric
vlan (optional)
Integer desc=VLAN assigned to ACL:type=uint16:range=[0,4095] format: int32
port (optional)
Integer desc=port number format: int32
proto (optional)
Integer desc=protocol assigned to ACL:type=uint8 format: int32
vnet-id (optional)
String desc=VLAN VNET assigned to ACL:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain assigned to ACL:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
api.proto (optional)
Enum:
tcp
udp
icmp
igmp
ip
icmpv6
ntp
dns
dhcp
dhcpv6
src-ip (optional)
String desc=source IP address:type=IPv4 or IPv6 address
src-ip-mask (optional)
Integer desc=source IP netmask:type=netmask:requires=[src-ip]:mask-for=[src-ip] format: int32
src-port (optional)
Integer desc=source port number format: int32
dst-ip (optional)
String desc=destination IP address:type=IPv4 or IPv6 address
dst-ip-mask (optional)
Integer desc=destination IP netmask:type=netmask:requires=[dst-ip]:mask-for=[dst-ip] format: int32
dst-port (optional)
Integer desc=destination port number format: int32

acl-ip-modify - Up

modify an IP ACL
action (optional)
String desc=action for the ACL - permit or deny:type=enum
Enum:
permit
deny
vlan (optional)
Integer desc=VLAN assigned to ACL:type=uint16:range=[0,4095] format: int32
port (optional)
Integer desc=port number format: int32
proto (optional)
Integer desc=protocol assigned to ACL:type=uint8 format: int32
vnet-id (optional)
String desc=VLAN VNET assigned to ACL:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain assigned to ACL:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
api.proto (optional)
Enum:
tcp
udp
icmp
igmp
ip
icmpv6
ntp
dns
dhcp
dhcpv6
src-ip (optional)
String desc=source IP address:type=IPv4 or IPv6 address
src-ip-mask (optional)
Integer desc=source IP netmask:type=netmask:requires=[src-ip]:mask-for=[src-ip] format: int32
src-port (optional)
Integer desc=source port number format: int32
dst-ip (optional)
String desc=destination IP address:type=IPv4 or IPv6 address
dst-ip-mask (optional)
Integer desc=destination IP netmask:type=netmask:requires=[dst-ip]:mask-for=[dst-ip] format: int32
dst-port (optional)
Integer desc=destination port number format: int32

acl-ip-show - Up

display IP ACL information
api.switch-name (optional)
name
String desc=name of the ACL
id
String desc=ID assigned to the ACL:type=identifier
action (optional)
String desc=action for the ACL - permit or deny:type=enum
Enum:
permit
deny
vlan (optional)
Integer desc=VLAN assigned to ACL:type=uint16:range=[0,4095] format: int32
scope (optional)
String desc=scope of ACL - local or fabric
Enum:
local
fabric
port (optional)
Integer desc=port number format: int32
proto (optional)
Integer desc=protocol assigned to ACL:type=uint8 format: int32
vnet-id (optional)
String desc=VLAN VNET assigned to ACL:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain assigned to ACL:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
src-ip (optional)
String desc=source IP address:type=IPv4 or IPv6 address
src-ip-mask (optional)
Integer desc=source IP netmask:type=netmask:requires=[src-ip]:mask-for=[src-ip] format: int32
src-port (optional)
Integer desc=source port number format: int32
dst-ip (optional)
String desc=destination IP address:type=IPv4 or IPv6 address
dst-ip-mask (optional)
Integer desc=destination IP netmask:type=netmask:requires=[dst-ip]:mask-for=[dst-ip] format: int32
dst-port (optional)
Integer desc=destination port number format: int32

acl-ip-show-response - Up

acl-mac-create - Up

create a MAC ACL
name
String desc=name of the ACL:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
action
String desc=action for the ACL - permit or deny:type=enum
Enum:
permit
deny
scope
String desc=scope of the ACL - local or fabric
Enum:
local
fabric
vlan (optional)
Integer desc=VLAN assigned to ACL:type=uint16:range=[0,4095] format: int32
port (optional)
Integer desc=port number format: int32
vnet-id (optional)
String desc=VLAN VNET assigned to ACL:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain assigned to ACL:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
src-mac (optional)
String desc=source MAC address:type=mac-address
dst-mac (optional)
String desc=destination MAC address:type=mac-address
src-mac-mask (optional)
String desc=source MAC mask:type=mac-address:requires=[src-mac]
dst-mac-mask (optional)
String desc=destination MAC mask:type=mac-address:requires=[dst-mac]
ether-type (optional)
String desc=ether-type assigned to the ACL:type=uint16:hex=0x[0-9a-fA-F]{4}
Enum:
ipv4
0x800
2048
arp
0x806
2054
wake
0x842
2114
rarp
0x8035
32821
vlan
0x8100
33024
ipv6
0x86dd
34525
lacp
0x8809
34825
mpls-uni
0x8847
34887
mpls-multi
0x8848
34888
jumbo
0x8870
34928
dot1X
0x888e
34958
aoe
0x88a2
34978
qinq
0x88a8
34984
lldp
0x88cc
35020
macsec
0x88e5
35045
ecp
0x8940
35136
ptp
0x88f7
35063
fcoe
0x8906
35078
fcoe-init
0x8914
35092
qinq-old
0x9100
37120

acl-mac-modify - Up

modify a MAC ACL
action (optional)
String desc=action for the ACL - permit or deny:type=enum
Enum:
permit
deny
vlan (optional)
Integer desc=VLAN assigned to ACL:type=uint16:range=[0,4095] format: int32
port (optional)
Integer desc=port number format: int32
vnet-id (optional)
String desc=VLAN VNET assigned to ACL:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain assigned to ACL:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
src-mac (optional)
String desc=source MAC address:type=mac-address
dst-mac (optional)
String desc=destination MAC address:type=mac-address
src-mac-mask (optional)
String desc=source MAC mask:type=mac-address:requires=[src-mac]
dst-mac-mask (optional)
String desc=destination MAC mask:type=mac-address:requires=[dst-mac]
ether-type (optional)
String desc=ether-type assigned to the ACL:type=uint16:hex=0x[0-9a-fA-F]{4}
Enum:
ipv4
0x800
2048
arp
0x806
2054
wake
0x842
2114
rarp
0x8035
32821
vlan
0x8100
33024
ipv6
0x86dd
34525
lacp
0x8809
34825
mpls-uni
0x8847
34887
mpls-multi
0x8848
34888
jumbo
0x8870
34928
dot1X
0x888e
34958
aoe
0x88a2
34978
qinq
0x88a8
34984
lldp
0x88cc
35020
macsec
0x88e5
35045
ecp
0x8940
35136
ptp
0x88f7
35063
fcoe
0x8906
35078
fcoe-init
0x8914
35092
qinq-old
0x9100
37120

acl-mac-show - Up

display a MAC ACL
api.switch-name (optional)
name
String desc=name of the ACL
id
String desc=ID assigned to the ACL:type=identifier
action (optional)
String desc=action for the ACL - permit or deny:type=enum
Enum:
permit
deny
vlan (optional)
Integer desc=VLAN assigned to ACL:type=uint16:range=[0,4095] format: int32
scope (optional)
String desc=scope of the ACL - local or fabric
Enum:
local
fabric
port (optional)
Integer desc=port number format: int32
vnet-id (optional)
String desc=VLAN VNET assigned to ACL:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain assigned to ACL:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
src-mac (optional)
String desc=source MAC address:type=mac-address
dst-mac (optional)
String desc=destination MAC address:type=mac-address
src-mac-mask (optional)
String desc=source MAC mask:type=mac-address:requires=[src-mac]
dst-mac-mask (optional)
String desc=destination MAC mask:type=mac-address:requires=[dst-mac]
ether-type (optional)
String desc=ether-type assigned to the ACL:type=uint16:hex=0x[0-9a-fA-F]{4}
Enum:
0x800
0x806
0x842
0x8035
0x8100
0x86dd
0x8809
0x8847
0x8848
0x8870
0x888e
0x88a2
0x88a8
0x88cc
0x88e5
0x8940
0x88f7
0x8906
0x8914
0x9100

acl-mac-show-response - Up

admin-cc-mode-modify - Up

Enable/Disable CC mode
enable (optional)
Boolean desc=enable CC mode - disabled by default:default=false

admin-cc-mode-show - Up

Display CC mode
api.switch-name (optional)
enable (optional)
Boolean desc=enable CC mode - disabled by default

admin-cc-mode-show-response - Up

admin-crl-config-modify - Up

Modify CRL config
url (optional)
String desc=HTTP URL to fetch CRLs
enable (optional)
Boolean desc=enable or disable CRL fetch:default=false
interval (optional)
Long desc=CRL fetch interval in minutes:min-10m, max-10080m(7 days), default-1440m(1 day):type=uint32:range=[10,10080]:default=1440 format: int64

admin-crl-config-show - Up

Show CRL Config
api.switch-name (optional)
url (optional)
String desc=HTTP URL to fetch CRLs
enable (optional)
Boolean desc=enable or disable CRL fetch
interval (optional)
Long desc=CRL fetch interval in minutes:min-10m, max-10080m(7 days), default-1440m(1 day):type=uint32:range=[10,10080] format: int64

admin-crl-config-show-response - Up

admin-ipmi-modify - Up

modify parameters for IPMI
ipmi-password (optional)
String desc=IPMI password:password=true
enable (optional)
Boolean desc=enable IPMI
addr-type (optional)
String desc=address type - static or DHCP:type=enum
Enum:
static
dhcp
ip (optional)
String desc=IP address of the IPMI interface:type=IPv4 or IPv6 address:requires=[netmask,gateway-ip]
netmask (optional)
Integer desc=netmask of the IP address:type=netmask:mask-for=[ip] format: int32
gateway-ip (optional)
String desc=gateway IP address:type=IPv4 or IPv6 address
secondary-enable (optional)
Boolean desc=enable IPMI
secondary-addr-type (optional)
String desc=address type - static or DHCP:type=enum
Enum:
static
dhcp
secondary-ip (optional)
String desc=IP address of the IPMI interface:type=IPv4 or IPv6 address:requires=[netmask,gateway-ip]
secondary-netmask (optional)
Integer desc=netmask of the IP address:type=netmask:mask-for=[ip] format: int32
secondary-gateway-ip (optional)
String desc=gateway IP address:type=IPv4 or IPv6 address

admin-ipmi-show - Up

display parameters for IPMI
api.switch-name (optional)
user (optional)
String desc=username
mac (optional)
String desc=MAC address of the IPMI address:type=mac-address
secondary-mac (optional)
String desc=MAC address of the IPMI address:type=mac-address
GUID (optional)
String desc=Globally Unique Identifier
enable (optional)
Boolean desc=enable IPMI
addr-type (optional)
String desc=address type - static or DHCP:type=enum
Enum:
static
dhcp
ip (optional)
String desc=IP address of the IPMI interface:type=IPv4 or IPv6 address:requires=[netmask,gateway-ip]
netmask (optional)
Integer desc=netmask of the IP address:type=netmask:mask-for=[ip] format: int32
gateway-ip (optional)
String desc=gateway IP address:type=IPv4 or IPv6 address
secondary-enable (optional)
Boolean desc=enable IPMI
secondary-addr-type (optional)
String desc=address type - static or DHCP:type=enum
Enum:
static
dhcp
secondary-ip (optional)
String desc=IP address of the IPMI interface:type=IPv4 or IPv6 address:requires=[netmask,gateway-ip]
secondary-netmask (optional)
Integer desc=netmask of the IP address:type=netmask:mask-for=[ip] format: int32
secondary-gateway-ip (optional)
String desc=gateway IP address:type=IPv4 or IPv6 address

admin-ipmi-show-response - Up

admin-service-modify - Up

modify services on the server-switch
ssh (optional)
Boolean desc=Secure Shell - enable or disable
nfs (optional)
Boolean desc=Network File System (NFS) - enable or disable
web (optional)
Boolean desc=Web (HTTP) - enable or disable
vrrp (optional)
Boolean desc=vrrp enable or disable
snmp (optional)
Boolean desc=Simple Network Monitoring Protocol (SNMP) - enable or disable
netconf (optional)
Boolean desc=NETCONF - enable or disable
icmp (optional)
Boolean desc=Internet Message Control Protocol (ICMP) - enable or disable
web-log (optional)
Boolean desc=Web logging - enable or disable:default=false
web-ssl (optional)
Boolean desc=Web SSL (HTTPS) - enable or disable
web-ssl-port (optional)
Integer desc=Web SSL (HTTPS) port - enable or disable:type=uint16:default=443 format: int32
web-port (optional)
Integer desc=Web (HTTP) port - enable or disable:type=uint16:default=80 format: int32

admin-service-show - Up

display services on the server-switch
api.switch-name (optional)
if
String desc=administrative service interface
ssh (optional)
Boolean desc=Secure Shell - enable or disable
nfs (optional)
Boolean desc=Network File System (NFS) - enable or disable
web (optional)
Boolean desc=Web (HTTP) - enable or disable
vrrp (optional)
Boolean desc=vrrp enable or disable
snmp (optional)
Boolean desc=Simple Network Monitoring Protocol (SNMP) - enable or disable
netconf (optional)
Boolean desc=NETCONF - enable or disable
icmp (optional)
Boolean desc=Internet Message Control Protocol (ICMP) - enable or disable
web-log (optional)
Boolean desc=Web logging - enable or disable
web-ssl (optional)
Boolean desc=Web SSL (HTTPS) - enable or disable
web-ssl-port (optional)
Integer desc=Web SSL (HTTPS) port - enable or disable:type=uint16 format: int32
web-port (optional)
Integer desc=Web (HTTP) port - enable or disable:type=uint16 format: int32

admin-service-show-response - Up

admin-session-timeout-modify - Up

Modify login session timeout
timeout (optional)
Long desc=Maximum time to wait for user activity before terminating login session:default=60m format: int64

admin-session-timeout-show - Up

Login session timeout
api.switch-name (optional)
timeout (optional)
Long desc=Maximum time to wait for user activity before terminating login session:filter=false format: int64

admin-session-timeout-show-response - Up

admin-sftp-modify - Up

modify SFTP functionality
enable
Boolean desc=enable SFTP - disabled by default:default=false

admin-sftp-modify-1 - Up

modify SFTP functionality
enable
Boolean desc=enable SFTP - disabled by default:default=true
sftp-password
String desc=SFTP password:password=true
minimum-pw-length (optional)
Integer desc=Minimum password length for sftp account:type=uint8:range=[6,65]:default=6 format: int32

admin-sftp-modify-2 - Up

modify SFTP functionality
sftp-password
String desc=SFTP password:password=true

admin-sftp-modify-3 - Up

modify SFTP functionality
pub-key
String desc=name of ssh public key file:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
key-auth (optional)
Boolean desc=enable or disable key authentication

admin-sftp-modify-4 - Up

modify SFTP functionality
key-auth
Boolean desc=enable or disable key authentication

admin-sftp-modify-5 - Up

modify SFTP functionality
disable-pass-auth
Boolean desc=enable or disable password authentication:default=false

admin-sftp-show - Up

display SFTP functionality
api.switch-name (optional)
enable (optional)
Boolean desc=enable SFTP - disabled by default
pub-key-content (optional)
String desc=ssh public key content
sftp-user (optional)
String desc=SFTP username
disable-pass-auth (optional)
Boolean desc=enable or disable password authentication
pub-key (optional)
String desc=name of ssh public key file:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
key-auth (optional)
Boolean desc=enable or disable key authentication
minimum-pw-length (optional)
Integer desc=Minimum password length for sftp account:type=uint8:range=[6,65] format: int32

admin-sftp-show-response - Up

admin-syslog-create - Up

create the scope and other parameters of syslog event collection
name
String desc=name of the system log:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=scope of the system log
Enum:
local
fabric
host
String desc=host name to log system events:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
port (optional)
Long desc=host port:type=uint32:default=514 format: int64
transport (optional)
String desc=transport for log events - tcp/tls or udp:type=enum:default=udp
Enum:
tcp-tls
udp
message-format (optional)
String desc=message-format for log events - structured or legacy:type=enum:default=legacy
Enum:
structured
legacy
export-container-logs (optional)
Boolean desc=modify container log export functionality:default=false
export-os-logs (optional)
Boolean desc=modify operating system log export functionality:default=false

admin-syslog-match-add - Up

add a syslog event match filter
name
String desc=name of the matching scheme:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
msg-category (optional)
String desc=message category as event, audit, system, perror:type=enum
Enum:
event
audit
session
system
perror
container
os-logs
xact-truncate
msg-program (optional)
String desc=name of the program used to generate log messages
msg-name (optional)
String desc=message name to match
msg-code (optional)
Long desc=message code to match:type=uint64 format: int64
msg-level (optional)
String desc=the level of severity to match:type=enum
Enum:
critical
error
warn
note
info
msg-event-type (optional)
String desc=message log event type to match:type=enum
Enum:
system
port
tcp
stp
igmp
lldp
lacp
vdp
ecp
evb
ptp
storage
tacacs
mld
mroute
vport
lacp-port-event
msg-vnet (optional)
String desc=VNET to match:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
msg-remote_switch (optional)
String desc=remote switch node to match:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=name:api-ref-val=name
msg-user (optional)
String desc=username to match:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
msg-client-addr (optional)
String desc=client IP address to match:type=IPv4 or IPv6 address
msg-port (optional)
Long desc=port to match:type=uint32 format: int64
msg-vlan (optional)
Integer desc=VLAN to match:type=uint16:range=[0,4095] format: int32
msg-bd (optional)
String desc=Bridge Domain to match:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
msg-vxlan (optional)
String desc=VXLAN to match:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

admin-syslog-match-modify - Up

modify a syslog file for specific events logged to it
msg-category (optional)
String desc=message category as event, audit, system, perror:type=enum
Enum:
event
audit
session
system
perror
container
os-logs
xact-truncate
msg-program (optional)
String desc=name of the program used to generate log messages
msg-name (optional)
String desc=message name to match
msg-code (optional)
Long desc=message code to match:type=uint64 format: int64
msg-level (optional)
String desc=the level of severity to match:type=enum
Enum:
critical
error
warn
note
info
msg-event-type (optional)
String desc=message log event type to match:type=enum
Enum:
system
port
tcp
stp
igmp
lldp
lacp
vdp
ecp
evb
ptp
storage
tacacs
mld
mroute
vport
lacp-port-event
msg-vnet (optional)
String desc=VNET to match:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
msg-remote_switch (optional)
String desc=remote switch node to match:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=name:api-ref-val=name
msg-user (optional)
String desc=username to match:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
msg-client-addr (optional)
String desc=client IP address to match:type=IPv4 or IPv6 address
msg-port (optional)
Long desc=port to match:type=uint32 format: int64
msg-vlan (optional)
Integer desc=VLAN to match:type=uint16:range=[0,4095] format: int32
msg-bd (optional)
String desc=Bridge Domain to match:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
msg-vxlan (optional)
String desc=VXLAN to match:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

admin-syslog-match-show - Up

display a syslog file with specific events logged to it
api.switch-name (optional)
name
String desc=name of the matching scheme
set-severity (optional)
Integer desc=severity to match:range=[0,7] format: int32
msg-pid (optional)
Long desc=product ID generating log messages to match:type=uint32 format: int64
msg-client-pid (optional)
Long desc=product ID to match:type=uint32 format: int64
msg-args (optional)
String desc=arguments to match:filter=false
msg-message (optional)
String desc=the message to match:filter=false
msg-time (optional)
String desc=time of the event:filter=false
msg-switch (optional)
String desc=switch to collect log events:filter=false
msg-starting-point (optional)
Long desc=message starting point to match:type=uint64:requires=[msg-length,msg-count] format: int64
msg-length (optional)
Long desc=message length to match:type=uint64:requires=[msg-starting-point,msg-count] format: int64
msg-reverse (optional)
Boolean desc=reverse the order of the messages:requires=[msg-starting-point,msg-length,msg-count]
msg-show-time (optional)
String desc=the time that the message appeared:filter=false
msg-since-last-reset (optional)
Boolean desc=messages since the log reset
set-facility (optional)
Integer desc=facility type to match:range=[0,23] format: int32
msg-category (optional)
String desc=message category as event, audit, system, perror:type=enum
Enum:
event
audit
session
system
perror
container
os-logs
xact-truncate
msg-program (optional)
String desc=name of the program used to generate log messages
msg-name (optional)
String desc=message name to match
msg-code (optional)
Long desc=message code to match:type=uint64 format: int64
msg-level (optional)
String desc=the level of severity to match:type=enum
Enum:
critical
error
warn
note
info
msg-event-type (optional)
String desc=message log event type to match:type=enum
Enum:
system
port
tcp
stp
igmp
lldp
lacp
vdp
ecp
evb
ptp
storage
tacacs
mld
mroute
vport
lacp-port-event
msg-vnet (optional)
String desc=VNET to match:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
msg-remote_switch (optional)
String desc=remote switch node to match:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=name:api-ref-val=name
msg-user (optional)
String desc=username to match:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
msg-client-addr (optional)
String desc=client IP address to match:type=IPv4 or IPv6 address
msg-port (optional)
Long desc=port to match:type=uint32 format: int64
msg-vlan (optional)
Integer desc=VLAN to match:type=uint16:range=[0,4095] format: int32
msg-bd (optional)
String desc=Bridge Domain to match:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
msg-vxlan (optional)
String desc=VXLAN to match

admin-syslog-match-show-response - Up

admin-syslog-modify - Up

modify parameters of syslog event collection
scope (optional)
String desc=scope of the system log
Enum:
local
fabric
host (optional)
String desc=host name to log system events:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
port (optional)
Long desc=host port:type=uint32:default=514 format: int64
transport (optional)
String desc=transport for log events - tcp/tls or udp:type=enum:default=udp
Enum:
tcp-tls
udp
message-format (optional)
String desc=message-format for log events - structured or legacy:type=enum:default=legacy
Enum:
structured
legacy
export-container-logs (optional)
Boolean desc=modify container log export functionality:default=false
export-os-logs (optional)
Boolean desc=modify operating system log export functionality:default=false

admin-syslog-show - Up

display syslog event collection parameters
api.switch-name (optional)
name
String desc=name of the system log
scope (optional)
String desc=scope of the system log
Enum:
local
fabric
host (optional)
String desc=host name to log system events
port (optional)
Long desc=host port:type=uint32 format: int64
status (optional)
String desc=syslog export status
transport (optional)
String desc=transport for log events - tcp/tls or udp:type=enum
Enum:
tcp-tls
udp
message-format (optional)
String desc=message-format for log events - structured or legacy:type=enum
Enum:
structured
legacy
export-container-logs (optional)
Boolean desc=modify container log export functionality
export-os-logs (optional)
Boolean desc=modify operating system log export functionality

admin-syslog-show-response - Up

alert-show - Up

show alerts for system issues
api.switch-name (optional)
level (optional)
String desc=alert level:type=flag
Enum:
critical
message (optional)
String desc=alert message:filter=false

alert-show-response - Up

api-install-install - Up

install nvOS on a Linux platform and use the API associated features
user
String desc=username:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
password
String desc=plain text password:password=true
linux-host
String desc=linux-host name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

bezel-portmap-show - Up

display the mapping of logical ports to bezel interface numbers
api.switch-name (optional)
port (optional)
Long desc=logical port:type=uint32 format: int64
bezel-intf (optional)
String desc=bezel interface number

bezel-portmap-show-response - Up

bootenv-activate-and-reboot - Up

activate a boot environment and reboot it
name
String desc=boot environment name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
apply-current-config (optional)
Boolean desc=apply current configuration to activated boot environment
disable-auto-recovery (optional)
Boolean desc=Disable auto recovery to activated boot environment

bootenv-show - Up

display a boot environment
api.switch-name (optional)
name
String desc=boot environment name
version (optional)
String desc=boot environment version
current (optional)
Boolean desc=current boot environment
reboot (optional)
Boolean desc=reboot to current environment
space (optional)
Long desc=disk space allocated to boot environment:type=uint64:filter=false format: int64
created (optional)
String desc=boot environment created:date=yyyy-mm-ddThh:mm:ss:filter=false
apply-current-config (optional)
Boolean desc=apply current configuration to activated boot environment
disable-auto-recovery (optional)
Boolean desc=Disable auto recovery to activated boot environment:filter=false

bootenv-show-response - Up

bridge-domain-create - Up

create a Bridge Domain
name
String desc=Bridge Domain name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=Bridge Domain scope
Enum:
local
fabric
cluster
auto-vxlan (optional)
Boolean desc=Automatically assign VXLAN and/or assign to VTEPs
description (optional)
String desc=BD description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
rsvd-vlan (optional)
Integer desc=Fabric reserved vlan for cluster switches for Bridge Domain:type=uint16:range=[2,4093]:precludes=[suppress-rsvd-vlan] format: int32
local-rsvd-vlan (optional)
Integer desc=Local reserved vlan for cluster switches for Bridge Domain:type=uint16:range=[2,4093] format: int32
vxlan-inner-packet (optional)
String desc=Preseve original ethernet header inside the VXLAN tunnel:type=enum:default=auto
Enum:
auto
remove-tags
transparent
l2-tunneling (optional)
String desc=Enable l2-tunneling on this Bridge Domain:type=flag:default=none
Enum:
none
lldp
stp
lacp
all
mac-learning (optional)
Boolean desc=Mac-learning enable or disable:default=true
vxlan (optional)
Long desc=VXLAN identifier for tunnel, value 0 indicates unconfigure vxlan:type=uint32:range=[0,16777215] format: int64
vnet-id (optional)
String desc=VNET for this Bridge Domain:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
suppress-rsvd-vlan (optional)
Boolean desc=suppress fabric rsvd-vlan configuration requirement:default=false:precludes=[rsvd-vlan]

bridge-domain-modify - Up

modify a Bridge Domain
description (optional)
String desc=BD description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
rsvd-vlan (optional)
Integer desc=Fabric reserved vlan for cluster switches for Bridge Domain:type=uint16:range=[2,4093]:precludes=[suppress-rsvd-vlan] format: int32
local-rsvd-vlan (optional)
Integer desc=Local reserved vlan for cluster switches for Bridge Domain:type=uint16:range=[2,4093] format: int32
vxlan-inner-packet (optional)
String desc=Preseve original ethernet header inside the VXLAN tunnel:type=enum:default=auto
Enum:
auto
remove-tags
transparent
l2-tunneling (optional)
String desc=Enable l2-tunneling on this Bridge Domain:type=flag:default=none
Enum:
none
lldp
stp
lacp
all
mac-learning (optional)
Boolean desc=Mac-learning enable or disable:default=true

bridge-domain-port-add - Up

add a port to a Bridge Domain
port
String desc=port assigned to Network:type=port-list
cos (optional)
Long desc=Dot1Q CoS priority:type=uint32:range=[0,7]:requires=[vlans] format: int64
outer-vlan (optional)
Integer desc=outer vlan for Q-in-Q vlan:type=uint16:range=[2,4093]:precludes=[vlan,vlans] format: int32
vlan-range (optional)
String desc=access vlans for Q-in-Q as range(upto 8), for BUM limiting:type=vlan-list:precludes=[inner-vlan,outer-vlan,vlans]
vlans (optional)
String desc=access vlans for Q-in-Q:type=vlan-list:precludes=[inner-vlan,outer-vlan]
untagged-port-vlan (optional)
Integer desc=vlan for untagged port:type=uint16:range=[2,4093] format: int32
inner-vlan (optional)
Integer desc=inner vlan for ports assigned to Network:type=uint16:range=[0,4095]:default=0:requires=[outer-vlan]:precludes=[vlan,vlans] format: int32
l2-learning (optional)
String desc=mac-learning provisioning [none|enable|disable]:type=enum:default=none
Enum:
none
enable
disable
outer-cos (optional)
Long desc=Outer Vlan CoS value:type=uint32:range=[0,7]:requires=[outer-vlan] format: int64
inner-cos (optional)
Long desc=Inner Vlan CoS value:type=uint32:range=[0,7]:requires=[inner-vlan] format: int64
outer-tpid (optional)
String desc=Outer TPID value:type=enum:default=none:requires=[outer-vlan]
Enum:
none
dot1q
q-in-q
q-in-q-old

bridge-domain-port-modify - Up

modify a port from a Bridge Domain
vlans (optional)
String desc=access vlans for Q-in-Q:type=vlan-list:precludes=[inner-vlan,outer-vlan]
l2-learning (optional)
String desc=mac-learning provisioning [none|enable|disable]:type=enum:default=none
Enum:
none
enable
disable

bridge-domain-port-remove - Up

remove a port from a Bridge Domain
port
String desc=port assigned to Network:type=port-list

bridge-domain-port-show - Up

display ports for a Bridge Domain
api.switch-name (optional)
port
String desc=port assigned to Network:type=port-list
cos (optional)
Long desc=Dot1Q CoS priority:type=uint32:range=[0,7]:requires=[vlans] format: int64
active-ports (optional)
String desc=active ports:type=port-list
single-bum-domain (optional)
Boolean desc=q-in-q vlans in range for bum-limit
outer-vlan (optional)
Integer desc=outer vlan for Q-in-Q vlan:type=uint16:range=[2,4093]:precludes=[vlan,vlans] format: int32
vlan-range (optional)
String desc=access vlans for Q-in-Q as range(upto 8), for BUM limiting:type=vlan-list:precludes=[inner-vlan,outer-vlan,vlans]
vlans (optional)
String desc=access vlans for Q-in-Q:type=vlan-list:precludes=[inner-vlan,outer-vlan]
untagged-port-vlan (optional)
Integer desc=vlan for untagged port:type=uint16:range=[2,4093] format: int32
inner-vlan (optional)
Integer desc=inner vlan for ports assigned to Network:type=uint16:range=[0,4095]:requires=[outer-vlan]:precludes=[vlan,vlans] format: int32
l2-learning (optional)
String desc=mac-learning provisioning [none|enable|disable]:type=enum
Enum:
none
enable
disable
outer-cos (optional)
Long desc=Outer Vlan CoS value:type=uint32:range=[0,7]:requires=[outer-vlan] format: int64
inner-cos (optional)
Long desc=Inner Vlan CoS value:type=uint32:range=[0,7]:requires=[inner-vlan] format: int64
outer-tpid (optional)
String desc=Outer TPID value:type=enum:requires=[outer-vlan]
Enum:
none
dot1q
q-in-q
q-in-q-old

bridge-domain-port-show-response - Up

bridge-domain-show - Up

show Bridge Domain information
api.switch-name (optional)
name
String desc=Bridge Domain name
vnet-id
String desc=VNET for this Bridge Domain:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
scope (optional)
String desc=Bridge Domain scope
Enum:
local
fabric
cluster
active (optional)
Boolean desc=Bridge Domain active status
vxlan-hybrid-mode (optional)
String desc=VXLAN encapsulation mapping to tunnel in hybrid mode:type=enum
Enum:
standard
transparent
hw-vpn (optional)
Integer desc=hardware VPN:type=uint16 format: int32
hw-mcast-group (optional)
Integer desc=hardware multicast group format: int32
net-id (optional)
Integer desc=Bridge Domain ID:type=uint16:range=[0,12287] format: int32
peer-net-id (optional)
Integer desc=peer network ID:type=uint16:range=[0,12287] format: int32
qinq_rsvd_vlan (optional)
Integer desc=Running reserved vlan for cluster switches for Bridge Domain:type=uint16:range=[0,4095] format: int32
auto-vxlan (optional)
Boolean desc=Automatically assign VXLAN and/or assign to VTEPs
description (optional)
String desc=BD description
rsvd-vlan (optional)
Integer desc=Fabric reserved vlan for cluster switches for Bridge Domain:type=uint16:range=[2,4093]:precludes=[suppress-rsvd-vlan] format: int32
local-rsvd-vlan (optional)
Integer desc=Local reserved vlan for cluster switches for Bridge Domain:type=uint16:range=[2,4093] format: int32
vxlan-inner-packet (optional)
String desc=Preseve original ethernet header inside the VXLAN tunnel:type=enum
Enum:
auto
remove-tags
transparent
l2-tunneling (optional)
String desc=Enable l2-tunneling on this Bridge Domain:type=flag
Enum:
none
lldp
stp
lacp
all
mac-learning (optional)
Boolean desc=Mac-learning enable or disable
vxlan (optional)
Long desc=VXLAN identifier for tunnel, value 0 indicates unconfigure vxlan:type=uint32:range=[0,16777215] format: int64
ports (optional)
String desc=ports assigned to Bridge Domain:type=port-list
suppress-rsvd-vlan (optional)
Boolean desc=suppress fabric rsvd-vlan configuration requirement:precludes=[rsvd-vlan]

bridge-domain-show-response - Up

cert-create - Up

Create server certificate and self-sign
name
String desc=Certificate name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
country
String desc=Country Name (2 letter code)
state
String desc=State or Province Name
city
String desc=City Name
organization
String desc=Organization Name
organizational-unit
String desc=Organizational Unit Name
common-name
String desc=Common Name
container (optional)
String desc=Certificate zone/container name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/zones:api-ref-model=zone-show:api-ref-id=name:api-ref-val=name
status (optional)
String desc=The expiration status of the certificate

cert-expiration-alert-modify - Up

Modify certificate expiration alerts configuration
netvisor (optional)
Boolean desc=enable or disable netvisor certificate expiration alerts:default=true
days-before-expiration (optional)
Long desc=Modify the number of days before expiration to send alerts (Default 30 days):type=uint32:range=[7,180]:default=30 format: int64

cert-expiration-alert-show - Up

Show certificate expiration alerts configuration
api.switch-name (optional)
netvisor (optional)
Boolean desc=enable or disable netvisor certificate expiration alerts
days-before-expiration (optional)
Long desc=Modify the number of days before expiration to send alerts (Default 30 days):type=uint32:range=[7,180] format: int64

cert-expiration-alert-show-response - Up

cert-import - Up

import certificates from sftp directory
name
String desc=Certificate name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
file-ca
String desc=Name of CA Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
file-server
String desc=Name of Server Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
container (optional)
String desc=Certificate zone/container name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/zones:api-ref-model=zone-show:api-ref-id=name:api-ref-val=name
file-inter (optional)
String desc=Name of Intermediate CA Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
status (optional)
String desc=The expiration status of the certificate

cert-import-1 - Up

import certificates from sftp directory
name
String desc=Certificate name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
file-server
String desc=Name of Server Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
container (optional)
String desc=Certificate zone/container name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/zones:api-ref-model=zone-show:api-ref-id=name:api-ref-val=name
file-inter (optional)
String desc=Name of Intermediate CA Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
status (optional)
String desc=The expiration status of the certificate
file-ca (optional)
String desc=Name of CA Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters

cert-request-create - Up

create a certificate signing request from existing server certificate
name
String desc=Certificate name:api-ref-path=/certs:api-ref-model=cert-show:api-ref-id=name:api-ref-val=name
container (optional)
String desc=Certificate zone/container name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/zones:api-ref-model=zone-show:api-ref-id=name:api-ref-val=name

cert-request-show - Up

display certificate signing request
api.switch-name (optional)
name
String desc=Certificate name:api-ref-path=/certs:api-ref-model=cert-show:api-ref-id=name:api-ref-val=name
container (optional)
String desc=Certificate zone/container name:api-ref-path=/zones:api-ref-model=zone-show:api-ref-id=name:api-ref-val=name
cert-request (optional)
String desc=Certificate Signing Request

cert-request-show-response - Up

cert-show - Up

Display certificates imported by admin
api.switch-name (optional)
name (optional)
String desc=Certificate name
container (optional)
String desc=Certificate zone/container name:api-ref-path=/zones:api-ref-model=zone-show:api-ref-id=name:api-ref-val=name
cert-type (optional)
String desc=The type of certificate: CA, intermediate or server:type=enum
Enum:
ca
intermediate
server
subject (optional)
String desc=The subject of the certificate
issuer (optional)
String desc=The issuer of the certificate
serial-number (optional)
Long desc=The serial number of the certificate:type=uint64 format: int64
valid-from (optional)
String desc=The time from which the certificate is valid.
valid-to (optional)
String desc=The time at which the certificate expires and is no longer valid.
status (optional)
String desc=The expiration status of the certificate
country (optional)
String desc=Country Name (2 letter code)
state (optional)
String desc=State or Province Name
city (optional)
String desc=City Name
organization (optional)
String desc=Organization Name
organizational-unit (optional)
String desc=Organizational Unit Name
common-name (optional)
String desc=Common Name

cert-show-response - Up

cert-upload - Up

upload certificates through APIs
name
String desc=Certificate name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
cert-ca
String desc=CA Certificate
cert-server
String desc=Server Certificate
container (optional)
String desc=Certificate zone/container name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/zones:api-ref-model=zone-show:api-ref-id=name:api-ref-val=name
status (optional)
String desc=The expiration status of the certificate
cert-inter (optional)
String desc=Intermediate CA Certificate

cert-upload-1 - Up

upload certificates through APIs
name
String desc=Certificate name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
cert-server
String desc=Server Certificate
container (optional)
String desc=Certificate zone/container name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/zones:api-ref-model=zone-show:api-ref-id=name:api-ref-val=name
file-inter (optional)
String desc=Name of Intermediate CA Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
status (optional)
String desc=The expiration status of the certificate
cert-ca (optional)
String desc=CA Certificate
cert-inter (optional)
String desc=Intermediate CA Certificate
file-ca (optional)
String desc=Name of CA Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
file-server (optional)
String desc=Name of Server Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters

client-server-stats-clear - Up

clear statistics generated between a client and server
vnet (optional)
String desc=client server statistics per VNET:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan (optional)
Integer desc=client server statistics per VLAN:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=client server statistics per VXLAN:type=uint32:range=[0,16777215] format: int64
syn (optional)
Long desc=number of syns:type=uint64 format: int64
est (optional)
Long desc=number of established connections:type=uint64 format: int64
fin (optional)
Long desc=number of finished/terminated connections:type=uint64 format: int64
syn-resends (optional)
Long desc=number of syn resends:type=uint64 format: int64
syn-ack-resends (optional)
Long desc=number of syn-ack resends:type=uint64 format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64 format: int64
ibytes (optional)
Long desc=incoming bytes:type=uint64 format: int64
total-bytes (optional)
Long desc=total bytes:type=uint64 format: int64
avg-dur (optional)
Long desc=average duration of a connection format: int64
avg-lat (optional)
Long desc=average latency of a connection format: int64
first-seen (optional)
String desc=time that client server statistics were first seen:date=yyyy-mm-ddThh:mm:ss
last-seen (optional)
String desc=time that client server statistics were last seen:date=yyyy-mm-ddThh:mm:ss
count (optional)
Long desc=client server statistics count:type=uint32 format: int64
client-switch-port (optional)
Integer desc=client server statistics per client switch port format: int32
server-switch-port (optional)
Integer desc=client server statistics per server switch port format: int32
client-mac (optional)
String desc=client server statistics per client MAC:type=mac-address
server-mac (optional)
String desc=client server statistics per server MAC:type=mac-address
client-ip (optional)
String desc=client server statistics per client IP:type=IPv4 or IPv6 address
server-ip (optional)
String desc=client server statistics server IP:type=IPv4 or IPv6 address
api.server-port (optional)
Enum:
ftp-data
ftp-control
ssh
telnet
http
https
rpc
sql
imap
bgp
ldap
iSCSI
oracle-db
nfs
cifs
iSCSI-target
lockd
HDFS-Namenode-WebUI
HDFS-Secure-Namenode-WebUI
HDFS-Metadata-operations-8020
HDFS-Metadata-operations-9000
HDFS-DataNode-WebUI
HDFS-Secure-DataNode-WebUI
HDFS-DataTransfer
HDFS-DataNode-Metadata
HDFS-Secondary-NameNode
MR-JobTracker-WebUI
MR-JobTracker
MR-TaskTracker-WebUI
MR-History-WebUI
Hive-Server-Thrift
Hive-Metastore-Thrift
HBase-HMaster
HBase-HMaster-WebUI
HBase-Region-Server
HBase-Region-Server-Http
HBase-Zookeeper
HBase-Zookeeper-Peer
HBase-Zookeeper-Client-Port
WebHCat-Server
Ganglia-Gmond-Collectors-8660
Ganglia-Gmond-Collectors-8661
Ganglia-Gmond-Collectors-8662
Ganglia-Gmond-Collectors-8663
MySQL
Snap-Mirror/Vault
CIFS/SMB
Cassandra-InterNode-Cluster
Cassandra-Secure-InterNode-Cluster
Cassandra-JMX-Monitoring
Cassandra-Client
Cassandra-Client-Thrift
Cassandra-OpsCenter
Cassandra-OpsCenter-Monitoring
Cassandra-OpsCenter-Agent
VMotion
LDAP
LDAP-SSL
Ganglia-gmetad
Nutanix-Stargate
Nutanix-Curator
Nutanix-Chronos-Master
Nutanix-Chronos-Node
Nutanix-Transfer-Manager
Nutanix-Alert-Manager
Nutanix-Deduplication-Object-Store
Nutanix-Pithos
Nutanix-Stats Aggregator-Monitor
Nutanix-Prism Monitor-Port
Nutanix-Nutanix-Cerebro
Nutanix-Stats-Aggregator
Nutanix-Arithmos
Nutanix-Hyperint
Nutanix-Mount/NFS-RPC-service
Nutanix-Genesis
server-port (optional)
Integer desc=client server statistics per server port:type=uint16 format: int32
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
bd (optional)
String desc=client server statistics per Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

client-server-stats-show - Up

display statistics generated between a client and server
api.switch-name (optional)
vnet (optional)
String desc=client server statistics per VNET:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan (optional)
Integer desc=client server statistics per VLAN:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=client server statistics per VXLAN:type=uint32:range=[0,16777215] format: int64
last-seen-ago (optional)
Long desc=client server statistics last seen time format: int64
syn (optional)
Long desc=number of syns:type=uint64 format: int64
est (optional)
Long desc=number of established connections:type=uint64 format: int64
fin (optional)
Long desc=number of finished/terminated connections:type=uint64 format: int64
syn-resends (optional)
Long desc=number of syn resends:type=uint64 format: int64
syn-ack-resends (optional)
Long desc=number of syn-ack resends:type=uint64 format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64:filter=false format: int64
ibytes (optional)
Long desc=incoming bytes:type=uint64:filter=false format: int64
total-bytes (optional)
Long desc=total bytes:type=uint64:filter=false format: int64
avg-dur (optional)
Long desc=average duration of a connection:filter=false format: int64
avg-lat (optional)
Long desc=average latency of a connection:filter=false format: int64
first-seen (optional)
String desc=time that client server statistics were first seen:date=yyyy-mm-ddThh:mm:ss
last-seen (optional)
String desc=time that client server statistics were last seen:date=yyyy-mm-ddThh:mm:ss
count (optional)
Long desc=client server statistics count:type=uint32 format: int64
client-switch-port (optional)
Integer desc=client server statistics per client switch port format: int32
server-switch-port (optional)
Integer desc=client server statistics per server switch port format: int32
client-mac (optional)
String desc=client server statistics per client MAC:type=mac-address
server-mac (optional)
String desc=client server statistics per server MAC:type=mac-address
client-ip (optional)
String desc=client server statistics per client IP:type=IPv4 or IPv6 address
server-ip (optional)
String desc=client server statistics server IP:type=IPv4 or IPv6 address
server-port (optional)
Integer desc=client server statistics per server port:type=uint16 format: int32
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
bd (optional)
String desc=client server statistics per Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

client-server-stats-show-response - Up

cluster-bringdown-modify - Up

update cluster bring down settings
vlag-port-staggered-interval (optional)
Long desc=Interval between vlag ports bringdown:default=0s format: int64
defer-node-1-ports (optional)
String desc=ports to be brought down after vlag & l3 for cluster-node-1:type=port-list
defer-node-2-ports (optional)
String desc=ports to be brought down after vlag & l3 for cluster-node-2:type=port-list
fast_port_down (optional)
Boolean desc=Faster, simultaneous port down during switch reboot:default=false

cluster-bringdown-show - Up

show cluster bring downsettings
api.switch-name (optional)
vlag-port-staggered-interval (optional)
Long desc=Interval between vlag ports bringdown format: int64
defer-node-1-ports (optional)
String desc=ports to be brought down after vlag & l3 for cluster-node-1:type=port-list
defer-node-2-ports (optional)
String desc=ports to be brought down after vlag & l3 for cluster-node-2:type=port-list
fast_port_down (optional)
Boolean desc=Faster, simultaneous port down during switch reboot

cluster-bringdown-show-response - Up

cluster-bringup-modify - Up

update cluster bring up settings
minimum-sync-delay (optional)
Long desc=Minimum delay to wait for cluster to sync before starting l3/vlag port bring up format: int64
l3-port-bringup-mode (optional)
String desc=L3 port bring up mode during start up:type=enum:default=staggered
Enum:
staggered
simultaneous
l3-port-staggered-interval (optional)
Long desc=Interval between L3 ports in L3 staggered mode:default=3s format: int64
vlag-port-bringup-mode (optional)
String desc=Vlag port bring up mode during start up:type=enum:default=staggered
Enum:
staggered
simultaneous
vlag-port-staggered-interval (optional)
Long desc=Interval between vlag ports in vlag staggered mode:default=3s format: int64
cluster-trunk-port-staggered-interval (optional)
Long desc=Interval between cluster trunk ports in staggered mode:default=0s format: int64
maximum-sync-delay (optional)
Long desc=Maximum delay to wait for cluster to sync before starting l3/vlag port bring up:default=60s format: int64
l3-to-vlag-delay (optional)
Long desc=Delay between last L3 port and first vlag port bring up:default=15s format: int64
l3-to-vlan-interface-delay (optional)
Long desc=Delay between last L3 port and vRouter vlan interface bring up:default=0s format: int64
port-defer-bringup-delay (optional)
Long desc=Global timer value used for port delay-bringup:default=30s format: int64
port-defer-bringup-mode (optional)
String desc=port defer-bringup mode during start up:type=enum:default=staggered
Enum:
staggered
simultaneous
port-defer-bringup-staggered-interval (optional)
Long desc=Interval between ports in defer-bringup mode:default=0s format: int64
vrouter-if-bringup-mode (optional)
String desc=vRouter vlan interface bring up mode:type=enum:default=staggered
Enum:
staggered
simultaneous
vrouter-if-staggered-interval (optional)
Long desc=Interval in ms between vRouter vlan interface bringups in staggered mode:type=uint32:range=[0,60000]:default=0 format: int64
start-port-enable-delay (optional)
Long desc=time delay (sec) to start enabling ports (incl cluster ports) on slave switch:type=uint32:range=[0,240]:default=0 format: int64

cluster-bringup-show - Up

show cluster bring up settings
api.switch-name (optional)
state (optional)
String desc=port bring up state during start up:type=flag
Enum:
ports-disabled
status-updates-wait
router-init-wait
cluster-stp-wait
l3-coming-up
l3-to-vlan-interface-wait
l3-to-vlag-wait
vlags-coming-up
ports-enabled
zone-upgrade-wait
cluster-link-up-wait
min-delay-wait
port-defer-bringup-wait
minimum-sync-delay (optional)
Long desc=Minimum delay to wait for cluster to sync before starting l3/vlag port bring up format: int64
l3-port-bringup-mode (optional)
String desc=L3 port bring up mode during start up:type=enum
Enum:
staggered
simultaneous
l3-port-staggered-interval (optional)
Long desc=Interval between L3 ports in L3 staggered mode format: int64
vlag-port-bringup-mode (optional)
String desc=Vlag port bring up mode during start up:type=enum
Enum:
staggered
simultaneous
vlag-port-staggered-interval (optional)
Long desc=Interval between vlag ports in vlag staggered mode format: int64
cluster-trunk-port-staggered-interval (optional)
Long desc=Interval between cluster trunk ports in staggered mode format: int64
maximum-sync-delay (optional)
Long desc=Maximum delay to wait for cluster to sync before starting l3/vlag port bring up format: int64
l3-to-vlag-delay (optional)
Long desc=Delay between last L3 port and first vlag port bring up format: int64
l3-to-vlan-interface-delay (optional)
Long desc=Delay between last L3 port and vRouter vlan interface bring up format: int64
port-defer-bringup-delay (optional)
Long desc=Global timer value used for port delay-bringup format: int64
port-defer-bringup-mode (optional)
String desc=port defer-bringup mode during start up:type=enum
Enum:
staggered
simultaneous
port-defer-bringup-staggered-interval (optional)
Long desc=Interval between ports in defer-bringup mode format: int64
vrouter-if-bringup-mode (optional)
String desc=vRouter vlan interface bring up mode:type=enum
Enum:
staggered
simultaneous
vrouter-if-staggered-interval (optional)
Long desc=Interval in ms between vRouter vlan interface bringups in staggered mode:type=uint32:range=[0,60000] format: int64
start-port-enable-delay (optional)
Long desc=time delay (sec) to start enabling ports (incl cluster ports) on slave switch:type=uint32:range=[0,240] format: int64

cluster-bringup-show-response - Up

cluster-create - Up

create a new cluster for high availability (HA) in a fabric
name
String desc=name for cluster configuration:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
cluster-node-1
Long desc=name for cluster-node 1:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
cluster-node-2
Long desc=name for cluster-node 2:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
vxlan (optional)
Long desc=VXLAN id for Cluster over tunnel:type=uint32:range=[0,16777215] format: int64
validate (optional)
Boolean desc=validate the cluster link:default=false
node1-ip (optional)
String desc=cluster node 1's IP address:type=IPv4 or IPv6 address:requires=[vxlan,node2-ip]
node2-ip (optional)
String desc=cluser node 2's IP address:type=IPv4 or IPv6 address:requires=[vxlan,node1-ip]
cluster-sync-timeout (optional)
Long desc=cluster sync timeout(ms):type=uint32:range=[500,20000]:default=2000 format: int64
cluster-sync-offline-count (optional)
Long desc=number of missed syncs after which cluster will go offline:type=uint32:range=[1,30]:default=3 format: int64

cluster-membership-modify - Up

update the cluster membership
cluster-node-1 (optional)
Long desc=name for cluster-node 1:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
cluster-node-2 (optional)
Long desc=name for cluster-node 2:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64

cluster-membership-show - Up

show cluster membership
api.switch-name (optional)
name
String desc=name for cluster configuration
state (optional)
String desc=state of the cluster:type=enum
Enum:
offline
online
unavailable
coming-online
slave-ready
going-offline
vxlan (optional)
Long desc=VXLAN id for Cluster over tunnel:type=uint32:range=[0,16777215] format: int64
tid (optional)
Long desc=transaction ID assigned to cluster:type=uint64 format: int64
mode (optional)
String desc=cluster mode:type=enum
Enum:
none
master
slave
ports (optional)
String desc=list of ports:type=port-list
validate (optional)
Boolean desc=validate the cluster link
mst-config-digest (optional)
String desc=Configuration Digest
cluster-mode (optional)
String desc=STP cluster mode:type=enum
Enum:
none
master
slave
mst-digest-mismatch-on-ports (optional)
String desc=MST digest mismatch:type=port-list
mst-digest-mismatch-on-peer-ports (optional)
String desc=MST digest mismatch for cluster peer:type=port-list
mst-config-id-mismatch-on-ports (optional)
String desc=MST Config ID mismatch:type=port-list
mst-config-id-mismatch-on-peer-ports (optional)
String desc=MST Config ID mismatch for cluster peer:type=port-list
remote-ports (optional)
String desc=list of remote ports:type=port-list
mst-revision-mismatch-on-ports (optional)
String desc=MST Revision mismatch:type=port-list
mst-revision-mismatch-on-peer-ports (optional)
String desc=MST Revision mismatch for cluster peer:type=port-list
switch (optional)
Long desc=switch name:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
id (optional)
String desc=ID assigned to cluster:type=identifier
cluster-node-1 (optional)
Long desc=name for cluster-node 1:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
cluster-node-2 (optional)
Long desc=name for cluster-node 2:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
enable (optional)
Boolean desc=enable or disable STP
stp-mode (optional)
String desc=STP mode:type=enum
Enum:
rstp
mstp
bpdus-bridge-ports (optional)
Boolean desc=BPDU packets to bridge specific port
bridge-id (optional)
String desc=STP bridge id:type=mac-address
bridge-priority (optional)
Long desc=STP bridge priority - Multiples of 4096, default 32768:type=uint64:range=[0,61440] format: int64
hello-time (optional)
Integer desc=STP hello time between 1 and 10 secs - default 2:range=[1,10] format: int32
forwarding-delay (optional)
Integer desc=STP forwarding delay between 4 and 30 secs - default 15:range=[4,30] format: int32
max-age (optional)
Integer desc=maximum age time between 6 and 40 secs - default 20:range=[6,40] format: int32
mst-max-hops (optional)
Integer desc=maximum hop count for mstp bpdu - default 20:range=[1,32] format: int32
mst-config-name (optional)
String desc=Name for MST Configuration Instance
mst-config-revision (optional)
Integer desc=MST Revision from 0 to 65535:type=uint16 format: int32
root-guard-wait-time (optional)
Integer desc=root guard wait time between 0 and 300 secs - default 20, 0 to disable wait:range=[0,300] format: int32
node1-ip (optional)
String desc=cluster node 1's IP address:type=IPv4 or IPv6 address:requires=[vxlan,node2-ip]
node2-ip (optional)
String desc=cluser node 2's IP address:type=IPv4 or IPv6 address:requires=[vxlan,node1-ip]
cluster-sync-timeout (optional)
Long desc=cluster sync timeout(ms):type=uint32:range=[500,20000]:filter=false format: int64
cluster-sync-offline-count (optional)
Long desc=number of missed syncs after which cluster will go offline:type=uint32:range=[1,30]:filter=false format: int64

cluster-membership-show-response - Up

cluster-modify - Up

update a cluster
vxlan (optional)
Long desc=VXLAN id for Cluster over tunnel:type=uint32:range=[0,16777215] format: int64
enable (optional)
Boolean desc=enable or disable STP:default=true
stp-mode (optional)
String desc=STP mode:type=enum:default=rstp
Enum:
rstp
mstp
bpdus-bridge-ports (optional)
Boolean desc=BPDU packets to bridge specific port:default=true
bridge-id (optional)
String desc=STP bridge id:type=mac-address
bridge-priority (optional)
Long desc=STP bridge priority - Multiples of 4096, default 32768:type=uint64:range=[0,61440]:default=32768 format: int64
hello-time (optional)
Integer desc=STP hello time between 1 and 10 secs - default 2:range=[1,10]:default=2 format: int32
forwarding-delay (optional)
Integer desc=STP forwarding delay between 4 and 30 secs - default 15:range=[4,30]:default=15 format: int32
max-age (optional)
Integer desc=maximum age time between 6 and 40 secs - default 20:range=[6,40]:default=20 format: int32
mst-max-hops (optional)
Integer desc=maximum hop count for mstp bpdu - default 20:range=[1,32]:default=20 format: int32
mst-config-name (optional)
String desc=Name for MST Configuration Instance:default=Pluribus:pattern=^[a-zA-Z0-9_-]+$:pattern-help=letters, numbers, _, and -
mst-config-revision (optional)
Integer desc=MST Revision from 0 to 65535:type=uint16:default=0 format: int32
root-guard-wait-time (optional)
Integer desc=root guard wait time between 0 and 300 secs - default 20, 0 to disable wait:range=[0,300]:default=20 format: int32
node1-ip (optional)
String desc=cluster node 1's IP address:type=IPv4 or IPv6 address:requires=[vxlan,node2-ip]
node2-ip (optional)
String desc=cluser node 2's IP address:type=IPv4 or IPv6 address:requires=[vxlan,node1-ip]
cluster-sync-timeout (optional)
Long desc=cluster sync timeout(ms):type=uint32:range=[500,20000]:default=2000 format: int64
cluster-sync-offline-count (optional)
Long desc=number of missed syncs after which cluster will go offline:type=uint32:range=[1,30]:default=3 format: int64

cluster-show - Up

display cluster information about high availability (HA) in a fabric
api.switch-name (optional)
name
String desc=name for cluster configuration
state (optional)
String desc=state of the cluster:type=enum
Enum:
offline
online
unavailable
coming-online
slave-ready
going-offline
vxlan (optional)
Long desc=VXLAN id for Cluster over tunnel:type=uint32:range=[0,16777215] format: int64
tid (optional)
Long desc=transaction ID assigned to cluster:type=uint64 format: int64
mode (optional)
String desc=cluster mode:type=enum
Enum:
none
master
slave
ports (optional)
String desc=list of ports:type=port-list
validate (optional)
Boolean desc=validate the cluster link
mst-config-digest (optional)
String desc=Configuration Digest
cluster-mode (optional)
String desc=STP cluster mode:type=enum
Enum:
none
master
slave
mst-digest-mismatch-on-ports (optional)
String desc=MST digest mismatch:type=port-list
mst-digest-mismatch-on-peer-ports (optional)
String desc=MST digest mismatch for cluster peer:type=port-list
mst-config-id-mismatch-on-ports (optional)
String desc=MST Config ID mismatch:type=port-list
mst-config-id-mismatch-on-peer-ports (optional)
String desc=MST Config ID mismatch for cluster peer:type=port-list
remote-ports (optional)
String desc=list of remote ports:type=port-list
mst-revision-mismatch-on-ports (optional)
String desc=MST Revision mismatch:type=port-list
mst-revision-mismatch-on-peer-ports (optional)
String desc=MST Revision mismatch for cluster peer:type=port-list
switch (optional)
Long desc=switch name:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
id (optional)
String desc=ID assigned to cluster:type=identifier
cluster-node-1 (optional)
Long desc=name for cluster-node 1:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
cluster-node-2 (optional)
Long desc=name for cluster-node 2:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
enable (optional)
Boolean desc=enable or disable STP
stp-mode (optional)
String desc=STP mode:type=enum
Enum:
rstp
mstp
bpdus-bridge-ports (optional)
Boolean desc=BPDU packets to bridge specific port
bridge-id (optional)
String desc=STP bridge id:type=mac-address
bridge-priority (optional)
Long desc=STP bridge priority - Multiples of 4096, default 32768:type=uint64:range=[0,61440] format: int64
hello-time (optional)
Integer desc=STP hello time between 1 and 10 secs - default 2:range=[1,10] format: int32
forwarding-delay (optional)
Integer desc=STP forwarding delay between 4 and 30 secs - default 15:range=[4,30] format: int32
max-age (optional)
Integer desc=maximum age time between 6 and 40 secs - default 20:range=[6,40] format: int32
mst-max-hops (optional)
Integer desc=maximum hop count for mstp bpdu - default 20:range=[1,32] format: int32
mst-config-name (optional)
String desc=Name for MST Configuration Instance
mst-config-revision (optional)
Integer desc=MST Revision from 0 to 65535:type=uint16 format: int32
root-guard-wait-time (optional)
Integer desc=root guard wait time between 0 and 300 secs - default 20, 0 to disable wait:range=[0,300] format: int32
node1-ip (optional)
String desc=cluster node 1's IP address:type=IPv4 or IPv6 address:requires=[vxlan,node2-ip]
node2-ip (optional)
String desc=cluser node 2's IP address:type=IPv4 or IPv6 address:requires=[vxlan,node1-ip]
cluster-sync-timeout (optional)
Long desc=cluster sync timeout(ms):type=uint32:range=[500,20000]:filter=false format: int64
cluster-sync-offline-count (optional)
Long desc=number of missed syncs after which cluster will go offline:type=uint32:range=[1,30]:filter=false format: int64

cluster-show-response - Up

cluster-vrrp-optimize-modify - Up

modify optimization
mode (optional)
String desc=enable/disable optimisation mode(needs restart):type=enum:default=disable
Enum:
enable
disable
master (optional)
String desc=will be MASTER for given vlans:type=vlan-list
slave (optional)
String desc=will be slave for given vlans:type=vlan-list

cluster-vrrp-optimize-show - Up

display vrrp optimization mode
api.switch-name (optional)
mode (optional)
String desc=enable/disable optimisation mode(needs restart):type=enum
Enum:
enable
disable
is_restart_pending (optional)
Boolean desc=shows if the restarting pending due to enable/disable
master (optional)
String desc=will be MASTER for given vlans:type=vlan-list
slave (optional)
String desc=will be slave for given vlans:type=vlan-list

cluster-vrrp-optimize-show-response - Up

connection-clear - Up

clear connection statistics
vnet (optional)
String desc=VNET of the connection:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan (optional)
Integer desc=VLAN of the connection information:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=VXLAN for the connection:type=uint32:range=[0,16777215] format: int64
dscp (optional)
Integer desc=DSCP assigned to the connection:type=uint8 format: int32
proto (optional)
Integer desc=protocol assigned to the connection:type=uint8 format: int32
dur (optional)
Long desc=duration for the connection format: int64
cur-state (optional)
String desc=current state of the connection:type=enum
Enum:
syn
syn-ack
est
fin
rst
none
count (optional)
Long desc=number of connections:type=uint32 format: int64
egress-vnet (optional)
String desc=Egress VNET of the connection:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
egress-bd (optional)
String desc=Egress Bridge Domain of the connection:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
egress-vlan (optional)
Integer desc=Egress VLAN of the connection:type=uint16:range=[0,4095] format: int32
src-switch-port (optional)
Integer desc=source-switch-port for the connection format: int32
dst-switch-port (optional)
Integer desc=destination-switch-port for the connection format: int32
src-mac (optional)
String desc=source MAC for the connection:type=mac-address
dst-mac (optional)
String desc=destination MAC for the connection:type=mac-address
src-ip (optional)
String desc=source IP for the connection:type=IPv4 or IPv6 address
dst-ip (optional)
String desc=destination IP for the connection:type=IPv4 or IPv6 address
src-port (optional)
Integer desc=source port for the connection:type=uint16 format: int32
api.src-port (optional)
Enum:
ftp-data
ftp-control
ssh
telnet
http
https
rpc
sql
imap
bgp
ldap
iSCSI
oracle-db
nfs
cifs
iSCSI-target
lockd
HDFS-Namenode-WebUI
HDFS-Secure-Namenode-WebUI
HDFS-Metadata-operations-8020
HDFS-Metadata-operations-9000
HDFS-DataNode-WebUI
HDFS-Secure-DataNode-WebUI
HDFS-DataTransfer
HDFS-DataNode-Metadata
HDFS-Secondary-NameNode
MR-JobTracker-WebUI
MR-JobTracker
MR-TaskTracker-WebUI
MR-History-WebUI
Hive-Server-Thrift
Hive-Metastore-Thrift
HBase-HMaster
HBase-HMaster-WebUI
HBase-Region-Server
HBase-Region-Server-Http
HBase-Zookeeper
HBase-Zookeeper-Peer
HBase-Zookeeper-Client-Port
WebHCat-Server
Ganglia-Gmond-Collectors-8660
Ganglia-Gmond-Collectors-8661
Ganglia-Gmond-Collectors-8662
Ganglia-Gmond-Collectors-8663
MySQL
Snap-Mirror/Vault
CIFS/SMB
Cassandra-InterNode-Cluster
Cassandra-Secure-InterNode-Cluster
Cassandra-JMX-Monitoring
Cassandra-Client
Cassandra-Client-Thrift
Cassandra-OpsCenter
Cassandra-OpsCenter-Monitoring
Cassandra-OpsCenter-Agent
VMotion
LDAP
LDAP-SSL
Ganglia-gmetad
Nutanix-Stargate
Nutanix-Curator
Nutanix-Chronos-Master
Nutanix-Chronos-Node
Nutanix-Transfer-Manager
Nutanix-Alert-Manager
Nutanix-Deduplication-Object-Store
Nutanix-Pithos
Nutanix-Stats Aggregator-Monitor
Nutanix-Prism Monitor-Port
Nutanix-Nutanix-Cerebro
Nutanix-Stats-Aggregator
Nutanix-Arithmos
Nutanix-Hyperint
Nutanix-Mount/NFS-RPC-service
Nutanix-Genesis
api.dst-port (optional)
Enum:
ftp-data
ftp-control
ssh
telnet
http
https
rpc
sql
imap
bgp
ldap
iSCSI
oracle-db
nfs
cifs
iSCSI-target
lockd
HDFS-Namenode-WebUI
HDFS-Secure-Namenode-WebUI
HDFS-Metadata-operations-8020
HDFS-Metadata-operations-9000
HDFS-DataNode-WebUI
HDFS-Secure-DataNode-WebUI
HDFS-DataTransfer
HDFS-DataNode-Metadata
HDFS-Secondary-NameNode
MR-JobTracker-WebUI
MR-JobTracker
MR-TaskTracker-WebUI
MR-History-WebUI
Hive-Server-Thrift
Hive-Metastore-Thrift
HBase-HMaster
HBase-HMaster-WebUI
HBase-Region-Server
HBase-Region-Server-Http
HBase-Zookeeper
HBase-Zookeeper-Peer
HBase-Zookeeper-Client-Port
WebHCat-Server
Ganglia-Gmond-Collectors-8660
Ganglia-Gmond-Collectors-8661
Ganglia-Gmond-Collectors-8662
Ganglia-Gmond-Collectors-8663
MySQL
Snap-Mirror/Vault
CIFS/SMB
Cassandra-InterNode-Cluster
Cassandra-Secure-InterNode-Cluster
Cassandra-JMX-Monitoring
Cassandra-Client
Cassandra-Client-Thrift
Cassandra-OpsCenter
Cassandra-OpsCenter-Monitoring
Cassandra-OpsCenter-Agent
VMotion
LDAP
LDAP-SSL
Ganglia-gmetad
Nutanix-Stargate
Nutanix-Curator
Nutanix-Chronos-Master
Nutanix-Chronos-Node
Nutanix-Transfer-Manager
Nutanix-Alert-Manager
Nutanix-Deduplication-Object-Store
Nutanix-Pithos
Nutanix-Stats Aggregator-Monitor
Nutanix-Prism Monitor-Port
Nutanix-Nutanix-Cerebro
Nutanix-Stats-Aggregator
Nutanix-Arithmos
Nutanix-Hyperint
Nutanix-Mount/NFS-RPC-service
Nutanix-Genesis
icmp_type (optional)
Integer desc=ICMP type of the flow:type=uint8 format: int32
api.icmp_type (optional)
Enum:
echo
reply
v6-echo
v6-reply
tunnel-vnet (optional)
String desc=VNET of the tunnel:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
tunnel-bd (optional)
String desc=Bridge Domain of the tunnel:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
tunnel-vlan (optional)
Integer desc=VLAN of the tunnel:type=uint16:range=[0,4095] format: int32
tunnel-src-mac (optional)
String desc=source MAC for the tunnel:type=mac-address
tunnel-dst-mac (optional)
String desc=destination MAC for the tunnel:type=mac-address
tunnel-src-ip (optional)
String desc=source IP for the tunnel:type=IPv4 or IPv6 address
tunnel-dst-ip (optional)
String desc=destination IP for the tunnel:type=IPv4 or IPv6 address
tunnel-src-port (optional)
Integer desc=source port for the tunnel:type=uint16 format: int32
api.tunnel-src-port (optional)
Enum:
ftp-data
ftp-control
ssh
telnet
http
https
rpc
sql
imap
bgp
ldap
iSCSI
oracle-db
nfs
cifs
iSCSI-target
lockd
HDFS-Namenode-WebUI
HDFS-Secure-Namenode-WebUI
HDFS-Metadata-operations-8020
HDFS-Metadata-operations-9000
HDFS-DataNode-WebUI
HDFS-Secure-DataNode-WebUI
HDFS-DataTransfer
HDFS-DataNode-Metadata
HDFS-Secondary-NameNode
MR-JobTracker-WebUI
MR-JobTracker
MR-TaskTracker-WebUI
MR-History-WebUI
Hive-Server-Thrift
Hive-Metastore-Thrift
HBase-HMaster
HBase-HMaster-WebUI
HBase-Region-Server
HBase-Region-Server-Http
HBase-Zookeeper
HBase-Zookeeper-Peer
HBase-Zookeeper-Client-Port
WebHCat-Server
Ganglia-Gmond-Collectors-8660
Ganglia-Gmond-Collectors-8661
Ganglia-Gmond-Collectors-8662
Ganglia-Gmond-Collectors-8663
MySQL
Snap-Mirror/Vault
CIFS/SMB
Cassandra-InterNode-Cluster
Cassandra-Secure-InterNode-Cluster
Cassandra-JMX-Monitoring
Cassandra-Client
Cassandra-Client-Thrift
Cassandra-OpsCenter
Cassandra-OpsCenter-Monitoring
Cassandra-OpsCenter-Agent
VMotion
LDAP
LDAP-SSL
Ganglia-gmetad
Nutanix-Stargate
Nutanix-Curator
Nutanix-Chronos-Master
Nutanix-Chronos-Node
Nutanix-Transfer-Manager
Nutanix-Alert-Manager
Nutanix-Deduplication-Object-Store
Nutanix-Pithos
Nutanix-Stats Aggregator-Monitor
Nutanix-Prism Monitor-Port
Nutanix-Nutanix-Cerebro
Nutanix-Stats-Aggregator
Nutanix-Arithmos
Nutanix-Hyperint
Nutanix-Mount/NFS-RPC-service
Nutanix-Genesis
tunnel-dst-port (optional)
Integer desc=destination port for the tunnel:type=uint16 format: int32
api.tunnel-dst-port (optional)
Enum:
ftp-data
ftp-control
ssh
telnet
http
https
rpc
sql
imap
bgp
ldap
iSCSI
oracle-db
nfs
cifs
iSCSI-target
lockd
HDFS-Namenode-WebUI
HDFS-Secure-Namenode-WebUI
HDFS-Metadata-operations-8020
HDFS-Metadata-operations-9000
HDFS-DataNode-WebUI
HDFS-Secure-DataNode-WebUI
HDFS-DataTransfer
HDFS-DataNode-Metadata
HDFS-Secondary-NameNode
MR-JobTracker-WebUI
MR-JobTracker
MR-TaskTracker-WebUI
MR-History-WebUI
Hive-Server-Thrift
Hive-Metastore-Thrift
HBase-HMaster
HBase-HMaster-WebUI
HBase-Region-Server
HBase-Region-Server-Http
HBase-Zookeeper
HBase-Zookeeper-Peer
HBase-Zookeeper-Client-Port
WebHCat-Server
Ganglia-Gmond-Collectors-8660
Ganglia-Gmond-Collectors-8661
Ganglia-Gmond-Collectors-8662
Ganglia-Gmond-Collectors-8663
MySQL
Snap-Mirror/Vault
CIFS/SMB
Cassandra-InterNode-Cluster
Cassandra-Secure-InterNode-Cluster
Cassandra-JMX-Monitoring
Cassandra-Client
Cassandra-Client-Thrift
Cassandra-OpsCenter
Cassandra-OpsCenter-Monitoring
Cassandra-OpsCenter-Agent
VMotion
LDAP
LDAP-SSL
Ganglia-gmetad
Nutanix-Stargate
Nutanix-Curator
Nutanix-Chronos-Master
Nutanix-Chronos-Node
Nutanix-Transfer-Manager
Nutanix-Alert-Manager
Nutanix-Deduplication-Object-Store
Nutanix-Pithos
Nutanix-Stats Aggregator-Monitor
Nutanix-Prism Monitor-Port
Nutanix-Nutanix-Cerebro
Nutanix-Stats-Aggregator
Nutanix-Arithmos
Nutanix-Hyperint
Nutanix-Mount/NFS-RPC-service
Nutanix-Genesis
tunnel-proto (optional)
Integer desc=protocol assigned to the tunnel:type=uint8 format: int32
api.tunnel-proto (optional)
Enum:
tcp
udp
icmp
igmp
ip
icmpv6
ntp
dns
dhcp
dhcpv6
latency (optional)
Long desc=latency for the connection format: int64
ibytes (optional)
Long desc=incoming bytes for the connection:type=uint64 format: int64
total-bytes (optional)
Long desc=total bytes for the connection:type=uint64 format: int64
total-pkts (optional)
Long desc=total packets for the flow:type=uint32 format: int64
started-time (optional)
String desc=started time of the connection:date=yyyy-mm-ddThh:mm:ss
update-id (optional)
Long desc=id for last update to connection in elapsed time (ns) format: int64
started-time-ns (optional)
Long desc=started time of the connection in ns format: int64
ended-time (optional)
String desc=ended time of the connection:date=yyyy-mm-ddThh:mm:ss
transition-state (optional)
String desc=transition-state of the connection:type=enum
Enum:
any
started-and-ended
started
ended
on-going
dst-port (optional)
Integer desc=destination port for the connection:type=uint16 format: int32
ether-type (optional)
String desc=ether-type for the connection information:type=uint16:hex=0x[0-9a-fA-F]{4}
Enum:
ipv4
0x800
2048
arp
0x806
2054
wake
0x842
2114
rarp
0x8035
32821
vlan
0x8100
33024
ipv6
0x86dd
34525
lacp
0x8809
34825
mpls-uni
0x8847
34887
mpls-multi
0x8848
34888
jumbo
0x8870
34928
dot1X
0x888e
34958
aoe
0x88a2
34978
qinq
0x88a8
34984
lldp
0x88cc
35020
macsec
0x88e5
35045
ecp
0x8940
35136
ptp
0x88f7
35063
fcoe
0x8906
35078
fcoe-init
0x8914
35092
qinq-old
0x9100
37120
api.proto (optional)
Enum:
tcp
udp
icmp
igmp
ip
icmpv6
ntp
dns
dhcp
dhcpv6
obytes (optional)
Long desc=outgoing bytes for the connection:type=uint64 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
bd (optional)
String desc=Bridge Domain of the connection information:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

connection-latency-show - Up

display latency information for connections
api.switch-name (optional)
min (optional)
Long desc=minimum latency format: int64
max (optional)
Long desc=maximum latency format: int64
num-bins (optional)
Integer desc=number of bins to divide the latency range:type=uint16 format: int32
num-conns (optional)
Long desc=number of connections:type=uint32:filter=false format: int64
percent (optional)
Long desc=percent of latency:type=uint32:filter=false format: int64
avg-dur (optional)
Long desc=average duration:filter=false format: int64
ibytes (optional)
Long desc=incoming bytes:type=uint64:filter=false format: int64
total-bytes (optional)
Long desc=total bytes:type=uint64:filter=false format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64:filter=false format: int64

connection-latency-show-response - Up

connection-show - Up

display connection statistics
api.switch-name (optional)
vnet (optional)
String desc=VNET of the connection:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan (optional)
Integer desc=VLAN of the connection information:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=VXLAN for the connection:type=uint32:range=[0,16777215] format: int64
dscp (optional)
Integer desc=DSCP assigned to the connection:type=uint8 format: int32
proto (optional)
Integer desc=protocol assigned to the connection:type=uint8 format: int32
dur (optional)
Long desc=duration for the connection format: int64
age (optional)
Long desc=age of the connection format: int64
cur-state (optional)
String desc=current state of the connection:type=enum
Enum:
syn
syn-ack
est
fin
rst
none
count (optional)
Long desc=number of connections:type=uint32 format: int64
egress-vnet (optional)
String desc=Egress VNET of the connection:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
egress-bd (optional)
String desc=Egress Bridge Domain of the connection:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
egress-vlan (optional)
Integer desc=Egress VLAN of the connection:type=uint16:range=[0,4095] format: int32
src-switch-port (optional)
Integer desc=source-switch-port for the connection format: int32
dst-switch-port (optional)
Integer desc=destination-switch-port for the connection format: int32
src-mac (optional)
String desc=source MAC for the connection:type=mac-address
dst-mac (optional)
String desc=destination MAC for the connection:type=mac-address
src-ip (optional)
String desc=source IP for the connection:type=IPv4 or IPv6 address
dst-ip (optional)
String desc=destination IP for the connection:type=IPv4 or IPv6 address
src-port (optional)
Integer desc=source port for the connection:type=uint16 format: int32
icmp_type (optional)
Integer desc=ICMP type of the flow:type=uint8 format: int32
tunnel-vnet (optional)
String desc=VNET of the tunnel:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
tunnel-bd (optional)
String desc=Bridge Domain of the tunnel:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
tunnel-vlan (optional)
Integer desc=VLAN of the tunnel:type=uint16:range=[0,4095] format: int32
tunnel-src-mac (optional)
String desc=source MAC for the tunnel:type=mac-address
tunnel-dst-mac (optional)
String desc=destination MAC for the tunnel:type=mac-address
tunnel-src-ip (optional)
String desc=source IP for the tunnel:type=IPv4 or IPv6 address
tunnel-dst-ip (optional)
String desc=destination IP for the tunnel:type=IPv4 or IPv6 address
tunnel-src-port (optional)
Integer desc=source port for the tunnel:type=uint16 format: int32
tunnel-dst-port (optional)
Integer desc=destination port for the tunnel:type=uint16 format: int32
tunnel-proto (optional)
Integer desc=protocol assigned to the tunnel:type=uint8 format: int32
latency (optional)
Long desc=latency for the connection format: int64
ibytes (optional)
Long desc=incoming bytes for the connection:type=uint64 format: int64
total-bytes (optional)
Long desc=total bytes for the connection:type=uint64 format: int64
total-pkts (optional)
Long desc=total packets for the flow:type=uint32 format: int64
started-time (optional)
String desc=started time of the connection:date=yyyy-mm-ddThh:mm:ss:filter=false
update-id (optional)
Long desc=id for last update to connection in elapsed time (ns) format: int64
started-time-ns (optional)
Long desc=started time of the connection in ns:filter=false format: int64
ended-time (optional)
String desc=ended time of the connection:date=yyyy-mm-ddThh:mm:ss:filter=false
transition-state (optional)
String desc=transition-state of the connection:type=enum
Enum:
any
started-and-ended
started
ended
on-going
dst-port (optional)
Integer desc=destination port for the connection:type=uint16 format: int32
ether-type (optional)
String desc=ether-type for the connection information:type=uint16:hex=0x[0-9a-fA-F]{4}
Enum:
0x800
0x806
0x842
0x8035
0x8100
0x86dd
0x8809
0x8847
0x8848
0x8870
0x888e
0x88a2
0x88a8
0x88cc
0x88e5
0x8940
0x88f7
0x8906
0x8914
0x9100
obytes (optional)
Long desc=outgoing bytes for the connection:type=uint64 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
bd (optional)
String desc=Bridge Domain of the connection information:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

connection-show-response - Up

connection-stats-clear - Up

clears statistics collected while connected to the host
mac (optional)
String desc=MAC addresses of connections:type=mac-address
vnet (optional)
String desc=VNET of connections:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan (optional)
Integer desc=VLAN of connections:type=uint16:range=[0,4095] format: int32
ip (optional)
String desc=IP addresses of connections:type=IPv4 or IPv6 address
port (optional)
Long desc=port of connections:type=uint32 format: int64
iconns (optional)
Long desc=incoming connections:type=uint64 format: int64
oconns (optional)
Long desc=outgoing connections:type=uint64 format: int64
ibytes (optional)
Long desc=incoming bytes:type=uint64 format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64 format: int64
total-bytes (optional)
Long desc=total bytes:type=uint64 format: int64
first-seen (optional)
String desc=first-seen time:date=yyyy-mm-ddThh:mm:ss
last-seen (optional)
String desc=last-seen time:date=yyyy-mm-ddThh:mm:ss
count (optional)
Long desc=count connection statistics:type=uint32 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
bd (optional)
String desc=Bridge Domain of connections:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

connection-stats-settings-modify - Up

modify the settings for collecting statistical data about connections
enable (optional)
Boolean desc=enable or disable collecting connections statistics:default=true
connection-max-memory (optional)
Long desc=maximum memory allowed for connection statistics:type=uint64:default=52428800 format: int64
client-server-stats-max-memory (optional)
Long desc=maximum memory for client server statistics:type=uint64:default=52428800 format: int64
connection-stats-max-memory (optional)
Long desc=maximum memory allowed for connection statistics:type=uint64:default=52428800 format: int64
service-stat-max-memory (optional)
Long desc=maximum memory allowed for service statistics:type=uint64:default=1048576 format: int64
fabric-connection-max-memory (optional)
Long desc=maximum memory allowed for fabric connection statistics:type=uint64:default=10485760 format: int64
nv-queue-max-pkts (optional)
Long desc=maximum packets allowed per nv-queue for connection statistics:type=uint32:range=[0,32768]:default=0 format: int64

connection-stats-settings-show - Up

display the settings for collecting statistical data about connections
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable collecting connections statistics
connection-stats-max-cnt (optional)
Long desc=maximum count for connection statistics:type=uint32 format: int64
connection-stats-cur-cnt (optional)
Long desc=current count of connections:type=uint32 format: int64
service-stat-max-cnt (optional)
Long desc=maximum count allowed for service statistics:type=uint32 format: int64
service-stat-cur-cnt (optional)
Long desc=current count allowed for service statistics:type=uint32 format: int64
fabric-connection-max-count (optional)
Long desc=maximum count for fabric connection statistics:type=uint32 format: int64
fabric-connection-current-count (optional)
Long desc=current count of fabric connections:type=uint32 format: int64
connection-max-count (optional)
Long desc=maximum count for connection statistics:type=uint32 format: int64
connection-current-count (optional)
Long desc=current count of connections:type=uint32 format: int64
client-server-stats-max-cnt (optional)
Long desc=maximum count for client server statistics:type=uint32 format: int64
client-server-stats-cur-cnt (optional)
Long desc=current count for client server statistics:type=uint32 format: int64
connection-max-memory (optional)
Long desc=maximum memory allowed for connection statistics:type=uint64 format: int64
client-server-stats-max-memory (optional)
Long desc=maximum memory for client server statistics:type=uint64 format: int64
connection-stats-max-memory (optional)
Long desc=maximum memory allowed for connection statistics:type=uint64 format: int64
service-stat-max-memory (optional)
Long desc=maximum memory allowed for service statistics:type=uint64 format: int64
fabric-connection-max-memory (optional)
Long desc=maximum memory allowed for fabric connection statistics:type=uint64 format: int64
nv-queue-max-pkts (optional)
Long desc=maximum packets allowed per nv-queue for connection statistics:type=uint32:range=[0,32768] format: int64

connection-stats-settings-show-response - Up

connection-stats-show - Up

display statistics collected while connected to the host
api.switch-name (optional)
mac (optional)
String desc=MAC addresses of connections:type=mac-address
vnet (optional)
String desc=VNET of connections:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan (optional)
Integer desc=VLAN of connections:type=uint16:range=[0,4095] format: int32
ip (optional)
String desc=IP addresses of connections:type=IPv4 or IPv6 address
port (optional)
Long desc=port of connections:type=uint32 format: int64
iconns (optional)
Long desc=incoming connections:type=uint64 format: int64
oconns (optional)
Long desc=outgoing connections:type=uint64 format: int64
ibytes (optional)
Long desc=incoming bytes:type=uint64 format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64 format: int64
last-seen-ago (optional)
Long desc=last-seen-ago time in days,hours,minutes and seconds format: int64
total-bytes (optional)
Long desc=total bytes:type=uint64 format: int64
first-seen (optional)
String desc=first-seen time:date=yyyy-mm-ddThh:mm:ss
last-seen (optional)
String desc=last-seen time:date=yyyy-mm-ddThh:mm:ss
count (optional)
Long desc=count connection statistics:type=uint32 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
bd (optional)
String desc=Bridge Domain of connections:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

connection-stats-show-response - Up

control-stats-settings-modify - Up

modify the settings for packet counts sent from the CPU
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

control-stats-settings-show - Up

display the settings for packet counts sent from the CPU
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

control-stats-settings-show-response - Up

control-stats-show - Up

display the packet counts sent from the CPU
api.switch-name (optional)
caller
String desc=control statistics collection caller:type=enum
Enum:
Unknown
Total
ARP
Vxlan-ARP
Vxlan-multicast
Vxlan-TCP
Vxlan-encap
Vxlan
Discovery
Keep-Alive
Internal-Keep-Alive
ECP
ICMP
IGMP
LLDP
LACP
Logical-switch
PTP
STP
PVST
nvOS-control
Ipv6-mc
TCP-conn
RX-queue
NAT-Dynamic
CPU-RX-TX
VLAG
BCAST
Flood
Vport-stat
Vxlan-vport-stat
intsw
intsw-fabclust
intsw-l3
ttl1
l3-cpu-switch
loop
analytics
analytics-vxlan
fabric-guard
Vle
PBR_NHOP_RESOLVE
inline-svc-hbeat
dhcp
dhcpv6
ND
DMF
fastpath-bfd
ipkts (optional)
Long desc=incoming packets for control statistics:type=uint64:filter=false format: int64
ibytes (optional)
Long desc=incoming bytes for control statistics:type=uint64:filter=false format: int64
idrops (optional)
Long desc=incoming dropped packets:type=uint64:filter=false format: int64
opkts (optional)
Long desc=outgoing packets for control statistics:type=uint64:filter=false format: int64
obytes (optional)
Long desc=outgoing bytes for control statistics:type=uint64:filter=false format: int64
odrops (optional)
Long desc=outgoing dropped packets:type=uint64:filter=false format: int64
oqfull (optional)
Long desc=outgoing queue full:type=uint64:filter=false format: int64
idrop-bytes (optional)
Long desc=incoming dropped bytes:type=uint64:filter=false format: int64
idrops-vlan (optional)
Long desc=incoming dropped packets per VLAN:type=uint64:filter=false format: int64
idrops-stp (optional)
Long desc=incoming dropped packets for STP:type=uint64:filter=false format: int64
idrops-vxlan (optional)
Long desc=incoming dropped packets for VXLAN:type=uint64:filter=false format: int64
idrops-packet-size (optional)
Long desc=incoming dropped packet size:type=uint64:filter=false format: int64
idrops-err (optional)
Long desc=incoming dropped packets with errors:type=uint64:filter=false format: int64
idrops-loop (optional)
Long desc=incoming dropped packets due to loop:type=uint64:filter=false format: int64
idrops-qfull (optional)
Long desc=incoming dropped packets due to queue full:type=uint64:filter=false format: int64
idrops-from-mirror (optional)
Long desc=incoming dropped packets from mirror:type=uint64:filter=false format: int64
odrop-bytes (optional)
Long desc=outgoing dropped bytes:type=uint64:filter=false format: int64
odrops-requeue (optional)
Long desc=outgoing dropped packets requeued:type=uint64:filter=false format: int64
odrops-alloc (optional)
Long desc=outgoing dropped packets allocated:type=uint64:filter=false format: int64
odrops-stp (optional)
Long desc=outgoing dropped packets for STP:type=uint64:filter=false format: int64
odrops-vlan (optional)
Long desc=outgoing dropped packets for VLAN:type=uint64:filter=false format: int64
odrops-port (optional)
Long desc=outgoing dropped packets per port:type=uint64:filter=false format: int64
odrops-switch-cfg (optional)
Long desc=outgoing dropped packets per switch config:type=uint64:filter=false format: int64
odrops-pktsz (optional)
Long desc=outgoing dropped packet size:type=uint64:filter=false format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

control-stats-show-response - Up

control-traffic-modify - Up

update control traffic configuration
cpu_class (optional)
String desc=cpu control class:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/cpu-classes:api-ref-model=cpu-class-show:api-ref-id=name:api-ref-val=name
class (optional)
String desc=control class:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vflow-classes:api-ref-model=vflow-class-show:api-ref-id=name:api-ref-val=name

control-traffic-show - Up

show control traffic configuration
api.switch-name (optional)
type
String desc=control traffic type:type=enum
Enum:
smac-miss
dmac-miss
l3-miss
l2mc-miss
l3-ttl
cpu_class (optional)
String desc=cpu control class:api-ref-path=/cpu-classes:api-ref-model=cpu-class-show:api-ref-id=name:api-ref-val=name
class (optional)
String desc=control class:api-ref-path=/vflow-classes:api-ref-model=vflow-class-show:api-ref-id=name:api-ref-val=name

control-traffic-show-response - Up

dhcp-filter-create - Up

creates a new DHCP filter config
name
String desc=name of the DHCP filter:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
trusted-ports
String desc=trusted ports:type=port-list

dhcp-filter-modify - Up

modify a DHCP filter config
trusted-ports
String desc=trusted ports:type=port-list

dhcp-filter-show - Up

display information about DHCP filter config
api.switch-name (optional)
name
String desc=name of the DHCP filter
vlan (optional)
String desc=VLAN range:type=vlan-list
trusted-ports (optional)
String desc=trusted ports:type=port-list

dhcp-filter-show-response - Up

dhcp-lease-show - Up

display DHCP lease information
api.switch-name (optional)
ip (optional)
String desc=IP address for DHCP client:type=IPv4 or IPv6 address
mac (optional)
String desc=MAC address for DHCP client:type=mac-address
port (optional)
String desc=ports:type=port-list
vlan (optional)
Integer desc=VLAN for DHCP client:type=uint16:range=[0,4095] format: int32
client-port (optional)
Long desc=port for DHCP client:type=uint32:filter=false format: int64
end-time (optional)
String desc=DHCP lease end-time:date=yyyy-mm-ddThh:mm:ss
trusted-server (optional)
Boolean desc=DHCP trusted server
last-msg-time (optional)
String desc=last message time DHCP lease:date=yyyy-mm-ddThh:mm:ss
last-msg (optional)
String desc=last message for DHCP lease:type=enum
Enum:
-
discover
offer
request
decline
ack
nack
release
inform
server-ip (optional)
String desc=DHCP server IP address:type=IPv4 or IPv6 address
start-time (optional)
String desc=DHCP lease start-time:date=yyyy-mm-ddThh:mm:ss
server-port (optional)
Long desc=DHCP server port:type=uint32 format: int64
vnet-id (optional)
String desc=VLAN VNET for DHCP client:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain for DHCP client:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

dhcp-lease-show-response - Up

disk-library-image-add - Up

add blank disk image of a specific size to the disk library
label
String desc=image label:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
size
Long desc=image size:type=uint64 format: int64

disk-library-image-clone - Up

used to clone existing disk images
label
String desc=image label:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
library
String desc=name of the image library:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/disk-libraries:api-ref-model=disk-library-show:api-ref-id=name:api-ref-val=name:api-ref-target=fabric-peer:api-ref-fabric-id=destination-switch
parent_label
String desc=disk image label of parent image:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/disk-images:api-ref-model=disk-image-show:api-ref-id=label:api-ref-val=label
destination-switch
Long desc=destination switch for clone image:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64

disk-library-image-export - Up

export images from the disk library
label
String desc=image label:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
library (optional)
String desc=name of the image library:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/disk-libraries:api-ref-model=disk-library-show:api-ref-id=name:api-ref-val=name:api-ref-target=fabric-peer:api-ref-fabric-id=destination-switch
file (optional)
String desc=name of the image file:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
size (optional)
Long desc=image size:type=uint64 format: int64
parent_label (optional)
String desc=disk image label of parent image:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/disk-images:api-ref-model=disk-image-show:api-ref-id=label:api-ref-val=label

disk-library-image-import - Up

import images to the disk library
label
String desc=image label:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
file
String desc=name of the image file:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
library (optional)
String desc=name of the image library:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/disk-libraries:api-ref-model=disk-library-show:api-ref-id=name:api-ref-val=name:api-ref-target=fabric-peer:api-ref-fabric-id=destination-switch
size (optional)
Long desc=image size:type=uint64 format: int64

disk-library-image-show - Up

display images in the disk library
api.switch-name (optional)
label
String desc=image label
library (optional)
String desc=name of the image library:api-ref-path=/disk-libraries:api-ref-model=disk-library-show:api-ref-id=name:api-ref-val=name:api-ref-target=fabric-peer:api-ref-fabric-id=destination-switch
file (optional)
String desc=name of the image file
size (optional)
Long desc=image size:type=uint64 format: int64
parent_label (optional)
String desc=disk image label of parent image:api-ref-path=/disk-images:api-ref-model=disk-image-show:api-ref-id=label:api-ref-val=label
destination-switch (optional)
Long desc=destination switch for clone image:type=uint32:filter=false:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64

disk-library-image-show-response - Up

disk-library-imports-show - Up

display imported images in the disk library
api.switch-name (optional)
name
String desc=name of imported images

disk-library-imports-show-response - Up

disk-library-modify - Up

modify sharing ISO image properties in the disk library
sharing
String desc=sharing protocols or no sharing:type=flag
Enum:
none
sftp
nfs

disk-library-show - Up

display sharing ISO image properties in the disk library
api.switch-name (optional)
name
String desc=name of disk library
data-set (optional)
String desc=data set of library
import-share (optional)
String desc=location of import-share
import-share-path (optional)
String desc=import share path for library
export-share (optional)
String desc=location to export-shared image
export-share-path (optional)
String desc=export share path for library
storage-pool (optional)
String desc=storage-pool assigned to library:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name
sharing (optional)
String desc=sharing protocols or no sharing:type=flag
Enum:
none
sftp
nfs
switch-name (optional)
Long desc=switch name:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64

disk-library-show-response - Up

dscp-map-create - Up

Create a DSCP priority mapping table
name
String desc=Name for the DSCP map:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=scope for dscp map
Enum:
local
fabric

dscp-map-pri-map-modify - Up

Update priority mappings in tables
dsmap (optional)
String desc=DSCP value(s)

dscp-map-pri-map-show - Up

Show priority mappings in tables
api.switch-name (optional)
pri
Integer desc=CoS priority:type=uint8:range=[0,7] format: int32
dsmap (optional)
String desc=DSCP value(s)

dscp-map-pri-map-show-response - Up

dscp-map-show - Up

Show DSCP priority mapping tables
api.switch-name (optional)
name
String desc=Name for the DSCP map
scope (optional)
String desc=scope for dscp map
Enum:
local
fabric

dscp-map-show-response - Up

eap-host-profile-create - Up

create a host profile
name
String desc=name of the profile:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
mode
String desc=EAP auth mode:type=enum
Enum:
md5
identity (optional)
String desc=user identitiy
scope (optional)
String desc=scope of host profile - local or cluster:default=local
Enum:
local
cluster
password (optional)
String desc=password for the user identity:password=true

eap-host-profile-modify - Up

modify a host profile
mode (optional)
String desc=EAP auth mode:type=enum
Enum:
md5
identity (optional)
String desc=user identitiy
scope (optional)
String desc=scope of host profile - local or cluster:default=local
Enum:
local
cluster
password (optional)
String desc=password for the user identity:password=true

eap-host-profile-show - Up

display a host profile
api.switch-name (optional)
name
String desc=name of the profile
mode (optional)
String desc=EAP auth mode:type=enum
Enum:
md5
identity (optional)
String desc=user identitiy
scope (optional)
String desc=scope of host profile - local or cluster
Enum:
local
cluster

eap-host-profile-show-response - Up

err-disable-clear-counters - Up

reset err-disable counters for all ports
bpduguard (optional)
Boolean desc=recovery for bpduguard errors:default=false
macsecurity (optional)
Boolean desc=recovery for maclimit errors:default=false
recovery-timer (optional)
Long desc=Global recovery time (in seconds):default=5m format: int64

err-disable-modify - Up

update port recovery settings
bpduguard (optional)
Boolean desc=recovery for bpduguard errors:default=false
macsecurity (optional)
Boolean desc=recovery for maclimit errors:default=false
recovery-timer (optional)
Long desc=Global recovery time (in seconds):default=5m format: int64

err-disable-show - Up

show port recovery settings
api.switch-name (optional)
bpduguard (optional)
Boolean desc=recovery for bpduguard errors
macsecurity (optional)
Boolean desc=recovery for maclimit errors
recovery-timer (optional)
Long desc=Global recovery time (in seconds) format: int64

err-disable-show-response - Up

eula-show - Up

display the End Use License Agreement
api.switch-name (optional)
accepted (optional)
Boolean desc=EULA accepted or not
timestamp (optional)
String desc=timestamp when EULA accepted:date=yyyy-mm-ddThh:mm:ss

eula-show-response - Up

evpn-check-show - Up

show inconsistent evpn configuration
api.switch-name (optional)
data1
String desc=config check data

evpn-check-show-response - Up

fabric-anycast-mac-modify - Up

modify fabric anycast mac address
mac (optional)
String desc=anycast mac address of the fabric:type=mac-address

fabric-anycast-mac-show - Up

display fabric anycast mac address
api.switch-name (optional)
mac (optional)
String desc=anycast mac address of the fabric:type=mac-address

fabric-anycast-mac-show-response - Up

fabric-comm-ports-modify - Up

update fabric communication port settings
range-start (optional)
Integer desc=port range start:type=uint16:range=[1024,65435]:default=23300 format: int32

fabric-comm-ports-show - Up

show fabric communication port settings
api.switch-name (optional)
cluster-analytics-port (optional)
Integer desc=cluster analytics sync listener port:type=uint16 format: int32
igmp-port (optional)
Integer desc=cluster igmp listener port:type=uint16 format: int32
notify-port (optional)
Integer desc=status/vport updates, keep-alives, cluster listener port:type=uint16 format: int32
fabric-keepalive-port (optional)
Integer desc=fabric keep-alive listener port:type=uint16 format: int32
filesystem-replication-port (optional)
Integer desc=filesystem replication listener port:type=uint16 format: int32
cluster-traffic-forwarding-port (optional)
Integer desc=cluster forwarded data-plane traffic listener port:type=uint16 format: int32
vport-statistics-port (optional)
Integer desc=vport stats listener port:type=uint16 format: int32
l2-encap-port (optional)
Integer desc=forwarded L2 packet vxlan udp port:type=uint16 format: int32
igmp-encap-port (optional)
Integer desc=forwarded igmp packet vxlan udp port:type=uint16 format: int32
icmpv6-encap-port (optional)
Integer desc=forwarded icmp v6 packet vxlan udp port:type=uint16 format: int32
arp-encap-port (optional)
Integer desc=forwarded arp packet vxlan udp port:type=uint16 format: int32
fabric-port (optional)
Integer desc=transactions, vlag syncs, global discovery listener port:type=uint16 format: int32
proxy-port (optional)
Integer desc=nvio proxy command listener port:type=uint16 format: int32
range-start (optional)
Integer desc=port range start:type=uint16:range=[1024,65435] format: int32

fabric-comm-ports-show-response - Up

fabric-comm-vrouter-bgp-create - Up

create vRouter for fabric communication
name
String desc=name of the fabric communication vRouter:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
bgp-as
Long desc=BGP Autonomous System number from 1 to 4294967295:type=uint32:range=[1,4294967295] format: int64
bgp-nic-ip
String desc=IP address:type=IPv4 or IPv6 address:requires=[bgp-nic-netmask]:precludes=[bgp-nic-assignment]
bgp-nic-netmask
Integer desc=netmask:type=netmask:requires=[bgp-nic-ip]:precludes=[bgp-nic-assignment]:mask-for=[bgp-nic-ip] format: int32
bgp-redistribute (optional)
String desc=BGP route redistribution:type=flag:default=connected
Enum:
static
connected
rip
ospf
bgp-max-paths (optional)
Integer desc=maximum BGP paths:type=uint16:range=[1,255] format: int32
bgp-ibgp-multipath (optional)
Integer desc=number of IBGP multipath connections:type=uint16:range=[1,255] format: int32
router-id (optional)
String desc=OSPF and BGP router id:type=IPv4 or IPv6 address
hw-vrrp-id (optional)
Integer desc=VRRP ID assigned to the hardware vRouter:default=-1 format: int32
bgp-nic-linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
bgp-nic-ipv6-unnumbered (optional)
Boolean desc=IPv6 address is LinkLocal only:requires=[bgp-nic-l3-port]
bgp-nic-vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bgp-nic-bd (optional)
String desc=interface Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[bgp-nic-alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
bgp-nic-vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[bgp-nic-alias-on] format: int32
bgp-nic-vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[bgp-nic-vlan]:precludes=[bgp-nic-vnet-id]
Enum:
public
private
bgp-nic-l3-port (optional)
Long desc=Layer 3 port:type=uint32:default=4294967295:precludes=[bgp-nic-exclusive]:api-ref-path=/l3port-usable-ports:api-ref-model=l3port-usable-port-show:api-ref-id=intf:api-ref-val=name format: int64
bgp-nic-mtu (optional)
Integer desc=Interface MTU:type=uint16:range=[68,9398]:default=1500 format: int32
bgp-nic-if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
in-band-nic-ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[bgp-nic-netmask]:precludes=[bgp-nic-assignment]
in-band-nic-netmask (optional)
Integer desc=netmask:type=netmask:requires=[bgp-nic-ip]:precludes=[bgp-nic-assignment]:mask-for=[bgp-nic-ip] format: int32
in-band-nic-linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
in-band-nic-vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
in-band-nic-if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
in-band-nic-wake-on-lan (optional)
Boolean desc=wake on lan :default=false
bgp-nic-wake-on-lan (optional)
Boolean desc=wake on lan :default=false
neighbor (optional)
String desc=IP address for BGP neighbor:type=IPv4 or IPv6 address:precludes=[l3-port]
l3-port (optional)
Long desc=l3 port for BGP session:type=uint32:default=4294967295:precludes=[neighbor]:api-ref-path=/l3port-usable-ports:api-ref-model=l3port-usable-port-show:api-ref-id=intf:api-ref-val=name format: int64
remote-as (optional)
Long desc=BGP remote AS from 1 to 4294967295 or external:range=[-2,4294967295] format: int64
api.remote-as (optional)
Enum:
external
internal
local-as (optional)
Long desc=BGP local AS from 1 to 4294967295 or external:range=[-2,4294967295] format: int64
api.local-as (optional)
Enum:
external
internal
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
next-hop-self (optional)
Boolean desc=BGP next hop is self or not
prepend (optional)
Boolean desc=BGP next hop is self or not:default=true:requires=[local-as]
replace-as (optional)
Boolean desc=BGP next hop is self or not
password (optional)
String desc=password for MD5 BGP:password=true
ebgp-multihop (optional)
Integer desc=value for external BGP from 1 to 255:type=uint16:range=[1,255] format: int32
update-source-interface (optional)
String desc=interface name of BGP packets required for peering over any interface:precludes=[update-source]
override-capability (optional)
Boolean desc=override capability
soft-reconfig-inbound (optional)
Boolean desc=soft reset to reconfigure inbound traffic
max-prefix (optional)
Long desc=maximum number of prefixes:type=uint32 format: int64
max-prefix-warn-only (optional)
Boolean desc=warn if the maximum number of prefixes is exceeded
bfd (optional)
Boolean desc=BFD protocol support for fault detection
bfd-multihop (optional)
Boolean desc=always use BFD multi-hop port for fault detection
weight (optional)
Integer desc=default weight value between 0 and 65535 for the neighbor's routes:range=[-1,65535]:default=-1 format: int32
api.weight (optional)
Enum:
none
default-originate (optional)
Boolean desc=announce default routes to the neighbor or not
neighbor-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds):type=uint32:range=[0,65535]:default=60:requires=[neighbor-holdtime] format: int64
neighbor-holdtime (optional)
Long desc=BGP Holdtime (seconds):type=uint32:range=[0,65535]:default=180 format: int64
connect-retry-interval (optional)
Long desc=BGP Connect retry interval (seconds):type=uint32:range=[0,65535]:default=15 format: int64
send-community (optional)
Boolean desc=send any community attribute to neighbor:default=true
unnumbered-interop (optional)
Boolean desc=Interop unnumbered BGP NBR, send LL and G NH both even if they are same:default=false
allowas-in (optional)
Boolean desc=Allow/reject routes with local AS in AS_PATH:precludes=[allowas-in-occurrences,allowas-in-origin]
allowas-in-occurrences (optional)
Long desc=Allow/reject routes with local AS in AS_PATH with max number of occurrences:type=uint32:range=[0,10]:precludes=[allowas-in,allowas-in-origin] format: int64
allowas-in-origin (optional)
Boolean desc=Allow/reject routes with local AS in AS_PATH if the route was orig. in my AS:precludes=[allowas-in-occurrences,allowas-in]
as-override (optional)
Boolean desc=Override ASNs in outbound updates if aspath equals remote-as
interface (optional)
String desc=Interface to reach the neighbor:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
advertisement-interval (optional)
Long desc=Minimum interval between sending BGP routing updates:type=uint32:range=[0,600] format: int64
no-route-map-in (optional)
Boolean desc=Remove ingress route-map from BGP neighbor:precludes=[route-map-in]
no-route-map-out (optional)
Boolean desc=Remove egress route-map from BGP neighbor:precludes=[route-map-out]
description (optional)
String desc=Vrouter bgp neighbor description:default=none:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
fabric-network (optional)
String desc=in-band network IP address:type=IPv4 or IPv6 address:requires=[bgp-nic-netmask]
fabric-netmask (optional)
Integer desc=in-band network IP address netmask:type=netmask:requires=[fabric-network]:mask-for=[fabric-network] format: int32

fabric-create - Up

create a fabric
name
String desc=name of the fabric:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
vlan (optional)
Integer desc=VLAN assigned to fabric:type=uint16:range=[0,4095] format: int32
fabric-network (optional)
String desc=fabric administration network:type=enum
Enum:
in-band
mgmt
vmgmt
repeer-to-cluster-node (optional)
Long desc=Replace a dead cluster node by restoring against the existing cluster node:type=uint32:api-ref-path=/cluster-repeer-nodes:api-ref-model=cluster-repeer-node-show:api-ref-id=id:api-ref-val=name format: int64
password (optional)
String desc=plain text password:password=true
control-network (optional)
String desc=control plane network:type=enum
Enum:
in-band
mgmt
vmgmt
delete-conflicts (optional)
Boolean desc=delete conflicts
fabric-advertisement-network (optional)
String desc=network to send fabric advertisements on:type=enum:default=inband-mgmt
Enum:
inband-mgmt
inband-vmgmt
inband-only
mgmt-only
vmgmt-only

fabric-evpn-node-show - Up

display EVPN node information for this fabric
api.switch-name (optional)
evpn-node (optional)
String desc=EVPN Node Name
fabric-pod (optional)
String desc=Fabric-Pod Name
version (optional)
String desc=nvOS version
evpn-role (optional)
String desc=evpn role for the node:type=enum
Enum:
primary
secondary
stand-alone
none
unknown
vtep-ip (optional)
String desc=vtep IP address:type=IPv4 or IPv6 address

fabric-evpn-node-show-response - Up

fabric-in-band-network-create - Up

create in-band network for fabric communication
network
String desc=in-band network IP address:type=IPv4 or IPv6 address
netmask
Integer desc=in-band network IP address netmask:type=netmask:mask-for=[network] format: int32

fabric-in-band-network-show - Up

display in-band network for fabric communication
api.switch-name (optional)
network
String desc=in-band network IP address:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=in-band network IP address netmask:type=netmask:mask-for=[network] format: int32

fabric-in-band-network-show-response - Up

fabric-join - Up

modify join parameters of a fabric
name
String desc=name of the fabric:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
location-id (optional)
Long desc=location id to use for joining node:type=uint32 format: int64
password (optional)
String desc=plain text password:password=true
delete-conflicts (optional)
Boolean desc=delete conflicts

fabric-join-1 - Up

modify join parameters of a fabric
switch-ip
String desc=switch IP address:type=IPv4 or IPv6 address
vlan (optional)
Integer desc=VLAN assigned to fabric:type=uint16:range=[0,4095] format: int32
location-id (optional)
Long desc=location id to use for joining node:type=uint32 format: int64
password (optional)
String desc=plain text password:password=true
delete-conflicts (optional)
Boolean desc=delete conflicts

fabric-join-2 - Up

modify join parameters of a fabric
repeer-to-cluster-node
Long desc=Replace a dead cluster node by restoring against the existing cluster node:type=uint32:api-ref-path=/cluster-repeer-nodes:api-ref-model=cluster-repeer-node-show:api-ref-id=id:api-ref-val=name format: int64
over-l3 (optional)
Boolean desc=fabric over L3
maintenance-enable (optional)
Boolean desc=maintenance-mode enable after repeer
password (optional)
String desc=plain text password:password=true
delete-conflicts (optional)
Boolean desc=delete conflicts

fabric-local-modify - Up

modify fabric local information
vlan (optional)
Integer desc=VLAN assigned to fabric:type=uint16:range=[0,4095] format: int32
fabric-network (optional)
String desc=fabric administration network:type=enum
Enum:
in-band
mgmt
vmgmt
control-network (optional)
String desc=control plane network:type=enum
Enum:
in-band
mgmt
vmgmt
fabric-advertisement-network (optional)
String desc=network to send fabric advertisements on:type=enum:default=inband-mgmt
Enum:
inband-mgmt
inband-vmgmt
inband-only
mgmt-only
vmgmt-only
change-password (optional)
String desc=current password via api/change password via cli:password=true:requires=[reset-password]
reset-password (optional)
String desc=plain text password via api/Reset password via cli:password=true

fabric-node-evict - Up

force a server-switch to unjoin the fabric
name
String desc=node name:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=name:api-ref-val=name

fabric-node-evict-1 - Up

force a server-switch to unjoin the fabric
id
Long desc=ID assigned to node:type=uint32 format: int64

fabric-node-show - Up

display fabric node information
api.switch-name (optional)
serial (optional)
String desc=node serial number
name (optional)
String desc=node name:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=name:api-ref-val=name
state (optional)
String desc=fabric state:type=enum
Enum:
offline
online
in-band-only-online
mgmt-only-online
vmgmt-only-online
offline(evicted)
online(joined)
eula-required
setup-required
fabric-required
fresh-install
vmgmt-assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[mgmt-linklocal]
Enum:
none
dhcp
dhcpv6
vmgmt-mac (optional)
String desc=interface MAC address:type=mac-address
vmgmt-public-vlan (optional)
Integer desc=interface public VLAN:type=uint16:range=[0,4095] format: int32
vmgmt-vrf (optional)
String desc=name of vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
vmgmt-sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32
in-band-ip2 (optional)
String desc=Second IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask2]:precludes=[mgmt-assignment2]
in-band-netmask2 (optional)
Integer desc=Second IP netmask:type=netmask:requires=[mgmt-ip2]:precludes=[mgmt-assignment2]:mask-for=[mgmt-ip2] format: int32
in-band-assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[mgmt-ip2,mgmt-netmask2]
Enum:
none
dhcp
dhcpv6
in-band-assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[mgmt-linklocal]
Enum:
none
dhcp
dhcpv6
in-band-mac (optional)
String desc=interface MAC address:type=mac-address
in-band-public-vlan (optional)
Integer desc=interface public VLAN:type=uint16:range=[0,4095] format: int32
in-band-vrf (optional)
String desc=name of vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
in-band-sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32
firmware-upgrade (optional)
String desc=firmware upgrade status:type=enum
device-state (optional)
String desc=device state:type=enum
keepalive-timeout (optional)
Long desc=keepalive timeout format: int64
rollforward-failed (optional)
Boolean desc=roll-forward status of this node
version (optional)
String desc=nvOS version
mgmt-ip2 (optional)
String desc=Second IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask2]:precludes=[mgmt-assignment2]
mgmt-netmask2 (optional)
Integer desc=Second IP netmask:type=netmask:requires=[mgmt-ip2]:precludes=[mgmt-assignment2]:mask-for=[mgmt-ip2] format: int32
mgmt-assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[mgmt-ip2,mgmt-netmask2]
Enum:
none
dhcp
dhcpv6
mgmt-ipv6-unnumbered (optional)
Boolean desc=IPv6 address is LinkLocal only:requires=[mgmt-l3-port]
mgmt-assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[mgmt-linklocal]
Enum:
none
dhcp
dhcpv6
mgmt-mac (optional)
String desc=interface MAC address:type=mac-address
mgmt-public-vlan (optional)
Integer desc=interface public VLAN:type=uint16:range=[0,4095] format: int32
mgmt-vrf (optional)
String desc=name of vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
mgmt-sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32
vmgmt-ip2 (optional)
String desc=Second IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask2]:precludes=[mgmt-assignment2]
vmgmt-netmask2 (optional)
Integer desc=Second IP netmask:type=netmask:requires=[mgmt-ip2]:precludes=[mgmt-assignment2]:mask-for=[mgmt-ip2] format: int32
vmgmt-assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[mgmt-ip2,mgmt-netmask2]
Enum:
none
dhcp
dhcpv6
vmgmt-ipv6-unnumbered (optional)
Boolean desc=IPv6 address is LinkLocal only:requires=[mgmt-l3-port]
control-network (optional)
String desc=control plane network:type=enum
Enum:
in-band
mgmt
vmgmt
id (optional)
Long desc=ID assigned to node:type=uint32 format: int64
location-id (optional)
Long desc=location ID assigned to fabric node:type=uint32 format: int64
fab-name (optional)
String desc=fabric name
fab-id (optional)
String desc=ID assigned to fabric:type=identifier
cluster-id (optional)
String desc=ID assigned to cluster:type=identifier
local-mac (optional)
String desc=local MAC address:type=mac-address
fabric-network (optional)
String desc=network fabric:type=enum
Enum:
in-band
mgmt
vmgmt
mgmt-ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask]:precludes=[mgmt-assignment]
mgmt-netmask (optional)
Integer desc=netmask:type=netmask:requires=[mgmt-ip]:precludes=[mgmt-assignment]:mask-for=[mgmt-ip] format: int32
mgmt-linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
mgmt-vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
mgmt-secondary-macs (optional)
String desc=secondary MAC addresses
mgmt-if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
mgmt-wake-on-lan (optional)
Boolean desc=wake on lan
vmgmt-ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask]:precludes=[mgmt-assignment]
vmgmt-netmask (optional)
Integer desc=netmask:type=netmask:requires=[mgmt-ip]:precludes=[mgmt-assignment]:mask-for=[mgmt-ip] format: int32
vmgmt-linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
vmgmt-vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
vmgmt-vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[mgmt-alias-on] format: int32
vmgmt-secondary-macs (optional)
String desc=secondary MAC addresses
vmgmt-wake-on-lan (optional)
Boolean desc=wake on lan
in-band-ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask]:precludes=[mgmt-assignment]
in-band-netmask (optional)
Integer desc=netmask:type=netmask:requires=[mgmt-ip]:precludes=[mgmt-assignment]:mask-for=[mgmt-ip] format: int32
in-band-linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
in-band-vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
in-band-bd (optional)
String desc=interface Bridge Domain:precludes=[mgmt-alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
in-band-vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[mgmt-alias-on] format: int32
in-band-vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[mgmt-vlan]:precludes=[mgmt-vnet-id]
Enum:
public
private
in-band-secondary-macs (optional)
String desc=secondary MAC addresses
in-band-if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
in-band-wake-on-lan (optional)
Boolean desc=wake on lan
fab-tid (optional)
Long desc=fabric transaction ID:type=uint64 format: int64
cluster-tid (optional)
Long desc=cluster transaction ID:type=uint64 format: int64
out-port (optional)
Long desc=fabric outgoing port:type=uint32 format: int64
ports (optional)
Long desc=ports:type=uint32 format: int64

fabric-node-show-response - Up

fabric-show - Up

display information about fabrics
api.switch-name (optional)
name
String desc=name of the fabric
id
String desc=ID assigned to fabric:type=identifier
vlan (optional)
Integer desc=VLAN assigned to fabric:type=uint16:range=[0,4095] format: int32
tid (optional)
Long desc=transaction ID:type=uint64 format: int64
fabric-network (optional)
String desc=fabric administration network:type=enum
Enum:
in-band
mgmt
vmgmt
repeer-to-cluster-node (optional)
Long desc=Replace a dead cluster node by restoring against the existing cluster node:type=uint32:api-ref-path=/cluster-repeer-nodes:api-ref-model=cluster-repeer-node-show:api-ref-id=id:api-ref-val=name format: int64
switch-ip (optional)
String desc=switch IP address:type=IPv4 or IPv6 address
over-l3 (optional)
Boolean desc=fabric over L3:filter=false
maintenance-enable (optional)
Boolean desc=maintenance-mode enable after repeer:filter=false
control-network (optional)
String desc=control plane network:type=enum
Enum:
in-band
mgmt
vmgmt
delete-conflicts (optional)
Boolean desc=delete conflicts:filter=false
fabric-advertisement-network (optional)
String desc=network to send fabric advertisements on:type=enum
Enum:
inband-mgmt
inband-vmgmt
inband-only
mgmt-only
vmgmt-only

fabric-show-response - Up

fabric-stats-show - Up

display statistical information about the fabric
api.switch-name (optional)
id
Long desc=ID assigned to fabric:type=uint32 format: int64
servers (optional)
Long desc=servers assigned to collect fabric statistics:type=uint32 format: int64
arp (optional)
Long desc=number of ARPs:type=uint64 format: int64
storage (optional)
Long desc=storage assigned to collect fabric statistics:type=uint32 format: int64
VM (optional)
Long desc=VM statistics:type=uint32 format: int64
vlan (optional)
Long desc=VLAN statistics:type=uint32 format: int64
vxlan (optional)
Long desc=VXLAN statistics:type=uint32 format: int64
tcp-syn (optional)
Long desc=number of TCP packets synchronized:type=uint64 format: int64
tcp-est (optional)
Long desc=number of TCP packets established:type=uint64 format: int64
tcp-completed (optional)
Long desc=number of completed TCP packets:type=uint64 format: int64
tcp-bytes (optional)
Long desc=number of TCP bytes sent through the fabric:type=uint64 format: int64
udp-bytes (optional)
Long desc=number of UDP bytes sent through the fabric:type=uint64 format: int64

fabric-stats-show-response - Up

fabric-unjoin - Up

unjoin a server-switch from a fabric
delete-conflicts (optional)
Boolean desc=delete conflicts

fabric-upgrade-abort - Up

indicate fabric upgrade to abort upgrade operation when ready
force (optional)
Boolean desc=Force immediate abort of fabric upgrade

fabric-upgrade-prepare-show - Up

display the status of prepared upgrades in the fabric nodes
api.switch-name (optional)
version (optional)
String desc=software version:filter=false
status (optional)
String desc= indicates whether platform is unsupported in nvOS version:filter=false
track (optional)
String desc=software track name:filter=false:api-ref-path=/software-tracks:api-ref-model=software-track-show:api-ref-id=name:api-ref-val=name
upgrade-status (optional)
String desc=upgrade status:type=enum:filter=false
Enum:
available
up-to-date
error
pkg-out-of-date
repository-unreachable
no-upgrade-running
in-progress
waiting-to-complete
waiting-for-agent-connection
needs-reboot-to-complete
abort
resume-wait
version-available (optional)
String desc=available software versions:filter=false
proxy-port (optional)
Integer desc=proxy host port:type=uint16:filter=false format: int32
download-count (optional)
Long desc=number of concurrent downloads (default: 5):type=uint32:range=[1,5]:filter=false format: int64
use-proxy (optional)
Boolean desc=use a proxy host:filter=false
proxy-host (optional)
String desc=proxy host name:filter=false
upload-server (optional)
String desc=upload config file to server via scp:filter=false:requires=[server-password]

fabric-upgrade-show-response - Up

fabric-upgrade-start - Up

start software upgrade/prepare on entire fabric
packages
String desc=Comma separate list of software bundles:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
prepare (optional)
Boolean desc=perform setups steps for the actual upgrade
server-password (optional)
String desc=SCP host password:password=true:requires=[upload-server]
auto-finish (optional)
Boolean desc=automatically reboot fabric after upgrade or not (default: no)
abort-on-failure (optional)
Boolean desc=whether to abort fabric upgrade if a node fails (default: no)
manual-reboot (optional)
Boolean desc=whether to defer to user for reboot after upgrade
download-count (optional)
Long desc=number of concurrent downloads (default: 5):type=uint32:range=[1,5]:default=5 format: int64
upload-server (optional)
String desc=upload config file to server via scp:requires=[server-password]

fabric-upgrade-status-show - Up

display the status of fabric upgrade
api.switch-name (optional)
version (optional)
String desc=software version:filter=false
status (optional)
String desc= indicates whether platform is unsupported in nvOS version:filter=false
track (optional)
String desc=software track name:filter=false:api-ref-path=/software-tracks:api-ref-model=software-track-show:api-ref-id=name:api-ref-val=name
log (optional)
String desc=logs:filter=false
state (optional)
String desc=indicate switch status for fabric-upgrade-status-show:filter=false
cluster (optional)
String desc=indicate cluster membership for fabric-upgrade-status-show:filter=false
switch (optional)
String desc=indicate switch name for fabric-upgrade-status-show:filter=false
upgrade-status (optional)
String desc=upgrade status:type=enum:filter=false
Enum:
available
up-to-date
error
pkg-out-of-date
repository-unreachable
no-upgrade-running
in-progress
waiting-to-complete
waiting-for-agent-connection
needs-reboot-to-complete
abort
resume-wait
version-available (optional)
String desc=available software versions:filter=false
proxy-port (optional)
Integer desc=proxy host port:type=uint16:filter=false format: int32
download-count (optional)
Long desc=number of concurrent downloads (default: 5):type=uint32:range=[1,5]:filter=false format: int64
use-proxy (optional)
Boolean desc=use a proxy host:filter=false
proxy-host (optional)
String desc=proxy host name:filter=false
upload-server (optional)
String desc=upload config file to server via scp:filter=false:requires=[server-password]

fabric-upgrade-status-show-response - Up

fabric-vnic-create - Up

create fabric vNIC
ip
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
vlan
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32

fabric-vnic-delete - Up

delete fabric vNIC
nic
String desc=virtual NIC assigned to interface
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
mac (optional)
String desc=interface MAC address:type=mac-address
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan :default=false
vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32
assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip2,netmask2]
Enum:
none
dhcp
dhcpv6
assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[linklocal]
Enum:
none
dhcp
dhcpv6
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32

fabric-vnic-modify - Up

modify fabric vNIC
ip
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
vlan
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32

fabric-vnic-show - Up

display information about fabric vNIC
api.switch-name (optional)
nic
String desc=virtual NIC assigned to interface
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
mac (optional)
String desc=interface MAC address:type=mac-address
vrf (optional)
String desc=name of vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan
vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32
assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip2,netmask2]
Enum:
none
dhcp
dhcpv6
assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[linklocal]
Enum:
none
dhcp
dhcpv6
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32

fabric-vnic-show-response - Up

flow-table-show - Up

display information about traffic flows
api.switch-name (optional)
name (optional)
String desc=name of flow table
id (optional)
Long desc=flow table ID:type=uint32 format: int64
flow-name (optional)
String desc=flow table flow name
flow-hw-id (optional)
Long desc=flow table flow hardware ID:type=uint32 format: int64
hw-id (optional)
Long desc=flow table hardware ID:type=uint32 format: int64

flow-table-show-response - Up

hog-violator-show - Up

show hog violators
api.switch-name (optional)
mac
String desc=hog violator mac address:type=mac-address
vnet-id
String desc=hog violator VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd
String desc=hog violator Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
vlan
Integer desc=hog violator vlan:type=uint16:range=[0,4095] format: int32
vxlan
Long desc=hog violator vxlan:type=uint32:range=[0,16777215] format: int64
port
Long desc=hog violator ingress port:type=uint32 format: int64
vflow2 (optional)
String desc=redirect vflow2
vflow3 (optional)
String desc=redirect vflow3
vflow4 (optional)
String desc=redirect vflow4
vflow5 (optional)
String desc=redirect vflow5
vflow6 (optional)
String desc=redirect vflow6
idle-count (optional)
Integer desc=current idle count format: int32
hog-cpu-class (optional)
String desc=hog queue cpu-class
created (optional)
String desc=time violator was created:date=yyyy-mm-ddThh:mm:ss
cpu-class (optional)
String desc=original cpu-class
vflow (optional)
String desc=redirect vflow

hog-violator-show-response - Up

hog-violator-stats-show - Up

show hog violator vflow stats
api.switch-name (optional)
name
String desc=name of the vFlow:api-ref-path=/vflows:api-ref-model=vflow-show:api-ref-id=name:api-ref-val=name
vnet (optional)
String desc=VNET of the vFlow:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
id (optional)
String desc=id assigned to the vFlow:type=identifier
bytes (optional)
Long desc=total number of bytes:type=uint64:filter=false format: int64
mismatches (optional)
Long desc=number of mismatches:type=uint64:filter=false format: int64
drops (optional)
Long desc=number of dropped packets:filter=false format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
pkts (optional)
Long desc=total number of packets:type=uint64:filter=false format: int64
cpu-pkts (optional)
Long desc=number of CPU packets:type=uint64:filter=false format: int64
cpu-bytes (optional)
Long desc=number of CPU bytes:type=uint64:filter=false format: int64
drop-bytes (optional)
Long desc=number of dropped bytes:filter=false format: int64
policer-drops (optional)
Long desc=number of policer dropped packets:type=uint64:filter=false format: int64
policer-drop-bytes (optional)
Long desc=number of policer dropped bytes:type=uint64:filter=false format: int64
cpu-tx-pkts (optional)
Long desc=number of packets sent from CPU:type=uint64:filter=false format: int64
cpu-tx-bytes (optional)
Long desc=number of bytes sent from CPU:type=uint64:filter=false format: int64

hog-violator-stats-show-response - Up

id-led-modify - Up

modify the setting for blinking the LED
enable (optional)
Boolean desc=enable or disable

id-led-show - Up

display LED configuration
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable

id-led-show-response - Up

igmp-querier-ip-modify - Up

modify IGMP Querier IP config
querier-ip (optional)
String desc=Snooping Querier IP address:type=IPv4 or IPv6 address

igmp-querier-ip-show - Up

display IGMP Querier IP config
api.switch-name (optional)
vlans-on-querier-ip
String desc=VLAN MAP:type=vlan-list
querier-ip (optional)
String desc=Snooping Querier IP address:type=IPv4 or IPv6 address

igmp-querier-ip-show-response - Up

igmp-router-show - Up

display Multicast routers on the network
api.switch-name (optional)
node-ip
String desc=Host IP address:type=IPv4 or IPv6 address
vxlan (optional)
Long desc=Host VXLAN:type=uint32:range=[0,16777215]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
vlan (optional)
Integer desc=Host VLAN:type=uint16:range=[0,4095] format: int32
port (optional)
Long desc=Switch port:type=uint32 format: int64
tunnel (optional)
String desc=tunnel name
vnet-id (optional)
String desc=Host VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Host Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

igmp-router-show-response - Up

igmp-show - Up

display IGMP group membership information on the network
api.switch-name (optional)
node-ip
String desc=Host IP address:type=IPv4 or IPv6 address
vxlan (optional)
Long desc=Host VXLAN:type=uint32:range=[0,16777215]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
vlan (optional)
Integer desc=Host VLAN:type=uint16:range=[0,4095] format: int32
port (optional)
Long desc=Switch port:type=uint32 format: int64
tunnel (optional)
String desc=tunnel name
source (optional)
String desc=Multicast traffic source:type=IPv4 or IPv6 address
group-ip (optional)
String desc=Multicast Group IP address:type=IPv4 or IPv6 address
node-type (optional)
String desc=Host/Router/Switch:type=enum
Enum:
host
router
switch
loopback
tunnel
expires (optional)
Long desc=Ageout time format: int64
vnet-id (optional)
String desc=Host VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Host Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

igmp-show-response - Up

igmp-snooping-modify - Up

modify Internet Group Management Protocol (IGMP) snooping
scope (optional)
String desc=IGMP snooping scope - fabric or local:type=enum
Enum:
local
fabric
enable (optional)
Boolean desc=enable or disable IGMP snooping:default=true
snoop-linklocal-vlans (optional)
String desc=Allow snooping of link-local groups(224.0.0.0/24) on these vlans:type=vlan-list:default=none:precludes=[no-snoop-linklocal-vlans]
no-snoop-linklocal-vlans (optional)
String desc=Remove snooping of link-local groups(224.0.0.0/24) on these vlans:type=vlan-list:default=1-4092:precludes=[snoop-linklocal-vlans]
igmpv3-vlans (optional)
String desc=VLANs on which to use IGMPv3 protocol:type=vlan-list:default=1-4092:precludes=[igmpv2-vlans]
igmpv2-vlans (optional)
String desc=VLANs on which to use IGMPv2 protocol:type=vlan-list:default=none:precludes=[igmpv3-vlans]
query-interval (optional)
Integer desc=IGMP query interval in seconds:type=uint8:range=[2,255]:default=60 format: int32
query-max-response-time (optional)
Integer desc=maximum response time, in seconds, advertised in IGMP queries:type=uint8:range=[1,255]:default=1 format: int32
vxlan (optional)
Boolean desc=enable or disable IGMP snooping on vxlans:default=false
enable-vlans (optional)
String desc=enable per VLAN IGMP snooping:type=vlan-list:default=1-4092

igmp-snooping-show - Up

display information about Internet Group Management Protocol (IGMP) snooping
api.switch-name (optional)
scope (optional)
String desc=IGMP snooping scope - fabric or local:type=enum:filter=false
Enum:
local
fabric
enable (optional)
Boolean desc=enable or disable IGMP snooping
nvOS-managed-vlans (optional)
String desc=nvOS managed VLANs:type=vlan-list
interop-v2-vlans (optional)
String desc=vlans degraded to v2 due to v2 received message:type=vlan-list
snoop-linklocal-vlans (optional)
String desc=Allow snooping of link-local groups(224.0.0.0/24) on these vlans:type=vlan-list:precludes=[no-snoop-linklocal-vlans]
no-snoop-linklocal-vlans (optional)
String desc=Remove snooping of link-local groups(224.0.0.0/24) on these vlans:type=vlan-list:precludes=[snoop-linklocal-vlans]
igmpv3-vlans (optional)
String desc=VLANs on which to use IGMPv3 protocol:type=vlan-list:precludes=[igmpv2-vlans]
igmpv2-vlans (optional)
String desc=VLANs on which to use IGMPv2 protocol:type=vlan-list:precludes=[igmpv3-vlans]
query-interval (optional)
Integer desc=IGMP query interval in seconds:type=uint8:range=[2,255] format: int32
query-max-response-time (optional)
Integer desc=maximum response time, in seconds, advertised in IGMP queries:type=uint8:range=[1,255] format: int32
vxlan (optional)
Boolean desc=enable or disable IGMP snooping on vxlans
enable-vlans (optional)
String desc=enable per VLAN IGMP snooping:type=vlan-list

igmp-snooping-show-response - Up

igmp-static-group-create - Up

create a static IGMP group on the network
vlan
Integer desc=static IGMP group VLAN:type=uint16:range=[0,4095] format: int32
group-ip
String desc=static IGMP group IP address:type=IPv4 or IPv6 address
ports
String desc=static IGMP group ports:type=port-list

igmp-static-group-show - Up

display a static IGMP group on the network
api.switch-name (optional)
vlan
Integer desc=static IGMP group VLAN:type=uint16:range=[0,4095] format: int32
group-ip
String desc=static IGMP group IP address:type=IPv4 or IPv6 address
ports (optional)
String desc=static IGMP group ports:type=port-list

igmp-static-group-show-response - Up

igmp-static-source-create - Up

create a static IP address as the IGMP source
vlan
Integer desc=static IGMP source VLAN:type=uint16:range=[0,4095] format: int32
group-ip
String desc=static IGMP source IP address:type=IPv4 or IPv6 address
source-ip
String desc=static IGMP source IP address:type=IPv4 or IPv6 address
ports (optional)
String desc=ports:type=port-list
vnet-id (optional)
String desc=static IGMP source VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=static IGMP source Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

igmp-static-source-show - Up

display a static IP address as the IGMP source
api.switch-name (optional)
vlan
Integer desc=static IGMP source VLAN:type=uint16:range=[0,4095] format: int32
group-ip
String desc=static IGMP source IP address:type=IPv4 or IPv6 address
source-ip
String desc=static IGMP source IP address:type=IPv4 or IPv6 address
ports (optional)
String desc=ports:type=port-list
vnet-id (optional)
String desc=static IGMP source VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=static IGMP source Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

igmp-static-source-show-response - Up

igmp-stats-clear - Up

clear packet statistics for igmp
vlan
Integer desc=IGMP VLAN:type=uint16:range=[0,4095] format: int32

igmp-stats-show - Up

display packet statistics or logs for igmp
api.switch-name (optional)
vlan
Integer desc=IGMP VLAN:type=uint16:range=[0,4095] format: int32
drops (optional)
Long desc=number of IGMP dropped events:type=uint64:filter=false format: int64
ignored (optional)
Long desc=number of IGMP events ignored:type=uint64:filter=false format: int64
v2-queries (optional)
Long desc=number of IGMPv2 queries:type=uint64:filter=false format: int64
v3-queries (optional)
Long desc=number of IGMPv3 queries:type=uint64:filter=false format: int64
v1-member-reports (optional)
Long desc=number of IGMPv1 member reports:type=uint64:filter=false format: int64
v2-member-reports (optional)
Long desc=number of IGMPv2 member reports:type=uint64:filter=false format: int64
v2-leave-group (optional)
Long desc=number of IGMPv2 leave group events:type=uint64:filter=false format: int64
v3-member-reports (optional)
Long desc=number of IGMPv3 member reports:type=uint64:filter=false format: int64
queries-sent (optional)
Long desc=number of IGMP queries-sent:type=uint64:filter=false format: int64

igmp-stats-show-response - Up

igmp-switches-show - Up

display IGMP Snooping Switches on the network
api.switch-name (optional)
node-ip
String desc=Host IP address:type=IPv4 or IPv6 address
vxlan (optional)
Long desc=Host VXLAN:type=uint32:range=[0,16777215]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
vlan (optional)
Integer desc=Host VLAN:type=uint16:range=[0,4095] format: int32
port (optional)
Long desc=Switch port:type=uint32 format: int64
tunnel (optional)
String desc=tunnel name
vnet-id (optional)
String desc=Host VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Host Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

igmp-switches-show-response - Up

inline-service-create - Up

create an inline service
name
String desc=configure inline service name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
tx-port
String desc=configure ports used to send to the inline service:type=port-list
rx-port
String desc=configure ports used to receive from the inline service:type=port-list
heartbeat (optional)
String desc=Service heartbeat.:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/service-heartbeats:api-ref-model=service-heartbeat-show:api-ref-id=name:api-ref-val=name

inline-service-modify - Up

modify an inline service
heartbeat
String desc=Service heartbeat.:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/service-heartbeats:api-ref-model=service-heartbeat-show:api-ref-id=name:api-ref-val=name

inline-service-show - Up

display inline services
api.switch-name (optional)
name
String desc=configure inline service name
status (optional)
String desc=Service operation status:type=enum
Enum:
down
up
heartbeat (optional)
String desc=Service heartbeat.:api-ref-path=/service-heartbeats:api-ref-model=service-heartbeat-show:api-ref-id=name:api-ref-val=name
tx-port (optional)
String desc=configure ports used to send to the inline service:type=port-list
rx-port (optional)
String desc=configure ports used to receive from the inline service:type=port-list

inline-service-show-response - Up

interface-stats-show - Up

display statistical information about an interface
api.switch-name (optional)
nic
String desc=NIC enabled for statistics collection
ibytes (optional)
Long desc=incoming bytes on the interface:type=uint64:filter=false format: int64
obytes (optional)
Long desc=outgoing bytes on the interface:type=uint64:filter=false format: int64
ipkts (optional)
Long desc=incoming packets on the interface:type=uint64:filter=false format: int64
ierrs (optional)
Long desc=incoming packets with errors on the interface:type=uint64:filter=false format: int64
opkts (optional)
Long desc=outgoing packets on the interface:type=uint64:filter=false format: int64
oerrs (optional)
Long desc=outgoing packets with errors on the interface:type=uint64:filter=false format: int64
time (optional)
String desc=time of collecting interface statistics:date=yyyy-mm-ddThh:mm:ss

interface-stats-show-response - Up

ip-pool-create - Up

creates a new IP address pool with a specific IP address range
name
String desc=name of the IP pool:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
netmask
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
start-ip
String desc=starting IP address:type=IPv4 or IPv6 address:precludes=[network]
end-ip
String desc=ending IP address:type=IPv4 or IPv6 address:precludes=[network]
vnet-id
String desc=name of VNET to assign IP pool:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
vlan (optional)
Integer desc=VLAN assigned to IP pool:type=uint16:range=[0,4095] format: int32
bd (optional)
String desc=Bridge Domain assigned to IP pool:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

ip-pool-create-1 - Up

creates a new IP address pool with a specific IP address range
name
String desc=name of the IP pool:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
network
String desc=IP address:type=IPv4 or IPv6 address
vnet-id
String desc=name of VNET to assign IP pool:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
vlan (optional)
Integer desc=VLAN assigned to IP pool:type=uint16:range=[0,4095] format: int32
netmask (optional)
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
bd (optional)
String desc=Bridge Domain assigned to IP pool:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

ip-pool-modify - Up

modify an IP address pool
vlan (optional)
Integer desc=VLAN assigned to IP pool:type=uint16:range=[0,4095] format: int32
network (optional)
String desc=IP address:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
start-ip (optional)
String desc=starting IP address:type=IPv4 or IPv6 address:precludes=[network]
end-ip (optional)
String desc=ending IP address:type=IPv4 or IPv6 address:precludes=[network]
bd (optional)
String desc=Bridge Domain assigned to IP pool:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

ip-pool-show - Up

display information about an IP address pool
api.switch-name (optional)
name
String desc=name of the IP pool
scope (optional)
String desc=scope for IP pool - fabric or local
Enum:
local
fabric
vlan (optional)
Integer desc=VLAN assigned to IP pool:type=uint16:range=[0,4095] format: int32
network (optional)
String desc=IP address:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
start-ip (optional)
String desc=starting IP address:type=IPv4 or IPv6 address:precludes=[network]
end-ip (optional)
String desc=ending IP address:type=IPv4 or IPv6 address:precludes=[network]
vnet-id (optional)
String desc=name of VNET to assign IP pool:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain assigned to IP pool:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

ip-pool-show-response - Up

ipfix-collector-create - Up

Create a new IPFIX collector entry
name
String desc=Name of the IPFIX collector:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
host
String desc=Address of the IPFIX collector:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
port (optional)
Integer desc=Listening port of the IPFIX collector. Default: 9090.:type=uint16:default=9090 format: int32
transport-protocol (optional)
Integer desc=Transport protocol for the IPFIX collector. Default: tcp.:type=uint8:default=6 format: int32
api.transport-protocol (optional)
Enum:
tcp
udp

ipfix-collector-modify - Up

Update an existing IPFIX collector entry
port (optional)
Integer desc=Listening port of the IPFIX collector. Default: 9090.:type=uint16:default=9090 format: int32
host (optional)
String desc=Address of the IPFIX collector:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
transport-protocol (optional)
Integer desc=Transport protocol for the IPFIX collector. Default: tcp.:type=uint8:default=6 format: int32
api.transport-protocol (optional)
Enum:
tcp
udp

ipfix-collector-show - Up

Show configured IPFIX collector entries
api.switch-name (optional)
name
String desc=Name of the IPFIX collector
port (optional)
Integer desc=Listening port of the IPFIX collector. Default: 9090.:type=uint16 format: int32
host (optional)
String desc=Address of the IPFIX collector
transport-protocol (optional)
Integer desc=Transport protocol for the IPFIX collector. Default: tcp.:type=uint8 format: int32

ipfix-collector-show-response - Up

ipfix-service-modify - Up

Enable/Disable the IPFIX exporter service
export-interval (optional)
Long desc=Export interval for IPFIX stats:default=30s format: int64
obs-domain (optional)
Long desc=Observation domain for the service:type=uint32:default=0 format: int64
udp-template-resend-interval (optional)
Long desc=Resend IPFIX template at regular intervals to UDP collectors:default=30m format: int64
max-connections-exported (optional)
Long desc=Maximum number of connections to be exported to the collector:type=uint32:range=[0,2000]:default=200 format: int64
enable-service (optional)
Boolean desc=Status of the IPFIX service set by the user:default=false

ipfix-service-show - Up

Show status of the IPFIX exporter service
api.switch-name (optional)
state (optional)
String desc=Current state of the IPFIX service:type=enum
Enum:
disable
enable
export-interval (optional)
Long desc=Export interval for IPFIX stats format: int64
obs-domain (optional)
Long desc=Observation domain for the service:type=uint32 format: int64
udp-template-resend-interval (optional)
Long desc=Resend IPFIX template at regular intervals to UDP collectors format: int64
max-connections-exported (optional)
Long desc=Maximum number of connections to be exported to the collector:type=uint32:range=[0,2000] format: int64
enable-service (optional)
Boolean desc=Status of the IPFIX service set by the user

ipfix-service-show-response - Up

ipv6security-raguard-create - Up

Add ipv6 RA Guard Policy
name
String desc=RA Guard Policy Name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
device
String desc=RA Guard Device: host or router:type=enum
Enum:
host
router
router-priority (optional)
String desc=RA Guard Router Priority:type=enum:default=medium
Enum:
low
medium
high
access-list (optional)
String desc=RA Guard Access List of Source IPs:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/access-lists:api-ref-model=access-list-show:api-ref-id=name:api-ref-val=name
prefix-list (optional)
String desc=RA Guard Prefix List:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/prefix-lists:api-ref-model=prefix-list-show:api-ref-id=name:api-ref-val=name

ipv6security-raguard-modify - Up

Update ipv6 RA guard Policy
device (optional)
String desc=RA Guard Device: host or router:type=enum
Enum:
host
router
router-priority (optional)
String desc=RA Guard Router Priority:type=enum:default=medium
Enum:
low
medium
high
access-list (optional)
String desc=RA Guard Access List of Source IPs:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/access-lists:api-ref-model=access-list-show:api-ref-id=name:api-ref-val=name
prefix-list (optional)
String desc=RA Guard Prefix List:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/prefix-lists:api-ref-model=prefix-list-show:api-ref-id=name:api-ref-val=name

ipv6security-raguard-port-add - Up

Add ports to RA Guard Policy
ports
String desc=Ports attached to RA Guard Policy:type=port-list

ipv6security-raguard-port-show - Up

Show ports attached to RA Guard Policy
api.switch-name (optional)
ports
String desc=Ports attached to RA Guard Policy:type=port-list

ipv6security-raguard-port-show-response - Up

ipv6security-raguard-show - Up

Show ipv6 RA Guard Policies
api.switch-name (optional)
name
String desc=RA Guard Policy Name
device (optional)
String desc=RA Guard Device: host or router:type=enum
Enum:
host
router
attached-ports (optional)
String desc=Ports attached to RA Guard Policy:type=port-list
attached-vlans (optional)
String desc=Vlans attached to RA Guard Policy:type=vlan-list
router-priority (optional)
String desc=RA Guard Router Priority:type=enum
Enum:
low
medium
high
access-list (optional)
String desc=RA Guard Access List of Source IPs:api-ref-path=/access-lists:api-ref-model=access-list-show:api-ref-id=name:api-ref-val=name
prefix-list (optional)
String desc=RA Guard Prefix List:api-ref-path=/prefix-lists:api-ref-model=prefix-list-show:api-ref-id=name:api-ref-val=name

ipv6security-raguard-show-response - Up

ipv6security-raguard-vlan-add - Up

Add vlans to RA Guard Policy
vlans
String desc=Vlans attached to RA Guard Policy:type=vlan-list

ipv6security-raguard-vlan-show - Up

Show vlans attached to RA Guard Policy
api.switch-name (optional)
vlans
String desc=Vlans attached to RA Guard Policy:type=vlan-list

ipv6security-raguard-vlan-show-response - Up

iso-library-image-export - Up

export an ISO image from the ISO library
label
String desc=image label:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
library (optional)
String desc=image library name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
file (optional)
String desc=image file name:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters

iso-library-image-import - Up

import an ISO image from the ISO library
label
String desc=image label:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
file
String desc=image file name:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
library (optional)
String desc=image library name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

iso-library-image-show - Up

display an ISO image from the ISO library
api.switch-name (optional)
label
String desc=image label
library (optional)
String desc=image library name
file (optional)
String desc=image file name

iso-library-image-show-response - Up

iso-library-modify - Up

modify an ISO image library
sharing
String desc=sharing protocols or no sharing:type=flag
Enum:
none
sftp
nfs

iso-library-show - Up

display ISO library information
api.switch-name (optional)
name
String desc=name of ISO library
data-set (optional)
String desc=data set of library
import-share (optional)
String desc=location of import-share
import-share-path (optional)
String desc=import share path for library
export-share (optional)
String desc=location to export-shared image
export-share-path (optional)
String desc=export share path for library
storage-pool (optional)
String desc=storage-pool assigned to library:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name
sharing (optional)
String desc=sharing protocols or no sharing:type=flag
Enum:
none
sftp
nfs

iso-library-show-response - Up

k8s-cluster-show - Up

show kubernetes cluster control plane info
api.switch-name (optional)
control-plane-node
String desc=control plane node name
action (optional)
String desc=last changed action:type=enum
Enum:
none
add
remove
update
controller-status (optional)
String desc=kube-controller-manager status
scheduler-status (optional)
String desc=kube-scheduler status
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
last-changed (optional)
String desc=time when control plane status was last changed:date=yyyy-mm-ddThh:mm:ss:filter=false
control-plane-node-ip (optional)
String desc=control plane node ip

k8s-cluster-show-response - Up

k8s-cni-show - Up

Show kubernetes CNI plugin info
api.switch-name (optional)
cni-plugin
String desc=cni plugin name
backend (optional)
String desc=backend used by the cni plugin
vxlan (optional)
Long desc=VXLAN id for the vflow:type=uint32:range=[0,16777215] format: int64
action (optional)
String desc=last changed action:type=enum:filter=false
Enum:
none
add
remove
update
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
last-changed (optional)
String desc=time when cni plugin was last changed:date=yyyy-mm-ddThh:mm:ss:filter=false
udp-port (optional)
Integer desc=VXLAN destination port:type=uint16 format: int32
network-type (optional)
String desc=network type implemented by the cni plugin

k8s-cni-show-response - Up

k8s-connection-create - Up

create a new kubernetes connection
cluster-name
String desc=name for the kubernetes cluster:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
rest-user
String desc=username for vRest access on switch:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[password]:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
password (optional)
String desc=password for the given vRest user name:password=true:requires=[rest-user]
enable (optional)
Boolean desc=enable or disable kubernetes connection service:default=false
disk-space (optional)
Long desc=disk-space (MEM) in bytes (+K,M,G or T) allocated for history:type=uint64:default=52428800 format: int64
kube-config (optional)
String desc=absolute path to kube config file:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
track-history (optional)
Boolean desc=enable or disable kubernetes cluster history tracking:default=false

k8s-connection-modify - Up

modify kubernetes connection information
password (optional)
String desc=password for the given vRest user name:password=true:requires=[rest-user]
enable (optional)
Boolean desc=enable or disable kubernetes connection service:default=false
disk-space (optional)
Long desc=disk-space (MEM) in bytes (+K,M,G or T) allocated for history:type=uint64:default=52428800 format: int64
rest-user (optional)
String desc=username for vRest access on switch:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[password]:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
create-vport (optional)
Boolean desc=enable or disable vport creation for pod traffic:default=false
track-history (optional)
Boolean desc=enable or disable kubernetes cluster history tracking:default=false
overlay-vxlan-analytics (optional)
Boolean desc=enable or disable pod traffic analytics:default=false

k8s-connection-show - Up

Show kubernetes connection information
api.switch-name (optional)
cluster-name
String desc=name for the kubernetes cluster
enable (optional)
Boolean desc=enable or disable kubernetes connection service
status (optional)
String desc=current status of kubernetes connection service:type=enum:filter=false
Enum:
none
init
active
error
exited
unknown
api-server (optional)
String desc=ip address of the api server:filter=false
connected-at (optional)
String desc=kubernetes cluster connection time:date=yyyy-mm-ddThh:mm:ss:filter=false
connection-error (optional)
String desc=k8s connection error
k8s-vlan (optional)
Integer desc=vlan used by k8s for pod vport creation:type=uint16:range=[0,4095] format: int32
disk-space (optional)
Long desc=disk-space (MEM) in bytes (+K,M,G or T) allocated for history:type=uint64 format: int64
rest-user (optional)
String desc=username for vRest access on switch:requires=[password]:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
kube-config (optional)
String desc=absolute path to kube config file
create-vport (optional)
Boolean desc=enable or disable vport creation for pod traffic
track-history (optional)
Boolean desc=enable or disable kubernetes cluster history tracking
overlay-vxlan-analytics (optional)
Boolean desc=enable or disable pod traffic analytics

k8s-connection-show-response - Up

k8s-connectivity-show - Up

show kubernetes connectivity info
api.switch-name (optional)
namespace (optional)
String desc=name of the namespace
deployment (optional)
String desc=kubernetes deployment name:precludes=[service]
daemonset (optional)
String desc=kubernetes daemonset name:precludes=[service]
service (optional)
String desc=kubernetes service name:precludes=[deployment]
pod (optional)
String desc=name of the pod
node (optional)
String desc=kubernetes cluster node name:precludes=[deployment,service]
connections (optional)
String desc=connectivity of pod to fabric:filter=false
action (optional)
String desc=last changed action:type=enum:filter=false
Enum:
none
add
remove
update
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
last-changed (optional)
String desc=time when connection was last changed:date=yyyy-mm-ddThh:mm:ss:filter=false

k8s-connectivity-show-response - Up

k8s-daemonset-show - Up

show kubernetes daemonsets
api.switch-name (optional)
name
String desc=name of the daemonset
namespace
String desc=name of the namespace
selector (optional)
String desc=pod label selector for daemonset
action (optional)
String desc=last changed action:type=enum
Enum:
none
add
remove
update
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
last-changed (optional)
String desc=time when daemonset was last changed:date=yyyy-mm-ddThh:mm:ss:filter=false
desired-cnt (optional)
Long desc=desired number of pods:type=uint32 format: int64
ready-cnt (optional)
Long desc=number of pods ready:type=uint32 format: int64

k8s-daemonset-show-response - Up

k8s-deployment-show - Up

show kubernetes deployments
api.switch-name (optional)
name
String desc=name of the deployment
namespace
String desc=name of the namespace
replicas (optional)
Long desc=total replicas of pod:type=uint32 format: int64
selector (optional)
String desc=pod label in deployment
action (optional)
String desc=last changed action:type=enum
Enum:
none
add
remove
update
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
last-changed (optional)
String desc=time when deployment was last changed:date=yyyy-mm-ddThh:mm:ss:filter=false
ready-replicas (optional)
Long desc=ready replicas of pod:type=uint32 format: int64

k8s-deployment-show-response - Up

k8s-endpoint-show - Up

show kubernetes endpoint
api.switch-name (optional)
name
String desc=name of the service
namespace
String desc=name of the namespace
selector (optional)
String desc=label selector for the service
endpoints (optional)
String desc=list of pod ip addresses
action (optional)
String desc=last changed action:type=enum
Enum:
none
add
remove
update
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
last-changed (optional)
String desc=time when service was last changed:date=yyyy-mm-ddThh:mm:ss:filter=false
target-ports (optional)
String desc=ports targeted on pods

k8s-endpoint-show-response - Up

k8s-impact-show - Up

show impact when node or host is replaced
api.switch-name (optional)
host
String desc=host/node for which the impact needs to be checked:precludes=[switch]
switch
String desc=switch for which the impact needs to be checked:precludes=[host]:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=name:api-ref-val=name
namespace (optional)
String desc=name of the namespace
deployment (optional)
String desc=kubernetes deployment name:precludes=[service]
daemonset (optional)
String desc=kubernetes daemonset name:precludes=[service]
service (optional)
String desc=kubernetes service name:precludes=[deployment]
pod (optional)
String desc=name of the pod
impact (optional)
String desc=impact on the pod when node or switch is replaced:type=enum
Enum:
unknown
none
partial
full
connections (optional)
String desc=connectivity of pod to fabric:filter=false
action (optional)
String desc=last changed action:type=enum:filter=false
Enum:
none
add
remove
update
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
last-changed (optional)
String desc=time when connection was last changed:date=yyyy-mm-ddThh:mm:ss:filter=false

k8s-impact-show-response - Up

k8s-ingress-show - Up

show kubernetes ingress
api.switch-name (optional)
name
String desc=name of the ingress
namespace
String desc=name of the namespace
host (optional)
String desc=hostname of the ingress
path (optional)
String desc=path for the ingress rule
action (optional)
String desc=last changed action:type=enum
Enum:
none
add
remove
update
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
last-changed (optional)
String desc=time when ingress was last changed:date=yyyy-mm-ddThh:mm:ss:filter=false
service-name (optional)
String desc=backend service name
service-port (optional)
String desc=backend service port(s)
resource-api-group (optional)
String desc=backend resource api group
resource-kind (optional)
String desc=backen resource kind
resource-name (optional)
String desc=backend resource name

k8s-ingress-show-response - Up

k8s-network-show - Up

show kubernetes networks
api.switch-name (optional)
namespace
String desc=name of the namespace
ingress-name
String desc=name of the ingress
host (optional)
String desc=hostname of the ingress
selector (optional)
String desc=service selector to identify pods
endpoints (optional)
String desc=list of pod ip addresses
node-port (optional)
String desc=service node port
service-name (optional)
String desc=name of the service
type (optional)
String desc=service type
external-ip (optional)
String desc=external ip for services of type load balancer

k8s-network-show-response - Up

k8s-node-show - Up

Show kubernetes node info
api.switch-name (optional)
node
String desc=node name
role (optional)
String desc=role assigned to node
status (optional)
String desc=node status
ip (optional)
String desc=ip address of the node
labels (optional)
String desc=node labels
action (optional)
String desc=last changed action:type=enum
Enum:
none
add
remove
update
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
pod-CIDR (optional)
String desc=pod CIDR for the node
last-changed (optional)
String desc=time when node was last changed:date=yyyy-mm-ddThh:mm:ss:filter=false

k8s-node-show-response - Up

k8s-pod-show - Up

show kubernetes pods
api.switch-name (optional)
name
String desc=name of the pod
namespace
String desc=name of the namespace
ip (optional)
String desc=pod ip
state (optional)
String desc=pod status
node (optional)
String desc=node name
containers (optional)
String desc=container images running on the pod
labels (optional)
String desc=pod labels
action (optional)
String desc=last changed action:type=enum
Enum:
none
add
remove
update
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
last-changed (optional)
String desc=time when pod was last changed:date=yyyy-mm-ddThh:mm:ss:filter=false
container-state (optional)
String desc=pod's container high level state

k8s-pod-show-response - Up

k8s-service-show - Up

show kubernetes services
api.switch-name (optional)
name
String desc=name of the service
namespace
String desc=name of the namespace
selector (optional)
String desc=label selector for the service
ports (optional)
String desc=ports for the service
action (optional)
String desc=last changed action:type=enum
Enum:
none
add
remove
update
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
last-changed (optional)
String desc=time when service was last changed:date=yyyy-mm-ddThh:mm:ss:filter=false
type (optional)
String desc=service type
external-ip (optional)
String desc=external ip for services of type load balancer
service-ip (optional)
String desc=service ip

k8s-service-show-response - Up

k8s-show - Up

show kubernetes clustrer info
api.switch-name (optional)
cluster-name
String desc=name of the cluster

k8s-show-response - Up

k8s-trace-paths - Up

shows all the shortest paths between k8s pods or between two k8s nodes
api.switch-name (optional)
src-pod
String desc=name of k8s Src pod
dest-pod
String desc=name of k8s dest pod
cluster-name (optional)
String desc=name of k8s cluster

k8s-trace-show-response - Up

l2-check-show - Up

show inconsistent L2 entries
api.switch-name (optional)
mac
String desc=MAC address assigned to vPort:type=mac-address
vnet
String desc=VNET assigned to the vPort:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan
Integer desc=VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
vxlan
Long desc=VXLAN assigned to vPort:type=uint32:range=[0,16777215] format: int64
bd
String desc=Bridge Domain assigned to vPort:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
fix-action (optional)
String desc=Fix action:type=enum
Enum:
none
add-to-hardware
remove-from-hardware
fix-port-in-hardware
fix-tunnel-in-hardware
FAILED-add-to-hardware
FAILED-remove-from-hardware
FAILED-fix-port-in-hardware
FAILED-fix-tunnel-in-hardware
delete-port-mac
mark-port-mac
sw-port (optional)
Long desc=Port in software:type=uint32 format: int64
sw-state (optional)
String desc=State in software:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
hw-port (optional)
Long desc=Port in hardware:type=uint32 format: int64
hw-state (optional)
String desc=State in hardware:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
public-vlan (optional)
Integer desc=Public VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
tunnel-name (optional)
String desc=Tunnel name

l2-check-show-response - Up

l2-history-show - Up

display historical information about layer 2 entries
api.switch-name (optional)
mac
String desc=MAC address assigned to vPort:type=mac-address
vnet
String desc=VNET assigned to the vPort:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
bd
String desc=Bridge Domain assigned to vPort:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
vxlan
Long desc=VXLAN assigned to vPort:type=uint32:range=[0,16777215] format: int64
ip
String desc=IP address assigned to vPort:type=IPv4 or IPv6 address
vlan
Integer desc=VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
caller (optional)
String desc=feature that made the change for this entry:type=flag
Enum:
init
config
status
switch-cb
cluster
gre
ARP
router
flow-cb
vdp
vlag
port
inject
evict
vxlan
stats
vnm-vnic
adjacency
stp
trunk
intsw
ttl1
flood
flush
retire
loop
dhcp
fabric
table
l3-age-out
vlan
l2-checker
igmp
l2-age-out
port-mirror
mac-move
cluster-status
cluster-status-delete
vxlan-routing
subnet
br-dom
vrf
ND
VSG
excess-move-protection
retire-tunnel-up
evpnsnoop-browse
reason (optional)
String desc=reason for history entry:type=flag
Enum:
activate
deactivate
port-move
ip-move
ip-remove
batch-move
retire
break-loop
break-loop-timeout
create
modify
delete
policy
owner-status
remove-node
port-flags
check-owner
trunk-port-add
trunk-port-remove
move-router-if
age-out
hw-remove
restart
undo
flush
update-vxlan-vlan
needs-peer-status
owner-lost
owner-change
update-peer-only
user-delete
done
vm-metadata
excess-move-state-change
evpn-mac-move
changes (optional)
String desc=what changed in this entry:type=uint64
log-type (optional)
String desc=log-type for vPort history:type=enum
Enum:
l2-save
l3-save
restart
l2-modify
l2-delete
l3-modify
l3-delete
owner (optional)
Long desc=owner ID:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
inner-vlan (optional)
Integer desc=Q-in-Q inner VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
public-vlan (optional)
Integer desc=Public VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
num-ips (optional)
Integer desc=Number of IP addresses format: int32
config-intf (optional)
Long desc=interface configured for vPort:type=uint32:precludes=[config] format: int64
intf (optional)
Long desc=port that owns the vPort:type=uint32 format: int64
ports (optional)
String desc=ports assigned to vPort:type=port-list
state (optional)
String desc=vPort state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
local-intf (optional)
Long desc=vPort local interface:type=uint32:filter=false format: int64
local-ports (optional)
String desc=vPort local ports:type=port-list:filter=false
local-state (optional)
String desc=vPort local state:type=flag:filter=false
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
alt-owner (optional)
Long desc=Alternate cluster vPort owner:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
alt-owner-port (optional)
Long desc=Alternate cluster vPort port:type=uint32:filter=false format: int64
last-caller (optional)
String desc=most recent caller for this entry:type=flag
Enum:
init
config
status
switch-cb
cluster
gre
ARP
router
flow-cb
vdp
vlag
port
inject
evict
vxlan
stats
vnm-vnic
adjacency
stp
trunk
intsw
ttl1
flood
flush
retire
loop
dhcp
fabric
table
l3-age-out
vlan
l2-checker
igmp
l2-age-out
port-mirror
mac-move
cluster-status
cluster-status-delete
vxlan-routing
subnet
br-dom
vrf
ND
VSG
excess-move-protection
retire-tunnel-up
evpnsnoop-browse
last-reason (optional)
String desc=most recent reason for this entry:type=flag
Enum:
activate
deactivate
port-move
ip-move
ip-remove
batch-move
retire
break-loop
break-loop-timeout
create
modify
delete
policy
owner-status
remove-node
port-flags
check-owner
trunk-port-add
trunk-port-remove
move-router-if
age-out
hw-remove
restart
undo
flush
update-vxlan-vlan
needs-peer-status
owner-lost
owner-change
update-peer-only
user-delete
done
vm-metadata
excess-move-state-change
evpn-mac-move
alt-owner-ports (optional)
String desc=Alternate cluster vPort owner ports:type=port-list:filter=false
alt-owner-state (optional)
String desc=Alternate cluster vPort owner state:type=flag:filter=false
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
svc-name (optional)
String desc=vCenter connection service name
hostname (optional)
String desc=Hypervisor or switch host name:precludes=[config]
entity (optional)
String desc=VM or VM Kernel device name:precludes=[config]
power (optional)
String desc=vport entry power status:type=enum:precludes=[config]
Enum:
none
powered-off
powered-on
standby
suspended
unknown
running
waiting
terminated
failed
cpus (optional)
Long desc=number of CPUs on VM:type=uint32:precludes=[config] format: int64
os (optional)
String desc=Hypervisor or VM guest OS:precludes=[config]
portgroup (optional)
String desc=Port Group name associated with VM MAC:precludes=[config]
pg-vlans (optional)
String desc=Valid vlans for the Port Group:type=vlan-list
vswitch (optional)
String desc=vswitch name associated with NIC:precludes=[config]
vs-type (optional)
String desc=Virtual Switch type:type=enum:precludes=[config]
Enum:
none
host-vs
distributed-vs
unknown
vnic-type (optional)
String desc=vNic type attached to VM/VM-Kernel:type=flag:precludes=[config]
Enum:
untagged
tagged
trunked
vm-mgmt
vm-kernel
vMotion
vSAN
FTL
rep
p-NFC
r-NFC
mgmt
unknown
config (optional)
String desc=VM config:type=flag:precludes=[owner,local-intf,hostname,entity,cpus,portgroup,vswitch]
Enum:
none
owner
ip
port
hostname
entity
cpus
os
rem-switch (optional)
Long desc=vPort remote switch:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
rem-intf (optional)
Long desc=vPort remote interface:type=uint32 format: int64
rem-ports (optional)
String desc=vPort remote ports:type=port-list
peer-intf (optional)
Long desc=vPort peer interface:type=uint32 format: int64
peer-state (optional)
String desc=vPort peer state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
peer-owner-state (optional)
String desc=vPort peer owner state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
status (optional)
String desc=vPort status:type=flag
Enum:
phy-up
up
disabled
hw-nat-loop
mirror-loop
mirror-to
PN-switch
PN-fabric
PN-other
PN-cluster
PN-internal
host
uplink
STP-BPDUs
LLDP
trunk
l3-port
remote-l3-port
dhcp
dhcpsvr
blocked
no-BPDU
LACP-PDUs
vlag-active
vlag-blocked
stp-edge-port
LACP-wait
LACP-fallback
adjacency-wait
adjacency-check
vlag-wait
multicast-router
host-disabled
loop
congested
vxlan-loopback
vlan-up
vle
vbt-wait
phy-down
down
enabled
err-disabled
err-bpdu-guard
mac-violation
stp-bpdu-guard
stp-root-guard
defer-bringup-wait
rx-bw-threshold-exceeded
tx-bw-threshold-exceeded
vtep-ip (optional)
String desc=Remote VTEP IP address:type=IPv4 or IPv6 address
tunnel (optional)
String desc=vPort tunnel
create-time (optional)
String desc=vPort create-time:date=yyyy-mm-ddThh:mm:ss
last-seen (optional)
String desc=vPort last-seen:date=yyyy-mm-ddThh:mm:ss
last-seen-since (optional)
String desc=vPort last-seen since a specified time:date=yyyy-mm-ddThh:mm:ss
vxlan-lru (optional)
String desc=vPort VXLAN lru:date=yyyy-mm-ddThh:mm:ss
hit (optional)
Long desc=number of hits:type=uint32 format: int64
migrate (optional)
Long desc=number of times entry migrated:type=uint32 format: int64
drops (optional)
Long desc=number of dropped packets:type=uint32 format: int64
hw-index (optional)
Integer desc=hardware index format: int32
rt-if (optional)
String desc=router interface
hw-flags (optional)
String desc=vport hw flags:type=flag
Enum:
invalid-vlan
invalid-port
mc-index (optional)
Long desc=L2 multicast group index in hw:type=uint32 format: int64
count (optional)
Long desc=count for vPort history:type=uint32 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

l2-history-show-response - Up

l2-setting-modify - Up

modify the Layer 2 settings
aging-time (optional)
Long desc=aging-time for Layer 2 entries:type=uint32:range=[1,2000000]:default=900 format: int64
software-aging (optional)
Boolean desc=aging controlled by software:default=true
l2-max-count (optional)
Long desc=maximum count for Layer 2 entries:type=uint32 format: int64
l2-checker (optional)
Boolean desc=l2 consistency checker with hardware:default=false
l2-checker-interval (optional)
Long desc=Set interval for l2 consistency checker:default=10m format: int64
l3-arp-max-count (optional)
Long desc=maximum count of ARPs for Layer 3 entries:type=uint32 format: int64

l2-setting-show - Up

display the Layer 2 setting
api.switch-name (optional)
l2-cur-count (optional)
Long desc=current count for Layer 2 entries:type=uint32 format: int64
l2-active-count (optional)
Long desc=active count for Layer 2 entries:type=uint32 format: int64
l2-max-mem (optional)
Long desc=maximum memory for Layer 2 entries:type=uint64 format: int64
l2-cur-mem (optional)
Long desc=current memory for Layer 2 entries:type=uint64 format: int64
l3-arp-cur-count (optional)
Long desc=current count of ARPs for Layer 3 entries:type=uint32 format: int64
l3-arp-max-mem (optional)
Long desc=maximum memory for Layer 3 ARP entries:type=uint64 format: int64
l3-arp-cur-mem (optional)
Long desc=current memory for Layer 3 ARP entries:type=uint64 format: int64
aging-time (optional)
Long desc=aging-time for Layer 2 entries:type=uint32:range=[1,2000000]:filter=false format: int64
software-aging (optional)
Boolean desc=aging controlled by software
l2-max-count (optional)
Long desc=maximum count for Layer 2 entries:type=uint32 format: int64
l2-checker (optional)
Boolean desc=l2 consistency checker with hardware
l2-checker-interval (optional)
Long desc=Set interval for l2 consistency checker format: int64
l3-arp-max-count (optional)
Long desc=maximum count of ARPs for Layer 3 entries:type=uint32 format: int64

l2-setting-show-response - Up

l2-static-multicast-group-create - Up

create a static L2 multicast group on the network
vlan
Integer desc=L2 multicast group VLAN:type=uint16:range=[0,4095] format: int32
group-mac
String desc=L2 multicast group MAC address:type=mac-address
ports
String desc=L2 multicast group ports:type=port-list

l2-static-multicast-group-port-add - Up

add port to l2 multicast group
ports (optional)
String desc=port(s):type=port-list

l2-static-multicast-group-port-remove - Up

remove port from l2 multicast group
ports
String desc=port(s):type=port-list

l2-static-multicast-group-show - Up

display a static L2 multicast group on the network
api.switch-name (optional)
vlan
Integer desc=L2 multicast group VLAN:type=uint16:range=[0,4095] format: int32
group-mac
String desc=L2 multicast group MAC address:type=mac-address
ports (optional)
String desc=L2 multicast group ports:type=port-list

l2-static-multicast-group-show-response - Up

l2-table-flush - Up

clear information from the L2 table
mac (optional)
String desc=MAC address assigned to vPort:type=mac-address
vlan (optional)
Integer desc=VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
ports (optional)
String desc=ports assigned to vPort:type=port-list

l2-table-show - Up

display information in the L2 table
api.switch-name (optional)
mac
String desc=MAC address assigned to vPort:type=mac-address
vnet
String desc=VNET assigned to the vPort:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan
Integer desc=VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
vxlan
Long desc=VXLAN assigned to vPort:type=uint32:range=[0,16777215] format: int64
ip
String desc=IP address assigned to vPort:type=IPv4 or IPv6 address
bd
String desc=Bridge Domain assigned to vPort:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
owner (optional)
Long desc=owner ID:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
hostname (optional)
String desc=Hypervisor or switch host name:precludes=[config]
entity (optional)
String desc=VM or VM Kernel device name:precludes=[config]
power (optional)
String desc=vport entry power status:type=enum:precludes=[config]
Enum:
none
powered-off
powered-on
standby
suspended
unknown
running
waiting
terminated
failed
portgroup (optional)
String desc=Port Group name associated with VM MAC:precludes=[config]
vswitch (optional)
String desc=vswitch name associated with NIC:precludes=[config]
config (optional)
String desc=VM config:type=flag:precludes=[owner,local-intf,hostname,entity,cpus,portgroup,vswitch]
Enum:
none
owner
ip
port
hostname
entity
cpus
os
tunnel (optional)
String desc=vPort tunnel
peer-intf (optional)
Long desc=vPort peer interface:type=uint32 format: int64
local-intf (optional)
Long desc=vPort local interface:type=uint32:filter=false format: int64
local-ports (optional)
String desc=vPort local ports:type=port-list:filter=false
local-state (optional)
String desc=vPort local state:type=flag:filter=false
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
alt-owner (optional)
Long desc=Alternate cluster vPort owner:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
alt-owner-port (optional)
Long desc=Alternate cluster vPort port:type=uint32:filter=false format: int64
alt-owner-ports (optional)
String desc=Alternate cluster vPort owner ports:type=port-list:filter=false
alt-owner-state (optional)
String desc=Alternate cluster vPort owner state:type=flag:filter=false
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
rem-intf (optional)
Long desc=vPort remote interface:type=uint32 format: int64
rem-ports (optional)
String desc=vPort remote ports:type=port-list
peer-state (optional)
String desc=vPort peer state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
peer-owner-state (optional)
String desc=vPort peer owner state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
status (optional)
String desc=vPort status:type=flag
Enum:
phy-up
up
disabled
hw-nat-loop
mirror-loop
mirror-to
PN-switch
PN-fabric
PN-other
PN-cluster
PN-internal
host
uplink
STP-BPDUs
LLDP
trunk
l3-port
remote-l3-port
dhcp
dhcpsvr
blocked
no-BPDU
LACP-PDUs
vlag-active
vlag-blocked
stp-edge-port
LACP-wait
LACP-fallback
adjacency-wait
adjacency-check
vlag-wait
multicast-router
host-disabled
loop
congested
vxlan-loopback
vlan-up
vle
vbt-wait
phy-down
down
enabled
err-disabled
err-bpdu-guard
mac-violation
stp-bpdu-guard
stp-root-guard
defer-bringup-wait
rx-bw-threshold-exceeded
tx-bw-threshold-exceeded
vtep-ip (optional)
String desc=Remote VTEP IP address:type=IPv4 or IPv6 address
create-time (optional)
String desc=vPort create-time:date=yyyy-mm-ddThh:mm:ss
last-seen (optional)
String desc=vPort last-seen:date=yyyy-mm-ddThh:mm:ss
last-seen-since (optional)
String desc=vPort last-seen since a specified time:date=yyyy-mm-ddThh:mm:ss
vxlan-lru (optional)
String desc=vPort VXLAN lru:date=yyyy-mm-ddThh:mm:ss
hit (optional)
Long desc=number of hits:type=uint32 format: int64
migrate (optional)
Long desc=number of times entry migrated:type=uint32 format: int64
drops (optional)
Long desc=number of dropped packets:type=uint32 format: int64
mc-index (optional)
Long desc=L2 multicast group index in hw:type=uint32 format: int64
ports (optional)
String desc=ports assigned to vPort:type=port-list
state (optional)
String desc=vPort state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
intf (optional)
Long desc=port that owns the vPort:type=uint32 format: int64
public-vlan (optional)
Integer desc=Public VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
num-ips (optional)
Integer desc=Number of IP addresses format: int32
config-intf (optional)
Long desc=interface configured for vPort:type=uint32:precludes=[config] format: int64
svc-name (optional)
String desc=vCenter connection service name
cpus (optional)
Long desc=number of CPUs on VM:type=uint32:precludes=[config] format: int64
os (optional)
String desc=Hypervisor or VM guest OS:precludes=[config]
pg-vlans (optional)
String desc=Valid vlans for the Port Group:type=vlan-list
vs-type (optional)
String desc=Virtual Switch type:type=enum:precludes=[config]
Enum:
none
host-vs
distributed-vs
unknown
vnic-type (optional)
String desc=vNic type attached to VM/VM-Kernel:type=flag:precludes=[config]
Enum:
untagged
tagged
trunked
vm-mgmt
vm-kernel
vMotion
vSAN
FTL
rep
p-NFC
r-NFC
mgmt
unknown
rem-switch (optional)
Long desc=vPort remote switch:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
hw-index (optional)
Integer desc=hardware index format: int32
rt-if (optional)
String desc=router interface
hw-flags (optional)
String desc=vport hw flags:type=flag
Enum:
invalid-vlan
invalid-port
inner-vlan (optional)
Integer desc=Q-in-Q inner VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32

l2-table-show-response - Up

l3-check-show - Up

show inconsistent L3 entries
api.switch-name (optional)
vrid
Integer desc=virtual router ID:type=uint16:range=[0,1024] format: int32
ip
String desc=IP address:type=IPv4 or IPv6 address
prelen
Long desc=prefix length:type=uint32:range=[0,128]:requires=[ip] format: int64
vlan
Integer desc=VLAN id:type=uint16:range=[0,4095] format: int32
vnet-id
String desc=VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd
String desc=Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
mac (optional)
String desc=MAC address:type=mac-address:filter=false
fix-action (optional)
String desc=Fix action:type=enum
Enum:
none
add-host-to-hardware
remove-host-from-hardware
re-add-host-to-hardware
add-route-to-hardware
remove-route-from-hardware
re-add-route-to-hardware
none-hardware-only-route
none-cached-route
none-ecmp-cached-route
FAILED-add-host-to-hardware
FAILED-remove-host-from-hardware
FAILED-add-route-to-hardware
FAILED-remove-route-from-hardware

l3-check-show-response - Up

l3-history-show - Up

display historical information about layer 3 entries
api.switch-name (optional)
mac
String desc=MAC address assigned to vPort:type=mac-address
vnet
String desc=VNET assigned to the vPort:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
bd
String desc=Bridge Domain assigned to vPort:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
vxlan
Long desc=VXLAN assigned to vPort:type=uint32:range=[0,16777215] format: int64
ip
String desc=IP address assigned to vPort:type=IPv4 or IPv6 address
vlan
Integer desc=VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
caller (optional)
String desc=feature that made the change for this entry:type=flag
Enum:
init
config
status
switch-cb
cluster
gre
ARP
router
flow-cb
vdp
vlag
port
inject
evict
vxlan
stats
vnm-vnic
adjacency
stp
trunk
intsw
ttl1
flood
flush
retire
loop
dhcp
fabric
table
l3-age-out
vlan
l2-checker
igmp
l2-age-out
port-mirror
mac-move
cluster-status
cluster-status-delete
vxlan-routing
subnet
br-dom
vrf
ND
VSG
excess-move-protection
retire-tunnel-up
evpnsnoop-browse
reason (optional)
String desc=reason for history entry:type=flag
Enum:
activate
deactivate
port-move
ip-move
ip-remove
batch-move
retire
break-loop
break-loop-timeout
create
modify
delete
policy
owner-status
remove-node
port-flags
check-owner
trunk-port-add
trunk-port-remove
move-router-if
age-out
hw-remove
restart
undo
flush
update-vxlan-vlan
needs-peer-status
owner-lost
owner-change
update-peer-only
user-delete
done
vm-metadata
excess-move-state-change
evpn-mac-move
changes (optional)
String desc=what changed in this entry:type=uint64
log-type (optional)
String desc=log-type for vPort history:type=enum
Enum:
l2-save
l3-save
restart
l2-modify
l2-delete
l3-modify
l3-delete
owner (optional)
Long desc=owner ID:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
inner-vlan (optional)
Integer desc=Q-in-Q inner VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
public-vlan (optional)
Integer desc=Public VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
num-ips (optional)
Integer desc=Number of IP addresses format: int32
config-intf (optional)
Long desc=interface configured for vPort:type=uint32:precludes=[config] format: int64
intf (optional)
Long desc=port that owns the vPort:type=uint32 format: int64
ports (optional)
String desc=ports assigned to vPort:type=port-list
state (optional)
String desc=vPort state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
local-intf (optional)
Long desc=vPort local interface:type=uint32:filter=false format: int64
local-ports (optional)
String desc=vPort local ports:type=port-list:filter=false
local-state (optional)
String desc=vPort local state:type=flag:filter=false
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
alt-owner (optional)
Long desc=Alternate cluster vPort owner:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
alt-owner-port (optional)
Long desc=Alternate cluster vPort port:type=uint32:filter=false format: int64
last-caller (optional)
String desc=most recent caller for this entry:type=flag
Enum:
init
config
status
switch-cb
cluster
gre
ARP
router
flow-cb
vdp
vlag
port
inject
evict
vxlan
stats
vnm-vnic
adjacency
stp
trunk
intsw
ttl1
flood
flush
retire
loop
dhcp
fabric
table
l3-age-out
vlan
l2-checker
igmp
l2-age-out
port-mirror
mac-move
cluster-status
cluster-status-delete
vxlan-routing
subnet
br-dom
vrf
ND
VSG
excess-move-protection
retire-tunnel-up
evpnsnoop-browse
last-reason (optional)
String desc=most recent reason for this entry:type=flag
Enum:
activate
deactivate
port-move
ip-move
ip-remove
batch-move
retire
break-loop
break-loop-timeout
create
modify
delete
policy
owner-status
remove-node
port-flags
check-owner
trunk-port-add
trunk-port-remove
move-router-if
age-out
hw-remove
restart
undo
flush
update-vxlan-vlan
needs-peer-status
owner-lost
owner-change
update-peer-only
user-delete
done
vm-metadata
excess-move-state-change
evpn-mac-move
alt-owner-ports (optional)
String desc=Alternate cluster vPort owner ports:type=port-list:filter=false
alt-owner-state (optional)
String desc=Alternate cluster vPort owner state:type=flag:filter=false
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
svc-name (optional)
String desc=vCenter connection service name
hostname (optional)
String desc=Hypervisor or switch host name:precludes=[config]
entity (optional)
String desc=VM or VM Kernel device name:precludes=[config]
power (optional)
String desc=vport entry power status:type=enum:precludes=[config]
Enum:
none
powered-off
powered-on
standby
suspended
unknown
running
waiting
terminated
failed
cpus (optional)
Long desc=number of CPUs on VM:type=uint32:precludes=[config] format: int64
os (optional)
String desc=Hypervisor or VM guest OS:precludes=[config]
portgroup (optional)
String desc=Port Group name associated with VM MAC:precludes=[config]
pg-vlans (optional)
String desc=Valid vlans for the Port Group:type=vlan-list
vswitch (optional)
String desc=vswitch name associated with NIC:precludes=[config]
vs-type (optional)
String desc=Virtual Switch type:type=enum:precludes=[config]
Enum:
none
host-vs
distributed-vs
unknown
vnic-type (optional)
String desc=vNic type attached to VM/VM-Kernel:type=flag:precludes=[config]
Enum:
untagged
tagged
trunked
vm-mgmt
vm-kernel
vMotion
vSAN
FTL
rep
p-NFC
r-NFC
mgmt
unknown
config (optional)
String desc=VM config:type=flag:precludes=[owner,local-intf,hostname,entity,cpus,portgroup,vswitch]
Enum:
none
owner
ip
port
hostname
entity
cpus
os
rem-switch (optional)
Long desc=vPort remote switch:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
rem-intf (optional)
Long desc=vPort remote interface:type=uint32 format: int64
rem-ports (optional)
String desc=vPort remote ports:type=port-list
peer-intf (optional)
Long desc=vPort peer interface:type=uint32 format: int64
peer-state (optional)
String desc=vPort peer state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
peer-owner-state (optional)
String desc=vPort peer owner state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
status (optional)
String desc=vPort status:type=flag
Enum:
phy-up
up
disabled
hw-nat-loop
mirror-loop
mirror-to
PN-switch
PN-fabric
PN-other
PN-cluster
PN-internal
host
uplink
STP-BPDUs
LLDP
trunk
l3-port
remote-l3-port
dhcp
dhcpsvr
blocked
no-BPDU
LACP-PDUs
vlag-active
vlag-blocked
stp-edge-port
LACP-wait
LACP-fallback
adjacency-wait
adjacency-check
vlag-wait
multicast-router
host-disabled
loop
congested
vxlan-loopback
vlan-up
vle
vbt-wait
phy-down
down
enabled
err-disabled
err-bpdu-guard
mac-violation
stp-bpdu-guard
stp-root-guard
defer-bringup-wait
rx-bw-threshold-exceeded
tx-bw-threshold-exceeded
vtep-ip (optional)
String desc=Remote VTEP IP address:type=IPv4 or IPv6 address
tunnel (optional)
String desc=vPort tunnel
create-time (optional)
String desc=vPort create-time:date=yyyy-mm-ddThh:mm:ss
last-seen (optional)
String desc=vPort last-seen:date=yyyy-mm-ddThh:mm:ss
last-seen-since (optional)
String desc=vPort last-seen since a specified time:date=yyyy-mm-ddThh:mm:ss
vxlan-lru (optional)
String desc=vPort VXLAN lru:date=yyyy-mm-ddThh:mm:ss
hit (optional)
Long desc=number of hits:type=uint32 format: int64
migrate (optional)
Long desc=number of times entry migrated:type=uint32 format: int64
drops (optional)
Long desc=number of dropped packets:type=uint32 format: int64
hw-index (optional)
Integer desc=hardware index format: int32
rt-if (optional)
String desc=router interface
hw-flags (optional)
String desc=vport hw flags:type=flag
Enum:
invalid-vlan
invalid-port
mc-index (optional)
Long desc=L2 multicast group index in hw:type=uint32 format: int64
count (optional)
Long desc=count for vPort history:type=uint32 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

l3-history-show-response - Up

l3-route-show - Up

display Layer 3 route table information
api.switch-name (optional)
network
String desc=network address:type=IPv4 or IPv6 address
netmask
Integer desc=mask for the network:type=netmask:mask-for=[network] format: int32
vrf_name
String desc=VRF name
vrf_vnet
String desc=VNET for the VRF
gateway-ip
String desc=gateway IP address:type=IPv4 or IPv6 address
owner (optional)
Long desc=owner ID:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
router-mac (optional)
String desc=router mac address:type=mac-address

l3-route-show-response - Up

l3-setting-modify - Up

modify the Layer 3 settings
aging-time (optional)
Long desc=aging-time for Layer 3 entries, use 0 to disable aging:type=uint32:range=[0,2000000]:default=600 format: int64
convergence-time (optional)
Long desc=unicast convergence time on bootup (seconds):type=uint32:range=[0,3600]:default=60 format: int64
l3-checker (optional)
Boolean desc=l3 consistency checker with hardware:default=false
l3-checker-interval (optional)
Long desc=Set interval for l3 consistency checker:default=10m format: int64
l3-checker-fix (optional)
Boolean desc=enable fixing of inconsistent entries:default=false

l3-setting-show - Up

display the Layer 3 setting
api.switch-name (optional)
aging-time (optional)
Long desc=aging-time for Layer 3 entries, use 0 to disable aging:type=uint32:range=[0,2000000]:filter=false format: int64
convergence-time (optional)
Long desc=unicast convergence time on bootup (seconds):type=uint32:range=[0,3600]:filter=false format: int64
l3-checker (optional)
Boolean desc=l3 consistency checker with hardware
l3-checker-interval (optional)
Long desc=Set interval for l3 consistency checker format: int64
l3-checker-fix (optional)
Boolean desc=enable fixing of inconsistent entries

l3-setting-show-response - Up

l3-table-show - Up

display Layer 3 table information
api.switch-name (optional)
ip
String desc=IP address:type=IPv4 or IPv6 address
vnet
String desc=L3 entry VNET:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan
Integer desc=assigned VLAN:type=uint16:range=[0,4095] format: int32
vxlan
Long desc=assigned VXLAN:type=uint32:range=[0,16777215] format: int64
bd
String desc=L3 entry Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
owner (optional)
Long desc=owner ID:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
mac (optional)
String desc=MAC address:type=mac-address
tunnel (optional)
String desc=tunnel name
state (optional)
String desc=state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
alt-owner (optional)
Long desc=alternate cluster owner ID:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
alt-owner-state (optional)
String desc=alternate cluster owner state:type=flag:filter=false
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
peer-state (optional)
String desc=peer state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
create-time (optional)
String desc=time entry created:date=yyyy-mm-ddThh:mm:ss
last-seen (optional)
String desc=last time entry seen on the network:date=yyyy-mm-ddThh:mm:ss
hit (optional)
Long desc=number of hits:type=uint32 format: int64
owner-state (optional)
String desc=owner state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
public-vlan (optional)
Integer desc=Public VLAN:type=uint16:range=[0,4095] format: int32
rt-if (optional)
String desc=router interface
hw-intf (optional)
Long desc=interface programmed in hw:type=uint32 format: int64
egress-id (optional)
Integer desc=hardware egress id format: int32
intf (optional)
Long desc=interface:type=uint32 format: int64

l3-table-show-response - Up

lacp-modify - Up

modify LACP parameters
enable (optional)
Boolean desc=enable or disable:default=true
system-priority (optional)
Long desc=assigned system priority from 1 to 65535:type=uint32:range=[1,65535]:default=32768 format: int64

lacp-port-stats-settings-modify - Up

modify lacp port settings for collecting statistics
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

lacp-port-stats-settings-show - Up

display lacp port settings for collecting statistics
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

lacp-port-stats-settings-show-response - Up

lacp-show - Up

display LACP parameters
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable
system-id (optional)
String desc=assigned system ID:type=uint64:hex=0x[0-9a-fA-F]{16}
system-priority (optional)
Long desc=assigned system priority from 1 to 65535:type=uint32:range=[1,65535] format: int64

lacp-show-response - Up

lldp-show - Up

display LLDP information
api.switch-name (optional)
chassis-id
String desc=chassis ID
local-port
Integer desc=local port format: int32
port-id
String desc=port ID
ttl (optional)
Integer desc=time-to-live (ttl):type=uint16:filter=false format: int32
port-vlan-id (optional)
Integer desc=port VLAN ID:type=uint16:filter=false format: int32
sys-name (optional)
String desc=system name
system-cap (optional)
String desc=system cap:filter=false
system-cap-enabled (optional)
String desc=system cap enabled:filter=false
max-frame-size (optional)
Integer desc=maximum frame size:type=uint16:filter=false format: int32
cong-notif (optional)
Boolean desc=received congestion notification:filter=false
ets-conf (optional)
Boolean desc=received enhanced transmission selection conf:filter=false
ets-recomm (optional)
Boolean desc=received ets recommendation:filter=false
pfc-conf (optional)
Boolean desc=received priority flow control:filter=false
appl-priority (optional)
Boolean desc=received application priority:filter=false
bezel-port (optional)
String desc=bezel port
port-desc (optional)
String desc=port description:filter=false

lldp-show-response - Up

log-admin-audit-modify - Up

modify Auditing functionality
enable
Boolean desc=enable or disable Auditing - disabled by default:default=false

log-admin-audit-show - Up

display Auditing functionality
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable Auditing - disabled by default

log-admin-audit-show-response - Up

log-alert-show - Up

display log alerts information
api.switch-name (optional)
port (optional)
Long desc=port to match:type=uint32 format: int64
code (optional)
Long desc=alert code:type=uint32 format: int64
name (optional)
String desc=name of the alert
count (optional)
Long desc=number of times the alert occurred:type=uint32:filter=false format: int64
last-message (optional)
String desc=last message logged:filter=false
cur-interval (optional)
Long desc=current interval for logging alerts:type=uint32:filter=false format: int64
switch (optional)
Long desc=switch logging alerts:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

log-alert-show-response - Up

log-archival-schedule-files-add - Up

Add log files to the archival list
log-file
String desc=List of log files to be archived

log-archival-schedule-files-remove - Up

Remove log files from the archival list
log-file
String desc=List of log files to be archived

log-archival-schedule-modify - Up

Modify log archival schedule parameters
enable
Boolean desc=enable or disable log archival schedule:default=false

log-archival-schedule-modify-1 - Up

Modify log archival schedule parameters
archive-server-password (optional)
String desc=SCP server password:password=true
archive-server-username (optional)
String desc=SCP username of log archive server:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[archive-server-password]
archive-server (optional)
String desc=IP or hostname of the log archive server:pattern=^[a-zA-Z0-9.-]*$:pattern-help=letters, numbers, ., -, and ''
archive-server-path (optional)
String desc=SCP server's path to archive logs in:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
key-auth (optional)
Boolean desc=enable or disable key authentication:default=false
archive-interval (optional)
Long desc=log archival interval in minutes - minimum 30m, default 1440m (1 day):type=uint32:range=[30,4294967295]:default=1440 format: int64

log-archival-schedule-show - Up

Show log archival schedule
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable log archival schedule
archive-server-username (optional)
String desc=SCP username of log archive server:requires=[archive-server-password]
archive-server (optional)
String desc=IP or hostname of the log archive server
archive-server-path (optional)
String desc=SCP server's path to archive logs in
log-file (optional)
String desc=List of log files to be archived
key-auth (optional)
Boolean desc=enable or disable key authentication
archive-interval (optional)
Long desc=log archival interval in minutes - minimum 30m, default 1440m (1 day):type=uint32:range=[30,4294967295] format: int64

log-archival-schedule-show-response - Up

log-archival-schedule-ssh-key-gen - Up

Generate SSH keys
key-type
String desc=SSH key type:type=enum:default=rsa
Enum:
rsa
ecdsa
none
key-bits
Integer desc=key bits; rsa min-2048, max-16384; ecdsa-256, 384 or 521 bits:range=[256,16384]:default=2048 format: int32

log-archival-schedule-ssh-key-import - Up

import SSH keys
file-private-key
String desc=SSH private key file:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
passphrase (optional)
String desc=passphrase of SSH key:password=true

log-archival-schedule-ssh-key-show - Up

display SSH key
api.switch-name (optional)
key-type (optional)
String desc=SSH key type:type=enum
Enum:
rsa
ecdsa
none
key-bits (optional)
Integer desc=key bits; rsa min-2048, max-16384; ecdsa-256, 384 or 521 bits:range=[256,16384] format: int32
file-public-key (optional)
String desc=SSH public key file:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
file-private-key (optional)
String desc=SSH private key file:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name

log-archival-schedule-ssh-key-show-response - Up

log-audit-exception-create - Up

Create an audit logging exception
type
String desc=type of audit exception:type=enum
Enum:
cli
shell
vtysh
scope
String desc=scope of exception
Enum:
local
fabric
pattern (optional)
String desc=regular expression to match exceptions
access (optional)
String desc=access to match exceptions:type=enum
Enum:
any
read-only
read-write

log-audit-exception-show - Up

Display audit logging exceptions
api.switch-name (optional)
type
String desc=type of audit exception:type=enum
Enum:
cli
shell
vtysh
pattern
String desc=regular expression to match exceptions
access
String desc=access to match exceptions:type=enum
Enum:
any
read-only
read-write
scope (optional)
String desc=scope of exception
Enum:
local
fabric

log-audit-exception-show-response - Up

log-audit-show - Up

display audit logs information
api.switch-name (optional)
duration (optional)
Long desc=duration to match format: int64
time (optional)
String desc=time of the event:filter=false
pid (optional)
Long desc=product ID generating log messages to match:type=uint32 format: int64
name (optional)
String desc=message name to match
code (optional)
Long desc=message code to match:type=uint64 format: int64
level (optional)
String desc=the level of severity to match:type=enum
Enum:
critical
error
warn
note
info
vnet (optional)
String desc=VNET to match:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
user (optional)
String desc=username to match:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
port (optional)
Long desc=port to match:type=uint32 format: int64
vlan (optional)
Integer desc=VLAN to match:type=uint16:range=[0,4095] format: int32
vxlan (optional)
String desc=VXLAN to match
args (optional)
String desc=arguments to match:filter=false
message (optional)
String desc=the message to match:filter=false
reverse (optional)
Boolean desc=reverse the order of the messages:requires=[starting-point,length,count]
end-time (optional)
String desc=end time to match:date=yyyy-mm-ddThh:mm:ss
program (optional)
String desc=name of the program used to generate log messages
remote_switch (optional)
String desc=remote switch node to match:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=name:api-ref-val=name
switch (optional)
String desc=switch to collect log events:filter=false
length (optional)
Long desc=message length to match:type=uint64:requires=[starting-point,count] format: int64
client-pid (optional)
Long desc=product ID to match:type=uint32 format: int64
starting-point (optional)
Long desc=message starting point to match:type=uint64:requires=[length,count] format: int64
client-addr (optional)
String desc=client IP address to match:type=IPv4 or IPv6 address
show-time (optional)
String desc=the time that the message appeared:filter=false
start-time (optional)
String desc=start-time to match:date=yyyy-mm-ddThh:mm:ss
bd (optional)
String desc=Bridge Domain to match:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

log-audit-show-response - Up

log-datetime-fmt-mode-modify - Up

Modify log datetime format mode
classic-mode (optional)
Boolean desc=Use classic datetimestamp for logs:default=false

log-datetime-fmt-mode-show - Up

Log datetime format mode
api.switch-name (optional)
classic-mode (optional)
Boolean desc=Use classic datetimestamp for logs

log-datetime-fmt-mode-show-response - Up

log-event-settings-modify - Up

modify the log event settings
system (optional)
Boolean desc=system on or off:default=true
port (optional)
Boolean desc=port on or off:default=true
tcp (optional)
Boolean desc=TCP events on or off:default=false
stp (optional)
Boolean desc=STP events on or off:default=false
igmp (optional)
Boolean desc=IGMP events on or off:default=false
lldp (optional)
Boolean desc=LLDP events on or off:default=false
lacp (optional)
Boolean desc=LACP events on or off:default=false
vdp (optional)
Boolean desc=VDP events on or off:default=false
ecp (optional)
Boolean desc=ECP events on or off:default=false
evb (optional)
Boolean desc=EVB events on or off:default=false
ptp (optional)
Boolean desc=PTP events on or off:default=false
storage (optional)
Boolean desc=storage events on or off:default=false
tacacs (optional)
Boolean desc=TACACS+ events on or off:default=true
mld (optional)
Boolean desc=MLD events on or off:default=false
mroute (optional)
Boolean desc=MROUTE events on or off:default=false
vport (optional)
Boolean desc=vport events on or off:default=false
lacp-port-event (optional)
Boolean desc=LACP port events on or off:default=false

log-event-settings-show - Up

display the log event settings
api.switch-name (optional)
system (optional)
Boolean desc=system on or off
port (optional)
Boolean desc=port on or off
tcp (optional)
Boolean desc=TCP events on or off
stp (optional)
Boolean desc=STP events on or off
igmp (optional)
Boolean desc=IGMP events on or off
lldp (optional)
Boolean desc=LLDP events on or off
lacp (optional)
Boolean desc=LACP events on or off
vdp (optional)
Boolean desc=VDP events on or off
ecp (optional)
Boolean desc=ECP events on or off
evb (optional)
Boolean desc=EVB events on or off
ptp (optional)
Boolean desc=PTP events on or off
storage (optional)
Boolean desc=storage events on or off
tacacs (optional)
Boolean desc=TACACS+ events on or off
mld (optional)
Boolean desc=MLD events on or off
mroute (optional)
Boolean desc=MROUTE events on or off
vport (optional)
Boolean desc=vport events on or off
lacp-port-event (optional)
Boolean desc=LACP port events on or off

log-event-settings-show-response - Up

log-event-show - Up

display event logs information
api.switch-name (optional)
duration (optional)
Long desc=duration to match format: int64
time (optional)
String desc=time of the event:filter=false
pid (optional)
Long desc=product ID generating log messages to match:type=uint32 format: int64
name (optional)
String desc=message name to match
code (optional)
Long desc=message code to match:type=uint64 format: int64
level (optional)
String desc=the level of severity to match:type=enum
Enum:
critical
error
warn
note
info
vnet (optional)
String desc=VNET to match:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
port (optional)
Long desc=port to match:type=uint32 format: int64
vlan (optional)
Integer desc=VLAN to match:type=uint16:range=[0,4095] format: int32
vxlan (optional)
String desc=VXLAN to match
args (optional)
String desc=arguments to match:filter=false
message (optional)
String desc=the message to match:filter=false
reverse (optional)
Boolean desc=reverse the order of the messages:requires=[starting-point,length,count]
end-time (optional)
String desc=end time to match:date=yyyy-mm-ddThh:mm:ss
event-type (optional)
String desc=message log event type to match:type=enum
Enum:
system
port
tcp
stp
igmp
lldp
lacp
vdp
ecp
evb
ptp
storage
tacacs
mld
mroute
vport
lacp-port-event
program (optional)
String desc=name of the program used to generate log messages
remote_switch (optional)
String desc=remote switch node to match:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=name:api-ref-val=name
switch (optional)
String desc=switch to collect log events:filter=false
length (optional)
Long desc=message length to match:type=uint64:requires=[starting-point,count] format: int64
client-pid (optional)
Long desc=product ID to match:type=uint32 format: int64
starting-point (optional)
Long desc=message starting point to match:type=uint64:requires=[length,count] format: int64
client-addr (optional)
String desc=client IP address to match:type=IPv4 or IPv6 address
show-time (optional)
String desc=the time that the message appeared:filter=false
start-time (optional)
String desc=start-time to match:date=yyyy-mm-ddThh:mm:ss
bd (optional)
String desc=Bridge Domain to match:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

log-event-show-response - Up

log-session-show - Up

display session logs information
api.switch-name (optional)
duration (optional)
Long desc=duration to match format: int64
time (optional)
String desc=time of the event:filter=false
pid (optional)
Long desc=product ID generating log messages to match:type=uint32 format: int64
name (optional)
String desc=message name to match
code (optional)
Long desc=message code to match:type=uint64 format: int64
level (optional)
String desc=the level of severity to match:type=enum
Enum:
critical
error
warn
note
info
vnet (optional)
String desc=VNET to match:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
user (optional)
String desc=username to match:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
port (optional)
Long desc=port to match:type=uint32 format: int64
vlan (optional)
Integer desc=VLAN to match:type=uint16:range=[0,4095] format: int32
vxlan (optional)
String desc=VXLAN to match
args (optional)
String desc=arguments to match:filter=false
message (optional)
String desc=the message to match:filter=false
reverse (optional)
Boolean desc=reverse the order of the messages:requires=[starting-point,length,count]
end-time (optional)
String desc=end time to match:date=yyyy-mm-ddThh:mm:ss
program (optional)
String desc=name of the program used to generate log messages
remote_switch (optional)
String desc=remote switch node to match:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=name:api-ref-val=name
switch (optional)
String desc=switch to collect log events:filter=false
length (optional)
Long desc=message length to match:type=uint64:requires=[starting-point,count] format: int64
client-pid (optional)
Long desc=product ID to match:type=uint32 format: int64
starting-point (optional)
Long desc=message starting point to match:type=uint64:requires=[length,count] format: int64
client-addr (optional)
String desc=client IP address to match:type=IPv4 or IPv6 address
show-time (optional)
String desc=the time that the message appeared:filter=false
start-time (optional)
String desc=start-time to match:date=yyyy-mm-ddThh:mm:ss
bd (optional)
String desc=Bridge Domain to match:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

log-session-show-response - Up

log-system-counters-reset - Up

resets the log counters
reset-time
String desc=reset time

log-system-counters-show - Up

display the log counters
api.switch-name (optional)
critical (optional)
Long desc=critical logs:type=uint32:filter=false format: int64
error (optional)
Long desc=error logs:type=uint32:filter=false format: int64
warn (optional)
Long desc=warn logs:type=uint32:filter=false format: int64
note (optional)
Long desc=note logs:type=uint32:filter=false format: int64
info (optional)
Long desc=info logs:type=uint32:filter=false format: int64
reset-time (optional)
String desc=reset time:filter=false

log-system-counters-show-response - Up

log-system-show - Up

display information about system logs
api.switch-name (optional)
duration (optional)
Long desc=duration to match format: int64
time (optional)
String desc=time of the event:filter=false
pid (optional)
Long desc=product ID generating log messages to match:type=uint32 format: int64
name (optional)
String desc=message name to match
code (optional)
Long desc=message code to match:type=uint64 format: int64
level (optional)
String desc=the level of severity to match:type=enum
Enum:
critical
error
warn
note
info
vnet (optional)
String desc=VNET to match:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
user (optional)
String desc=username to match:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
port (optional)
Long desc=port to match:type=uint32 format: int64
vlan (optional)
Integer desc=VLAN to match:type=uint16:range=[0,4095] format: int32
vxlan (optional)
String desc=VXLAN to match
args (optional)
String desc=arguments to match:filter=false
message (optional)
String desc=the message to match:filter=false
reverse (optional)
Boolean desc=reverse the order of the messages:requires=[starting-point,length,count]
end-time (optional)
String desc=end time to match:date=yyyy-mm-ddThh:mm:ss
program (optional)
String desc=name of the program used to generate log messages
remote_switch (optional)
String desc=remote switch node to match:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=name:api-ref-val=name
switch (optional)
String desc=switch to collect log events:filter=false
length (optional)
Long desc=message length to match:type=uint64:requires=[starting-point,count] format: int64
client-pid (optional)
Long desc=product ID to match:type=uint32 format: int64
starting-point (optional)
Long desc=message starting point to match:type=uint64:requires=[length,count] format: int64
client-addr (optional)
String desc=client IP address to match:type=IPv4 or IPv6 address
show-time (optional)
String desc=the time that the message appeared:filter=false
start-time (optional)
String desc=start-time to match:date=yyyy-mm-ddThh:mm:ss
bd (optional)
String desc=Bridge Domain to match:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

log-system-show-response - Up

mac-limit-modify - Up

Update mac-limit on a port
mac-limit (optional)
Long desc=maximum mac addresses that can be learnt on the port:type=uint32 format: int64
mac-limit-action (optional)
String desc=action to take when mac-limit is exceeded on a port:type=enum:default=log
Enum:
log
disable

mac-limit-show - Up

Show mac-limit on a port
api.switch-name (optional)
port
String desc=physical port or trunk-id:type=port-list
num-macs (optional)
Long desc=macs learnt on port:type=uint32 format: int64
mac-limit (optional)
Long desc=maximum mac addresses that can be learnt on the port:type=uint32 format: int64
mac-limit-action (optional)
String desc=action to take when mac-limit is exceeded on a port:type=enum
Enum:
log
disable

mac-limit-show-response - Up

mac-pool-show - Up

display mac pool
api.switch-name (optional)
name (optional)
String desc=MAC pool

mac-pool-show-response - Up

mcast-show - Up

display multicast group information
api.switch-name (optional)
group-ports
String desc=ports:type=port-list:filter=false
vlan (optional)
Integer desc=VLAN:type=uint16:range=[0,4095]:filter=false format: int32
group-id (optional)
Integer desc=group ID:filter=false format: int32
group-ip (optional)
String desc=group IP address:type=IPv4 or IPv6 address
vnet-id (optional)
String desc=group VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=group Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

mcast-show-response - Up

mgmt-session-show - Up

show current user information
api.switch-name (optional)
user
String desc=User name
pid (optional)
Integer desc=process ID format: int32
terminal (optional)
String desc=Terminal ID
vnet (optional)
String desc=User VNET
cli-user (optional)
String desc=CLI session user name
from-ip (optional)
String desc=User source IP:type=IPv4 or IPv6 address
login-time (optional)
String desc=User login time:date=yyyy-mm-ddThh:mm:ss
type (optional)
String desc=Session type:type=enum
Enum:
cli
api
shell
remote-node (optional)
String desc=Remote node name for proxy sessions

mgmt-session-show-response - Up

mirror-create - Up

create mirrored ports and flows
name
String desc=mirror name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
filtering (optional)
String desc=filter traffic policy:type=enum:default=port
Enum:
port
vflow-and-port
vflow-or-port
enable (optional)
Boolean desc=mirror state - default enable:default=true
span-remote-ip (optional)
String desc=remote IP v4 address:type=IPv4 or IPv6 address
out-port (optional)
String desc=outgoing traffic port:type=port-list:precludes=[out-trunk]
span-local-ip (optional)
String desc=local IP v4 address:type=IPv4 or IPv6 address
direction (optional)
String desc=direction of mirrored traffic:type=enum:default=ingress
Enum:
ingress
egress
bidirection
out-trunk (optional)
Long desc=outgoing traffic trunk:type=uint32:precludes=[out-port]:api-ref-path=/trunks:api-ref-model=trunk-show:api-ref-id=trunk-id:api-ref-val=name format: int64
in-port (optional)
String desc=Port(s) to mirror traffic from:type=port-list
other-egress-out (optional)
Boolean desc=allow other traffic out - default prevent:default=false
span-encap (optional)
String desc=mirror span type - default none:type=enum:default=none
Enum:
none
over-ip
over-vlan
span-src-mac (optional)
String desc=source MAC address for the span:type=mac-address
span-dst-mac (optional)
String desc=destination MAC address for the span:type=mac-address
span-tagging-vlan (optional)
Integer desc=mirror span vlan tagging ID - default none:type=uint16:range=[1,4095] format: int32
span-tos (optional)
Integer desc=mirror span tos - default none:type=uint8:range=[0,255] format: int32
nvie-mirror (optional)
Boolean desc=Mark this mirror as NVIE mirror, used to mirror traffic to NVIE VM.:default=false

mirror-modify - Up

modify mirrored ports and flows
filtering (optional)
String desc=filter traffic policy:type=enum:default=port
Enum:
port
vflow-and-port
vflow-or-port
enable (optional)
Boolean desc=mirror state - default enable:default=true
span-remote-ip (optional)
String desc=remote IP v4 address:type=IPv4 or IPv6 address
out-port (optional)
String desc=outgoing traffic port:type=port-list:precludes=[out-trunk]
span-local-ip (optional)
String desc=local IP v4 address:type=IPv4 or IPv6 address
direction (optional)
String desc=direction of mirrored traffic:type=enum:default=ingress
Enum:
ingress
egress
bidirection
out-trunk (optional)
Long desc=outgoing traffic trunk:type=uint32:precludes=[out-port]:api-ref-path=/trunks:api-ref-model=trunk-show:api-ref-id=trunk-id:api-ref-val=name format: int64
in-port (optional)
String desc=Port(s) to mirror traffic from:type=port-list
other-egress-out (optional)
Boolean desc=allow other traffic out - default prevent:default=false
span-encap (optional)
String desc=mirror span type - default none:type=enum:default=none
Enum:
none
over-ip
over-vlan
span-src-mac (optional)
String desc=source MAC address for the span:type=mac-address
span-dst-mac (optional)
String desc=destination MAC address for the span:type=mac-address
span-tagging-vlan (optional)
Integer desc=mirror span vlan tagging ID - default none:type=uint16:range=[1,4095] format: int32
span-tos (optional)
Integer desc=mirror span tos - default none:type=uint8:range=[0,255] format: int32
nvie-mirror (optional)
Boolean desc=Mark this mirror as NVIE mirror, used to mirror traffic to NVIE VM.:default=false

mirror-show - Up

display mirrored ports and flows
api.switch-name (optional)
name
String desc=mirror name
id (optional)
String desc=mirror ID:type=identifier
filtering (optional)
String desc=filter traffic policy:type=enum
Enum:
port
vflow-and-port
vflow-or-port
enable (optional)
Boolean desc=mirror state - default enable
loopback-port (optional)
Long desc=loopback port for mirrored traffic:type=uint32 format: int64
span-remote-ip (optional)
String desc=remote IP v4 address:type=IPv4 or IPv6 address
out-port (optional)
String desc=outgoing traffic port:type=port-list:precludes=[out-trunk]
span-local-ip (optional)
String desc=local IP v4 address:type=IPv4 or IPv6 address
direction (optional)
String desc=direction of mirrored traffic:type=enum
Enum:
ingress
egress
bidirection
out-trunk (optional)
Long desc=outgoing traffic trunk:type=uint32:precludes=[out-port]:api-ref-path=/trunks:api-ref-model=trunk-show:api-ref-id=trunk-id:api-ref-val=name format: int64
in-port (optional)
String desc=Port(s) to mirror traffic from:type=port-list
other-egress-out (optional)
Boolean desc=allow other traffic out - default prevent
span-encap (optional)
String desc=mirror span type - default none:type=enum
Enum:
none
over-ip
over-vlan
span-src-mac (optional)
String desc=source MAC address for the span:type=mac-address
span-dst-mac (optional)
String desc=destination MAC address for the span:type=mac-address
span-tagging-vlan (optional)
Integer desc=mirror span vlan tagging ID - default none:type=uint16:range=[1,4095] format: int32
span-tos (optional)
Integer desc=mirror span tos - default none:type=uint8:range=[0,255] format: int32
nvie-mirror (optional)
Boolean desc=Mark this mirror as NVIE mirror, used to mirror traffic to NVIE VM.

mirror-show-response - Up

mld-router-show - Up

display IPv6 Multicast routers on the network
api.switch-name (optional)
node-ip
String desc=Host IP address:type=IPv4 or IPv6 address
vxlan (optional)
Long desc=Host VXLAN:type=uint32:range=[0,16777215]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
vlan (optional)
Integer desc=Host VLAN:type=uint16:range=[0,4095] format: int32
port (optional)
Long desc=Switch port:type=uint32 format: int64
tunnel (optional)
String desc=tunnel name
vnet-id (optional)
String desc=Host VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Host Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

mld-router-show-response - Up

mld-show - Up

display MLD group membership information on the network
api.switch-name (optional)
node-ip
String desc=Host IP address:type=IPv4 or IPv6 address
vxlan (optional)
Long desc=Host VXLAN:type=uint32:range=[0,16777215]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
vlan (optional)
Integer desc=Host VLAN:type=uint16:range=[0,4095] format: int32
port (optional)
Long desc=Switch port:type=uint32 format: int64
tunnel (optional)
String desc=tunnel name
source (optional)
String desc=Multicast traffic source:type=IPv4 or IPv6 address
group-ip (optional)
String desc=Multicast Group IP address:type=IPv4 or IPv6 address
node-type (optional)
String desc=Host/Router/Switch:type=enum
Enum:
host
router
switch
loopback
tunnel
expires (optional)
Long desc=Ageout time format: int64
vnet-id (optional)
String desc=Host VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Host Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

mld-show-response - Up

mld-snooping-modify - Up

enables or disables Multicast Listener Discovery (MLD) snooping
scope (optional)
String desc=mld snooping scope - fabric or local:type=enum
Enum:
local
fabric
enable (optional)
Boolean desc=enable or disable MLD snooping:default=false
mldv1-vlans (optional)
String desc=VLANs on which to enable snooping and use MLDv1 protocol:type=vlan-list:default=none
mldv2-vlans (optional)
String desc=VLANs on which to enable snooping and use MLDv2 protocol:type=vlan-list:default=1-4092
snoop-linklocal-vlans (optional)
String desc=Allow snooping of link-local groups(ff02::/16) on these vlans:type=vlan-list:default=none
query-interval (optional)
Integer desc=MLD query interval in seconds:type=uint8:range=[1,255]:default=60 format: int32
query-max-response-time (optional)
Integer desc=maximum response time, in seconds, advertised in MLD queries:type=uint8:range=[1,255]:default=10 format: int32
snoop-nd-vlans (optional)
String desc=Allow snooping of ND SN Multicast addresses (ff02::1:ff/104) on these vlans:type=vlan-list:default=none

mld-snooping-show - Up

display information about Multicast Listener Discovery (MLD) snooping
api.switch-name (optional)
scope (optional)
String desc=mld snooping scope - fabric or local:type=enum:filter=false
Enum:
local
fabric
enable (optional)
Boolean desc=enable or disable MLD snooping
vlans (optional)
String desc=v1 and v2 vlans minus any nvOS managed vlans on which snooping is enabled:type=vlan-list
nvOS-managed-vlans (optional)
String desc=nvOS managed VLANs:type=vlan-list
interop-v1-vlans (optional)
String desc=vlans degraded to v1 due to v1 query received:type=vlan-list
mldv1-vlans (optional)
String desc=VLANs on which to enable snooping and use MLDv1 protocol:type=vlan-list
mldv2-vlans (optional)
String desc=VLANs on which to enable snooping and use MLDv2 protocol:type=vlan-list
snoop-linklocal-vlans (optional)
String desc=Allow snooping of link-local groups(ff02::/16) on these vlans:type=vlan-list
query-interval (optional)
Integer desc=MLD query interval in seconds:type=uint8:range=[1,255] format: int32
query-max-response-time (optional)
Integer desc=maximum response time, in seconds, advertised in MLD queries:type=uint8:range=[1,255] format: int32
snoop-nd-vlans (optional)
String desc=Allow snooping of ND SN Multicast addresses (ff02::1:ff/104) on these vlans:type=vlan-list

mld-snooping-show-response - Up

mld-static-group-create - Up

creates a static MLD multicast group on the interface
vlan
Integer desc=static IGMP group VLAN:type=uint16:range=[0,4095] format: int32
group-ip
String desc=static IGMP group IP address:type=IPv4 or IPv6 address
ports
String desc=static IGMP group ports:type=port-list

mld-static-group-show - Up

display a static MLD group on the network
api.switch-name (optional)
vlan
Integer desc=static IGMP group VLAN:type=uint16:range=[0,4095] format: int32
group-ip
String desc=static IGMP group IP address:type=IPv4 or IPv6 address
ports (optional)
String desc=static IGMP group ports:type=port-list

mld-static-group-show-response - Up

mld-static-source-create - Up

creates a static (Source, Group) Join entry for multicast traffic
vlan
Integer desc=static IGMP source VLAN:type=uint16:range=[0,4095] format: int32
group-ip
String desc=static IGMP source IP address:type=IPv4 or IPv6 address
source-ip
String desc=static IGMP source IP address:type=IPv4 or IPv6 address
ports (optional)
String desc=ports:type=port-list
vnet-id (optional)
String desc=static IGMP source VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=static IGMP source Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

mld-static-source-show - Up

displays a static (Source, Group) entry
api.switch-name (optional)
vlan
Integer desc=static IGMP source VLAN:type=uint16:range=[0,4095] format: int32
group-ip
String desc=static IGMP source IP address:type=IPv4 or IPv6 address
source-ip
String desc=static IGMP source IP address:type=IPv4 or IPv6 address
ports (optional)
String desc=ports:type=port-list
vnet-id (optional)
String desc=static IGMP source VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=static IGMP source Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

mld-static-source-show-response - Up

mld-stats-show - Up

display MLD statistics
api.switch-name (optional)
vlan (optional)
Integer desc=MLD VLAN:type=uint16:range=[0,4095] format: int32
drops (optional)
Long desc=number of MLD dropped events:type=uint64:filter=false format: int64
ignored (optional)
Long desc=number of MLD events ignored:type=uint64:filter=false format: int64
v2-queries (optional)
Long desc=number of MLDv2 queries:type=uint64:filter=false format: int64
v1-member-reports (optional)
Long desc=number of MLDv1 member reports:type=uint64:filter=false format: int64
v2-member-reports (optional)
Long desc=number of MLDv2 member reports:type=uint64:filter=false format: int64
queries-sent (optional)
Long desc=number of MLD queries-sent:type=uint64:filter=false format: int64
v1-queries (optional)
Long desc=number of MLDv1 queries:type=uint64:filter=false format: int64
done-group (optional)
Long desc=number of MLD Done group events:type=uint64:filter=false format: int64

mld-stats-show-response - Up

mld-switches-show - Up

display MLD Snooping Switches on the network
api.switch-name (optional)
node-ip
String desc=Host IP address:type=IPv4 or IPv6 address
vxlan (optional)
Long desc=Host VXLAN:type=uint32:range=[0,16777215]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
vlan (optional)
Integer desc=Host VLAN:type=uint16:range=[0,4095] format: int32
port (optional)
Long desc=Switch port:type=uint32 format: int64
tunnel (optional)
String desc=tunnel name
vnet-id (optional)
String desc=Host VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Host Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

mld-switches-show-response - Up

mst-config-create - Up

Create MST Instance
instance-id
Long desc=ID for mst configuration:type=uint32:range=[0,64] format: int64
bridge-priority (optional)
Long desc=Bridge Priority for mst instance - Multiples of 4096:type=uint64:range=[0,61440] format: int64
vlans (optional)
String desc=Vlans associated mst configuration:type=vlan-list

mst-config-modify - Up

Update MST Instance
bridge-priority (optional)
Long desc=Bridge Priority for mst instance - Multiples of 4096:type=uint64:range=[0,61440] format: int64
vlans (optional)
String desc=Vlans associated mst configuration:type=vlan-list

mst-config-show - Up

Display MST Instance
api.switch-name (optional)
instance-id
Long desc=ID for mst configuration:type=uint32:range=[0,64] format: int64
bridge-priority (optional)
Long desc=Bridge Priority for mst instance - Multiples of 4096:type=uint64:range=[0,61440] format: int64
vlans (optional)
String desc=Vlans associated mst configuration:type=vlan-list

mst-config-show-response - Up

node-show - Up

display information about all nodes on the network
api.switch-name (optional)
serial (optional)
String desc=node serial number
name (optional)
String desc=node name:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=name:api-ref-val=name
state (optional)
String desc=fabric state:type=enum
Enum:
offline
online
in-band-only-online
mgmt-only-online
vmgmt-only-online
offline(evicted)
online(joined)
eula-required
setup-required
fabric-required
fresh-install
vmgmt-assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[mgmt-linklocal]
Enum:
none
dhcp
dhcpv6
vmgmt-mac (optional)
String desc=interface MAC address:type=mac-address
vmgmt-public-vlan (optional)
Integer desc=interface public VLAN:type=uint16:range=[0,4095] format: int32
vmgmt-vrf (optional)
String desc=name of vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
vmgmt-sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32
in-band-ip2 (optional)
String desc=Second IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask2]:precludes=[mgmt-assignment2]
in-band-netmask2 (optional)
Integer desc=Second IP netmask:type=netmask:requires=[mgmt-ip2]:precludes=[mgmt-assignment2]:mask-for=[mgmt-ip2] format: int32
in-band-assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[mgmt-ip2,mgmt-netmask2]
Enum:
none
dhcp
dhcpv6
in-band-assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[mgmt-linklocal]
Enum:
none
dhcp
dhcpv6
in-band-mac (optional)
String desc=interface MAC address:type=mac-address
in-band-public-vlan (optional)
Integer desc=interface public VLAN:type=uint16:range=[0,4095] format: int32
in-band-vrf (optional)
String desc=name of vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
in-band-sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32
firmware-upgrade (optional)
String desc=firmware upgrade status:type=enum
device-state (optional)
String desc=device state:type=enum
keepalive-timeout (optional)
Long desc=keepalive timeout format: int64
rollforward-failed (optional)
Boolean desc=roll-forward status of this node
version (optional)
String desc=nvOS version
mgmt-ip2 (optional)
String desc=Second IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask2]:precludes=[mgmt-assignment2]
mgmt-netmask2 (optional)
Integer desc=Second IP netmask:type=netmask:requires=[mgmt-ip2]:precludes=[mgmt-assignment2]:mask-for=[mgmt-ip2] format: int32
mgmt-assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[mgmt-ip2,mgmt-netmask2]
Enum:
none
dhcp
dhcpv6
mgmt-ipv6-unnumbered (optional)
Boolean desc=IPv6 address is LinkLocal only:requires=[mgmt-l3-port]
mgmt-assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[mgmt-linklocal]
Enum:
none
dhcp
dhcpv6
mgmt-mac (optional)
String desc=interface MAC address:type=mac-address
mgmt-public-vlan (optional)
Integer desc=interface public VLAN:type=uint16:range=[0,4095] format: int32
mgmt-vrf (optional)
String desc=name of vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
mgmt-sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32
vmgmt-ip2 (optional)
String desc=Second IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask2]:precludes=[mgmt-assignment2]
vmgmt-netmask2 (optional)
Integer desc=Second IP netmask:type=netmask:requires=[mgmt-ip2]:precludes=[mgmt-assignment2]:mask-for=[mgmt-ip2] format: int32
vmgmt-assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[mgmt-ip2,mgmt-netmask2]
Enum:
none
dhcp
dhcpv6
vmgmt-ipv6-unnumbered (optional)
Boolean desc=IPv6 address is LinkLocal only:requires=[mgmt-l3-port]
control-network (optional)
String desc=control plane network:type=enum
Enum:
in-band
mgmt
vmgmt
id (optional)
Long desc=ID assigned to node:type=uint32 format: int64
location-id (optional)
Long desc=location ID assigned to fabric node:type=uint32 format: int64
fab-name (optional)
String desc=fabric name
fab-id (optional)
String desc=ID assigned to fabric:type=identifier
cluster-id (optional)
String desc=ID assigned to cluster:type=identifier
local-mac (optional)
String desc=local MAC address:type=mac-address
fabric-network (optional)
String desc=network fabric:type=enum
Enum:
in-band
mgmt
vmgmt
mgmt-ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask]:precludes=[mgmt-assignment]
mgmt-netmask (optional)
Integer desc=netmask:type=netmask:requires=[mgmt-ip]:precludes=[mgmt-assignment]:mask-for=[mgmt-ip] format: int32
mgmt-linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
mgmt-vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
mgmt-secondary-macs (optional)
String desc=secondary MAC addresses
mgmt-if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
mgmt-wake-on-lan (optional)
Boolean desc=wake on lan
vmgmt-ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask]:precludes=[mgmt-assignment]
vmgmt-netmask (optional)
Integer desc=netmask:type=netmask:requires=[mgmt-ip]:precludes=[mgmt-assignment]:mask-for=[mgmt-ip] format: int32
vmgmt-linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
vmgmt-vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
vmgmt-vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[mgmt-alias-on] format: int32
vmgmt-secondary-macs (optional)
String desc=secondary MAC addresses
vmgmt-wake-on-lan (optional)
Boolean desc=wake on lan
in-band-ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask]:precludes=[mgmt-assignment]
in-band-netmask (optional)
Integer desc=netmask:type=netmask:requires=[mgmt-ip]:precludes=[mgmt-assignment]:mask-for=[mgmt-ip] format: int32
in-band-linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
in-band-vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
in-band-bd (optional)
String desc=interface Bridge Domain:precludes=[mgmt-alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
in-band-vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[mgmt-alias-on] format: int32
in-band-vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[mgmt-vlan]:precludes=[mgmt-vnet-id]
Enum:
public
private
in-band-secondary-macs (optional)
String desc=secondary MAC addresses
in-band-if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
in-band-wake-on-lan (optional)
Boolean desc=wake on lan
fab-tid (optional)
Long desc=fabric transaction ID:type=uint64 format: int64
cluster-tid (optional)
Long desc=cluster transaction ID:type=uint64 format: int64
out-port (optional)
Long desc=fabric outgoing port:type=uint32 format: int64
ports (optional)
Long desc=ports:type=uint32 format: int64

node-show-response - Up

nv-queue-mirror-modify - Up

Enable/disable queue packet mirroring
status (optional)
String desc=status of mirroring for the queue:type=enum:default=disable
Enum:
disable
enable

nv-queue-mirror-show - Up

Show the packet mirroring setting for a queue
api.switch-name (optional)
name
String desc=name of the queue:api-ref-path=/nv-queue-pkt-mirror-lists:api-ref-model=nv-queue-pkt-mirror-list-show:api-ref-id=name:api-ref-val=name
status (optional)
String desc=status of mirroring for the queue:type=enum
Enum:
disable
enable

nv-queue-mirror-show-response - Up

nv-queue-stats-clear - Up

clear internal queue statistics
name (optional)
String desc=name of the queue:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/nv-queue-stats-lists:api-ref-model=nv-queue-stats-list-show:api-ref-id=name:api-ref-val=name

nv-queue-stats-settings-modify - Up

modify the settings for internal queue statistics
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

nv-queue-stats-settings-show - Up

display the settings for internal queue statistics
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

nv-queue-stats-settings-show-response - Up

nv-queue-stats-show - Up

display internal queue statistics
api.switch-name (optional)
name
String desc=name of the queue:api-ref-path=/nv-queue-stats-lists:api-ref-model=nv-queue-stats-list-show:api-ref-id=name:api-ref-val=name
q-delay-avg (optional)
Long desc=average sampled delay from insertion to removal format: int64
q-pts-39 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 39) format: int64
q-pts-4 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 4) format: int64
q-high (optional)
Long desc=highest count in queue:type=uint32 format: int64
q-pts-7 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 7) format: int64
q-pts-16 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 16) format: int64
q-pts-25 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 25) format: int64
q-pts-12 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 12) format: int64
q-pts-5 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 5) format: int64
q-max (optional)
Long desc=maximum queue size:type=uint32 format: int64
q-pts-11 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 11) format: int64
q-in (optional)
Long desc=number of items inserted into queue:type=uint64 format: int64
q-pts-15 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 15) format: int64
q-pts-14 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 14) format: int64
q-pts-10 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 10) format: int64
q-pts-26 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 26) format: int64
q-pts-1 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 1) format: int64
q-pts-2 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 2) format: int64
q-pts-22 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 22) format: int64
q-pts-43 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 43 format: int64
q-pts-13 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 13) format: int64
q-pts-18 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 18) format: int64
q-low (optional)
Long desc=lowest count in queue:type=uint32 format: int64
q-pts-3 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 3) format: int64
q-pts-42 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 42) format: int64
q-pts-33 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 33 format: int64
q-pts-29 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 29) format: int64
q-pts-31 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 31) format: int64
q-pts-19 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 19) format: int64
q-pts-20 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 20) format: int64
q-pts-44 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 44) format: int64
q-pts-41 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 41) format: int64
q-pts-24 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 24) format: int64
q-delay-samples (optional)
Long desc=number of delay samples queue:type=uint64 format: int64
q-pts-8 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 8) format: int64
q-out (optional)
Long desc=number of items removed from queue:type=uint64 format: int64
q-pts-9 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 9) format: int64
q-pts-27 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 27) format: int64
q-pts-23 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 23 format: int64
q-pts-21 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 21) format: int64
q-pts-37 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 37) format: int64
q-pts-0 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 0) format: int64
q-pts-6 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 6) format: int64
q-pts-35 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 35) format: int64
q-pts-32 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 32) format: int64
q-pts-36 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 36) format: int64
q-pts-34 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 34) format: int64
q-pts-30 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 30) format: int64
q-underflow (optional)
Long desc=allocation failed because queue was empty:type=uint64 format: int64
q-pts-28 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 28) format: int64
q-delay-high (optional)
Long desc=highest delay from insertion to removal format: int64
q-overflow (optional)
Long desc=insertion failed because queue was full:type=uint64 format: int64
q-pts-38 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 38) format: int64
q-pts-17 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 17) format: int64
q-pts-40 (optional)
Long desc=corresponds to code line NVOS_PKTPROC_TIME(, 40) format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

nv-queue-stats-show-response - Up

object-location-modify - Up

Change all fabric objects location from one node to another
new-location
Long desc=new location:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64

object-location-show - Up

Show objects at a location
api.switch-name (optional)
location
Long desc=current location:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
type (optional)
String desc=object type
name (optional)
String desc=object name
new-location (optional)
Long desc=new location:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64

object-location-show-response - Up

openvswitch-create - Up

create an OpenvSwitch configuration
tunnel-ip
String desc=tunnel ip address:type=IPv4 or IPv6 address
name
String desc=name of service config:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter
vnet
String desc=vnet assigned to service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[scope]:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
bfd (optional)
Boolean desc=configure BFD for OVSDB created tunnels:default=false
gateway (optional)
String desc=gateway IP address for service:type=IPv4 or IPv6 address
vnet-service (optional)
Boolean desc=service as dedicated or shared
shared-vnet-mgr (optional)
String desc=vnet-manager to share with if shared service:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter:api-ref-path=/vnet-managers:api-ref-model=vnet-manager-show:api-ref-id=name:api-ref-val=name
global-vtep (optional)
Boolean desc=hardware vtep associated with openvswitch:default=false
cert-name (optional)
String desc=Certificate name for SSL connections
cert-location (optional)
String desc=Certificate location - global or within container:type=enum:default=global
Enum:
none
global
container
ca-cert-name (optional)
String desc=CA Certificate name for SSL connections:requires=[cert-name]
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name

openvswitch-hwvtep-manager-add - Up

Add vtep manager
ip
String desc=manager IP address:type=IPv4 or IPv6 address
username (optional)
String desc=manager username:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[password]
password (optional)
String desc=manager password:password=true:requires=[username]
port (optional)
Integer desc=manager port:default=6640 format: int32
connection-method (optional)
String desc=connection method:type=enum:default=tcp
Enum:
unix-socket
tcp
unix-socket-listen
tcp-listen
ssl
default
auto-service-binding (optional)
Boolean desc=Hardware VTEP service binding for NSX:default=false
manager-type (optional)
String desc=manager type:type=enum:default=odl
Enum:
odl
nsx

openvswitch-hwvtep-manager-show - Up

display information about ovs hwvtep managers
api.switch-name (optional)
ip
String desc=manager IP address:type=IPv4 or IPv6 address
username (optional)
String desc=manager username:requires=[password]
port (optional)
Integer desc=manager port format: int32
status (optional)
String desc=controller status
controller-ip (optional)
String desc=controller IP address:type=IPv4 or IPv6 address
connection-method (optional)
String desc=connection method:type=enum
Enum:
unix-socket
tcp
unix-socket-listen
tcp-listen
ssl
default
auto-service-binding (optional)
Boolean desc=Hardware VTEP service binding for NSX
manager-type (optional)
String desc=manager type:type=enum
Enum:
odl
nsx

openvswitch-hwvtep-manager-show-response - Up

openvswitch-interface-add - Up

add an interface to OVS
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
exclusive (optional)
Boolean desc=exclusive interface:default=false:precludes=[l3-port]
assignment (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip,netmask]
Enum:
none
dhcp
dhcpv6
vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[vlan]:precludes=[vnet-id]
Enum:
public
private
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan :default=false
vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
if (optional)
String desc=interface type:type=enum:precludes=[alias-on]
Enum:
mgmt
data
span
span2
span3
alias-on (optional)
String desc=alias name:precludes=[vlan,if,nic]
nic-config (optional)
Boolean desc=NIC config:default=true
vrrp-id (optional)
Long desc=ID assigned to VRRP:type=uint32:range=[0,255]:requires=[vrrp-primary] format: int64
vrrp-primary (optional)
String desc=VRRP primary interface
vrrp-adv-int (optional)
Integer desc=VRRP Advertisement Interval (ms, min 300, max 40950, default 1000):type=uint16:range=[300,40950] format: int32
vrrp-preempt-mode (optional)
String desc=Used to allow/prevent high prio BACKUP from becoming MASTER:type=enum:default=enable
Enum:
disable
enable
secondary-macs (optional)
String desc=secondary MAC addresses:pattern=^[a-fA-F0-9:,]+$|^none$|^$
if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
priority-tag (optional)
Boolean desc=Add priority tag on forwarded traffic:default=false

openvswitch-interface-modify - Up

modify an OVS interface
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
exclusive (optional)
Boolean desc=exclusive interface:default=false:precludes=[l3-port]
assignment (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip,netmask]
Enum:
none
dhcp
dhcpv6
vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[vlan]:precludes=[vnet-id]
Enum:
public
private
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan :default=false
vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
if (optional)
String desc=interface type:type=enum:precludes=[alias-on]
Enum:
mgmt
data
span
span2
span3
alias-on (optional)
String desc=alias name:precludes=[vlan,if,nic]
nic-config (optional)
Boolean desc=NIC config:default=true
vrrp-primary (optional)
String desc=VRRP primary interface
vrrp-adv-int (optional)
Integer desc=VRRP Advertisement Interval (ms, min 300, max 40950, default 1000):type=uint16:range=[300,40950] format: int32
vrrp-preempt-mode (optional)
String desc=Used to allow/prevent high prio BACKUP from becoming MASTER:type=enum:default=enable
Enum:
disable
enable
secondary-macs (optional)
String desc=secondary MAC addresses:pattern=^[a-fA-F0-9:,]+$|^none$|^$
if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
priority-tag (optional)
Boolean desc=Add priority tag on forwarded traffic:default=false

openvswitch-interface-show - Up

display information about OVS interfaces
api.switch-name (optional)
nic
String desc=virtual NIC assigned to interface
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
ip2 (optional)
String desc=Second IP address:type=IPv4 or IPv6 address:requires=[netmask2]:precludes=[assignment2]
netmask2 (optional)
Integer desc=Second IP netmask:type=netmask:requires=[ip2]:precludes=[assignment2]:mask-for=[ip2] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
mac (optional)
String desc=interface MAC address:type=mac-address
exclusive (optional)
Boolean desc=exclusive interface:precludes=[l3-port]
vrf (optional)
String desc=name of vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
public-vlan (optional)
Integer desc=interface public VLAN:type=uint16:range=[0,4095] format: int32
nic-state (optional)
String desc=NIC state:type=enum
Enum:
down
up
is-primary (optional)
Boolean desc=Primary VRRP interface
is-primary2 (optional)
Boolean desc=Primary VRRP interface for Second IP
is-vip (optional)
Boolean desc=VIP VRRP interface
pim-vlag-vlan (optional)
Boolean desc=VNIC is on a vlan with a VLAG
vrrp-state (optional)
String desc=state of VRRP:type=enum
Enum:
slave
master
assignment (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip,netmask]
Enum:
none
dhcp
dhcpv6
vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[vlan]:precludes=[vnet-id]
Enum:
public
private
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:precludes=[alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan
vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32
assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip2,netmask2]
Enum:
none
dhcp
dhcpv6
assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[linklocal]
Enum:
none
dhcp
dhcpv6
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32
if (optional)
String desc=interface type:type=enum:precludes=[alias-on]
Enum:
mgmt
data
span
span2
span3
alias-on (optional)
String desc=alias name:precludes=[vlan,if,nic]
nic-config (optional)
Boolean desc=NIC config
vrrp-id (optional)
Long desc=ID assigned to VRRP:type=uint32:range=[0,255]:requires=[vrrp-primary] format: int64
vrrp-primary (optional)
String desc=VRRP primary interface
vrrp-adv-int (optional)
Integer desc=VRRP Advertisement Interval (ms, min 300, max 40950, default 1000):type=uint16:range=[300,40950] format: int32
vrrp-preempt-mode (optional)
String desc=Used to allow/prevent high prio BACKUP from becoming MASTER:type=enum
Enum:
disable
enable
secondary-macs (optional)
String desc=secondary MAC addresses
if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
priority-tag (optional)
Boolean desc=Add priority tag on forwarded traffic

openvswitch-interface-show-response - Up

openvswitch-modify - Up

modify an OpenvSwitch configuration
bfd (optional)
Boolean desc=configure BFD for OVSDB created tunnels:default=false
gateway (optional)
String desc=gateway IP address for service:type=IPv4 or IPv6 address
tunnel-ip (optional)
String desc=tunnel ip address:type=IPv4 or IPv6 address
global-vtep (optional)
Boolean desc=hardware vtep associated with openvswitch:default=false
cert-name (optional)
String desc=Certificate name for SSL connections
cert-location (optional)
String desc=Certificate location - global or within container:type=enum:default=global
Enum:
none
global
container
ca-cert-name (optional)
String desc=CA Certificate name for SSL connections:requires=[cert-name]
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name

openvswitch-rest-config-create - Up

create openvswitch config for vRest
password
String desc=password for the given user name:password=true
user-name
String desc=username for vRest access:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
ip-address
String desc=IP address where vRest service is running:pattern=^[a-zA-Z0-9.-]*$:pattern-help=letters, numbers, ., -, and ''

openvswitch-rest-config-show - Up

display openvswitch config for vRest
api.switch-name (optional)
user-name
String desc=username for vRest access:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
ip-address (optional)
String desc=IP address where vRest service is running:filter=false

openvswitch-rest-config-show-response - Up

openvswitch-show - Up

display information about OpenvSwitch configurations
api.switch-name (optional)
name
String desc=name of service config
mode (optional)
String desc=current operating mode for openvswitch:type=enum
Enum:
standalone
master
slave
bfd (optional)
Boolean desc=configure BFD for OVSDB created tunnels
id (optional)
String desc=ID assigned to service:type=identifier
type (optional)
String desc=type of service:type=enum
Enum:
vnet-mgr
vrouter
netzone
orphaned
netvm
nat
ovs
scope (optional)
String desc=scope of service - fabric or local
Enum:
local
fabric
is-global (optional)
Boolean desc=service is global
state (optional)
String desc=state of service:type=enum:filter=false
Enum:
disable
enable
template (optional)
Boolean desc=template to load:filter=false:precludes=[load-template,scope,vnet]
failover-controller (optional)
Long desc=Switch coordinating the failover:type=uint32:filter=false format: int64
failover-action (optional)
String desc=Current state of the failover:type=enum:filter=false
Enum:
stop-old
start-new
restore-orig
sync
finished
db-conn-type (optional)
String desc=database connection type:type=enum
Enum:
unix-socket
tcp
unix-socket-listen
tcp-listen
ssl
default
db-ip (optional)
String desc=database IP address:type=IPv4 or IPv6 address
db-port (optional)
Integer desc=database port format: int32
db-socket (optional)
String desc=database socket
gateway (optional)
String desc=gateway IP address for service:type=IPv4 or IPv6 address:filter=false
tunnel-ip (optional)
String desc=tunnel ip address:type=IPv4 or IPv6 address
vnet (optional)
String desc=vnet assigned to service:precludes=[scope]:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vnet-service (optional)
Boolean desc=service as dedicated or shared:filter=false
shared-vnet-mgr (optional)
String desc=vnet-manager to share with if shared service:filter=false:api-ref-path=/vnet-managers:api-ref-model=vnet-manager-show:api-ref-id=name:api-ref-val=name
global-vtep (optional)
Boolean desc=hardware vtep associated with openvswitch
cert-name (optional)
String desc=Certificate name for SSL connections
cert-location (optional)
String desc=Certificate location - global or within container:type=enum
Enum:
none
global
container
ca-cert-name (optional)
String desc=CA Certificate name for SSL connections:requires=[cert-name]
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:filter=false:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name

openvswitch-show-response - Up

pn-script-run - Up

Run PN script
name
String desc=Script to execute:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

pn-script-show - Up

Show PN scripts
api.switch-name (optional)
name
String desc=Script to execute

pn-script-show-response - Up

pn-service-show-response - Up

pn-service-status-show - Up

Display status of split brain
api.switch-name (optional)
name (optional)
String desc=Service name:type=enum
Enum:
split-brain
status (optional)
String desc=Status of service:filter=false

port-association-create - Up

create a port state association
name
String desc=configuration name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
master-ports
String desc=master ports:type=port-list
slave-ports
String desc=slave ports:type=port-list
policy (optional)
String desc=port association policy - default all-masters:type=enum:default=all-masters
Enum:
all-masters
any-master
bidir (optional)
Boolean desc=bi-directional port state tracking:default=false
enable (optional)
Boolean desc=enable or disable port association in hardware:default=true
virtual-wire (optional)
Boolean desc=associated ports form a virtual wire:default=false
monitor-ports (optional)
String desc=monitor ports:type=port-list:requires=[virtual-wire]

port-association-modify - Up

update a port state association
policy (optional)
String desc=port association policy - default all-masters:type=enum:default=all-masters
Enum:
all-masters
any-master
bidir (optional)
Boolean desc=bi-directional port state tracking:default=false
enable (optional)
Boolean desc=enable or disable port association in hardware:default=true
master-ports (optional)
String desc=master ports:type=port-list
slave-ports (optional)
String desc=slave ports:type=port-list
virtual-wire (optional)
Boolean desc=associated ports form a virtual wire:default=false
monitor-ports (optional)
String desc=monitor ports:type=port-list:requires=[virtual-wire]

port-association-path-create - Up

create a port association path
name
String desc=path name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
topology
String desc=fabric topology name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/topologies:api-ref-model=topology-show:api-ref-id=name:api-ref-val=name
node1
Long desc=name for link node 1:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
node2
Long desc=name for link node 2:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
node1-port
Long desc=port on the node 1:type=uint32 format: int64
node2-port
Long desc=port on the node 2:type=uint32 format: int64

port-association-path-show - Up

display port association paths
api.switch-name (optional)
name
String desc=path name
topology (optional)
String desc=fabric topology name:api-ref-path=/topologies:api-ref-model=topology-show:api-ref-id=name:api-ref-val=name
node1 (optional)
Long desc=name for link node 1:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
node2 (optional)
Long desc=name for link node 2:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
status (optional)
String desc=path status:type=enum
Enum:
down
up
path (optional)
String desc=path string
node1-port (optional)
Long desc=port on the node 1:type=uint32 format: int64
node2-port (optional)
Long desc=port on the node 2:type=uint32 format: int64

port-association-path-show-response - Up

port-association-service-add - Up

add a port association service
inline-service
String desc=inline service name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/inline-services:api-ref-model=inline-service-show:api-ref-id=name:api-ref-val=name
policy-action
String desc=Service order in port assoc service:type=enum
Enum:
fail-open
fail-closed
order (optional)
Integer desc=Service order in port assoc service:range=[1,65535] format: int32

port-association-service-modify - Up

modify a port association service
order (optional)
Integer desc=Service order in port assoc service:range=[1,65535] format: int32
policy-action (optional)
String desc=Service order in port assoc service:type=enum
Enum:
fail-open
fail-closed

port-association-service-show - Up

display port association services
api.switch-name (optional)
inline-service
String desc=inline service name:api-ref-path=/inline-services:api-ref-model=inline-service-show:api-ref-id=name:api-ref-val=name
order (optional)
Integer desc=Service order in port assoc service:range=[1,65535] format: int32
policy-action (optional)
String desc=Service order in port assoc service:type=enum
Enum:
fail-open
fail-closed

port-association-service-show-response - Up

port-association-show - Up

display port state associations
api.switch-name (optional)
name
String desc=configuration name
policy (optional)
String desc=port association policy - default all-masters:type=enum
Enum:
all-masters
any-master
bidir (optional)
Boolean desc=bi-directional port state tracking
enable (optional)
Boolean desc=enable or disable port association in hardware
master-ports (optional)
String desc=master ports:type=port-list
slave-ports (optional)
String desc=slave ports:type=port-list
virtual-wire (optional)
Boolean desc=associated ports form a virtual wire
monitor-ports (optional)
String desc=monitor ports:type=port-list:requires=[virtual-wire]

port-association-show-response - Up

port-buffer-settings-modify - Up

modify settings for port buffering
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

port-buffer-settings-show - Up

display port buffering settings
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

port-buffer-settings-show-response - Up

port-buffer-show - Up

display information about port buffers
api.switch-name (optional)
port
String desc=port number:type=port-list
ingress-used-buf (optional)
Long desc=percentage of used ingress buffer:type=uint64:filter=false format: int64
ingress-used-buf-val (optional)
Long desc=ingress buffer used value:type=uint64:filter=false format: int64
egress-used-buf (optional)
Long desc=percentage of used egress buffer:type=uint64:filter=false format: int64
egress-used-buf-val (optional)
Long desc=egress buffer used value:type=uint64:filter=false format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

port-buffer-show-response - Up

port-bw-threshold-alert-modify - Up

modify port bandwidth threshold
bw-threshold
String desc=bandwidth threshold for corresponding port:default=0:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)

port-bw-threshold-alert-show - Up

display port and corresponding bandwidth threshold
api.switch-name (optional)
port
String desc=identity of port:type=port-list
bw-threshold (optional)
String desc=bandwidth threshold for corresponding port:filter=false

port-bw-threshold-alert-show-response - Up

port-bw-threshold-mon-int-modify - Up

update port bandwidth monitoring interval
monitor-interval (optional)
Long desc=The monitoring interval value in seconds:type=uint32:range=[10,300]:default=30 format: int64

port-bw-threshold-mon-int-show - Up

display port bandwidth monitoring interval
api.switch-name (optional)
monitor-interval (optional)
Long desc=The monitoring interval value in seconds:type=uint32:range=[10,300] format: int64

port-bw-threshold-mon-int-show-response - Up

port-config-modify - Up

modify a port configuration with port number
speed (optional)
Long desc=physical port speed:type=uint32 format: int64
autoneg (optional)
String desc=physical port autonegotiation:type=enum
Enum:
autoneg
no-autoneg
jumbo (optional)
String desc=jumbo frames on physical port:type=enum
Enum:
jumbo
no-jumbo
enable (optional)
String desc=physical port enable:type=enum:default=enable
Enum:
enable
disable
reflect (optional)
String desc=physical port reflection:type=enum:default=no-reflect
Enum:
reflect
no-reflect
pause (optional)
Boolean desc=physical port pause
description (optional)
String desc=physical port description
loopback (optional)
String desc=physical port loopback:type=enum:default=no-loopback
Enum:
no-loopback
loopback
remote-loopback
routing (optional)
Boolean desc=routing:default=true
fec (optional)
String desc=port forward error correction (FEC) mode:type=enum:default=no-fec
Enum:
fec
no-fec
defer-bringup (optional)
Boolean desc=defer port bringup
host-enable (optional)
Boolean desc=Host facing port control setting:default=true
crc-check (optional)
String desc=CRC check on ingress and rewrite on egress:type=enum:default=crc-check-enable
Enum:
crc-check-enable
crc-check-disable
dscp-map (optional)
String desc=DSCP map name to enable on port:api-ref-path=/dscp-maps:api-ref-model=dscp-map-show:api-ref-id=name:api-ref-val=name
local-switching (optional)
String desc=no-local-switching port cannot bridge traffic to another no-local-switching port:type=enum:default=local-switching
Enum:
local-switching
no-local-switching
allowed-tpid (optional)
String desc=Allowed TPID in addition to 0x8100 on Vlan header:type=flag
Enum:
vlan
q-in-q
q-in-q-old
fabric-guard (optional)
Boolean desc=Fabric guard configuration:default=false
port-mac-address (optional)
String desc=physical port MAC Address:type=mac-address
api.speed (optional)
Enum:
disable
10m
100m
1g
2.5g
10g
25g
40g
50g
100g
200g
400g
egress-rate-limit (optional)
Long desc=max egress port data rate limit:type=uint64 format: int64
api.egress-rate-limit (optional)
Enum:
unlimited
eth-mode (optional)
String desc=physical Ethernet mode:type=enum:default=sys-default
Enum:
1000base-x
sgmii
xlaui
gmii
sfi
xfi
cx
kr4
sr4
lr4
er4
cr4
cx4
kx4
caui4
kr2
er2
cr2
sr2
lr2
xlaui2
cx2
sr
lr
er
cr
kx
kr
zr
base-x
sys-default
caui
aoc
xlppi
psm4
base_t
base_cx
base_lx
base_sx
acc
lacp-priority (optional)
Long desc=LACP priority from 1 to 65535 - default 32768:type=uint32:range=[1,65535]:default=32768 format: int64
edge-switch (optional)
Boolean desc=physical port edge switch
vxlan-termination (optional)
String desc=physical port vxlan termination setting:type=enum:default=vxlan-termination
Enum:
vxlan-termination
no-vxlan-termination
receive-only (optional)
String desc=physical port mirror only:type=enum:default=no-mirror-receive-only
Enum:
mirror-only
no-mirror-receive-only
send-port (optional)
Long desc=send port:type=uint32 format: int64
loop-vlans (optional)
String desc=looping vlans:type=vlan-list

port-config-modify-1 - Up

modify a port configuration with port description
speed (optional)
Long desc=physical port speed:type=uint32 format: int64
autoneg (optional)
String desc=physical port autonegotiation:type=enum
Enum:
autoneg
no-autoneg
jumbo (optional)
String desc=jumbo frames on physical port:type=enum
Enum:
jumbo
no-jumbo
enable (optional)
String desc=physical port enable:type=enum:default=enable
Enum:
enable
disable
reflect (optional)
String desc=physical port reflection:type=enum:default=no-reflect
Enum:
reflect
no-reflect
pause (optional)
Boolean desc=physical port pause
description (optional)
String desc=physical port description
loopback (optional)
String desc=physical port loopback:type=enum:default=no-loopback
Enum:
no-loopback
loopback
remote-loopback
routing (optional)
Boolean desc=routing:default=true
fec (optional)
String desc=port forward error correction (FEC) mode:type=enum:default=no-fec
Enum:
fec
no-fec
defer-bringup (optional)
Boolean desc=defer port bringup
host-enable (optional)
Boolean desc=Host facing port control setting:default=true
crc-check (optional)
String desc=CRC check on ingress and rewrite on egress:type=enum:default=crc-check-enable
Enum:
crc-check-enable
crc-check-disable
dscp-map (optional)
String desc=DSCP map name to enable on port:api-ref-path=/dscp-maps:api-ref-model=dscp-map-show:api-ref-id=name:api-ref-val=name
local-switching (optional)
String desc=no-local-switching port cannot bridge traffic to another no-local-switching port:type=enum:default=local-switching
Enum:
local-switching
no-local-switching
allowed-tpid (optional)
String desc=Allowed TPID in addition to 0x8100 on Vlan header:type=flag
Enum:
vlan
q-in-q
q-in-q-old
fabric-guard (optional)
Boolean desc=Fabric guard configuration:default=false
port-mac-address (optional)
String desc=physical port MAC Address:type=mac-address
api.speed (optional)
Enum:
disable
10m
100m
1g
2.5g
10g
25g
40g
50g
100g
200g
400g
egress-rate-limit (optional)
Long desc=max egress port data rate limit:type=uint64 format: int64
api.egress-rate-limit (optional)
Enum:
unlimited
eth-mode (optional)
String desc=physical Ethernet mode:type=enum:default=sys-default
Enum:
1000base-x
sgmii
xlaui
gmii
sfi
xfi
cx
kr4
sr4
lr4
er4
cr4
cx4
kx4
caui4
kr2
er2
cr2
sr2
lr2
xlaui2
cx2
sr
lr
er
cr
kx
kr
zr
base-x
sys-default
caui
aoc
xlppi
psm4
base_t
base_cx
base_lx
base_sx
acc
lacp-priority (optional)
Long desc=LACP priority from 1 to 65535 - default 32768:type=uint32:range=[1,65535]:default=32768 format: int64
edge-switch (optional)
Boolean desc=physical port edge switch
vxlan-termination (optional)
String desc=physical port vxlan termination setting:type=enum:default=vxlan-termination
Enum:
vxlan-termination
no-vxlan-termination
receive-only (optional)
String desc=physical port mirror only:type=enum:default=no-mirror-receive-only
Enum:
mirror-only
no-mirror-receive-only
send-port (optional)
Long desc=send port:type=uint32 format: int64
loop-vlans (optional)
String desc=looping vlans:type=vlan-list

port-config-show - Up

display information about port configurations
api.switch-name (optional)
port
String desc=physical port:type=port-list
speed (optional)
Long desc=physical port speed:type=uint32 format: int64
autoneg (optional)
String desc=physical port autonegotiation:type=enum
Enum:
autoneg
no-autoneg
jumbo (optional)
String desc=jumbo frames on physical port:type=enum
Enum:
jumbo
no-jumbo
enable (optional)
String desc=physical port enable:type=enum
Enum:
enable
disable
reflect (optional)
String desc=physical port reflection:type=enum
Enum:
reflect
no-reflect
pause (optional)
Boolean desc=physical port pause
description (optional)
String desc=physical port description
lldp (optional)
Boolean desc=physical port LLDP enabled
loopback (optional)
String desc=physical port loopback:type=enum
Enum:
no-loopback
loopback
remote-loopback
routing (optional)
Boolean desc=routing
fec (optional)
String desc=port forward error correction (FEC) mode:type=enum
Enum:
fec
no-fec
bw-bps (optional)
Long desc=trunk bandwidth in bps:type=uint64 format: int64
stp-port-cost (optional)
Long desc=physical STP port cost:type=uint32:filter=false format: int64
stp-port-priority (optional)
Integer desc=STP port priority:type=uint16:filter=false format: int32
lport (optional)
Long desc=physical local port:type=uint32:filter=false format: int64
rswitch (optional)
Long desc=physical remote switch:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
rswitch-ip (optional)
String desc=remote switch IP address:type=IPv4 or IPv6 address:filter=false
rswitch-mac (optional)
String desc=remote switch MAC address:type=mac-address:filter=false
rem-rswitch-port-mac (optional)
String desc=remote physical port MAC Address:type=mac-address:filter=false
rswitch-default-vlan (optional)
Integer desc=remote switch default VLAN:type=uint16:filter=false format: int32
rport (optional)
Long desc=remote switch port:type=uint32:filter=false format: int64
vle-id (optional)
String desc=vle on this port:type=identifier:api-ref-path=/vles:api-ref-model=vle-show:api-ref-id=id:api-ref-val=name
updown_time (optional)
Long desc=updown time format: int64
in_use (optional)
Boolean desc=physical port inuse:filter=false
cluster-port (optional)
Boolean desc=port is a cluster port
rhost (optional)
String desc=physical remote host
defer-bringup (optional)
Boolean desc=defer port bringup
host-enable (optional)
Boolean desc=Host facing port control setting
crc-check (optional)
String desc=CRC check on ingress and rewrite on egress:type=enum
Enum:
crc-check-enable
crc-check-disable
dscp-map (optional)
String desc=DSCP map name to enable on port:api-ref-path=/dscp-maps:api-ref-model=dscp-map-show:api-ref-id=name:api-ref-val=name
local-switching (optional)
String desc=no-local-switching port cannot bridge traffic to another no-local-switching port:type=enum
Enum:
local-switching
no-local-switching
allowed-tpid (optional)
String desc=Allowed TPID in addition to 0x8100 on Vlan header:type=flag
Enum:
vlan
q-in-q
q-in-q-old
fabric-guard (optional)
Boolean desc=Fabric guard configuration
switch (optional)
Long desc=physical switch id:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
port-mac-address (optional)
String desc=physical port MAC Address:type=mac-address:filter=false
egress-rate-limit (optional)
Long desc=max egress port data rate limit:type=uint64 format: int64
eth-mode (optional)
String desc=physical Ethernet mode:type=enum
Enum:
1000base-x
sgmii
xlaui
gmii
sfi
xfi
cx
kr4
sr4
lr4
er4
cr4
cx4
kx4
caui4
kr2
er2
cr2
sr2
lr2
xlaui2
cx2
sr
lr
er
cr
kx
kr
zr
base-x
sys-default
caui
aoc
xlppi
psm4
base_t
base_cx
base_lx
base_sx
acc
lacp-priority (optional)
Long desc=LACP priority from 1 to 65535 - default 32768:type=uint32:range=[1,65535] format: int64
edge-switch (optional)
Boolean desc=physical port edge switch
vxlan-termination (optional)
String desc=physical port vxlan termination setting:type=enum
Enum:
vxlan-termination
no-vxlan-termination
receive-only (optional)
String desc=physical port mirror only:type=enum
Enum:
mirror-only
no-mirror-receive-only
send-port (optional)
Long desc=send port:type=uint32 format: int64
loop-vlans (optional)
String desc=looping vlans:type=vlan-list
config (optional)
String desc=physical port config:type=flag:filter=false
Enum:
10m
100m
1g
2.5g
10g
25g
40g
50g
100g
loopback
mirror-only
autoneg
jumbo
vxlan-termination
no-local-switching
fec
backplane
200g
400g
remote-loopback

port-config-show-response - Up

port-cos-bw-modify - Up

Update b/w settings for CoS queues
weight (optional)
Integer desc=Scheduling weight (1 to 127) after b/w guarantee met:type=uint8:requires=[port,cos] format: int32
min-bw-guarantee (optional)
String desc=Minimum b/w in %:default=0:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
max-bw-limit (optional)
String desc=Maximum b/w in %:default=100:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
api.weight (optional)
Enum:
priority
no-priority

port-cos-bw-show - Up

Show updated b/w settings for CoS queues
api.switch-name (optional)
cos
Integer desc=CoS priority:type=uint8:range=[0,11]:requires=[port] format: int32
port
String desc=physical port:type=port-list:requires=[cos]
weight (optional)
Integer desc=Scheduling weight (1 to 127) after b/w guarantee met:type=uint8:requires=[port,cos] format: int32
min-bw-guarantee (optional)
String desc=Minimum b/w in %
max-bw-limit (optional)
String desc=Maximum b/w in %

port-cos-bw-show-response - Up

port-cos-rate-setting-modify - Up

update the port cos rate limit
cos0-rate (optional)
Long desc=cos0 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos0-rate (optional)
Enum:
unlimited
cos1-rate (optional)
Long desc=cos1 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos1-rate (optional)
Enum:
unlimited
cos2-rate (optional)
Long desc=cos2 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos2-rate (optional)
Enum:
unlimited
cos3-rate (optional)
Long desc=cos3 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos3-rate (optional)
Enum:
unlimited
cos4-rate (optional)
Long desc=cos4 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos4-rate (optional)
Enum:
unlimited
cos5-rate (optional)
Long desc=cos5 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos5-rate (optional)
Enum:
unlimited
cos6-rate (optional)
Long desc=cos6 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos6-rate (optional)
Enum:
unlimited
cos7-rate (optional)
Long desc=cos7 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos7-rate (optional)
Enum:
unlimited
cos8-rate (optional)
Long desc=cos8 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos8-rate (optional)
Enum:
unlimited
cos9-rate (optional)
Long desc=cos9 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos9-rate (optional)
Enum:
unlimited
cos10-rate (optional)
Long desc=cos10 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos10-rate (optional)
Enum:
unlimited
cos11-rate (optional)
Long desc=cos11 rate limit (pps):type=uint64:range=[0,10000000] format: int64
api.cos11-rate (optional)
Enum:
unlimited

port-cos-rate-setting-show - Up

display per cos port rate limit
api.switch-name (optional)
port
String desc=port:type=enum
Enum:
control-port
data-port
span-ports
ports (optional)
String desc=port map:type=port-list
cos0-rate (optional)
Long desc=cos0 rate limit (pps):type=uint64:range=[0,10000000] format: int64
cos1-rate (optional)
Long desc=cos1 rate limit (pps):type=uint64:range=[0,10000000] format: int64
cos2-rate (optional)
Long desc=cos2 rate limit (pps):type=uint64:range=[0,10000000] format: int64
cos3-rate (optional)
Long desc=cos3 rate limit (pps):type=uint64:range=[0,10000000] format: int64
cos4-rate (optional)
Long desc=cos4 rate limit (pps):type=uint64:range=[0,10000000] format: int64
cos5-rate (optional)
Long desc=cos5 rate limit (pps):type=uint64:range=[0,10000000] format: int64
cos6-rate (optional)
Long desc=cos6 rate limit (pps):type=uint64:range=[0,10000000] format: int64
cos7-rate (optional)
Long desc=cos7 rate limit (pps):type=uint64:range=[0,10000000] format: int64
cos8-rate (optional)
Long desc=cos8 rate limit (pps):type=uint64:range=[0,10000000] format: int64
cos9-rate (optional)
Long desc=cos9 rate limit (pps):type=uint64:range=[0,10000000] format: int64
cos10-rate (optional)
Long desc=cos10 rate limit (pps):type=uint64:range=[0,10000000] format: int64
cos11-rate (optional)
Long desc=cos11 rate limit (pps):type=uint64:range=[0,10000000] format: int64

port-cos-rate-setting-show-response - Up

port-cos-stats-clear - Up

clear port cos statistics
port
String desc=port:type=port-list

port-cos-stats-settings-modify - Up

modify port cos settings for collecting statistics
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

port-cos-stats-settings-show - Up

display port cos settings for collecting statistics
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

port-cos-stats-settings-show-response - Up

port-cos-stats-show - Up

show per port cos queue statistics
api.switch-name (optional)
port
String desc=port:type=port-list
cos11-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
cos11-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos11-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos0-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos2-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos2-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos3-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos3-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
cos3-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos3-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos4-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos4-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
cos4-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos4-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos5-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos5-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
cos5-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos5-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos6-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos6-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
cos6-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos6-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos7-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos7-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
cos7-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos7-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos8-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos8-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
cos8-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos8-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos9-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos9-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
cos9-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos9-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos10-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos10-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
cos10-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos10-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos11-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos0-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
cos0-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos0-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos1-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos1-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
cos1-opkts (optional)
Long desc=transmitted packet count (scaled by 1000):type=uint64:filter=false format: int64
cos1-droppkts (optional)
Long desc=dropped packet count (scaled by 1000):type=uint64:filter=false format: int64
cos2-obits (optional)
Long desc=transmitted bit count:type=uint64:filter=false format: int64
cos2-dropbits (optional)
Long desc=dropped bit count:type=uint64:filter=false format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

port-cos-stats-show-response - Up

port-cos-weight-modify - Up

modify class of service settings
cos0-weight (optional)
Integer desc=cos0 weight:type=uint8:default=16 format: int32
api.cos0-weight (optional)
Enum:
priority
cos1-weight (optional)
Integer desc=cos1 weight:type=uint8:default=32 format: int32
api.cos1-weight (optional)
Enum:
priority
cos2-weight (optional)
Integer desc=cos2 weight:type=uint8:default=32 format: int32
api.cos2-weight (optional)
Enum:
priority
cos3-weight (optional)
Integer desc=cos3 weight:type=uint8:default=32 format: int32
api.cos3-weight (optional)
Enum:
priority
cos4-weight (optional)
Integer desc=cos4 weight:type=uint8:default=32 format: int32
api.cos4-weight (optional)
Enum:
priority
cos5-weight (optional)
Integer desc=cos5 weight:type=uint8:default=32 format: int32
api.cos5-weight (optional)
Enum:
priority
cos6-weight (optional)
Integer desc=cos6 weight:type=uint8 format: int32
api.cos6-weight (optional)
Enum:
priority
cos7-weight (optional)
Integer desc=cos7 weight:type=uint8 format: int32
api.cos7-weight (optional)
Enum:
priority
cos8-weight (optional)
Integer desc=cos8 weight:type=uint8 format: int32
api.cos8-weight (optional)
Enum:
priority
cos9-weight (optional)
Integer desc=cos9 weight:type=uint8 format: int32
api.cos9-weight (optional)
Enum:
priority
cos10-weight (optional)
Integer desc=cos10 weight:type=uint8 format: int32
api.cos10-weight (optional)
Enum:
priority
cos11-weight (optional)
Integer desc=cos11 weight:type=uint8 format: int32
api.cos11-weight (optional)
Enum:
priority

port-cos-weight-show - Up

show class of service settings
api.switch-name (optional)
cos0-weight (optional)
Integer desc=cos0 weight:type=uint8 format: int32
cos1-weight (optional)
Integer desc=cos1 weight:type=uint8 format: int32
cos2-weight (optional)
Integer desc=cos2 weight:type=uint8 format: int32
cos3-weight (optional)
Integer desc=cos3 weight:type=uint8 format: int32
cos4-weight (optional)
Integer desc=cos4 weight:type=uint8 format: int32
cos5-weight (optional)
Integer desc=cos5 weight:type=uint8 format: int32
cos6-weight (optional)
Integer desc=cos6 weight:type=uint8 format: int32
cos7-weight (optional)
Integer desc=cos7 weight:type=uint8 format: int32
cos8-weight (optional)
Integer desc=cos8 weight:type=uint8 format: int32
cos9-weight (optional)
Integer desc=cos9 weight:type=uint8 format: int32
cos10-weight (optional)
Integer desc=cos10 weight:type=uint8 format: int32
cos11-weight (optional)
Integer desc=cos11 weight:type=uint8 format: int32

port-cos-weight-show-response - Up

port-egress-show - Up

show port egress config
api.switch-name (optional)
port
String desc=physical port:type=port-list
egress (optional)
String desc=set allowed egress ports:type=port-list
rx-only (optional)
String desc=receive only ports:type=port-list
active-active-vlags (optional)
String desc=active-active vlag ports:type=port-list
loopback (optional)
String desc=loopback ports:type=port-list
mir_prevent_out (optional)
String desc=prevent mirror ports:type=port-list
no-local-switching (optional)
String desc=no local-switching mask:type=port-list

port-egress-show-response - Up

port-fec-stats-settings-modify - Up

Update FEC statistic setting for port
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

port-fec-stats-settings-show - Up

Show FEC statistic setting for port
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

port-fec-stats-settings-show-response - Up

port-force-linkup-add - Up

Add port(s) for force link up
mode
String desc=rx or tx side of the port:type=enum
Enum:
tx
rx
port-id
Long desc=Ports allowed for force linkup:type=uint32 format: int64

port-force-linkup-remove - Up

Disable force link-up from ports
port-id
Long desc=Ports allowed for force linkup:type=uint32 format: int64

port-force-linkup-show - Up

Ports to link-up with no Rx connection
api.switch-name (optional)
port-id
Long desc=Ports allowed for force linkup:type=uint32 format: int64
mode (optional)
String desc=rx or tx side of the port:type=enum
Enum:
tx
rx

port-force-linkup-show-response - Up

port-group-show - Up

Show port(s) group chip info
api.switch-name (optional)
ports
String desc=physical ports:type=port-list
device
Integer desc=Phy device number:type=uint16 format: int32

port-group-show-response - Up

port-lacp-modify - Up

modify LACP port configuration
test-mode (optional)
String desc=port is in test mode:type=enum
Enum:
none
no-tx
no-rx
no-rx-or-tx

port-lacp-show - Up

display information about LACP port configurations
api.switch-name (optional)
port
String desc=port number:type=port-list
neighbor (optional)
Boolean desc=port state neighbor
name (optional)
String desc=name
mode (optional)
String desc=LACP mode:type=enum
Enum:
off
passive
active
timeout (optional)
String desc=LACP timeout:type=enum
Enum:
slow
fast
sync (optional)
Boolean desc=synchronize LACP ports
defaulted (optional)
Boolean desc=LACP ports defaulted
expired (optional)
Boolean desc=port expired
lacp-key (optional)
Integer desc=lacp key:type=uint16 format: int32
port-state (optional)
String desc=port state:type=uint8:hex=0x[0-9a-fA-F]{2}
aggregatable (optional)
Boolean desc=Aggregate LACP ports
coll (optional)
Boolean desc=LACP port is collecting
dist (optional)
Boolean desc=LACP port is distributing
port-priority (optional)
Integer desc=port priority:type=uint16 format: int32
port-type (optional)
String desc=LACP port type:type=enum
Enum:
none
vlag
trunk
system-id (optional)
String desc=system ID:type=mac-address
system-priority (optional)
Integer desc=system priority:type=uint16 format: int32
test-mode (optional)
String desc=port is in test mode:type=enum
Enum:
none
no-tx
no-rx
no-rx-or-tx

port-lacp-show-response - Up

port-lacp-stats-clear - Up

clear port lacp statistics
port
String desc=port number:type=port-list

port-lacp-stats-show - Up

display port lacp statistics
api.switch-name (optional)
port
String desc=port number:type=port-list
lacp-marker-tx (optional)
Long desc=LACP Marker tx counter:type=uint64 format: int64
lacp-port-down (optional)
Long desc=LACP port down counter:type=uint64 format: int64
lacp-allocate-failure (optional)
Long desc=LACP Allocate tx failure counter:type=uint64 format: int64
lacp-pdu-tx (optional)
Long desc=LACP PDU tx counter:type=uint64 format: int64
lacp-port-up (optional)
Long desc=LACP port up counter:type=uint64 format: int64
lacp-expired (optional)
Long desc=LACP Port Expired counter:type=uint64 format: int64
lacp-marker-rx (optional)
Long desc=LACP Marker rx counter:type=uint64 format: int64
lacp-defaulted (optional)
Long desc=LACP Port defaulted counter:type=uint64 format: int64
lacp-pdu-rx (optional)
Long desc=LACP PDU rx counter:type=uint64 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

port-lacp-stats-show-response - Up

port-lldp-modify - Up

update LLDP on a port
lldp
Boolean desc=LLDP on or off:default=true

port-lldp-show - Up

display LLDP on a port
api.switch-name (optional)
port
String desc=LLDP port:type=port-list
lldp (optional)
Boolean desc=LLDP on or off

port-lldp-show-response - Up

port-lpmode-recover - Up

Recover port with power class 5 & above transceiver following online insertion
ports
String desc=Ports for which LPMode needs to be recovered:type=port-list

port-pfc-create - Up

Add a port PFC configuration
priority
Integer desc=Priority for PFC setting:type=uint8:range=[0,7] format: int32
port
String desc=Physical ports for the PFC configuration:type=port-list

port-pfc-modify - Up

Update PFC configuration for a port
port (optional)
String desc=Physical ports for the PFC configuration:type=port-list

port-pfc-show - Up

Show PFC configuration on ports
api.switch-name (optional)
priority
Integer desc=Priority for PFC setting:type=uint8:range=[0,7] format: int32
error (optional)
String desc=PFC status errors
port (optional)
String desc=Physical ports for the PFC configuration:type=port-list

port-pfc-show-response - Up

port-pfc-stats-clear - Up

clear port PFC statistics
port
String desc=port:type=port-list

port-pfc-stats-settings-modify - Up

modify port settings for collecting PFC frame statistics
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

port-pfc-stats-settings-show - Up

display port settings for collecting PFC frame statistics
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

port-pfc-stats-settings-show-response - Up

port-pfc-stats-show - Up

display PFC statistics
api.switch-name (optional)
port
String desc=port:type=port-list
pri0-rx (optional)
Long desc=Received PFC frame count:type=uint64:filter=false format: int64
pri0-tx (optional)
Long desc=Transmitted PFC frame count:type=uint64:filter=false format: int64
pri1-rx (optional)
Long desc=Received PFC frame count:type=uint64:filter=false format: int64
pri1-tx (optional)
Long desc=Transmitted PFC frame count:type=uint64:filter=false format: int64
pri2-rx (optional)
Long desc=Received PFC frame count:type=uint64:filter=false format: int64
pri2-tx (optional)
Long desc=Transmitted PFC frame count:type=uint64:filter=false format: int64
pri3-rx (optional)
Long desc=Received PFC frame count:type=uint64:filter=false format: int64
pri3-tx (optional)
Long desc=Transmitted PFC frame count:type=uint64:filter=false format: int64
pri4-rx (optional)
Long desc=Received PFC frame count:type=uint64:filter=false format: int64
pri4-tx (optional)
Long desc=Transmitted PFC frame count:type=uint64:filter=false format: int64
pri5-rx (optional)
Long desc=Received PFC frame count:type=uint64:filter=false format: int64
pri5-tx (optional)
Long desc=Transmitted PFC frame count:type=uint64:filter=false format: int64
pri6-rx (optional)
Long desc=Received PFC frame count:type=uint64:filter=false format: int64
pri6-tx (optional)
Long desc=Transmitted PFC frame count:type=uint64:filter=false format: int64
pri7-rx (optional)
Long desc=Received PFC frame count:type=uint64:filter=false format: int64
pri7-tx (optional)
Long desc=Transmitted PFC frame count:type=uint64:filter=false format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

port-pfc-stats-show-response - Up

port-phy-show - Up

display information about Layer 1 status of ports
api.switch-name (optional)
port (optional)
Long desc=physical port:type=uint32:filter=false format: int64
state (optional)
String desc=physical port state:type=enum
Enum:
off
admin-down
admin-pwrdown
bist
dfe-tuning
down
local-fault
partially-up
remote-fault
up
failed
mode (optional)
String desc=physical port mode:type=enum
Enum:
off
admin-down
admin-pwrdown
bist
dfe-tuning
down
local-fault
partially-up
remote-fault
up
failed
autoneg (optional)
String desc=autonegotiation
speed (optional)
Long desc=physical port speed:type=uint32 format: int64
medium (optional)
String desc=medium for port:type=enum
fec (optional)
String desc=forward error correction
max-frame (optional)
Long desc=maximum frames:type=uint32 format: int64
def-vlan (optional)
Long desc=default VLAN:type=uint32 format: int64
dfe-mode (optional)
String desc=dfe mode:type=enum
Enum:
static
one-shot
continuous
kr
dfe-coarse (optional)
String desc=dfe coarse state:type=enum
Enum:
not-started
in-progress
complete
error
dfe-fine (optional)
String desc=dfe fine state:type=enum
Enum:
not-started
in-progress
complete
error
bezel-port (optional)
String desc=bezel port
eth-mode (optional)
String desc=ethernet mode:type=enum
Enum:
1000base-x
sgmii
xlaui
gmii
sfi
xfi
cx
kr4
sr4
lr4
er4
cr4
cx4
kx4
caui4
kr2
er2
cr2
sr2
lr2
xlaui2
cx2
sr
lr
er
cr
kx
kr
zr
base-x
sys-default
caui
aoc
xlppi
psm4
base_t
base_cx
base_lx
base_sx
acc

port-phy-show-response - Up

port-show - Up

display port information
api.switch-name (optional)
ip (optional)
String desc=IP addresses:type=IPv4 or IPv6 address
mac (optional)
String desc=MAC address:type=mac-address
vnet (optional)
String desc=VLAN VNET:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan (optional)
Integer desc=VLAN:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=VXLAN:type=uint32:range=[0,16777215] format: int64
hostname (optional)
String desc=hostname
rport (optional)
Long desc=remote switch port:type=uint32 format: int64
config (optional)
String desc=configured port features:type=flag
Enum:
10m
100m
1g
2.5g
10g
25g
40g
50g
100g
loopback
mirror-only
autoneg
jumbo
vxlan-termination
no-local-switching
fec
backplane
200g
400g
remote-loopback
description (optional)
String desc=description
trunk (optional)
String desc=trunk name
status (optional)
String desc=status:type=flag
Enum:
phy-up
up
disabled
hw-nat-loop
mirror-loop
mirror-to
PN-switch
PN-fabric
PN-other
PN-cluster
PN-internal
host
uplink
STP-BPDUs
LLDP
trunk
l3-port
remote-l3-port
dhcp
dhcpsvr
blocked
no-BPDU
LACP-PDUs
vlag-active
vlag-blocked
stp-edge-port
LACP-wait
LACP-fallback
adjacency-wait
adjacency-check
vlag-wait
multicast-router
host-disabled
loop
congested
vxlan-loopback
vlan-up
vle
vbt-wait
phy-down
down
enabled
err-disabled
err-bpdu-guard
mac-violation
stp-bpdu-guard
stp-root-guard
defer-bringup-wait
rx-bw-threshold-exceeded
tx-bw-threshold-exceeded
link-detail (optional)
Boolean desc=phy, link, and status detail
rem-ip (optional)
String desc=remote switch IP address:type=IPv4 or IPv6 address
recover-time (optional)
Long desc=Timeleft for recovery from err-disable state format: int64
rem-mac (optional)
String desc=remote switch MAC address:type=mac-address
lport (optional)
Long desc=logical port number:type=uint32 format: int64
rswitch (optional)
Long desc=specifies remote switch:type=uint32 format: int64
last-seen (optional)
String desc=time last seen:date=yyyy-mm-ddThh:mm:ss:filter=false
err-bpduguard (optional)
Integer desc=Total count of err-disables by bpduguard:type=uint16 format: int32
err-maclimit (optional)
Integer desc=Total count of err-disables by mac-limit:type=uint16 format: int32
hide-connections (optional)
Boolean desc=hide connections
bezel-port (optional)
String desc=bezel port
switch-id (optional)
Long desc=node ID:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
loop-vlans (optional)
String desc=looping vlans:type=vlan-list
port (optional)
String desc=physical ports:type=port-list
bd (optional)
String desc=Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

port-show-response - Up

port-stats-clear - Up

clear port statistics
port
String desc=port numbers:type=port-list

port-stats-settings-modify - Up

modify port settings for collecting statistics
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64
congestion-threshold (optional)
Long desc=iCongDrops/oCongDrops threshold for syslogging:type=uint64:default=10 format: int64

port-stats-settings-show - Up

display port settings for collecting statistics
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64
congestion-threshold (optional)
Long desc=iCongDrops/oCongDrops threshold for syslogging:type=uint64 format: int64

port-stats-settings-show-response - Up

port-stats-show - Up

display port statistics
api.switch-name (optional)
port
String desc=port numbers:type=port-list
description (optional)
String desc=physical port description
port-speed (optional)
Long desc=port speed:type=uint32:filter=false format: int64
counter (optional)
Integer desc=port counters format: int32
ibytes (optional)
Long desc=incoming bytes:type=uint64 format: int64
ibits (optional)
Long desc=incoming bits:type=uint64 format: int64
iUpkts (optional)
Long desc=incoming unicast packets:type=uint64 format: int64
iBpkts (optional)
Long desc=incoming broadcast packets:type=uint64 format: int64
Rx-bw-th-exceed-count (optional)
Long desc=count of rx bw threshold exceed events:type=uint64:filter=false format: int64
Tx-bw-th-exceed-count (optional)
Long desc=count of tx bw threshold exceed events:type=uint64:filter=false format: int64
oBpkts (optional)
Long desc=outgoing broadcast packets:type=uint64 format: int64
oMpkts (optional)
Long desc=outgoing multicast packets:type=uint64 format: int64
oPauseFs (optional)
Long desc=outgoing pause frames:type=uint64 format: int64
oCongDrops (optional)
Long desc=outgoing packets dropped due to congestion:type=uint64 format: int64
odiscards (optional)
Long desc=discarded outgoing packets:type=uint64 format: int64
oerrs (optional)
Long desc=outgoing packets with errors:type=uint64 format: int64
mtu-errs (optional)
Long desc=mtu errors:type=uint64 format: int64
HER-pkts (optional)
Long desc=head end replicated packets:type=uint64 format: int64
iMpkts (optional)
Long desc=incoming multicast packets:type=uint64 format: int64
iPauseFs (optional)
Long desc=incoming pause frames:type=uint64 format: int64
iCongDrops (optional)
Long desc=incoming packets dropped due to congestion:type=uint64 format: int64
idiscards (optional)
Long desc=discarded incoming packets:type=uint64 format: int64
ierrs (optional)
Long desc=incoming packets with errors:type=uint64 format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64 format: int64
obits (optional)
Long desc=outgoing bits:type=uint64 format: int64
oUpkts (optional)
Long desc=outgoing unicast packets:type=uint64 format: int64
bezel-port (optional)
String desc=bezel port
HER-bytes (optional)
Long desc=head end replicated bytes:type=uint64 format: int64
HER-bits (optional)
Long desc=head end replicated bits:type=uint64 format: int64
oPkts (optional)
Long desc=T4 out pkts includes HER,Unicast and BUM:type=uint64 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

port-stats-show-response - Up

port-stats-snmp-show - Up

Port Statistics SNMP
api.switch-name (optional)
port
String desc=port number:type=port-list
port-clear-count (optional)
Long desc=port clear count:type=uint32 format: int64
port_clear_time (optional)
Long desc= high-res timestamp of last port stats clear format: int64
port-clear-time (optional)
Long desc=last port stats clear time format: int64
all-ports (optional)
Boolean desc=Show all ports
counter (optional)
Integer desc=port counters format: int32
ibytes (optional)
Long desc=incoming bytes:type=uint64 format: int64
ibits (optional)
Long desc=incoming bits:type=uint64 format: int64
iUpkts (optional)
Long desc=incoming unicast packets:type=uint64 format: int64
iBpkts (optional)
Long desc=incoming broadcast packets:type=uint64 format: int64
oBpkts (optional)
Long desc=outgoing broadcast packets:type=uint64 format: int64
oMpkts (optional)
Long desc=outgoing multicast packets:type=uint64 format: int64
oPauseFs (optional)
Long desc=outgoing pause frames:type=uint64 format: int64
oCongDrops (optional)
Long desc=outgoing packets dropped due to congestion:type=uint64 format: int64
odiscards (optional)
Long desc=discarded outgoing packets:type=uint64 format: int64
oerrs (optional)
Long desc=outgoing packets with errors:type=uint64 format: int64
mtu-errs (optional)
Long desc=mtu errors:type=uint64 format: int64
HER-pkts (optional)
Long desc=head end replicated packets:type=uint64 format: int64
iMpkts (optional)
Long desc=incoming multicast packets:type=uint64 format: int64
iPauseFs (optional)
Long desc=incoming pause frames:type=uint64 format: int64
iCongDrops (optional)
Long desc=incoming packets dropped due to congestion:type=uint64 format: int64
idiscards (optional)
Long desc=discarded incoming packets:type=uint64 format: int64
ierrs (optional)
Long desc=incoming packets with errors:type=uint64 format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64 format: int64
obits (optional)
Long desc=outgoing bits:type=uint64 format: int64
oUpkts (optional)
Long desc=outgoing unicast packets:type=uint64 format: int64
HER-bytes (optional)
Long desc=head end replicated bytes:type=uint64 format: int64
HER-bits (optional)
Long desc=head end replicated bits:type=uint64 format: int64
oPkts (optional)
Long desc=T4 out pkts includes HER,Unicast and BUM:type=uint64 format: int64

port-stats-snmp-show-response - Up

port-storm-control-modify - Up

modify port storm control settings
unknown-ucast-level (optional)
String desc=unknown unicast level in % default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
unknown-mcast-level (optional)
String desc=unknown multicast level in % default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
broadcast-level (optional)
String desc=broadcast level in % - default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)

port-storm-control-show - Up

display information about port storm control features
api.switch-name (optional)
name
String desc=physical name:filter=false
intf
Long desc=physical interface:type=uint32:filter=false format: int64
speed (optional)
Long desc=physical port speed:type=uint32:filter=false format: int64
autoneg (optional)
String desc=physical port autonegotiation:type=enum:filter=false
Enum:
autoneg
no-autoneg
jumbo (optional)
String desc=jumbo frames on physical port:type=enum:filter=false
Enum:
jumbo
no-jumbo
enable (optional)
String desc=physical port enable:type=enum:filter=false
Enum:
enable
disable
reflect (optional)
String desc=physical port reflection:type=enum:filter=false
Enum:
reflect
no-reflect
pause (optional)
Boolean desc=physical port pause:filter=false
description (optional)
String desc=physical port description:filter=false
lldp (optional)
Boolean desc=physical port LLDP enabled:filter=false
loopback (optional)
String desc=physical port loopback:type=enum:filter=false
Enum:
no-loopback
loopback
remote-loopback
routing (optional)
Boolean desc=routing:filter=false
fec (optional)
String desc=port forward error correction (FEC) mode:type=enum:filter=false
Enum:
fec
no-fec
status (optional)
String desc=physical port status:type=flag:filter=false
Enum:
phy-up
up
disabled
hw-nat-loop
mirror-loop
mirror-to
PN-switch
PN-fabric
PN-other
PN-cluster
PN-internal
host
uplink
STP-BPDUs
LLDP
trunk
l3-port
remote-l3-port
dhcp
dhcpsvr
blocked
no-BPDU
LACP-PDUs
vlag-active
vlag-blocked
stp-edge-port
LACP-wait
LACP-fallback
adjacency-wait
adjacency-check
vlag-wait
multicast-router
host-disabled
loop
congested
vxlan-loopback
vlan-up
vle
vbt-wait
phy-down
down
enabled
err-disabled
err-bpdu-guard
mac-violation
stp-bpdu-guard
stp-root-guard
defer-bringup-wait
rx-bw-threshold-exceeded
tx-bw-threshold-exceeded
bw-bps (optional)
Long desc=trunk bandwidth in bps:type=uint64:filter=false format: int64
stp-port-cost (optional)
Long desc=physical STP port cost:type=uint32:filter=false format: int64
lacp-individual (optional)
String desc=LACP ports operating individully:type=port-list:filter=false
vlag-id (optional)
String desc=VLAG of this port:type=identifier:filter=false:api-ref-path=/vlags:api-ref-model=vlag-show:api-ref-id=id:api-ref-val=name
trunk-hw-id (optional)
Integer desc=trunk hardware ID:filter=false format: int32
stp-port-priority (optional)
Integer desc=STP port priority:type=uint16:filter=false format: int32
lport (optional)
Long desc=physical local port:type=uint32:filter=false format: int64
rswitch (optional)
Long desc=physical remote switch:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
rswitch-ip (optional)
String desc=remote switch IP address:type=IPv4 or IPv6 address:filter=false
rswitch-mac (optional)
String desc=remote switch MAC address:type=mac-address:filter=false
rem-rswitch-port-mac (optional)
String desc=remote physical port MAC Address:type=mac-address:filter=false
rswitch-default-vlan (optional)
Integer desc=remote switch default VLAN:type=uint16:filter=false format: int32
rport (optional)
Long desc=remote switch port:type=uint32:filter=false format: int64
vle-id (optional)
String desc=vle on this port:type=identifier:filter=false:api-ref-path=/vles:api-ref-model=vle-show:api-ref-id=id:api-ref-val=name
updown_time (optional)
Long desc=updown time:filter=false format: int64
in_use (optional)
Boolean desc=physical port inuse:filter=false
cluster-port (optional)
Boolean desc=port is a cluster port:filter=false
rhost (optional)
String desc=physical remote host:filter=false
trunk (optional)
Long desc=Trunk ID of this port:type=uint32:filter=false:api-ref-path=/trunks:api-ref-model=trunk-show:api-ref-id=trunk-id:api-ref-val=name format: int64
hash-mode (optional)
String desc=Trunk hash mode:type=enum:filter=false
Enum:
enhanced
l2-src
l2-dst
l2
l3-src
l3-dst
l3
resilient
lacp-mode (optional)
String desc=LACP mode of physical port:type=enum:filter=false
Enum:
off
passive
active
lacp-timeout (optional)
String desc=LACP timeout - default slow:type=enum:filter=false
Enum:
slow
fast
defer-bringup (optional)
Boolean desc=defer port bringup:filter=false
host-enable (optional)
Boolean desc=Host facing port control setting:filter=false
crc-check (optional)
String desc=CRC check on ingress and rewrite on egress:type=enum:filter=false
Enum:
crc-check-enable
crc-check-disable
dscp-map (optional)
String desc=DSCP map name to enable on port:filter=false:api-ref-path=/dscp-maps:api-ref-model=dscp-map-show:api-ref-id=name:api-ref-val=name
local-switching (optional)
String desc=no-local-switching port cannot bridge traffic to another no-local-switching port:type=enum:filter=false
Enum:
local-switching
no-local-switching
allowed-tpid (optional)
String desc=Allowed TPID in addition to 0x8100 on Vlan header:type=flag:filter=false
Enum:
vlan
q-in-q
q-in-q-old
fabric-guard (optional)
Boolean desc=Fabric guard configuration:filter=false
unknown-ucast-level (optional)
String desc=unknown unicast level in % default 30%
unknown-mcast-level (optional)
String desc=unknown multicast level in % default 30%
broadcast-level (optional)
String desc=broadcast level in % - default 30%
switch (optional)
Long desc=physical switch id:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
port-mac-address (optional)
String desc=physical port MAC Address:type=mac-address:filter=false
lacp-fallback (optional)
String desc=LACP fallback mode -- individual or bundled:type=enum:filter=false
Enum:
bundle
individual
lacp-fallback-timeout (optional)
Long desc=LACP fallback timeout -- default is 50 seconds:range=[30,60]:filter=false format: int64
egress-rate-limit (optional)
Long desc=max egress port data rate limit:type=uint64:filter=false format: int64
eth-mode (optional)
String desc=physical Ethernet mode:type=enum:filter=false
Enum:
1000base-x
sgmii
xlaui
gmii
sfi
xfi
cx
kr4
sr4
lr4
er4
cr4
cx4
kx4
caui4
kr2
er2
cr2
sr2
lr2
xlaui2
cx2
sr
lr
er
cr
kx
kr
zr
base-x
sys-default
caui
aoc
xlppi
psm4
base_t
base_cx
base_lx
base_sx
acc
lacp-priority (optional)
Long desc=LACP priority from 1 to 65535 - default 32768:type=uint32:range=[1,65535]:filter=false format: int64
edge-switch (optional)
Boolean desc=physical port edge switch:filter=false
vxlan-termination (optional)
String desc=physical port vxlan termination setting:type=enum:filter=false
Enum:
vxlan-termination
no-vxlan-termination
receive-only (optional)
String desc=physical port mirror only:type=enum:filter=false
Enum:
mirror-only
no-mirror-receive-only
send-port (optional)
Long desc=send port:type=uint32:filter=false format: int64
loop-vlans (optional)
String desc=looping vlans:type=vlan-list:filter=false
port (optional)
String desc=physical port:type=port-list
config (optional)
String desc=physical port config:type=flag:filter=false
Enum:
10m
100m
1g
2.5g
10g
25g
40g
50g
100g
loopback
mirror-only
autoneg
jumbo
vxlan-termination
no-local-switching
fec
backplane
200g
400g
remote-loopback

port-storm-control-show-response - Up

port-vlan-add - Up

add a VLAN to a specific port
port (optional)
Long desc=VLAN port:type=uint32 format: int64
vlans (optional)
String desc=VLANs:type=vlan-list
port-desc (optional)
String desc=VLAN port description
vnet-id (optional)
String desc=VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
untagged-vlan (optional)
Integer desc=untagged VLANs:type=uint16:range=[0,4095] format: int32

port-vlan-remove - Up

remove a VLAN to a specific port
vlans
String desc=VLANs:type=vlan-list
port (optional)
Long desc=VLAN port:type=uint32 format: int64
port-desc (optional)
String desc=VLAN port description
vnet-id (optional)
String desc=VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

port-vlan-show - Up

display ports with assigned VLANs
api.switch-name (optional)
port
Long desc=VLAN port:type=uint32:filter=false format: int64
port-desc
String desc=VLAN port description
ports (optional)
String desc=ports:type=port-list
vlans (optional)
String desc=VLANs:type=vlan-list
description (optional)
String desc=description
bezel-port (optional)
String desc=bezel port
active-vlans (optional)
String desc=active VLANs:type=vlan-list
vnet-id (optional)
String desc=VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
untagged-vlan (optional)
Integer desc=untagged VLANs:type=uint16:range=[0,4095] format: int32

port-vlan-show-response - Up

port-vnet-show - Up

display ports with assigned VNETS
api.switch-name (optional)
name
String desc=VNET name
vlans (optional)
String desc=VLANs assigned to public VLAN VNET:type=vlan-list:precludes=[num-vlans]
num-vlans (optional)
Integer desc=number of global VLANs assigned to VNET:type=uint16:range=[1,4094]:precludes=[vlans] format: int32
managed-ports (optional)
String desc=VNET exclusive ports:type=port-list

port-vnet-show-response - Up

port-xcvr-memory-show - Up

display information about transceivers memory
api.switch-name (optional)
port (optional)
Long desc=port:type=uint32:filter=false format: int64
pages (optional)
String desc=transceiver pages: default, seperate pages with comma

port-xcvr-memory-show-response - Up

port-xcvr-show - Up

display information about transceivers
api.switch-name (optional)
port (optional)
Long desc=port:type=uint32:filter=false format: int64
supported (optional)
Boolean desc=supported or unsupported transceiver
fw-rev (optional)
String desc=firmware revision number
vendor-name (optional)
String desc=transceiver vendor name
part-number (optional)
String desc=transceiver part number
serial-number (optional)
String desc=transceiver serial number
vendor-part-number (optional)
String desc=vendor part number
temp[C] (optional)
String desc=xcvr temperature
vcc33[V] (optional)
String desc=3.3V supply voltage
vcc18[V] (optional)
String desc=1.8V supply voltage
vcc10[V] (optional)
String desc=1.0V supply voltage
tx-bias[mA] (optional)
String desc=transmit bias current (mA)
tx-pwr[dBm] (optional)
String desc=transmit power (dBm)
rx-pwr[dBm] (optional)
String desc=receive power (dBm)
state (optional)
String desc=state:type=enum
Enum:
default
none
start
empty
insert
powerup
identify
invalid-cfg
initialize
mac-ready
phy-enabled
phy-disabled
error
mac-not-ready
bezel-port (optional)
String desc=bezel port
type (optional)
String desc=xcvr form factor:type=enum
Enum:
unknown
sfp
qsfp28
qsfp56-dd
sfp-dd
cbl-len (optional)
Integer desc=AOC/DAC cable length:type=uint8 format: int32
eth-mode (optional)
String desc=xcvr eth-mode:type=enum
Enum:
1000base-x
sgmii
xlaui
gmii
sfi
xfi
cx
kr4
sr4
lr4
er4
cr4
cx4
kx4
caui4
kr2
er2
cr2
sr2
lr2
xlaui2
cx2
sr
lr
er
cr
kx
kr
zr
base-x
sys-default
caui
aoc
xlppi
psm4
base_t
base_cx
base_lx
base_sx
acc

port-xcvr-show-response - Up

prefix-list-create - Up

create a prefix list
name
String desc=Prefix List Name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=scope - local or fabric
Enum:
local
fabric

prefix-list-network-add - Up

Add network associated with access list
network (optional)
String desc=network associated with the prefix list:type=IPv4 or IPv6 address:requires=[netmask]
netmask (optional)
Integer desc=netmask of the network associated the prefix list:type=netmask:mask-for=[network] format: int32

prefix-list-network-show - Up

Show networks associated with access list
api.switch-name (optional)
network
String desc=network associated with the prefix list:type=IPv4 or IPv6 address:requires=[netmask]
netmask
Integer desc=netmask of the network associated the prefix list:type=netmask:mask-for=[network] format: int32

prefix-list-network-show-response - Up

prefix-list-show - Up

display prefix lists
api.switch-name (optional)
name
String desc=Prefix List Name
scope (optional)
String desc=scope - local or fabric
Enum:
local
fabric

prefix-list-show-response - Up

ptp-modify - Up

modify Precision Time Protocol settings
enable (optional)
Boolean desc=enable PTP
master-ports (optional)
String desc=master ports for PTP:type=port-list
slave-port (optional)
Long desc=slave port for PTP:type=uint32 format: int64
sync-interval (optional)
Long desc=synchronization interval - default is 200:type=uint32:range=[10,5000]:default=200 format: int64
frequency-adjust-interval (optional)
Long desc=interval between time adjustments - default is 5:type=uint32:default=5 format: int64

ptp-show - Up

display Precision Time Protocol settings
api.switch-name (optional)
enable (optional)
Boolean desc=enable PTP
current-time (optional)
String desc=current time:date=yyyy-mm-ddThh:mm:ss
last-time-correction (optional)
Long desc=time of last time correction format: int64
last-delay (optional)
Long desc=last delay format: int64
last-frequency-correction (optional)
Long desc=time last frequency correction occurred format: int64
clock-frequency (optional)
Long desc=clock frequency:type=uint64 format: int64
master-ports (optional)
String desc=master ports for PTP:type=port-list
slave-port (optional)
Long desc=slave port for PTP:type=uint32 format: int64
sync-interval (optional)
Long desc=synchronization interval - default is 200:type=uint32:range=[10,5000] format: int64
frequency-adjust-interval (optional)
Long desc=interval between time adjustments - default is 5:type=uint32 format: int64

ptp-show-response - Up

result - Up

api.switch-name
scope
Enum:
local
fabric
status
Enum:
Success
Failure
code
Integer format: int32
message (optional)

result-list - Up

status
Enum:
Success
Failure
result

role-create - Up

create user roles
name
String desc=role name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=local or fabric
Enum:
local
fabric
access (optional)
String desc=type of access - default read-write:type=enum:default=read-write
Enum:
read-only
read-write
shell (optional)
Boolean desc=allow shell command:default=false
sudo (optional)
Boolean desc=allow sudo from shell:default=false
running-config (optional)
Boolean desc=display running configuration of switch:default=false

role-modify - Up

modify user roles
access (optional)
String desc=type of access - default read-write:type=enum:default=read-write
Enum:
read-only
read-write
shell (optional)
Boolean desc=allow shell command:default=false
sudo (optional)
Boolean desc=allow sudo from shell:default=false
running-config (optional)
Boolean desc=display running configuration of switch:default=false
delete-from-users (optional)
Boolean desc=delete from users:default=true

role-show - Up

display user role information
api.switch-name (optional)
name
String desc=role name
scope (optional)
String desc=local or fabric
Enum:
local
fabric
access (optional)
String desc=type of access - default read-write:type=enum
Enum:
read-only
read-write
shell (optional)
Boolean desc=allow shell command
sudo (optional)
Boolean desc=allow sudo from shell
group-id (optional)
Long desc=group id:type=uint32 format: int64
vnet-id (optional)
String desc=VNET access ID:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
id (optional)
String desc=role ID:type=identifier
running-config (optional)
Boolean desc=display running configuration of switch
delete-from-users (optional)
Boolean desc=delete from users

role-show-response - Up

service-heartbeat-create - Up

create a service heartbeat
name
String desc=heartbeat name:pattern=^[a-zA-Z0-9_.-]+$:pattern-help=letters, numbers, ., -, and _
interval
Long desc=Heartbeat interval format: int64
payload
String desc=ethernet frame payload for the heartbeat(include ethertype)
src-mac
String desc=source MAC address for the heartbeat:type=mac-address
dst-mac
String desc=destination MAC address for the heartbeat:type=mac-address
retry (optional)
Long desc=Service heartbeat dead count:type=uint32:default=10:requires=[interval] format: int64
vlan (optional)
Integer desc=VLAN ID for the heartbeat:type=uint16:range=[0,4095] format: int32
type (optional)
String desc=Heartbeat type: Passthrough, or request-response.:type=enum:default=normal
Enum:
normal
pass-through

service-heartbeat-modify - Up

modify a service heartbeat
interval (optional)
Long desc=Heartbeat interval format: int64
retry (optional)
Long desc=Service heartbeat dead count:type=uint32:default=10:requires=[interval] format: int64
payload (optional)
String desc=ethernet frame payload for the heartbeat(include ethertype)

service-heartbeat-show - Up

show the service heartbeats
api.switch-name (optional)
name
String desc=heartbeat name
interval (optional)
Long desc=Heartbeat interval format: int64
retry (optional)
Long desc=Service heartbeat dead count:type=uint32:requires=[interval] format: int64
vlan (optional)
Integer desc=VLAN ID for the heartbeat:type=uint16:range=[0,4095] format: int32
type (optional)
String desc=Heartbeat type: Passthrough, or request-response.:type=enum
Enum:
normal
pass-through
payload (optional)
String desc=ethernet frame payload for the heartbeat(include ethertype)
src-mac (optional)
String desc=source MAC address for the heartbeat:type=mac-address
dst-mac (optional)
String desc=destination MAC address for the heartbeat:type=mac-address

service-heartbeat-show-response - Up

service-stats-clear - Up

clear service statistics
service (optional)
Integer desc=service type on port:type=uint16 format: int32
api.service (optional)
Enum:
ftp-data
ftp-control
ssh
telnet
http
https
rpc
sql
imap
bgp
ldap
iSCSI
oracle-db
nfs
cifs
iSCSI-target
lockd
HDFS-Namenode-WebUI
HDFS-Secure-Namenode-WebUI
HDFS-Metadata-operations-8020
HDFS-Metadata-operations-9000
HDFS-DataNode-WebUI
HDFS-Secure-DataNode-WebUI
HDFS-DataTransfer
HDFS-DataNode-Metadata
HDFS-Secondary-NameNode
MR-JobTracker-WebUI
MR-JobTracker
MR-TaskTracker-WebUI
MR-History-WebUI
Hive-Server-Thrift
Hive-Metastore-Thrift
HBase-HMaster
HBase-HMaster-WebUI
HBase-Region-Server
HBase-Region-Server-Http
HBase-Zookeeper
HBase-Zookeeper-Peer
HBase-Zookeeper-Client-Port
WebHCat-Server
Ganglia-Gmond-Collectors-8660
Ganglia-Gmond-Collectors-8661
Ganglia-Gmond-Collectors-8662
Ganglia-Gmond-Collectors-8663
MySQL
Snap-Mirror/Vault
CIFS/SMB
Cassandra-InterNode-Cluster
Cassandra-Secure-InterNode-Cluster
Cassandra-JMX-Monitoring
Cassandra-Client
Cassandra-Client-Thrift
Cassandra-OpsCenter
Cassandra-OpsCenter-Monitoring
Cassandra-OpsCenter-Agent
VMotion
LDAP
LDAP-SSL
Ganglia-gmetad
Nutanix-Stargate
Nutanix-Curator
Nutanix-Chronos-Master
Nutanix-Chronos-Node
Nutanix-Transfer-Manager
Nutanix-Alert-Manager
Nutanix-Deduplication-Object-Store
Nutanix-Pithos
Nutanix-Stats Aggregator-Monitor
Nutanix-Prism Monitor-Port
Nutanix-Nutanix-Cerebro
Nutanix-Stats-Aggregator
Nutanix-Arithmos
Nutanix-Hyperint
Nutanix-Mount/NFS-RPC-service
Nutanix-Genesis

service-stats-show - Up

display service statistics
api.switch-name (optional)
service (optional)
Integer desc=service type on port:type=uint16 format: int32
bytes (optional)
Long desc=bytes:type=uint64 format: int64

service-stats-show-response - Up

sflow-collector-create - Up

create a sFlow collector
name
String desc=sFlow name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=local or fabric
Enum:
local
fabric
collector-port
Long desc=sFlow collector port:type=uint32 format: int64
collector-ip
String desc=sFlow collector IP address:type=IPv4 or IPv6 address

sflow-collector-modify - Up

modify a sflow collector
scope (optional)
String desc=local or fabric
Enum:
local
fabric
collector-port (optional)
Long desc=sFlow collector port:type=uint32 format: int64
collector-ip (optional)
String desc=sFlow collector IP address:type=IPv4 or IPv6 address

sflow-collector-show - Up

display sFlow collectors
api.switch-name (optional)
name
String desc=sFlow name
scope (optional)
String desc=local or fabric
Enum:
local
fabric
collector-port (optional)
Long desc=sFlow collector port:type=uint32 format: int64
collector-ip (optional)
String desc=sFlow collector IP address:type=IPv4 or IPv6 address

sflow-collector-show-response - Up

sflow-create - Up

create sFlow agent
name
String desc=sflow name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
ports
String desc=sFlow ports:type=port-list
type (optional)
String desc=sFlow type:type=enum:default=ingress
Enum:
ingress
egress
vlan (optional)
Integer desc=VLAN ID:type=uint16:range=[0,4095] format: int32
agent-id (optional)
String desc=local IP address:type=IPv4 or IPv6 address
sample-type (optional)
String desc=sFlow sample type:type=enum:default=raw
Enum:
raw
cooked
sample-rate (optional)
Long desc=sFlow sample rate:type=uint32:range=[0,16000]:default=4096 format: int64
counter-polling-interval (optional)
Integer desc=sFlow interface stats-counter polling interval:type=uint16:range=[0,120]:default=2 format: int32
trunc-length (optional)
Long desc=sFlow sample truncated length:type=uint32 format: int64

sflow-modify - Up

modify sflow agent
type (optional)
String desc=sFlow type:type=enum:default=ingress
Enum:
ingress
egress
vlan (optional)
Integer desc=VLAN ID:type=uint16:range=[0,4095] format: int32
ports (optional)
String desc=sFlow ports:type=port-list
agent-id (optional)
String desc=local IP address:type=IPv4 or IPv6 address
sample-type (optional)
String desc=sFlow sample type:type=enum:default=raw
Enum:
raw
cooked
sample-rate (optional)
Long desc=sFlow sample rate:type=uint32:range=[0,16000]:default=4096 format: int64
counter-polling-interval (optional)
Integer desc=sFlow interface stats-counter polling interval:type=uint16:range=[0,120]:default=2 format: int32
trunc-length (optional)
Long desc=sFlow sample truncated length:type=uint32 format: int64

sflow-port-add - Up

add a port to the sFlow agent
ports (optional)
String desc=ports:type=port-list

sflow-port-show - Up

display sFlow port information
api.switch-name (optional)
ports
String desc=ports:type=port-list

sflow-port-show-response - Up

sflow-show - Up

display sFlow agent information
api.switch-name (optional)
name
String desc=sflow name
type (optional)
String desc=sFlow type:type=enum
Enum:
ingress
egress
vlan (optional)
Integer desc=VLAN ID:type=uint16:range=[0,4095] format: int32
ports (optional)
String desc=sFlow ports:type=port-list
sample-pkt-cnt (optional)
Long desc=sFlow sample packet count:type=uint64 format: int64
sample-drops (optional)
Long desc=sFlow sample dropped packets:type=uint64 format: int64
malformed-packet-drops (optional)
Long desc=sFlow malformed packet drops:type=uint64 format: int64
malformed-vlan-packet-drops (optional)
Long desc=sFlow malformed vlan packet drops:type=uint64 format: int64
malformed-ip-packet-drops (optional)
Long desc=sFlow malformed ip packet drops:type=uint64 format: int64
internal-q-drops (optional)
Long desc=sFlow internal Q drops:type=uint64 format: int64
oversize-packet-drops (optional)
Long desc=sFlow over size packet drops:type=uint64 format: int64
internal-nq-drops (optional)
Long desc=sFlow internal nQ drops:type=uint64 format: int64
agent-id (optional)
String desc=local IP address:type=IPv4 or IPv6 address
sample-type (optional)
String desc=sFlow sample type:type=enum
Enum:
raw
cooked
sample-rate (optional)
Long desc=sFlow sample rate:type=uint32:range=[0,16000] format: int64
counter-polling-interval (optional)
Integer desc=sFlow interface stats-counter polling interval:type=uint16:range=[0,120] format: int32
trunc-length (optional)
Long desc=sFlow sample truncated length:type=uint32 format: int64

sflow-show-response - Up

sflow-thread-binding-show - Up

display sFlow thread binding information
api.switch-name (optional)
name
String desc=sflow name
thread-id (optional)
Long desc=associated thread id:type=uint64 format: int64
nv-msg-queue-name (optional)
String desc=associated nv sflow msg queue name
nv-cache-queue-name (optional)
String desc=associated nv sflow cache queue name

sflow-thread-binding-show-response - Up

snmp-community-create - Up

create SNMP communities
community-string
String desc=community name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
community-type (optional)
String desc=community type:type=enum
Enum:
read-only
read-write

snmp-community-modify - Up

modify SNMP communities
community-type (optional)
String desc=community type:type=enum
Enum:
read-only
read-write

snmp-community-show - Up

display SNMP communities
api.switch-name (optional)
community-string
String desc=community name
community-type (optional)
String desc=community type:type=enum
Enum:
read-only
read-write

snmp-community-show-response - Up

snmp-engineid-modify - Up

Should re-create SNMP user afer update
engineid
String desc=SNMP engine ID

snmp-engineid-show - Up

display the ID of the local SNMP engine
api.switch-name (optional)
engineid (optional)
String desc=SNMP engine ID

snmp-engineid-show-response - Up

snmp-show - Up

display SNMP information
api.switch-name (optional)
name
String desc=SNMP OID name:api-ref-path=/snmp-oids:api-ref-model=snmp-oid-show:api-ref-id=name:api-ref-val=name
show-type
String desc=type of community:type=enum
Enum:
walk
get
get-next
value (optional)
String desc=value:filter=false
community-string (optional)
String desc=SNMP community:precludes=[user-name]:api-ref-path=/snmp-communities:api-ref-model=snmp-community-show:api-ref-id=community-string:api-ref-val=community-string
user-name (optional)
String desc=username:precludes=[community-string]:api-ref-path=/snmp-users:api-ref-model=snmp-user-show:api-ref-id=user-name:api-ref-val=user-name

snmp-show-response - Up

snmp-system-clear - Up

Clear SNMP system information
syscontact (optional)
String desc=SNMP system contact
syslocation (optional)
String desc=SNMP system location

snmp-system-modify - Up

Modify SNMP system information
syscontact (optional)
String desc=SNMP system contact
syslocation (optional)
String desc=SNMP system location

snmp-system-show - Up

Display SNMP system information
api.switch-name (optional)
syscontact (optional)
String desc=SNMP system contact
syslocation (optional)
String desc=SNMP system location

snmp-system-show-response - Up

snmp-trap-enable-modify - Up

modify SNMP notifications about link conditions
link-up-down (optional)
Boolean desc=port link state:default=false
interface-up-down (optional)
Boolean desc=vrouter interface status:default=false
default-monitors (optional)
Boolean desc=default monitoring:default=false
physical-sensors (optional)
Boolean desc=Temperature, fan speed, etc.:default=false
low-disk-space (optional)
Boolean desc=Low disk space:default=false
low-disk-space-threshold (optional)
String desc=Threshold value of low-disk-space in %:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001):requires=[low-disk-space]
system-usage (optional)
Boolean desc=Memory and CPU usage:default=false
high-system-usage-threshold (optional)
String desc=Threshold value of system-usage in %:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001):requires=[system-usage]
login-failure (optional)
Boolean desc=Incorrect passwords on login:default=false
cluster-tr-diverge (optional)
Boolean desc=Cluster transaction lists have diverged:default=false
lacp-status (optional)
Boolean desc=LACP status:default=false
vport-modified (optional)
Boolean desc=vPort modification:default=false
stp-port-modified (optional)
Boolean desc=STP port modified:default=false
mirror-to-cpu (optional)
Boolean desc=Mirror to CPU configured:default=false
stp-port-state-failed (optional)
Boolean desc=STP Port State Failed:default=false
link-congestion-detected (optional)
Boolean desc=Congestion detected at port:default=false
fabric-node-state-changed (optional)
Boolean desc=Fabric Node State Changed:default=false
stp-new-root (optional)
Boolean desc=New Stp Root Detected:default=false
stp-topology-changed (optional)
Boolean desc=STP Topology Changed:default=false
vrrp-new-master (optional)
Boolean desc=Vrrp Master Change:default=false
disable-start-stop (optional)
Boolean desc=Disable Start/Stop Traps:default=false
cert-expiry (optional)
Boolean desc=certificate expiry:default=false
sysup-alert (optional)
Boolean desc=system up alert:default=false
port-oir-error-state (optional)
Boolean desc=port oir error state:default=false
port-bw-threshold-exceed-event (optional)
Boolean desc=port bw threshold exceeded alert:default=false

snmp-trap-enable-show - Up

display information about SNMP traps
api.switch-name (optional)
link-up-down (optional)
Boolean desc=port link state
interface-up-down (optional)
Boolean desc=vrouter interface status
default-monitors (optional)
Boolean desc=default monitoring
physical-sensors (optional)
Boolean desc=Temperature, fan speed, etc.
low-disk-space (optional)
Boolean desc=Low disk space
low-disk-space-threshold (optional)
String desc=Threshold value of low-disk-space in %:filter=false:requires=[low-disk-space]
system-usage (optional)
Boolean desc=Memory and CPU usage
high-system-usage-threshold (optional)
String desc=Threshold value of system-usage in %:filter=false:requires=[system-usage]
login-failure (optional)
Boolean desc=Incorrect passwords on login
cluster-tr-diverge (optional)
Boolean desc=Cluster transaction lists have diverged
lacp-status (optional)
Boolean desc=LACP status
vport-modified (optional)
Boolean desc=vPort modification
stp-port-modified (optional)
Boolean desc=STP port modified
mirror-to-cpu (optional)
Boolean desc=Mirror to CPU configured
stp-port-state-failed (optional)
Boolean desc=STP Port State Failed
link-congestion-detected (optional)
Boolean desc=Congestion detected at port
fabric-node-state-changed (optional)
Boolean desc=Fabric Node State Changed
stp-new-root (optional)
Boolean desc=New Stp Root Detected
stp-topology-changed (optional)
Boolean desc=STP Topology Changed
vrrp-new-master (optional)
Boolean desc=Vrrp Master Change
disable-start-stop (optional)
Boolean desc=Disable Start/Stop Traps
cert-expiry (optional)
Boolean desc=certificate expiry
sysup-alert (optional)
Boolean desc=system up alert
port-oir-error-state (optional)
Boolean desc=port oir error state
port-bw-threshold-exceed-event (optional)
Boolean desc=port bw threshold exceeded alert

snmp-trap-enable-show-response - Up

snmp-trap-sink-create - Up

create a SNMP trap sink
community
String desc=community type:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
dest-host
String desc=destination host:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, and -
type (optional)
String desc=trap type - default TRAP_TYPE_V2C_TRAP:type=enum:default=TRAP_TYPE_V2C_TRAP
Enum:
TRAP_TYPE_V1_TRAP
TRAP_TYPE_V2C_TRAP
TRAP_TYPE_V2_INFORM
dest-port (optional)
Integer desc=destination port - default 162:type=uint16:default=162 format: int32

snmp-trap-sink-show - Up

display SNMP trap sinks
api.switch-name (optional)
community
String desc=community type
dest-host
String desc=destination host
dest-port
Integer desc=destination port - default 162:type=uint16 format: int32
type (optional)
String desc=trap type - default TRAP_TYPE_V2C_TRAP:type=enum
Enum:
TRAP_TYPE_V1_TRAP
TRAP_TYPE_V2C_TRAP
TRAP_TYPE_V2_INFORM

snmp-trap-sink-show-response - Up

snmp-user-create - Up

create SNMPv3 users
user-name
String desc=SNMP user name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
auth (optional)
Boolean desc=authentication required
priv (optional)
Boolean desc=privileges
auth-password (optional)
String desc=authentication password:password=true:requires=[auth]
auth-hash (optional)
String desc=Hashing algorithm for authentication:type=enum:default=sha:requires=[auth]
Enum:
md5
sha
priv-password (optional)
String desc=privilege password:password=true:requires=[priv]

snmp-user-modify - Up

modify SNMPv3 users
auth (optional)
Boolean desc=authentication required
priv (optional)
Boolean desc=privileges
auth-password (optional)
String desc=authentication password:password=true:requires=[auth]
auth-hash (optional)
String desc=Hashing algorithm for authentication:type=enum:default=sha:requires=[auth]
Enum:
md5
sha
priv-password (optional)
String desc=privilege password:password=true:requires=[priv]

snmp-user-show - Up

display SNMPv3 users
api.switch-name (optional)
user-name
String desc=SNMP user name
auth (optional)
Boolean desc=authentication required
priv (optional)
Boolean desc=privileges
auth-hash (optional)
String desc=Hashing algorithm for authentication:type=enum:requires=[auth]
Enum:
md5
sha

snmp-user-show-response - Up

snmp-v3-trap-sink-create - Up

create SNMPv3 trap receivers
user-name
String desc=username:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
dest-host
String desc=destination host:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, and -
type (optional)
String desc=SNMP trap type - TRAP_TYPE_V3_TRAP/TRAP_TYPE_V3_INFORM:type=enum:default=TRAP_TYPE_V3_TRAP
Enum:
TRAP_TYPE_V3_TRAP
TRAP_TYPE_V3_INFORM
dest-port (optional)
Integer desc=destination port - default 162:type=uint16:default=162 format: int32

snmp-v3-trap-sink-show - Up

display SNMPv3 trap receivers
api.switch-name (optional)
user-name
String desc=username
dest-host
String desc=destination host
dest-port
Integer desc=destination port - default 162:type=uint16 format: int32
auth (optional)
Boolean desc=authentication required:requires=[user-name]
priv (optional)
Boolean desc=privileges:requires=[user-name]
engine-id (optional)
String desc=engine ID
type (optional)
String desc=SNMP trap type - TRAP_TYPE_V3_TRAP/TRAP_TYPE_V3_INFORM:type=enum
Enum:
TRAP_TYPE_V3_TRAP
TRAP_TYPE_V3_INFORM

snmp-v3-trap-sink-show-response - Up

snmp-vacm-create - Up

create View Access Control Models (VACM)
auth (optional)
Boolean desc=authentication required
priv (optional)
Boolean desc=privileges:requires=[auth]
user-name (optional)
String desc=SNMP administrator name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/snmp-users:api-ref-model=snmp-user-show:api-ref-id=user-name:api-ref-val=user-name
user-type (optional)
String desc=SNMP user type:type=enum:requires=[user-name]
Enum:
rouser
rwuser
oid-restrict (optional)
String desc=restrict OID:precludes=[view]

snmp-vacm-modify - Up

modify View Access Control Models (VACM)
auth (optional)
Boolean desc=authentication required
priv (optional)
Boolean desc=privileges:requires=[auth]
user-type (optional)
String desc=SNMP user type:type=enum:requires=[user-name]
Enum:
rouser
rwuser
oid-restrict (optional)
String desc=restrict OID:precludes=[view]

snmp-vacm-show - Up

display View Access Control Models (VACM)
api.switch-name (optional)
user-name
String desc=SNMP administrator name:api-ref-path=/snmp-users:api-ref-model=snmp-user-show:api-ref-id=user-name:api-ref-val=user-name
view (optional)
String desc=view type:precludes=[oid-restrict]
auth (optional)
Boolean desc=authentication required
priv (optional)
Boolean desc=privileges:requires=[auth]
user-type (optional)
String desc=SNMP user type:type=enum:requires=[user-name]
Enum:
rouser
rwuser
oid-restrict (optional)
String desc=restrict OID:precludes=[view]

snmp-vacm-show-response - Up

software-license-import-product-ids - Up

import product IDs for software licensing
pid-file
String desc=PID file to import:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name

software-license-install - Up

install software licenses
key
String desc=license key

software-license-show - Up

display software licensing information
api.switch-name (optional)
license-id
String desc=license ID
id (optional)
Long desc=ID:type=uint32 format: int64
description (optional)
String desc=license type
prompt (optional)
String desc=prompt
key (optional)
String desc=license key
feature (optional)
String desc=licensed features
upgrade (optional)
Boolean desc=license is upgradeable
sysconfig (optional)
Boolean desc=system configured
pending (optional)
Boolean desc=pending
status (optional)
String desc=software license status:type=enum
Enum:
unknown
VALID
EXPIRING
GRACE
EXPIRED
upgrade-from (optional)
String desc=license upgraded from another license
pid-file (optional)
String desc=PID file to import:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
expires-on (optional)
String desc=license expiration date

software-license-show-response - Up

software-show - Up

display information about software
api.switch-name (optional)
version (optional)
String desc=software version
status (optional)
String desc= indicates whether platform is unsupported in nvOS version
track (optional)
String desc=software track name:api-ref-path=/software-tracks:api-ref-model=software-track-show:api-ref-id=name:api-ref-val=name
upgrade-status (optional)
String desc=upgrade status:type=enum
Enum:
available
up-to-date
error
pkg-out-of-date
repository-unreachable
no-upgrade-running
in-progress
waiting-to-complete
waiting-for-agent-connection
needs-reboot-to-complete
abort
resume-wait
version-available (optional)
String desc=available software versions
proxy-port (optional)
Integer desc=proxy host port:type=uint16 format: int32
download-count (optional)
Long desc=number of concurrent downloads (default: 5):type=uint32:range=[1,5] format: int64
use-proxy (optional)
Boolean desc=use a proxy host
proxy-host (optional)
String desc=proxy host name
upload-server (optional)
String desc=upload config file to server via scp:requires=[server-password]

software-show-response - Up

software-upgrade - Up

start software upgrade on local switch
package
String desc=software bundle from SFTP files:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name

software-upgrade-1 - Up

start software upgrade on local switch
auto-reboot
Boolean desc=automatically reboot after software upgrade or not (default: yes):default=true
package
String desc=software bundle from SFTP files:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name

software-upgrade-2 - Up

start software upgrade on local switch
server-password
String desc=SCP host password:password=true:requires=[upload-server]
package
String desc=software bundle from SFTP files:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
upload-server
String desc=upload config file to server via scp:requires=[server-password]

software-upgrade-3 - Up

start software upgrade on local switch
server-password
String desc=SCP host password:password=true:requires=[upload-server]
auto-reboot
Boolean desc=automatically reboot after software upgrade or not (default: yes):default=true
package
String desc=software bundle from SFTP files:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
upload-server
String desc=upload config file to server via scp:requires=[server-password]

software-upgrade-instant-status-show - Up

display the current status of software upgrade
api.switch-name (optional)
version (optional)
String desc=software version:filter=false
status (optional)
String desc= indicates whether platform is unsupported in nvOS version:filter=false
track (optional)
String desc=software track name:filter=false:api-ref-path=/software-tracks:api-ref-model=software-track-show:api-ref-id=name:api-ref-val=name
log (optional)
String desc=logs:filter=false
upgrade-status (optional)
String desc=upgrade status:type=enum:filter=false
Enum:
available
up-to-date
error
pkg-out-of-date
repository-unreachable
no-upgrade-running
in-progress
waiting-to-complete
waiting-for-agent-connection
needs-reboot-to-complete
abort
resume-wait
version-available (optional)
String desc=available software versions:filter=false
proxy-port (optional)
Integer desc=proxy host port:type=uint16:filter=false format: int32
download-count (optional)
Long desc=number of concurrent downloads (default: 5):type=uint32:range=[1,5]:filter=false format: int64
use-proxy (optional)
Boolean desc=use a proxy host:filter=false
proxy-host (optional)
String desc=proxy host name:filter=false
upload-server (optional)
String desc=upload config file to server via scp:filter=false:requires=[server-password]

software-upgrade-instant-status-show-response - Up

software-upgrade-status-show - Up

display the status of software upgrade
api.switch-name (optional)
version (optional)
String desc=software version:filter=false
status (optional)
String desc= indicates whether platform is unsupported in nvOS version:filter=false
track (optional)
String desc=software track name:filter=false:api-ref-path=/software-tracks:api-ref-model=software-track-show:api-ref-id=name:api-ref-val=name
log (optional)
String desc=logs:filter=false
upgrade-status (optional)
String desc=upgrade status:type=enum:filter=false
Enum:
available
up-to-date
error
pkg-out-of-date
repository-unreachable
no-upgrade-running
in-progress
waiting-to-complete
waiting-for-agent-connection
needs-reboot-to-complete
abort
resume-wait
version-available (optional)
String desc=available software versions:filter=false
proxy-port (optional)
Integer desc=proxy host port:type=uint16:filter=false format: int32
download-count (optional)
Long desc=number of concurrent downloads (default: 5):type=uint32:range=[1,5]:filter=false format: int64
use-proxy (optional)
Boolean desc=use a proxy host:filter=false
proxy-host (optional)
String desc=proxy host name:filter=false
upload-server (optional)
String desc=upload config file to server via scp:filter=false:requires=[server-password]

software-upgrade-status-show-response - Up

static-arp-create - Up

Create a unicast static ARP
ip
String desc=IP address to bind with MAC:type=IPv4 or IPv6 address
mac
String desc=Unicast MAC address to bind with IP:type=mac-address
vlan
Integer desc=VLAN:type=uint16:range=[1,4095]:precludes=[vxlan]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=id:api-ref-val=id format: int32
scope (optional)
String desc=local, cluster or fabric:default=local
Enum:
local
fabric
cluster

static-arp-create-1 - Up

Create a unicast static ARP
ip
String desc=IP address to bind with MAC:type=IPv4 or IPv6 address
mac
String desc=Unicast MAC address to bind with IP:type=mac-address
vxlan
Long desc=VXLAN:type=uint32:range=[1,16777215]:precludes=[vlan]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
scope (optional)
String desc=local, cluster or fabric:default=local
Enum:
local
fabric
cluster

static-arp-show - Up

display unicast static ARP Entries
api.switch-name (optional)
ip
String desc=IP address to bind with MAC:type=IPv4 or IPv6 address
vxlan
Long desc=VXLAN:type=uint32:range=[1,16777215]:precludes=[vlan]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
vlan
Integer desc=VLAN:type=uint16:range=[1,4095]:precludes=[vxlan]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=id:api-ref-val=id format: int32
scope (optional)
String desc=local, cluster or fabric
Enum:
local
fabric
cluster
mac (optional)
String desc=Unicast MAC address to bind with IP:type=mac-address

static-arp-show-response - Up

static-ecmp-group-create - Up

create a static ECMP group
group-name
String desc=static ecmp group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope (optional)
String desc=local, cluster or fabric:default=local
Enum:
local
fabric
cluster
vrf (optional)
String desc=name of the dvrf service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[vrouter-name]:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
vrouter-name (optional)
String desc=name of the vrouter service:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
hash-type (optional)
String desc=ECMP hash type:type=enum
Enum:
static-fixed
resilient
dynamic-normal
vnet-id (optional)
String desc=VNET for the static ecmp group:type=identifier:requires=[vrf]:precludes=[vrouter-name]:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

static-ecmp-group-modify - Up

update static ECMP group
vrf (optional)
String desc=name of the dvrf service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[vrouter-name]:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
vrouter-name (optional)
String desc=name of the vrouter service:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
hash-type (optional)
String desc=ECMP hash type:type=enum
Enum:
static-fixed
resilient
dynamic-normal
vnet-id (optional)
String desc=VNET for the static ecmp group:type=identifier:requires=[vrf]:precludes=[vrouter-name]:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

static-ecmp-group-nh-add - Up

add a nexthop to static ECMP group
ip
String desc=gateway IP address:type=IPv4 or IPv6 address

static-ecmp-group-nh-show - Up

display nexthops in static ECMP group
api.switch-name (optional)
ip
String desc=gateway IP address:type=IPv4 or IPv6 address
vlan (optional)
Integer desc=vlan of nexthop:type=uint16:range=[0,4095] format: int32
egress-id (optional)
Integer desc=hw egress ID format: int32

static-ecmp-group-nh-show-response - Up

static-ecmp-group-show - Up

display static ECMP groups
api.switch-name (optional)
group-name
String desc=static ecmp group name
scope (optional)
String desc=local, cluster or fabric
Enum:
local
fabric
cluster
vrf (optional)
String desc=name of the dvrf service:precludes=[vrouter-name]:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
vrid (optional)
Integer desc=hardware vrouter ID format: int32
hw-ecmp-id (optional)
Integer desc=static ecmp group hw-id format: int32
vrouter-name (optional)
String desc=name of the vrouter service:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
hash-type (optional)
String desc=ECMP hash type:type=enum
Enum:
static-fixed
resilient
dynamic-normal
vnet-id (optional)
String desc=VNET for the static ecmp group:type=identifier:requires=[vrf]:precludes=[vrouter-name]:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

static-ecmp-group-show-response - Up

storage-device-free - Up

Remove existing partition/data from disk
name
String desc=storage device name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

storage-device-show - Up

display storage devices on the server-switch
api.switch-name (optional)
name
String desc=storage device name
label (optional)
String desc=storage device label
disk (optional)
String desc=storage disk
capacity (optional)
Long desc=storage capacity:type=uint64 format: int64
path (optional)
String desc=file path
type (optional)
String desc=storage disk type:type=enum
Enum:
disk
flash
data-set (optional)
String desc=type of data set
status (optional)
String desc=status of device:type=enum
Enum:
faulty
ok
blocked
spare
write_error
want_replacement
in-use (optional)
Boolean desc=storage device is in use

storage-device-show-response - Up

storage-pool-create - Up

create a storage pool
name
String desc=pool store name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
device1
String desc=name of storage device 1:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/storage-devices:api-ref-model=storage-device-show:api-ref-id=name:api-ref-val=name
device2 (optional)
String desc=name of storage device 2:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/storage-devices:api-ref-model=storage-device-show:api-ref-id=name:api-ref-val=name
device3 (optional)
String desc=name of storage device 3:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/storage-devices:api-ref-model=storage-device-show:api-ref-id=name:api-ref-val=name
device4 (optional)
String desc=name of storage device 4:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/storage-devices:api-ref-model=storage-device-show:api-ref-id=name:api-ref-val=name
raid-type (optional)
String desc=RAID type:type=enum:default=no-raid
Enum:
no-raid
mirror
raid5

storage-pool-device-add - Up

add storage pool
name
String desc=storage device name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

storage-pool-device-replace - Up

replace a storage pool on a storage device
name
String desc=storage device name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

storage-pool-device-show - Up

display storage pool devices
api.switch-name (optional)
name
String desc=storage device name
label (optional)
String desc=storage device label
disk (optional)
String desc=storage disk
capacity (optional)
Long desc=storage capacity:type=uint64 format: int64
path (optional)
String desc=file path
type (optional)
String desc=storage disk type:type=enum
Enum:
disk
flash
data-set (optional)
String desc=type of data set
status (optional)
String desc=status of device:type=enum
Enum:
faulty
ok
blocked
spare
write_error
want_replacement
in-use (optional)
Boolean desc=storage device is in use

storage-pool-device-show-response - Up

storage-pool-modify - Up

modify a storage pool on a storage device
raid-type (optional)
String desc=RAID type:type=enum:default=no-raid
Enum:
no-raid
mirror
raid5

storage-pool-show - Up

display storage pools
api.switch-name (optional)
name
String desc=pool store name
device1 (optional)
String desc=name of storage device 1:api-ref-path=/storage-devices:api-ref-model=storage-device-show:api-ref-id=name:api-ref-val=name
device2 (optional)
String desc=name of storage device 2:api-ref-path=/storage-devices:api-ref-model=storage-device-show:api-ref-id=name:api-ref-val=name
device3 (optional)
String desc=name of storage device 3:api-ref-path=/storage-devices:api-ref-model=storage-device-show:api-ref-id=name:api-ref-val=name
device4 (optional)
String desc=name of storage device 4:api-ref-path=/storage-devices:api-ref-model=storage-device-show:api-ref-id=name:api-ref-val=name
used (optional)
Long desc=total storage space used:type=uint64 format: int64
avail (optional)
Long desc=available storage space:type=uint64 format: int64
status (optional)
String desc=status of storage pool:type=enum
Enum:
corrupt-cache
missing-dev-r
missing-dev-nr
corrupt-label-r
corrupt-label-nr
bad-guid-sum
corrupt-pool
corrupt-data
failing-dev
version-newer
hostid-mismatch
io-failure-wait
io-failure-continue
bad-log
failed-dev-r
failed-dev-nr
version-older
resilvering
offline-dev
removed-dev
ok
degraded-dev-dtl
low-disk-space
state (optional)
String desc=storage pool health
ha-pool (optional)
String desc=HA-pool name (if any)
data-set (optional)
String desc=data set
raid-type (optional)
String desc=RAID type:type=enum
Enum:
no-raid
mirror
raid5
peer-pool (optional)
String desc=Peer-pool name (if any)
peer-switch (optional)
Long desc=Peer-switch where peer-pool resides:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64

storage-pool-show-response - Up

storage-stats-show - Up

display statistics about storage
api.switch-name (optional)
port (optional)
Integer desc=service type on port:type=uint16 format: int32
write-bytes (optional)
Long desc=bytes written:type=uint64 format: int64
read-bytes (optional)
Long desc=bytes read:type=uint64 format: int64
switch (optional)
Long desc=switch name:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
server-ip (optional)
String desc=storage server IP address:type=IPv4 or IPv6 address

storage-stats-show-response - Up

stp-modify - Up

modify Spanning Tree Protocol parameters
enable (optional)
Boolean desc=enable or disable STP:default=true
max-age (optional)
Integer desc=maximum age time between 6 and 40 secs - default 20:range=[6,40]:default=20 format: int32
stp-mode (optional)
String desc=STP mode:type=enum:default=rstp
Enum:
rstp
mstp
bpdus-bridge-ports (optional)
Boolean desc=BPDU packets to bridge specific port:default=true
bridge-id (optional)
String desc=STP bridge id:type=mac-address
bridge-priority (optional)
Long desc=STP bridge priority - Multiples of 4096, default 32768:type=uint64:range=[0,61440]:default=32768 format: int64
hello-time (optional)
Integer desc=STP hello time between 1 and 10 secs - default 2:range=[1,10]:default=2 format: int32
forwarding-delay (optional)
Integer desc=STP forwarding delay between 4 and 30 secs - default 15:range=[4,30]:default=15 format: int32
mst-max-hops (optional)
Integer desc=maximum hop count for mstp bpdu - default 20:range=[1,32]:default=20 format: int32
mst-config-name (optional)
String desc=Name for MST Configuration Instance:default=Pluribus:pattern=^[a-zA-Z0-9_-]+$:pattern-help=letters, numbers, _, and -
mst-config-revision (optional)
Integer desc=MST Revision from 0 to 65535:type=uint16:default=0 format: int32
root-guard-wait-time (optional)
Integer desc=root guard wait time between 0 and 300 secs - default 20, 0 to disable wait:range=[0,300]:default=20 format: int32

stp-port-event-show - Up

display information about STP port events
api.switch-name (optional)
port (optional)
Long desc=port for STP events collection:type=uint32 format: int64
vlan (optional)
String desc=VLAN for STP events collection:type=vlan-list
instance (optional)
Integer desc=Instance for STP events collection:type=uint16 format: int32
count (optional)
Integer desc=number of STP port events format: int32
initial-state (optional)
String desc=STP initial state:type=enum
Enum:
Disabled
Discarding
Learning
Forwarding
other-state (optional)
String desc=STP port event other state:type=enum
Enum:
Disabled
Discarding
Learning
Forwarding
final-state (optional)
String desc=STP port event final state:type=enum
Enum:
Disabled
Discarding
Learning
Forwarding
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

stp-port-event-show-response - Up

stp-port-modify - Up

modify Spanning Tree Protocol (STP) parameters
block (optional)
String desc=Specify if a STP port blocks BPDUs:type=enum:default=no-block
Enum:
block
no-block
filter (optional)
String desc=STP port filters BPDUs:type=enum:default=no-filter
Enum:
filter
no-filter
edge (optional)
Boolean desc=STP port is an edge port:default=false
priority (optional)
Integer desc=STP port priority from 0 to 240 - default 128:type=uint8:range=[0,240]:default=128 format: int32
cost (optional)
Long desc=STP port cost from 1 to 200000000 - default 2000:type=uint32:range=[1,200000000]:default=2000 format: int64
bpdu-guard (optional)
Boolean desc=STP port BPDU guard:default=false
root-guard (optional)
Boolean desc=STP port Root guard:default=false

stp-port-show - Up

display STP parameters
api.switch-name (optional)
port
String desc=STP port:type=port-list
block (optional)
String desc=Specify if a STP port blocks BPDUs:type=enum
Enum:
block
no-block
filter (optional)
String desc=STP port filters BPDUs:type=enum
Enum:
filter
no-filter
edge (optional)
Boolean desc=STP port is an edge port
priority (optional)
Integer desc=STP port priority from 0 to 240 - default 128:type=uint8:range=[0,240] format: int32
cost (optional)
Long desc=STP port cost from 1 to 200000000 - default 2000:type=uint32:range=[1,200000000] format: int64
bpdu-guard (optional)
Boolean desc=STP port BPDU guard
root-guard (optional)
Boolean desc=STP port Root guard

stp-port-show-response - Up

stp-port-state-show - Up

display spanning tree port state
api.switch-name (optional)
vlan (optional)
String desc=vlan for Spanning Tree Group:type=vlan-list
port (optional)
String desc=port number:type=port-list
role (optional)
String desc=port role:type=enum
Enum:
Disabled
Root
Designated
Alternate
Backup
state (optional)
String desc=port state machine state:type=flag
Enum:
new-info
proposing
proposed
agree
agreed
learn
learning
forward
forwarding
reselect
selected
reroot
rcvd-bpdu
rcvd-msg
rcvd-tc
rcvd-tc-ack
send-rstp
tc-prop
tc-ack
update-info
sync
synced
disputed
fdb-flush
online
looping
manual-online
edge
vlag-local-up
vlag-remote-up
requested-online
first-sync
p-is-d
p-is-m
root-guard-active
peer (optional)
Boolean desc=STP peer state
selected-role (optional)
String desc=selected port role:type=enum
Enum:
Disabled
Root
Designated
Alternate
Backup
designated-priority (optional)
String desc=designated priority vector
port-priority (optional)
String desc=port priority vector
message-priority (optional)
String desc=message priority vector
info-is (optional)
String desc=origin of port information:type=enum
Enum:
disabled
received
mine
aged
designated-times (optional)
String desc=designated times: age, max age, hello, forward delay
port-times (optional)
String desc=port times: age, max age, hello, forward delay
message-times (optional)
String desc=message times: age, max age, hello, forward delay
hello-timer (optional)
Integer desc=hello timer value:type=uint16 format: int32
forward-timer (optional)
Integer desc=forward delay timer value:type=uint16 format: int32
rcvd-info-timer (optional)
Integer desc=received info timer value:type=uint16 format: int32
recent-root-timer (optional)
Integer desc=recent root timer value:type=uint16 format: int32
recent-backup-timer (optional)
Integer desc=recent backup timer value:type=uint16 format: int32
edge-delay-timer (optional)
Integer desc=edge delay timer value:type=uint16 format: int32
migration-timer (optional)
Integer desc=migration delay timer value:type=uint16 format: int32
root-guard-timer (optional)
Integer desc=root guard bpdu delay timer value:type=uint16 format: int32
sm-table-bits (optional)
String desc=state machine table state:type=uint32:hex=0x[0-9a-fA-F]{8}
sm-table (optional)
String desc=state machine table description
vlag-peer-port (optional)
Long desc=vlag peer port if active-active:type=uint32 format: int64
topology-timer (optional)
Integer desc=topology change timer value:type=uint16 format: int32
stp-state (optional)
String desc=forwarding state:type=enum
Enum:
Disabled
Discarding
Learning
Forwarding

stp-port-state-show-response - Up

stp-show - Up

display Spanning Tree Protocol parameters
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable STP
max-age (optional)
Integer desc=maximum age time between 6 and 40 secs - default 20:range=[6,40] format: int32
mst-config-digest (optional)
String desc=Configuration Digest
cluster-mode (optional)
String desc=STP cluster mode:type=enum
Enum:
none
master
slave
mst-digest-mismatch-on-ports (optional)
String desc=MST digest mismatch:type=port-list
mst-digest-mismatch-on-peer-ports (optional)
String desc=MST digest mismatch for cluster peer:type=port-list
mst-config-id-mismatch-on-ports (optional)
String desc=MST Config ID mismatch:type=port-list
mst-config-id-mismatch-on-peer-ports (optional)
String desc=MST Config ID mismatch for cluster peer:type=port-list
mst-revision-mismatch-on-ports (optional)
String desc=MST Revision mismatch:type=port-list
mst-revision-mismatch-on-peer-ports (optional)
String desc=MST Revision mismatch for cluster peer:type=port-list
stp-mode (optional)
String desc=STP mode:type=enum
Enum:
rstp
mstp
bpdus-bridge-ports (optional)
Boolean desc=BPDU packets to bridge specific port
bridge-id (optional)
String desc=STP bridge id:type=mac-address
bridge-priority (optional)
Long desc=STP bridge priority - Multiples of 4096, default 32768:type=uint64:range=[0,61440] format: int64
hello-time (optional)
Integer desc=STP hello time between 1 and 10 secs - default 2:range=[1,10] format: int32
forwarding-delay (optional)
Integer desc=STP forwarding delay between 4 and 30 secs - default 15:range=[4,30] format: int32
mst-max-hops (optional)
Integer desc=maximum hop count for mstp bpdu - default 20:range=[1,32] format: int32
mst-config-name (optional)
String desc=Name for MST Configuration Instance
mst-config-revision (optional)
Integer desc=MST Revision from 0 to 65535:type=uint16 format: int32
root-guard-wait-time (optional)
Integer desc=root guard wait time between 0 and 300 secs - default 20, 0 to disable wait:range=[0,300] format: int32

stp-show-response - Up

stp-state-show - Up

display STP State information
api.switch-name (optional)
vlan (optional)
String desc=STP VLAN:type=vlan-list
name (optional)
String desc=STP name
disabled (optional)
String desc=STP disabled port list:type=port-list:filter=false
learning (optional)
String desc=STP learning port list:type=port-list:filter=false
forwarding (optional)
String desc=STP forwarding port list:type=port-list:filter=false
discarding (optional)
String desc=discarding:type=port-list:filter=false
edge (optional)
String desc=STP edge port list:type=port-list:filter=false
designated (optional)
String desc=STP designated port list:type=port-list:filter=false
alternate (optional)
String desc=STP alternate port list:type=port-list:filter=false
backup (optional)
String desc=STP backup port list:type=port-list:filter=false
internal (optional)
Boolean desc=STP internal state
peer (optional)
Boolean desc=STP peer state
instance-id (optional)
Integer desc=STP Instance Id format: int32
max-age (optional)
Integer desc=maximum age time between 6 and 40 seconds format: int32
root-port(peer) (optional)
Integer desc=STP root-port(peer) format: int32
nonroot-reroot-timer (optional)
String desc=nonroot-reroot timer:type=port-list:filter=false
run-scheduled (optional)
Boolean desc=run-scheduled:filter=false
fwd-delay-timer (optional)
String desc=forward delay timer:type=port-list:filter=false
topo-change-timer (optional)
String desc=topology change timer:type=port-list:filter=false
root-id (optional)
String desc=STP root-id:type=mac-address
root-priority (optional)
Long desc=STP root-priority:type=uint64 format: int64
root-port (optional)
Integer desc=STP root-port format: int32
ports (optional)
String desc=STP ports:type=port-list
bridge-id (optional)
String desc=STP bridge id:type=mac-address
bridge-priority (optional)
Integer desc=STP bridge-priority format: int32
hello-time (optional)
Integer desc=STP hello-time format: int32
forwarding-delay (optional)
Integer desc=STP forwarding delay between 4 and 30 seconds format: int32

stp-state-show-response - Up

subnet-create - Up

create subnet
vrf
String desc=vrf,subnet belongs to:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
name (optional)
String desc=subnet name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope (optional)
String desc=scope of the subnet:default=fabric
Enum:
local
fabric
cluster
vxlan (optional)
Long desc=VXLAN VNID:type=uint32:range=[0,16777215]:precludes=[vlan]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
network (optional)
String desc=ip subnet network:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=ip subnet netmask:type=netmask:mask-for=[network] format: int32
network6 (optional)
String desc=ip subnet network:type=IPv4 or IPv6 address
netmask6 (optional)
Integer desc=ip subnet netmask:type=netmask:mask-for=[network6] format: int32
enable (optional)
Boolean desc=enable/disable subnet routing:default=true
forward-proto (optional)
String desc=protocol type to forward packets:type=enum:default=dhcp
Enum:
dhcp
forward-ip (optional)
String desc=forwarding IPv4 address:type=IPv4 or IPv6 address
description (optional)
String desc=subnet description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
anycast-gw-ip (optional)
String desc=anycast gw-ip for the subnet:type=IPv4 or IPv6 address:requires=[network]
anycast-gw-ip6 (optional)
String desc=anycast gw-ip for the subnet:type=IPv4 or IPv6 address:requires=[network6]
packet-relay (optional)
String desc=enable packet relay:type=enum:default=disable
Enum:
enable
disable
none
forward-ip2 (optional)
String desc=second forwarding IPv4 address:type=IPv4 or IPv6 address
forward-ip6 (optional)
String desc=forwarding IPv6 address:type=IPv4 or IPv6 address
forward-ip6-2 (optional)
String desc=second forwarding IPv6 address:type=IPv4 or IPv6 address
flood (optional)
String desc=flooding state of BUM traffic:type=enum:default=none
Enum:
enable
disable
none
evpn-export-leaked-networks (optional)
String desc=exporting leaked subnets to eVPN overlay:type=enum:default=permit
Enum:
permit
deny
vnet-id (optional)
String desc=VNET of the network:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan :default=false

subnet-modify - Up

modify subnet
network (optional)
String desc=ip subnet network:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=ip subnet netmask:type=netmask:mask-for=[network] format: int32
network6 (optional)
String desc=ip subnet network:type=IPv4 or IPv6 address
netmask6 (optional)
Integer desc=ip subnet netmask:type=netmask:mask-for=[network6] format: int32
enable (optional)
Boolean desc=enable/disable subnet routing:default=true
forward-proto (optional)
String desc=protocol type to forward packets:type=enum:default=dhcp
Enum:
dhcp
forward-ip (optional)
String desc=forwarding IPv4 address:type=IPv4 or IPv6 address
description (optional)
String desc=subnet description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
anycast-gw-ip (optional)
String desc=anycast gw-ip for the subnet:type=IPv4 or IPv6 address:requires=[network]
anycast-gw-ip6 (optional)
String desc=anycast gw-ip for the subnet:type=IPv4 or IPv6 address:requires=[network6]
packet-relay (optional)
String desc=enable packet relay:type=enum:default=disable
Enum:
enable
disable
none
forward-ip2 (optional)
String desc=second forwarding IPv4 address:type=IPv4 or IPv6 address
forward-ip6 (optional)
String desc=forwarding IPv6 address:type=IPv4 or IPv6 address
forward-ip6-2 (optional)
String desc=second forwarding IPv6 address:type=IPv4 or IPv6 address
flood (optional)
String desc=flooding state of BUM traffic:type=enum:default=none
Enum:
enable
disable
none
evpn-export-leaked-networks (optional)
String desc=exporting leaked subnets to eVPN overlay:type=enum:default=permit
Enum:
permit
deny
wake-on-lan (optional)
Boolean desc=wake on lan :default=false

subnet-show - Up

display subnet
api.switch-name (optional)
name
String desc=subnet name
vnet-id
String desc=VNET of the network:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
scope (optional)
String desc=scope of the subnet
Enum:
local
fabric
cluster
vlan (optional)
Integer desc=VLAN:type=uint16:range=[0,4095]:precludes=[vxlan]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=id:api-ref-val=id format: int32
vxlan (optional)
Long desc=VXLAN VNID:type=uint32:range=[0,16777215]:precludes=[vlan]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
vrf (optional)
String desc=vrf,subnet belongs to:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
network (optional)
String desc=ip subnet network:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=ip subnet netmask:type=netmask:mask-for=[network] format: int32
network6 (optional)
String desc=ip subnet network:type=IPv4 or IPv6 address
netmask6 (optional)
Integer desc=ip subnet netmask:type=netmask:mask-for=[network6] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
state (optional)
String desc=subnet state:type=enum
Enum:
init
ok
vxlan not found
vxlan deactivated
not-in-hw
vrouter interface exists
enable (optional)
Boolean desc=enable/disable subnet routing
leaked-on (optional)
String desc=leaked vrf list
forward-proto (optional)
String desc=protocol type to forward packets:type=enum
Enum:
dhcp
forward-ip (optional)
String desc=forwarding IPv4 address:type=IPv4 or IPv6 address
description (optional)
String desc=subnet description
anycast-gw-ip (optional)
String desc=anycast gw-ip for the subnet:type=IPv4 or IPv6 address:requires=[network]
anycast-gw-ip6 (optional)
String desc=anycast gw-ip for the subnet:type=IPv4 or IPv6 address:requires=[network6]
packet-relay (optional)
String desc=enable packet relay:type=enum
Enum:
enable
disable
none
forward-ip2 (optional)
String desc=second forwarding IPv4 address:type=IPv4 or IPv6 address
forward-ip6 (optional)
String desc=forwarding IPv6 address:type=IPv4 or IPv6 address
forward-ip6-2 (optional)
String desc=second forwarding IPv6 address:type=IPv4 or IPv6 address
flood (optional)
String desc=flooding state of BUM traffic:type=enum
Enum:
enable
disable
none
evpn-export-leaked-networks (optional)
String desc=exporting leaked subnets to eVPN overlay:type=enum
Enum:
permit
deny
wake-on-lan (optional)
Boolean desc=wake on lan
hw-state (optional)
Boolean desc=subnet state in rib/fib

subnet-show-response - Up

switch-boot-solaris - Up

Boot switch to Solaris
name
String desc=boot environment name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

switch-config-copy-to-import - Up

copy a configuration to import to another server-switch
export-file
String desc=export a nvOS config file:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/switch-configs:api-ref-model=switch-config-show:api-ref-id=export-file:api-ref-val=export-file

switch-config-export - Up

export a switch configuration
export-file (optional)
String desc=export a nvOS config file:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/switch-configs:api-ref-model=switch-config-show:api-ref-id=export-file:api-ref-val=export-file
upload-server (optional)
String desc=upload config file to server via scp:requires=[server-password]

switch-config-import - Up

import a switch configuration
import-file
String desc=config file to import:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/switch-configs:api-ref-model=switch-config-show:api-ref-id=import-file:api-ref-val=import-file
apply-system-config (optional)
Boolean desc=apply system config file to server-switch

switch-config-show - Up

display the current switch configuration
api.switch-name (optional)
import-file (optional)
String desc=config file to import:api-ref-path=/switch-configs:api-ref-model=switch-config-show:api-ref-id=import-file:api-ref-val=import-file
apply-system-config (optional)
Boolean desc=apply system config file to server-switch
export-file (optional)
String desc=export a nvOS config file:api-ref-path=/switch-configs:api-ref-model=switch-config-show:api-ref-id=export-file:api-ref-val=export-file
upload-server (optional)
String desc=upload config file to server via scp:requires=[server-password]

switch-config-show-response - Up

switch-group-create - Up

create a switch group
name (optional)
String desc=switch group name
description (optional)
String desc=switch group description

switch-group-member-add - Up

add switches to the group
member (optional)
String desc=switch name:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=name:api-ref-val=name

switch-group-member-show - Up

display switch group member
api.switch-name (optional)
member
String desc=switch name:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=name:api-ref-val=name

switch-group-member-show-response - Up

switch-group-modify - Up

update switch group
description (optional)
String desc=switch group description

switch-group-show - Up

display switch group
api.switch-name (optional)
name
String desc=switch group name
description (optional)
String desc=switch group description

switch-group-show-response - Up

switch-info-show - Up

display information about the switch
api.switch-name (optional)
model (optional)
String desc=hardware model
chassis-serial (optional)
String desc=chassis serial number
cpu4-type (optional)
String desc=CPU 4 type
system-mem (optional)
Long desc=system memory:type=uint64 format: int64
switch-device (optional)
String desc=switch device status
polaris-device (optional)
String desc=polaris device status
gandalf-version (optional)
String desc=firmware version:type=uint32:hex=0x[0-9a-fA-F]{8}
cpu-cpld-version (optional)
String desc=cpu cpld version
switch-cpld-version (optional)
String desc=switch cpld version
bmc-cpld-version (optional)
String desc=bmc cpld version
fan1-status (optional)
String desc=fan 1 status
fan2-status (optional)
String desc=fan 2 status
fan3-status (optional)
String desc=fan 3 status
fan4-status (optional)
String desc=fan 4 status
fan5-status (optional)
String desc=fan 5 status
fan6-status (optional)
String desc=fan 6 status
fan7-status (optional)
String desc=fan 7 status
fan8-status (optional)
String desc=fan 8 status
fan9-status (optional)
String desc=fan 9 status
fan10-status (optional)
String desc=fan 10 status
fan11-status (optional)
String desc=fan 11 status
fan12-status (optional)
String desc=fan 12 status
fan13-status (optional)
String desc=fan 13 status
fan14-status (optional)
String desc=fan 14 status
fan15-status (optional)
String desc=fan 15 status
fan16-status (optional)
String desc=fan 16 status
ps1-status (optional)
String desc=power supply 1 status
ps2-status (optional)
String desc=power supply 2 status
disk-model (optional)
String desc=root disk model name
disk-serial (optional)
String desc=root disk serial number
disk-firmware (optional)
String desc=root disk firmware revision
disk-size (optional)
Long desc=total disk capacity:type=uint64 format: int64
disk-type (optional)
String desc=type of disk SSD/non-SSD, TRIM status
bios-vendor (optional)
String desc=BIOS vendor name
bios-version (optional)
String desc=BIOS version number
bmc-version (optional)
String desc=bmc version
netvisor-cert-valid-from (optional)
String desc=Switch certificate validity start date
netvisor-cert-valid-till (optional)
String desc=Switch certificate validity end date
cpu1-type (optional)
String desc=CPU 1 type
cpu2-type (optional)
String desc=CPU 2 type
cpu3-type (optional)
String desc=CPU 3 type

switch-info-show-response - Up

switch-mode-modify - Up

modify the mode of a server-switch
switch-mode
String desc=switch mode:type=enum
Enum:
store-and-forward
virtual-wire

switch-mode-show - Up

display switch mode information
api.switch-name (optional)
switch-mode (optional)
String desc=switch mode:type=enum
Enum:
store-and-forward
virtual-wire

switch-mode-show-response - Up

switch-nic-info-show - Up

display the nic info
api.switch-name (optional)
name
String desc=nic interface:api-ref-path=/switch-nic-stats-lists:api-ref-model=switch-nic-stats-list-show:api-ref-id=name:api-ref-val=name
driver (optional)
String desc=NIC Driver:filter=false
version (optional)
String desc=NIC Driver version:filter=false
firmware (optional)
String desc=NIC Firmware version:filter=false
speed (optional)
Long desc=NIC Speed in Mbps:type=uint32:filter=false format: int64
rxqnum (optional)
Long desc=Number of rx rings:type=uint32:filter=false format: int64
txqnum (optional)
Long desc=Number of tx rings:type=uint32:filter=false format: int64
rxqsize (optional)
Long desc=Size of rx rings:type=uint32:filter=false format: int64
txqsize (optional)
Long desc=Size of tx rings:type=uint32:filter=false format: int64
autoneg (optional)
Boolean desc=Autoneg:filter=false
rxpause (optional)
Boolean desc=RX pause frames:filter=false
txpause (optional)
Boolean desc=TX pause frames:filter=false

switch-nic-info-show-response - Up

switch-nic-stats-settings-modify - Up

modify nic settings for collecting statistics
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

switch-nic-stats-settings-show - Up

display nic settings for collecting statistics
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

switch-nic-stats-settings-show-response - Up

switch-nic-stats-show - Up

display the packet stats for a nic
api.switch-name (optional)
name
String desc=nic interface:api-ref-path=/switch-nic-stats-lists:api-ref-model=switch-nic-stats-list-show:api-ref-id=name:api-ref-val=name
ipkts (optional)
Long desc=incoming packets:type=uint64:filter=false format: int64
ibytes (optional)
Long desc=incoming bytes:type=uint64:filter=false format: int64
opkts (optional)
Long desc=outgoing packets:type=uint64:filter=false format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64:filter=false format: int64
ierrs (optional)
Long desc=incoming errors:type=uint64:filter=false format: int64
oerrs (optional)
Long desc=outgoing errors:type=uint64:filter=false format: int64
idrops (optional)
Long desc=incoming drops:type=uint64:filter=false format: int64
odrops (optional)
Long desc=outgoing drops:type=uint64:filter=false format: int64
imcast (optional)
Long desc=incoming multicast:type=uint64:filter=false format: int64
omcast (optional)
Long desc=outgoing multicast:type=uint64:filter=false format: int64
ibcast (optional)
Long desc=incoming broadcast:type=uint64:filter=false format: int64
obcast (optional)
Long desc=outgoing broadcast:type=uint64:filter=false format: int64
mcast (optional)
Long desc=total multicast:type=uint64:filter=false format: int64
bcast (optional)
Long desc=total broadcast:type=uint64:filter=false format: int64
ioverruns (optional)
Long desc=incoming overruns:type=uint64:filter=false format: int64
rxnobuf (optional)
Long desc=no rx buffers:type=uint64:filter=false format: int64
icrcerrs (optional)
Long desc=rx crc errors:type=uint64:filter=false format: int64
iframeerrs (optional)
Long desc=rx frame errors:type=uint64:filter=false format: int64
ififoerrs (optional)
Long desc=rx fifo errors:type=uint64:filter=false format: int64
ofifoerrs (optional)
Long desc=tx fifo errors:type=uint64:filter=false format: int64
ilongerrs (optional)
Long desc=rx long length errors:type=uint64:filter=false format: int64
ishorterrs (optional)
Long desc=rx short length errors:type=uint64:filter=false format: int64
ipkts_0 (optional)
Long desc=incoming packets for queue 0:type=uint64:filter=false format: int64
ipkts_1 (optional)
Long desc=incoming packets for queue 1:type=uint64:filter=false format: int64
ipkts_2 (optional)
Long desc=incoming packets for queue 2:type=uint64:filter=false format: int64
ipkts_3 (optional)
Long desc=incoming packets for queue 3:type=uint64:filter=false format: int64
ipkts_4 (optional)
Long desc=incoming packets for queue 4:type=uint64:filter=false format: int64
ipkts_5 (optional)
Long desc=incoming packets for queue 5:type=uint64:filter=false format: int64
ipkts_6 (optional)
Long desc=incoming packets for queue 6:type=uint64:filter=false format: int64
ipkts_7 (optional)
Long desc=incoming packets for queue 7:type=uint64:filter=false format: int64
ipkts_8 (optional)
Long desc=incoming packets for queue 8:type=uint64:filter=false format: int64
ipkts_9 (optional)
Long desc=incoming packets for queue 9:type=uint64:filter=false format: int64
ipkts_10 (optional)
Long desc=incoming packets for queue 10:type=uint64:filter=false format: int64
ipkts_11 (optional)
Long desc=incoming packets for queue 11:type=uint64:filter=false format: int64
ipkts_12 (optional)
Long desc=incoming packets for queue 12:type=uint64:filter=false format: int64
ipkts_13 (optional)
Long desc=incoming packets for queue 13:type=uint64:filter=false format: int64
ipkts_14 (optional)
Long desc=incoming packets for queue 14:type=uint64:filter=false format: int64
ipkts_15 (optional)
Long desc=incoming packets for queue 15:type=uint64:filter=false format: int64
ipkts_16 (optional)
Long desc=incoming packets for queue 16:type=uint64:filter=false format: int64
ipkts_17 (optional)
Long desc=incoming packets for queue 17:type=uint64:filter=false format: int64
ipkts_18 (optional)
Long desc=incoming packets for queue 18:type=uint64:filter=false format: int64
ipkts_19 (optional)
Long desc=incoming packets for queue 19:type=uint64:filter=false format: int64
ipkts_20 (optional)
Long desc=incoming packets for queue 20:type=uint64:filter=false format: int64
ipkts_21 (optional)
Long desc=incoming packets for queue 21:type=uint64:filter=false format: int64
ipkts_22 (optional)
Long desc=incoming packets for queue 22:type=uint64:filter=false format: int64
ipkts_23 (optional)
Long desc=incoming packets for queue 23:type=uint64:filter=false format: int64
opkts_0 (optional)
Long desc=outgoing packets for queue 0:type=uint64:filter=false format: int64
opkts_1 (optional)
Long desc=outgoing packets for queue 1:type=uint64:filter=false format: int64
opkts_2 (optional)
Long desc=outgoing packets for queue 2:type=uint64:filter=false format: int64
opkts_3 (optional)
Long desc=outgoing packets for queue 3:type=uint64:filter=false format: int64
opkts_4 (optional)
Long desc=outgoing packets for queue 4:type=uint64:filter=false format: int64
opkts_5 (optional)
Long desc=outgoing packets for queue 5:type=uint64:filter=false format: int64
opkts_6 (optional)
Long desc=outgoing packets for queue 6:type=uint64:filter=false format: int64
opkts_7 (optional)
Long desc=outgoing packets for queue 7:type=uint64:filter=false format: int64
opkts_8 (optional)
Long desc=outgoing packets for queue 8:type=uint64:filter=false format: int64
opkts_9 (optional)
Long desc=outgoing packets for queue 9:type=uint64:filter=false format: int64
opkts_10 (optional)
Long desc=outgoing packets for queue 10:type=uint64:filter=false format: int64
opkts_11 (optional)
Long desc=outgoing packets for queue 11:type=uint64:filter=false format: int64
opkts_12 (optional)
Long desc=outgoing packets for queue 12:type=uint64:filter=false format: int64
opkts_13 (optional)
Long desc=outgoing packets for queue 13:type=uint64:filter=false format: int64
opkts_14 (optional)
Long desc=outgoing packets for queue 14:type=uint64:filter=false format: int64
opkts_15 (optional)
Long desc=outgoing packets for queue 15:type=uint64:filter=false format: int64
opkts_16 (optional)
Long desc=outgoing packets for queue 16:type=uint64:filter=false format: int64
opkts_17 (optional)
Long desc=outgoing packets for queue 17:type=uint64:filter=false format: int64
opkts_18 (optional)
Long desc=outgoing packets for queue 18:type=uint64:filter=false format: int64
opkts_19 (optional)
Long desc=outgoing packets for queue 19:type=uint64:filter=false format: int64
opkts_20 (optional)
Long desc=outgoing packets for queue 20:type=uint64:filter=false format: int64
opkts_21 (optional)
Long desc=outgoing packets for queue 21:type=uint64:filter=false format: int64
opkts_22 (optional)
Long desc=outgoing packets for queue 22:type=uint64:filter=false format: int64
opkts_23 (optional)
Long desc=outgoing packets for queue 23:type=uint64:filter=false format: int64
idrops_0 (optional)
Long desc=incoming drops for queue 0:type=uint64:filter=false format: int64
idrops_1 (optional)
Long desc=incoming drops for queue 1:type=uint64:filter=false format: int64
idrops_2 (optional)
Long desc=incoming drops for queue 2:type=uint64:filter=false format: int64
idrops_3 (optional)
Long desc=incoming drops for queue 3:type=uint64:filter=false format: int64
idrops_4 (optional)
Long desc=incoming drops for queue 4:type=uint64:filter=false format: int64
idrops_5 (optional)
Long desc=incoming drops for queue 5:type=uint64:filter=false format: int64
idrops_6 (optional)
Long desc=incoming drops for queue 6:type=uint64:filter=false format: int64
idrops_7 (optional)
Long desc=incoming drops for queue 7:type=uint64:filter=false format: int64
idrops_8 (optional)
Long desc=incoming drops for queue 8:type=uint64:filter=false format: int64
idrops_9 (optional)
Long desc=incoming drops for queue 9:type=uint64:filter=false format: int64
idrops_10 (optional)
Long desc=incoming drops for queue 10:type=uint64:filter=false format: int64
idrops_11 (optional)
Long desc=incoming drops for queue 11:type=uint64:filter=false format: int64
idrops_12 (optional)
Long desc=incoming drops for queue 12:type=uint64:filter=false format: int64
idrops_13 (optional)
Long desc=incoming drops for queue 13:type=uint64:filter=false format: int64
idrops_14 (optional)
Long desc=incoming drops for queue 14:type=uint64:filter=false format: int64
idrops_15 (optional)
Long desc=incoming drops for queue 15:type=uint64:filter=false format: int64
idrops_16 (optional)
Long desc=incoming drops for queue 16:type=uint64:filter=false format: int64
idrops_17 (optional)
Long desc=incoming drops for queue 17:type=uint64:filter=false format: int64
idrops_18 (optional)
Long desc=incoming drops for queue 18:type=uint64:filter=false format: int64
idrops_19 (optional)
Long desc=incoming drops for queue 19:type=uint64:filter=false format: int64
idrops_20 (optional)
Long desc=incoming drops for queue 20:type=uint64:filter=false format: int64
idrops_21 (optional)
Long desc=incoming drops for queue 21:type=uint64:filter=false format: int64
idrops_22 (optional)
Long desc=incoming drops for queue 22:type=uint64:filter=false format: int64
idrops_23 (optional)
Long desc=incoming drops for queue 23:type=uint64:filter=false format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

switch-nic-stats-show-response - Up

switch-route-create - Up

create a switch route
netmask
Integer desc=destination IP netmask:type=netmask:default=32:mask-for=[network] format: int32
network
String desc=destination IP address:type=IPv4 or IPv6 address
nic (optional)
String desc=NIC:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/switch-nics:api-ref-model=switch-nic-show:api-ref-id=nic:api-ref-val=nic
metric (optional)
Long desc=metric:type=uint32:range=[1,4294967295] format: int64
gateway-ip (optional)
String desc=gateway IP address:type=IPv4 or IPv6 address

switch-route-modify - Up

modify a switch route
metric (optional)
Long desc=metric:type=uint32:range=[1,4294967295] format: int64

switch-route-show - Up

display switch routes
api.switch-name (optional)
netmask
Integer desc=destination IP netmask:type=netmask:mask-for=[network] format: int32
nic
String desc=NIC:api-ref-path=/switch-nics:api-ref-model=switch-nic-show:api-ref-id=nic:api-ref-val=nic
network
String desc=destination IP address:type=IPv4 or IPv6 address
gateway-ip
String desc=gateway IP address:type=IPv4 or IPv6 address
metric (optional)
Long desc=metric:type=uint32:range=[1,4294967295] format: int64

switch-route-show-response - Up

switch-setup-modify - Up

modify switch setup
timezone (optional)
String desc=timezone:api-ref-path=/time-zones:api-ref-model=time-zone-show:api-ref-id=name:api-ref-val=name
password (optional)
String desc=plain text password:password=true
date (optional)
String desc=date:date=yyyy-mm-ddThh:mm:ss
motd (optional)
String desc=Message of the Day
banner (optional)
String desc=Banner to display on server-switch
ntp (optional)
Boolean desc=Network Time Protocol - enable or disable:default=true
switch-name (optional)
String desc=switch name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
mgmt-dot1x-enable (optional)
Boolean desc=join the switch fabric:default=false
mgmt-dot1x-version (optional)
String desc=EAPOL version:type=enum:default=802.1X-2004
Enum:
802.1X-2001
802.1X-2004
mgmt-dot1x-profiles (optional)
String desc=Management dot1x profiles
mgmt-netmask (optional)
Integer desc=netmask:type=netmask:precludes=[mgmt-ip-assignment]:mask-for=[mgmt-ip] format: int32
mgmt-ip-assignment (optional)
String desc=IP address assignment:type=enum:precludes=[mgmt-ip,mgmt-netmask]
Enum:
none
dhcp
mgmt-ip6 (optional)
String desc=IPv6 address:type=IPv4 or IPv6 address:requires=[mgmt-netmask-ip6]:precludes=[mgmt-ip6-assignment]
mgmt-netmask-ip6 (optional)
Integer desc=IPv6 netmask:type=netmask:precludes=[mgmt-ip6-assignment]:mask-for=[mgmt-ip6] format: int32
mgmt-ip6-assignment (optional)
String desc=IPv6 address assignment:type=enum:precludes=[mgmt-ip6,mgmt-netmask-ip6,gateway-ip6]
Enum:
none
autoconf
in-band-ip (optional)
String desc=data in-band IP address:type=IPv4 or IPv6 address:requires=[in-band-netmask]
in-band-netmask (optional)
Integer desc=data in-band netmask:type=netmask:mask-for=[in-band-ip] format: int32
in-band-ip6 (optional)
String desc=data in-band IPv6 address:type=IPv4 or IPv6 address:requires=[in-band-netmask-ip6]:precludes=[in-band-ip6-assign]
in-band-netmask-ip6 (optional)
Integer desc=data in-band IPv6 netmask:type=netmask:precludes=[in-band-ip6-assign]:mask-for=[in-band-ip6] format: int32
in-band-ip6-assign (optional)
String desc=data IPv6 address assignment:type=enum:precludes=[in-band-ip6,in-band-netmask-ip6]
Enum:
none
autoconf
gateway-ip6 (optional)
String desc=gateway IPv6 address:type=IPv4 or IPv6 address
loopback-ip6 (optional)
String desc=loopback IPv6 address:type=IPv4 or IPv6 address
dns-ip (optional)
String desc=DNS IP address:type=IPv4 or IPv6 address
dns-secondary-ip (optional)
String desc=secondary DNS IP address:type=IPv4 or IPv6 address
ntp-server (optional)
String desc=Primary NTP server:pattern=^[a-zA-Z0-9.-]*$:pattern-help=letters, numbers, ., -, and ''
ntp-secondary-server (optional)
String desc=Secondary NTP server:pattern=^[a-zA-Z0-9.-]*$:pattern-help=letters, numbers, ., -, and ''
mgmt-ip (optional)
String desc=management IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask,gateway-ip]:precludes=[mgmt-ip-assignment]
domain-name (optional)
String desc=domain name:pattern=^[a-zA-Z0-9.-]*$:pattern-help=letters, numbers, ., -, and ''
ntp-tertiary-server (optional)
String desc=Tertiary NTP server:pattern=^[a-zA-Z0-9.-]*$:pattern-help=letters, numbers, ., -, and ''
eula-accepted (optional)
Boolean desc=accept EULA
eula_timestamp (optional)
String desc=EULA timestamp:date=yyyy-mm-ddThh:mm:ss
analytics-store (optional)
String desc=type of disk storage for analytics:type=enum:default=default
Enum:
default
optimized
force (optional)
Boolean desc=force analytics-store change even if it involves removing data:default=false:requires=[analytics-store]
enable-host-ports (optional)
Boolean desc=Enable host ports by default:default=true
mgmt-lag (optional)
String desc=Out of Band Fabric Management Link Aggregation:type=enum
Enum:
disable
enable
active-standby
mgmt-lacp-mode (optional)
String desc=LACP mode of the mgmt interface:type=enum:default=off
Enum:
off
passive
active
disk-mirror (optional)
Boolean desc=Enable Disk mirror:default=false
gateway-ip (optional)
String desc=gateway IPv4 address:type=IPv4 or IPv6 address
loopback-ip (optional)
String desc=loopback IPv4 address:type=IPv4 or IPv6 address

switch-setup-show - Up

display general switch setup information
api.switch-name (optional)
timezone (optional)
String desc=timezone:api-ref-path=/time-zones:api-ref-model=time-zone-show:api-ref-id=name:api-ref-val=name
date (optional)
String desc=date:date=yyyy-mm-ddThh:mm:ss
hostid (optional)
Long desc=host ID:type=uint32 format: int64
motd (optional)
String desc=Message of the Day:filter=false
banner (optional)
String desc=Banner to display on server-switch:filter=false
ntp (optional)
Boolean desc=Network Time Protocol - enable or disable
switch-name (optional)
String desc=switch name
mgmt-secondary-link-speed (optional)
Long desc=management secondary link speed:type=uint32 format: int64
mgmt-link-speed (optional)
Long desc=management link speed:type=uint32 format: int64
mgmt-lag-capable (optional)
Boolean desc=Does this platform have dual mgmt NICs?
device-id (optional)
String desc=Manufacture ID for White boxes
mgmt-dot1x-status (optional)
String desc=Management dot1x status
mgmt-mac (optional)
String desc=management MAC address:type=mac-address
mgmt-link-state (optional)
String desc=management link state:type=enum
Enum:
down
up
mgmt-secondary-link-state (optional)
String desc=management secondary link state:type=enum
Enum:
down
up
mgmt-dot1x-enable (optional)
Boolean desc=join the switch fabric
mgmt-dot1x-version (optional)
String desc=EAPOL version:type=enum
Enum:
802.1X-2001
802.1X-2004
mgmt-dot1x-profiles (optional)
String desc=Management dot1x profiles
mgmt-netmask (optional)
Integer desc=netmask:type=netmask:precludes=[mgmt-ip-assignment]:mask-for=[mgmt-ip] format: int32
mgmt-ip-assignment (optional)
String desc=IP address assignment:type=enum:precludes=[mgmt-ip,mgmt-netmask]
Enum:
none
dhcp
mgmt-ip6 (optional)
String desc=IPv6 address:type=IPv4 or IPv6 address:requires=[mgmt-netmask-ip6]:precludes=[mgmt-ip6-assignment]
mgmt-netmask-ip6 (optional)
Integer desc=IPv6 netmask:type=netmask:precludes=[mgmt-ip6-assignment]:mask-for=[mgmt-ip6] format: int32
mgmt-ip6-assignment (optional)
String desc=IPv6 address assignment:type=enum:precludes=[mgmt-ip6,mgmt-netmask-ip6,gateway-ip6]
Enum:
none
autoconf
in-band-ip (optional)
String desc=data in-band IP address:type=IPv4 or IPv6 address:requires=[in-band-netmask]
in-band-netmask (optional)
Integer desc=data in-band netmask:type=netmask:mask-for=[in-band-ip] format: int32
in-band-ip6 (optional)
String desc=data in-band IPv6 address:type=IPv4 or IPv6 address:requires=[in-band-netmask-ip6]:precludes=[in-band-ip6-assign]
in-band-netmask-ip6 (optional)
Integer desc=data in-band IPv6 netmask:type=netmask:precludes=[in-band-ip6-assign]:mask-for=[in-band-ip6] format: int32
in-band-ip6-assign (optional)
String desc=data IPv6 address assignment:type=enum:precludes=[in-band-ip6,in-band-netmask-ip6]
Enum:
none
autoconf
gateway-ip6 (optional)
String desc=gateway IPv6 address:type=IPv4 or IPv6 address
loopback-ip6 (optional)
String desc=loopback IPv6 address:type=IPv4 or IPv6 address
dns-ip (optional)
String desc=DNS IP address:type=IPv4 or IPv6 address
dns-secondary-ip (optional)
String desc=secondary DNS IP address:type=IPv4 or IPv6 address
ntp-server (optional)
String desc=Primary NTP server
ntp-secondary-server (optional)
String desc=Secondary NTP server
mgmt-ip (optional)
String desc=management IP address:type=IPv4 or IPv6 address:requires=[mgmt-netmask,gateway-ip]:precludes=[mgmt-ip-assignment]
domain-name (optional)
String desc=domain name
ntp-tertiary-server (optional)
String desc=Tertiary NTP server
eula-accepted (optional)
Boolean desc=accept EULA
eula_timestamp (optional)
String desc=EULA timestamp:date=yyyy-mm-ddThh:mm:ss
analytics-store (optional)
String desc=type of disk storage for analytics:type=enum
Enum:
default
optimized
force (optional)
Boolean desc=force analytics-store change even if it involves removing data:requires=[analytics-store]
enable-host-ports (optional)
Boolean desc=Enable host ports by default
mgmt-lag (optional)
String desc=Out of Band Fabric Management Link Aggregation:type=enum
Enum:
disable
enable
active-standby
mgmt-lacp-mode (optional)
String desc=LACP mode of the mgmt interface:type=enum
Enum:
off
passive
active
disk-mirror (optional)
Boolean desc=Enable Disk mirror
location-id (optional)
Long desc=Location ID:type=uint32 format: int64
gateway-ip (optional)
String desc=gateway IPv4 address:type=IPv4 or IPv6 address
loopback-ip (optional)
String desc=loopback IPv4 address:type=IPv4 or IPv6 address

switch-setup-show-response - Up

switch-status-settings-modify - Up

modify status settings
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

switch-status-settings-show - Up

display status settings
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

switch-status-settings-show-response - Up

switch-status-show - Up

display the status of a switch
api.switch-name (optional)
name (optional)
String desc=hardware name
units (optional)
String desc=hardware units:type=enum
Enum:
degrees-C
volts
rpm
watts
state (optional)
String desc=hardware state:type=enum
Enum:
ok
fault
fatal
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
value (optional)
String desc=hardware value

switch-status-show-response - Up

switch-vnic-create - Up

create a virtual NIC
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
exclusive (optional)
Boolean desc=exclusive interface:default=false:precludes=[l3-port]
assignment (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip,netmask]
Enum:
none
dhcp
dhcpv6
sriov-vf (optional)
Boolean desc=sriov vnic:default=false:precludes=[vm-nic-type,mirror-traffic]
mirror-traffic (optional)
Boolean desc=Mirror physical nic traffic to vnic:default=false:precludes=[sriov-vf]
vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[vlan]:precludes=[vnet-id]
Enum:
public
private
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan :default=false
vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:default=1:precludes=[alias-on] format: int32
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
if (optional)
String desc=interface type:type=enum:precludes=[alias-on]
Enum:
mgmt
data
span
span2
span3
alias-on (optional)
String desc=alias name:precludes=[vlan,if,nic]
nic-config (optional)
Boolean desc=NIC config:default=true
vrrp-id (optional)
Long desc=ID assigned to VRRP:type=uint32:range=[0,255]:default=254:requires=[vrrp-primary] format: int64
vrrp-primary (optional)
String desc=VRRP primary interface
vrrp-adv-int (optional)
Integer desc=VRRP Advertisement Interval (ms, min 300, max 40950, default 1000):type=uint16:range=[300,40950] format: int32
vrrp-preempt-mode (optional)
String desc=Used to allow/prevent high prio BACKUP from becoming MASTER:type=enum:default=enable
Enum:
disable
enable
secondary-macs (optional)
String desc=secondary MAC addresses:pattern=^[a-fA-F0-9:,]+$|^none$|^$
if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
priority-tag (optional)
Boolean desc=Add priority tag on forwarded traffic:default=false
vm-nic-type (optional)
String desc=interface NIC type:type=enum:precludes=[sriov-vf]
Enum:
e1000
virtio

switch-vnic-modify - Up

modify a virtual NIC
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
exclusive (optional)
Boolean desc=exclusive interface:default=false:precludes=[l3-port]
assignment (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip,netmask]
Enum:
none
dhcp
dhcpv6
sriov-vf (optional)
Boolean desc=sriov vnic:default=false:precludes=[vm-nic-type,mirror-traffic]
mirror-traffic (optional)
Boolean desc=Mirror physical nic traffic to vnic:default=false:precludes=[sriov-vf]
vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[vlan]:precludes=[vnet-id]
Enum:
public
private
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan :default=false
if (optional)
String desc=interface type:type=enum:precludes=[alias-on]
Enum:
mgmt
data
span
span2
span3
alias-on (optional)
String desc=alias name:precludes=[vlan,if,nic]
nic-config (optional)
Boolean desc=NIC config:default=true
secondary-macs (optional)
String desc=secondary MAC addresses:pattern=^[a-fA-F0-9:,]+$|^none$|^$
if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
vm-nic-type (optional)
String desc=interface NIC type:type=enum:precludes=[sriov-vf]
Enum:
e1000
virtio

switch-vnic-show - Up

display virtual NICs
api.switch-name (optional)
nic
String desc=virtual NIC assigned to interface
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
ip2 (optional)
String desc=Second IP address:type=IPv4 or IPv6 address:requires=[netmask2]:precludes=[assignment2]
netmask2 (optional)
Integer desc=Second IP netmask:type=netmask:requires=[ip2]:precludes=[assignment2]:mask-for=[ip2] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
mac (optional)
String desc=interface MAC address:type=mac-address
exclusive (optional)
Boolean desc=exclusive interface:precludes=[l3-port]
vrf (optional)
String desc=name of vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
public-vlan (optional)
Integer desc=interface public VLAN:type=uint16:range=[0,4095] format: int32
nic-state (optional)
String desc=NIC state:type=enum
Enum:
down
up
is-vip (optional)
Boolean desc=VIP VRRP interface
vrrp-state (optional)
String desc=state of VRRP:type=enum
Enum:
slave
master
assignment (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip,netmask]
Enum:
none
dhcp
dhcpv6
sriov-vf (optional)
Boolean desc=sriov vnic:precludes=[vm-nic-type,mirror-traffic]
mirror-traffic (optional)
Boolean desc=Mirror physical nic traffic to vnic:precludes=[sriov-vf]
vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[vlan]:precludes=[vnet-id]
Enum:
public
private
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:precludes=[alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan
assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip2,netmask2]
Enum:
none
dhcp
dhcpv6
assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[linklocal]
Enum:
none
dhcp
dhcpv6
sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32
ipv6-unnumbered (optional)
Boolean desc=IPv6 address is LinkLocal only:requires=[l3-port]
if (optional)
String desc=interface type:type=enum:precludes=[alias-on]
Enum:
mgmt
data
span
span2
span3
alias-on (optional)
String desc=alias name:precludes=[vlan,if,nic]
nic-config (optional)
Boolean desc=NIC config
vrrp-id (optional)
Long desc=ID assigned to VRRP:type=uint32:range=[0,255]:requires=[vrrp-primary] format: int64
vrrp-primary (optional)
String desc=VRRP primary interface
secondary-macs (optional)
String desc=secondary MAC addresses
if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
vm-nic-type (optional)
String desc=interface NIC type:type=enum:precludes=[sriov-vf]
Enum:
e1000
virtio

switch-vnic-show-response - Up

syslog-tls-cert-import - Up

import certificates from sftp/import directory
file-cert
String desc=Name of Switch Certificate File (signed by CA):pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
file-ca
String desc=Name of CA Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters

syslog-tls-cert-info-show - Up

display certificate information
api.switch-name (optional)
subject (optional)
String desc=The subject of the certificate
issuer (optional)
String desc=The issuer of the certificate
status (optional)
String desc=The expiration status of the certificate
cert-type (optional)
String desc=The type of certificate: CA, intermediate or server:type=enum
Enum:
ca
intermediate
server
valid-from (optional)
String desc=The time from which the certificate is valid.
valid-to (optional)
String desc=The time at which the certificate expires and is no longer valid.
serial-number (optional)
Long desc=The serial number of the certificate:type=uint64 format: int64

syslog-tls-cert-info-show-response - Up

syslog-tls-cert-request-create - Up

create key, certificate signing request; deletes existing key/cert
country
String desc=Country Name (2 letter code)
state
String desc=State or Province Name
city
String desc=City Name
organization
String desc=Organization Name
organizational-unit
String desc=Organizational Unit Name
common-name
String desc=Common Name

syslog-tls-cert-show - Up

display syslog TLS import certificate config
api.switch-name (optional)
file-cert (optional)
String desc=Name of Switch Certificate File (signed by CA)
cert-switch (optional)
String desc=Switch Certificate
cert-ca (optional)
String desc=CA Certificate
file-ca (optional)
String desc=Name of CA Certificate File

syslog-tls-cert-show-response - Up

system-diagnostics-hw-limits-show - Up

display information about the ASIC Limits
api.switch-name (optional)
l3_intf_vlan_split_egress (optional)
Long desc=l3 intf vlan split egress:type=uint32:filter=false format: int64
l3_max_ecmp_mode (optional)
Long desc=l3 max ecmp mode:type=uint32:filter=false format: int64
l3_mem_entries (optional)
Long desc=l3 mem entries:type=uint32:filter=false format: int64
num_ipv6_lpm_128b_entries (optional)
Long desc=ipv6 lpm 128b entries:type=uint32:filter=false format: int64
l3info_max_route (optional)
Long desc=l3 max route:type=uint32:filter=false format: int64
l3info_max_host (optional)
Long desc=l3 max host:type=uint32:filter=false format: int64
icap_max_entries (optional)
Long desc=icap max entries:type=uint32:filter=false format: int64
ecap_max_entries (optional)
Long desc=ecap max entries:type=uint32:filter=false format: int64
vcap_max_entries (optional)
Long desc=vcap max entries:type=uint32:filter=false format: int64
lpm_scaling_enable (optional)
Long desc=lpm scaling status:type=uint32:filter=false format: int64
ipv6_lpm_128b_enable (optional)
Long desc=ipv6 lpm 128b status:type=uint32:filter=false format: int64
l2_mem_entries (optional)
Long desc=l2 mem entries:type=uint32:filter=false format: int64
l3_alpm_enable (optional)
Long desc=l3 alpm status:type=uint32:filter=false format: int64
l2xmsg_mode (optional)
Long desc=l2xmsg mode:type=uint32:filter=false format: int64

system-diagnostics-hw-limits-show-response - Up

system-settings-modify - Up

update system settings
lldp (optional)
Boolean desc=LLDP:default=true
cluster-active-active-routing (optional)
Boolean desc=active-active routing on a cluster:default=true
routing-over-vlags (optional)
Boolean desc=enable/disable routing to vlags from cluster links:default=false
source-mac-miss (optional)
String desc=control unknown source mac learn behavior:type=enum:default=copy-to-cpu
Enum:
to-cpu
copy-to-cpu
optimize-datapath (optional)
String desc=Datapath optimization for cluster, fabric and data communication:type=enum
Enum:
disable
cluster-only
all
cpu-class-enable (optional)
Boolean desc=cpu class enable
usb-port (optional)
Boolean desc=usb port:default=true
igmp-snoop (optional)
Boolean desc=Use L2/L3 tables for IGMP Snooping
vle-tracking-timeout (optional)
byte[] desc=vle tracking timeout:range=[3,30]:default=3 format: byte
pfc-buffer-limit (optional)
String desc=% of global system buffer space allowed for PFC:default=40:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
cosq-weight-auto (optional)
Boolean desc=Adjust queue weights automatically based on min-guarantee configuration:default=false
port-cos-drop-stats-interval (optional)
Integer desc=collect port cos drop stats interval (s) on rear facing nic:type=uint16:range=[0,300]:default=0 format: int32
api.port-cos-drop-stats-interval (optional)
Enum:
disable
lossless-mode (optional)
Boolean desc=switch lossless mode:default=false
snoop-query-stagger (optional)
Boolean desc=Stagger igmp/mld snooping Queries:default=false
qsfp28-port-mode (optional)
String desc=configure the qsfp28 port mode 6x40G or 4x100G:type=enum
Enum:
none
6x40G
4x100G
sfp28-port-mode (optional)
String desc=configure the sfp28 port mode 48x25G or 36x25G+12x10G/1G or 24x25G+24x10G/1G:type=enum
Enum:
48x25G
36x25G+12x10G/1G
24x25G+24x10G/1G
host-refresh (optional)
Boolean desc=enable refreshing host arp entries to keep l2 entries active:default=false
proxy-conn-retry (optional)
Boolean desc=Enable/Disable proxy connection retry:default=true
proxy-conn-max-retry (optional)
Integer desc=Maximum number of proxy connection retry attempt:type=uint8:range=[0,10]:default=3 format: int32
proxy-conn-retry-interval (optional)
Long desc=milliseconds to wait between proxy connection retry attempt:type=uint32:range=[100,2000]:default=500 format: int64
nvos-debug-logging (optional)
Boolean desc=Logging mode selection(Direct OR viz. nvlog demon):default=false
manage-l2-uuc-drop (optional)
Boolean desc=enable/disable L2 Unknown Unicast Drop towards data port
optimize-rxlos (optional)
Boolean desc=enable/disable processing of port modules that do not support RXLOS:default=false
xcvr-link-debug (optional)
Boolean desc=System debug to capture link information:default=false
fastpath-bfd (optional)
Boolean desc=Enable/Disable bfd fast path:default=false
linkscan-interval (optional)
Integer desc=program the linkscan interval us, default 150000:range=[10000,1000000]:default=150000 format: int32
linkscan-mode (optional)
String desc=program the linkscan mode SW or HW:type=enum:default=software
Enum:
software
hardware
single-pass-l2-known-multicast (optional)
Boolean desc=enable single-pass L2 known multicast
single-pass-flood (optional)
Boolean desc=enable single-pass flood
single-pass-riot (optional)
Boolean desc=enable single-pass RIOT
hybrid-mode (optional)
Boolean desc=enable switch to working standard and transparent mode:default=false
xcvr-oir-debug-port (optional)
String desc=Enable / Disable transceiver oir per port debug:type=port-list
cos-8-and-9-queue (optional)
Boolean desc=enable cos-8-and-9-queue:default=false
batch-move-mac-hw-group-for-vlan-only (optional)
Boolean desc=enable/disable HW batch move for mac by group for VLAN case only:default=false
memory-tracker (optional)
Boolean desc=enable memory footprint tracker:default=true
bcm-ctr-thread-freq (optional)
Integer desc=Configure frequency of running counter threads (in seconds) in BCM SDK.:type=uint8:range=[1,120]:default=1 format: int32
symmetric-hash (optional)
Boolean desc=enable symmetric hashing :default=false
hash-suppress-unidir-fields (optional)
Boolean desc=enable unidir fields suppression in symmetric hashing :default=false
bcm-interrupt-timeout (optional)
Integer desc=Configure interrupt timeout value (in milliseconds) in BCM SDK:type=uint16:range=[0,4000]:default=2000 format: int32
prioritize-rx-reasons (optional)
Boolean desc=prioritize BCM Rx Reasons over TCP Analytics vFlow:default=false
ephy-rxlos-poll-interval (optional)
Long desc=program the ephy rxlos poll internal in milliseconds, default 1000:type=uint32:range=[100,60000]:default=1000 format: int64
hash-inner-ip-over-gre (optional)
Boolean desc=control the fields used in the hash for v4/v6 over v4/v6 GRE:default=true
multiple-tunnel-next-hops (optional)
Boolean desc=enable multiple tunnel next hops on same port :default=true
l3-use-host-table (optional)
Boolean desc=L3 Routes (such as EVPN type-5 routes) use host table for /32 and /128 routes:default=false
offline-notification-new-thread (optional)
Boolean desc=When switch goes down, thread to send offline notifications:default=false
uplink-oversubscription-action (optional)
String desc=nvOS action towards uplink oversubscription:type=enum:default=default
Enum:
default
warn
error
flow-tracker-enable (optional)
Boolean desc=enable flow-tracker feature:default=false
v6-vrrp-validate (optional)
Boolean desc=enable V6-VRRP validate :default=false
optimize-arps (optional)
Boolean desc=enable ARP optimization:default=false
policy-based-routing (optional)
Boolean desc=enable policy based routing:default=false
optimize-nd (optional)
Boolean desc=enable ND optimization:default=false
reactivate-mac (optional)
Boolean desc=enable reactivation of aged out mac entries:default=true
reactivate-vxlan-tunnel-mac (optional)
Boolean desc=enable reactivation of mac entries over vxlan tunnels:default=true
manage-unknown-unicast (optional)
Boolean desc=enable unknown unicast management:default=false
manage-broadcast (optional)
Boolean desc=enable broadcast management:default=false
manage-wake-on-lan (optional)
Boolean desc=enable wake-on-lan management:default=false
block-loops (optional)
Boolean desc=enable loop blocking:default=false
auto-trunk (optional)
Boolean desc=enable auto trunking:default=true
auto-host-bundle (optional)
Boolean desc=enable auto host bundling:default=false

system-settings-show - Up

show system settings
api.switch-name (optional)
lldp (optional)
Boolean desc=LLDP
cluster-active-active-routing (optional)
Boolean desc=active-active routing on a cluster
routing-over-vlags (optional)
Boolean desc=enable/disable routing to vlags from cluster links
source-mac-miss (optional)
String desc=control unknown source mac learn behavior:type=enum
Enum:
to-cpu
copy-to-cpu
optimize-datapath (optional)
String desc=Datapath optimization for cluster, fabric and data communication:type=enum
Enum:
disable
cluster-only
all
cpu-class-enable (optional)
Boolean desc=cpu class enable
usb-port (optional)
Boolean desc=usb port
igmp-snoop (optional)
Boolean desc=Use L2/L3 tables for IGMP Snooping
vle-tracking-timeout (optional)
byte[] desc=vle tracking timeout:range=[3,30] format: byte
pfc-buffer-limit (optional)
String desc=% of global system buffer space allowed for PFC:filter=false
cosq-weight-auto (optional)
Boolean desc=Adjust queue weights automatically based on min-guarantee configuration
port-cos-drop-stats-interval (optional)
Integer desc=collect port cos drop stats interval (s) on rear facing nic:type=uint16:range=[0,300] format: int32
lossless-mode (optional)
Boolean desc=switch lossless mode
snoop-query-stagger (optional)
Boolean desc=Stagger igmp/mld snooping Queries
qsfp28-port-mode (optional)
String desc=configure the qsfp28 port mode 6x40G or 4x100G:type=enum
Enum:
none
6x40G
4x100G
sfp28-port-mode (optional)
String desc=configure the sfp28 port mode 48x25G or 36x25G+12x10G/1G or 24x25G+24x10G/1G:type=enum
Enum:
48x25G
36x25G+12x10G/1G
24x25G+24x10G/1G
host-refresh (optional)
Boolean desc=enable refreshing host arp entries to keep l2 entries active
proxy-conn-retry (optional)
Boolean desc=Enable/Disable proxy connection retry
proxy-conn-max-retry (optional)
Integer desc=Maximum number of proxy connection retry attempt:type=uint8:range=[0,10] format: int32
proxy-conn-retry-interval (optional)
Long desc=milliseconds to wait between proxy connection retry attempt:type=uint32:range=[100,2000] format: int64
nvos-debug-logging (optional)
Boolean desc=Logging mode selection(Direct OR viz. nvlog demon)
manage-l2-uuc-drop (optional)
Boolean desc=enable/disable L2 Unknown Unicast Drop towards data port
optimize-rxlos (optional)
Boolean desc=enable/disable processing of port modules that do not support RXLOS
xcvr-link-debug (optional)
Boolean desc=System debug to capture link information
fastpath-bfd (optional)
Boolean desc=Enable/Disable bfd fast path
linkscan-interval (optional)
Integer desc=program the linkscan interval us, default 150000:range=[10000,1000000] format: int32
linkscan-mode (optional)
String desc=program the linkscan mode SW or HW:type=enum
Enum:
software
hardware
single-pass-l2-known-multicast (optional)
Boolean desc=enable single-pass L2 known multicast
single-pass-flood (optional)
Boolean desc=enable single-pass flood
single-pass-riot (optional)
Boolean desc=enable single-pass RIOT
hybrid-mode (optional)
Boolean desc=enable switch to working standard and transparent mode
xcvr-oir-debug-port (optional)
String desc=Enable / Disable transceiver oir per port debug:type=port-list
cos-8-and-9-queue (optional)
Boolean desc=enable cos-8-and-9-queue
batch-move-mac-hw-group-for-vlan-only (optional)
Boolean desc=enable/disable HW batch move for mac by group for VLAN case only
memory-tracker (optional)
Boolean desc=enable memory footprint tracker
bcm-ctr-thread-freq (optional)
Integer desc=Configure frequency of running counter threads (in seconds) in BCM SDK.:type=uint8:range=[1,120] format: int32
symmetric-hash (optional)
Boolean desc=enable symmetric hashing
hash-suppress-unidir-fields (optional)
Boolean desc=enable unidir fields suppression in symmetric hashing
bcm-interrupt-timeout (optional)
Integer desc=Configure interrupt timeout value (in milliseconds) in BCM SDK:type=uint16:range=[0,4000] format: int32
prioritize-rx-reasons (optional)
Boolean desc=prioritize BCM Rx Reasons over TCP Analytics vFlow
ephy-rxlos-poll-interval (optional)
Long desc=program the ephy rxlos poll internal in milliseconds, default 1000:type=uint32:range=[100,60000] format: int64
hash-inner-ip-over-gre (optional)
Boolean desc=control the fields used in the hash for v4/v6 over v4/v6 GRE
multiple-tunnel-next-hops (optional)
Boolean desc=enable multiple tunnel next hops on same port
l3-use-host-table (optional)
Boolean desc=L3 Routes (such as EVPN type-5 routes) use host table for /32 and /128 routes
offline-notification-new-thread (optional)
Boolean desc=When switch goes down, thread to send offline notifications
uplink-oversubscription-action (optional)
String desc=nvOS action towards uplink oversubscription:type=enum
Enum:
default
warn
error
flow-tracker-enable (optional)
Boolean desc=enable flow-tracker feature
v6-vrrp-validate (optional)
Boolean desc=enable V6-VRRP validate
optimize-arps (optional)
Boolean desc=enable ARP optimization
policy-based-routing (optional)
Boolean desc=enable policy based routing
optimize-nd (optional)
Boolean desc=enable ND optimization
reactivate-mac (optional)
Boolean desc=enable reactivation of aged out mac entries
reactivate-vxlan-tunnel-mac (optional)
Boolean desc=enable reactivation of mac entries over vxlan tunnels
manage-unknown-unicast (optional)
Boolean desc=enable unknown unicast management
manage-broadcast (optional)
Boolean desc=enable broadcast management
manage-wake-on-lan (optional)
Boolean desc=enable wake-on-lan management
block-loops (optional)
Boolean desc=enable loop blocking
auto-trunk (optional)
Boolean desc=enable auto trunking
auto-host-bundle (optional)
Boolean desc=enable auto host bundling

system-settings-show-response - Up

system-state-modify - Up

update system state
maintenance-mode (optional)
Boolean desc=Enable/Disable switch maintenance mode:default=false

system-state-show - Up

show system state
api.switch-name (optional)
system-state (optional)
String desc=system state to display

system-state-show-response - Up

system-stats-history-settings-modify - Up

modify system statistics history collection settings
enable (optional)
Boolean desc=enable or disable system statistics history:default=true

system-stats-history-settings-show - Up

display system statistics history collection settings
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable system statistics history
read-interval (optional)
Long desc=interval to collect system statistics format: int64

system-stats-history-settings-show-response - Up

system-stats-history-show - Up

display usage history over last 1 minute, 60 minutes and last 24 hours
api.switch-name (optional)
time (optional)
String desc=last time at which the stats was collected:date=yyyy-mm-ddThh:mm:ss:filter=false
mem-used (optional)
Long desc=percentage of memory used by system:type=uint64:filter=false format: int64
cpu-used (optional)
Long desc=sum of cpu-user and system CPU:type=uint64:filter=false format: int64
cpu-peak (optional)
Long desc=peak CPU usage:type=uint64:filter=false format: int64
over-last (optional)
Long desc=duration for average usage statistics:filter=false format: int64

system-stats-history-show-response - Up

system-stats-settings-modify - Up

modify system statistic collection settings
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

system-stats-settings-show - Up

display system statistic collection settings
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

system-stats-settings-show-response - Up

system-stats-show - Up

display system statistics
api.switch-name (optional)
cpu-total (optional)
Long desc=total CPU:type=uint64:filter=false format: int64
cpu-avg (optional)
Long desc=average CPU usage over last 30 seconds:type=uint64:filter=false format: int64
uptime (optional)
Long desc=length of time system is up format: int64
used-mem (optional)
Long desc=memory used by system statistic:type=uint64:filter=false format: int64
used-mem-val (optional)
Long desc=amount of memory used:type=uint64:filter=false format: int64
used-swap (optional)
Long desc=used swap:type=uint64:filter=false format: int64
used-swap-val (optional)
Long desc=amount of used-swap:type=uint64:filter=false format: int64
paging (optional)
Long desc=swap scan rate:type=uint64 format: int64
cpu-user (optional)
Long desc=cpu-user:type=uint64:filter=false format: int64
cpu-sys (optional)
Long desc=system CPU:type=uint64:filter=false format: int64
cpu-idle (optional)
Long desc=CPU idle time:type=uint64:filter=false format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

system-stats-show-response - Up

topology-create - Up

create a L1 topology
name
String desc=L1 topology name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

topology-import - Up

import existing vle or vflow connection information to the topology
name
String desc=L1 topology name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
type
String desc=type of connection to import:type=enum
Enum:
vflow
vle
vflow_name
String desc=vflow name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[type]:api-ref-path=/vflows:api-ref-model=vflow-show:api-ref-id=name:api-ref-val=name

topology-import-1 - Up

import existing vle or vflow connection information to the topology
name
String desc=L1 topology name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
vle_name
String desc=vle name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[type]:api-ref-path=/vles:api-ref-model=vle-show:api-ref-id=name:api-ref-val=name
type
String desc=type of connection to import:type=enum
Enum:
vflow
vle

topology-link-add - Up

add link to a topology
node1
Long desc=name for link node 1:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
node2
Long desc=name for link node 2:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
node1-port
Long desc=port on the node 1:type=uint32 format: int64
node2-port
Long desc=port on the node 2:type=uint32 format: int64
enable (optional)
Boolean desc=Topology Link state for path calculation:default=true

topology-link-modify - Up

modify a topology link state
enable
Boolean desc=Topology Link state for path calculation:default=true

topology-link-show - Up

show network topology links
api.switch-name (optional)
node1
Long desc=name for link node 1:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
node2
Long desc=name for link node 2:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
node1-port
Long desc=port on the node 1:type=uint32 format: int64
node2-port
Long desc=port on the node 2:type=uint32 format: int64
enable (optional)
Boolean desc=Topology Link state for path calculation
id (optional)
String desc=Link identifier:type=uint64:hex=0x[0-9a-fA-F]{16}
in-path (optional)
String desc=Topology Link used by this path
in-use (optional)
Boolean desc=topology link is in use

topology-link-show-response - Up

topology-modify - Up

deploy or clear all configurations by topology
enable
Boolean desc=deploy or clear vflow configurations:default=false

topology-node-show - Up

show network topology nodes
api.switch-name (optional)
local-port
Long desc=port on the node 1:type=uint32 format: int64
remote-port
Long desc=port on the node 2:type=uint32 format: int64
node
Long desc=name for link node 1:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
peer-node
Long desc=name for link node 2:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
enable (optional)
Boolean desc=Topology Link state for path calculation

topology-node-show-response - Up

topology-show - Up

show L1 topologies
api.switch-name (optional)
name
String desc=L1 topology name
enable (optional)
Boolean desc=deploy or clear vflow configurations
vlink_name_size (optional)
Integer desc=maximum chars allowed for vlink name:type=uint8 format: int32
vle_name_size (optional)
Integer desc=maximum chars allowed for vle name:type=uint8 format: int32
vle_name (optional)
String desc=vle name:requires=[type]:api-ref-path=/vles:api-ref-model=vle-show:api-ref-id=name:api-ref-val=name
type (optional)
String desc=type of connection to import:type=enum
Enum:
vflow
vle
vflow_name (optional)
String desc=vflow name:requires=[type]:api-ref-path=/vflows:api-ref-model=vflow-show:api-ref-id=name:api-ref-val=name

topology-show-response - Up

topology-vle-add - Up

add vle
node1
Long desc=node 1 name:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
node2
Long desc=node 2 name:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
vle-name
String desc=vle name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
node-1-port
Long desc=node1 port:type=uint32 format: int64
node-2-port
Long desc=node2 port:type=uint32 format: int64
vlan (optional)
Integer desc=vlan for VLE creation:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=vxlan for VLE creation:type=uint32:range=[0,16777215] format: int64

topology-vle-modify - Up

update vle
vlan (optional)
Integer desc=vlan for VLE creation:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=vxlan for VLE creation:type=uint32:range=[0,16777215] format: int64
node-1-port (optional)
Long desc=node1 port:type=uint32 format: int64
node-2-port (optional)
Long desc=node2 port:type=uint32 format: int64

topology-vle-show - Up

display vles
api.switch-name (optional)
vle-name
String desc=vle name
node1 (optional)
Long desc=node 1 name:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
node2 (optional)
Long desc=node 2 name:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
vlan (optional)
Integer desc=vlan for VLE creation:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=vxlan for VLE creation:type=uint32:range=[0,16777215] format: int64
node-1-port (optional)
Long desc=node1 port:type=uint32 format: int64
node-2-port (optional)
Long desc=node2 port:type=uint32 format: int64

topology-vle-show-response - Up

topology-vlink-add - Up

add vlink
endpoint1
String desc=endpoint1 of vlink:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
endpoint2
String desc=endpoint2 of vlink:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
vlink-name
String desc=vlink name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

topology-vlink-modify - Up

update vlink
endpoint1 (optional)
String desc=endpoint1 of vlink:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
endpoint2 (optional)
String desc=endpoint2 of vlink:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name

topology-vlink-show - Up

display vlinks
api.switch-name (optional)
vlink-name
String desc=vlink name
endpoint1 (optional)
String desc=endpoint1 of vlink:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
endpoint2 (optional)
String desc=endpoint2 of vlink:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name

topology-vlink-show-response - Up

transaction-log-file-truncate-to - Up

Truncate the local xact log file to given tid (latest tid entries are retained)
trunc_tid
Long desc=transaction ID:type=uint64 format: int64

transaction-node-show - Up

display node transaction information
api.switch-name (optional)
name (optional)
String desc=node name
fabric-changeid (optional)
String desc=fabric transaction unique change id
local-tid (optional)
Long desc=local transaction ID:type=uint64 format: int64
cluster-changeid (optional)
String desc=cluster transaction unique change id
id (optional)
Long desc=ID assigned to node:type=uint32 format: int64
fabric-tid (optional)
Long desc=fabric transaction ID:type=uint64 format: int64
cluster-tid (optional)
Long desc=cluster transaction ID:type=uint64 format: int64

transaction-node-show-response - Up

transaction-rollback-to - Up

roll back the fabric to a specific fabric transaction number
tid
Long desc=transaction ID:type=uint64 format: int64
transaction-scope
String desc=scope of transaction to roll: local, cluster, or fabric
Enum:
local
fabric
cluster
ignore-error (optional)
Boolean desc=ignore errors when rolling transactions (be very careful when using this)

transaction-rollforward-to - Up

roll forward the fabric to a specific fabric transaction number
transaction-scope
String desc=scope of transaction to roll: local, cluster, or fabric
Enum:
local
fabric
cluster
tid (optional)
Long desc=transaction ID:type=uint64 format: int64
remote-node (optional)
Long desc=which node to roll forward from:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
ignore-error (optional)
Boolean desc=ignore errors when rolling transactions (be very careful when using this)

transaction-settings-modify - Up

update transaction settings
allow-overlapping-parallel-commands (optional)
Boolean desc=Allow overlapping parallel commands:default=false
allow-offline-cluster-nodes (optional)
Boolean desc=Allow transactions to proceed even if a cluster node is offline:default=false
auto-recover (optional)
Boolean desc=Automatically recover missed transactions:default=true
failover-persistent (optional)
Boolean desc=Dual band failover persistent in transaction:default=true
auto-recover-retry-time (optional)
Long desc=Retry time for transaction auto-recover:default=5m format: int64
reserve-retry-maximum (optional)
Long desc=Maximum number of retires for transaction reservation; 0 for infinite:type=uint32:default=10 format: int64
reserve-retry-interval-maximum (optional)
Long desc=Maximum number of seconds to wait between transaction reservation retries:type=uint32:default=8 format: int64
max-local-xact-log-entries (optional)
Long desc=Max no. of entries in xact_log file(addtional 100 are saved before truncation):type=uint32:default=0 format: int64

transaction-settings-show - Up

show transaction settings
api.switch-name (optional)
allow-overlapping-parallel-commands (optional)
Boolean desc=Allow overlapping parallel commands
allow-offline-cluster-nodes (optional)
Boolean desc=Allow transactions to proceed even if a cluster node is offline
auto-recover (optional)
Boolean desc=Automatically recover missed transactions
failover-persistent (optional)
Boolean desc=Dual band failover persistent in transaction
auto-recover-retry-time (optional)
Long desc=Retry time for transaction auto-recover format: int64
reserve-retry-maximum (optional)
Long desc=Maximum number of retires for transaction reservation; 0 for infinite:type=uint32 format: int64
reserve-retry-interval-maximum (optional)
Long desc=Maximum number of seconds to wait between transaction reservation retries:type=uint32 format: int64
max-local-xact-log-entries (optional)
Long desc=Max no. of entries in xact_log file(addtional 100 are saved before truncation):type=uint32 format: int64

transaction-settings-show-response - Up

transaction-show - Up

display transaction information
api.switch-name (optional)
tid (optional)
Long desc=transaction ID:type=uint64 format: int64
changeid (optional)
String desc=transaction unique change id
failure (optional)
String desc=failure message if error ignored
end-time (optional)
Long desc=end time of transaction format: int64
start-tid (optional)
Long desc=starting transaction ID:type=uint64 format: int64
end-tid (optional)
Long desc=ending transaction ID:type=uint64 format: int64
state (optional)
String desc=transaction state:type=enum
Enum:
start
local-cmd
commit-request
commit-prep
commit
commit-done
abort-start
abort-done
remote-start
remote-commit-request
remote-commit-prep
remote-commit
remote-abort-start
remote-abort-done
undo-info
changeid
reserve
reserve-abort
remote-reserve
remote-reserve-abort
checkpoint-start
checkpoint-done
roll-forward
roll-back
roll-forward-result
roll-back-result
change-no-xact
failure
local-command (optional)
String desc=command issued with local-scoped fields
undo-command (optional)
String desc=undo command (more than one not shown)
transaction-scope (optional)
String desc=scope of transaction to roll: local, cluster, or fabric
Enum:
local
fabric
cluster
start-time (optional)
Long desc=start time of transaction format: int64
command (optional)
String desc=command issued
remote-node (optional)
Long desc=which node to roll forward from:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
trunc_tid (optional)
Long desc=transaction ID:type=uint64 format: int64

transaction-show-response - Up

trunk-create - Up

create a trunk configuration for link aggregation
name
String desc=physical name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
ports
String desc=physical port:type=port-list
speed (optional)
Long desc=physical port speed:type=uint32 format: int64
jumbo (optional)
String desc=jumbo frames on physical port:type=enum
Enum:
jumbo
no-jumbo
reflect (optional)
String desc=physical port reflection:type=enum:default=no-reflect
Enum:
reflect
no-reflect
pause (optional)
Boolean desc=physical port pause
description (optional)
String desc=physical port description
loopback (optional)
String desc=physical port loopback:type=enum:default=no-loopback
Enum:
no-loopback
loopback
remote-loopback
routing (optional)
Boolean desc=routing:default=true
hash-mode (optional)
String desc=Trunk hash mode:type=enum
Enum:
enhanced
l2-src
l2-dst
l2
l3-src
l3-dst
l3
resilient
lacp-mode (optional)
String desc=LACP mode of physical port:type=enum:default=off
Enum:
off
passive
active
lacp-timeout (optional)
String desc=LACP timeout - default slow:type=enum:default=slow
Enum:
slow
fast
defer-bringup (optional)
Boolean desc=defer port bringup
host-enable (optional)
Boolean desc=Host facing port control setting:default=true
dscp-map (optional)
String desc=DSCP map name to enable on port:api-ref-path=/dscp-maps:api-ref-model=dscp-map-show:api-ref-id=name:api-ref-val=name
local-switching (optional)
String desc=no-local-switching port cannot bridge traffic to another no-local-switching port:type=enum:default=local-switching
Enum:
local-switching
no-local-switching
allowed-tpid (optional)
String desc=Allowed TPID in addition to 0x8100 on Vlan header:type=flag
Enum:
vlan
q-in-q
q-in-q-old
fabric-guard (optional)
Boolean desc=Fabric guard configuration:default=false
unknown-ucast-level (optional)
String desc=unknown unicast level in % default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
unknown-mcast-level (optional)
String desc=unknown multicast level in % default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
broadcast-level (optional)
String desc=broadcast level in % - default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
port-mac-address (optional)
String desc=physical port MAC Address:type=mac-address
lacp-fallback (optional)
String desc=LACP fallback mode -- individual or bundled:type=enum:default=bundle
Enum:
bundle
individual
lacp-fallback-timeout (optional)
Long desc=LACP fallback timeout -- default is 50 seconds:range=[30,60]:default=50 format: int64
api.speed (optional)
Enum:
disable
10m
100m
1g
2.5g
10g
25g
40g
50g
100g
200g
400g
egress-rate-limit (optional)
Long desc=max egress port data rate limit:type=uint64 format: int64
api.egress-rate-limit (optional)
Enum:
unlimited
lacp-priority (optional)
Long desc=LACP priority from 1 to 65535 - default 32768:type=uint32:range=[1,65535]:default=32768 format: int64
edge-switch (optional)
Boolean desc=physical port edge switch
vxlan-termination (optional)
String desc=physical port vxlan termination setting:type=enum:default=vxlan-termination
Enum:
vxlan-termination
no-vxlan-termination
loop-vlans (optional)
String desc=looping vlans:type=vlan-list

trunk-modify - Up

modify a trunk configuration for link aggregation with trunk-id or name
ports
String desc=physical port:type=port-list
speed (optional)
Long desc=physical port speed:type=uint32 format: int64
jumbo (optional)
String desc=jumbo frames on physical port:type=enum
Enum:
jumbo
no-jumbo
reflect (optional)
String desc=physical port reflection:type=enum:default=no-reflect
Enum:
reflect
no-reflect
pause (optional)
Boolean desc=physical port pause
description (optional)
String desc=physical port description
loopback (optional)
String desc=physical port loopback:type=enum:default=no-loopback
Enum:
no-loopback
loopback
remote-loopback
routing (optional)
Boolean desc=routing:default=true
hash-mode (optional)
String desc=Trunk hash mode:type=enum
Enum:
enhanced
l2-src
l2-dst
l2
l3-src
l3-dst
l3
resilient
lacp-mode (optional)
String desc=LACP mode of physical port:type=enum:default=off
Enum:
off
passive
active
lacp-timeout (optional)
String desc=LACP timeout - default slow:type=enum:default=slow
Enum:
slow
fast
defer-bringup (optional)
Boolean desc=defer port bringup
host-enable (optional)
Boolean desc=Host facing port control setting:default=true
dscp-map (optional)
String desc=DSCP map name to enable on port:api-ref-path=/dscp-maps:api-ref-model=dscp-map-show:api-ref-id=name:api-ref-val=name
local-switching (optional)
String desc=no-local-switching port cannot bridge traffic to another no-local-switching port:type=enum:default=local-switching
Enum:
local-switching
no-local-switching
allowed-tpid (optional)
String desc=Allowed TPID in addition to 0x8100 on Vlan header:type=flag
Enum:
vlan
q-in-q
q-in-q-old
fabric-guard (optional)
Boolean desc=Fabric guard configuration:default=false
unknown-ucast-level (optional)
String desc=unknown unicast level in % default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
unknown-mcast-level (optional)
String desc=unknown multicast level in % default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
broadcast-level (optional)
String desc=broadcast level in % - default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
port-mac-address (optional)
String desc=physical port MAC Address:type=mac-address
lacp-fallback (optional)
String desc=LACP fallback mode -- individual or bundled:type=enum:default=bundle
Enum:
bundle
individual
lacp-fallback-timeout (optional)
Long desc=LACP fallback timeout -- default is 50 seconds:range=[30,60]:default=50 format: int64
api.speed (optional)
Enum:
disable
10m
100m
1g
2.5g
10g
25g
40g
50g
100g
200g
400g
egress-rate-limit (optional)
Long desc=max egress port data rate limit:type=uint64 format: int64
api.egress-rate-limit (optional)
Enum:
unlimited
lacp-priority (optional)
Long desc=LACP priority from 1 to 65535 - default 32768:type=uint32:range=[1,65535]:default=32768 format: int64
edge-switch (optional)
Boolean desc=physical port edge switch
vxlan-termination (optional)
String desc=physical port vxlan termination setting:type=enum:default=vxlan-termination
Enum:
vxlan-termination
no-vxlan-termination
loop-vlans (optional)
String desc=looping vlans:type=vlan-list

trunk-modify-1 - Up

modify a trunk configuration for link aggregation with trunk description
ports
String desc=physical port:type=port-list
speed (optional)
Long desc=physical port speed:type=uint32 format: int64
jumbo (optional)
String desc=jumbo frames on physical port:type=enum
Enum:
jumbo
no-jumbo
reflect (optional)
String desc=physical port reflection:type=enum:default=no-reflect
Enum:
reflect
no-reflect
pause (optional)
Boolean desc=physical port pause
description (optional)
String desc=physical port description
loopback (optional)
String desc=physical port loopback:type=enum:default=no-loopback
Enum:
no-loopback
loopback
remote-loopback
routing (optional)
Boolean desc=routing:default=true
hash-mode (optional)
String desc=Trunk hash mode:type=enum
Enum:
enhanced
l2-src
l2-dst
l2
l3-src
l3-dst
l3
resilient
lacp-mode (optional)
String desc=LACP mode of physical port:type=enum:default=off
Enum:
off
passive
active
lacp-timeout (optional)
String desc=LACP timeout - default slow:type=enum:default=slow
Enum:
slow
fast
defer-bringup (optional)
Boolean desc=defer port bringup
host-enable (optional)
Boolean desc=Host facing port control setting:default=true
dscp-map (optional)
String desc=DSCP map name to enable on port:api-ref-path=/dscp-maps:api-ref-model=dscp-map-show:api-ref-id=name:api-ref-val=name
local-switching (optional)
String desc=no-local-switching port cannot bridge traffic to another no-local-switching port:type=enum:default=local-switching
Enum:
local-switching
no-local-switching
allowed-tpid (optional)
String desc=Allowed TPID in addition to 0x8100 on Vlan header:type=flag
Enum:
vlan
q-in-q
q-in-q-old
fabric-guard (optional)
Boolean desc=Fabric guard configuration:default=false
unknown-ucast-level (optional)
String desc=unknown unicast level in % default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
unknown-mcast-level (optional)
String desc=unknown multicast level in % default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
broadcast-level (optional)
String desc=broadcast level in % - default 30%:default=30:pattern=^[0-9]+(.[0-9]{1,3})?$:pattern-help=percentage number with .001 granularity (e.g. 10.001)
port-mac-address (optional)
String desc=physical port MAC Address:type=mac-address
lacp-fallback (optional)
String desc=LACP fallback mode -- individual or bundled:type=enum:default=bundle
Enum:
bundle
individual
lacp-fallback-timeout (optional)
Long desc=LACP fallback timeout -- default is 50 seconds:range=[30,60]:default=50 format: int64
api.speed (optional)
Enum:
disable
10m
100m
1g
2.5g
10g
25g
40g
50g
100g
200g
400g
egress-rate-limit (optional)
Long desc=max egress port data rate limit:type=uint64 format: int64
api.egress-rate-limit (optional)
Enum:
unlimited
lacp-priority (optional)
Long desc=LACP priority from 1 to 65535 - default 32768:type=uint32:range=[1,65535]:default=32768 format: int64
edge-switch (optional)
Boolean desc=physical port edge switch
vxlan-termination (optional)
String desc=physical port vxlan termination setting:type=enum:default=vxlan-termination
Enum:
vxlan-termination
no-vxlan-termination
loop-vlans (optional)
String desc=looping vlans:type=vlan-list

trunk-show - Up

display trunk information
api.switch-name (optional)
name
String desc=physical name
ports
String desc=physical port:type=port-list
trunk-id
Long desc=physical interface:type=uint32 format: int64
speed (optional)
Long desc=physical port speed:type=uint32 format: int64
autoneg (optional)
String desc=physical port autonegotiation:type=enum
Enum:
autoneg
no-autoneg
jumbo (optional)
String desc=jumbo frames on physical port:type=enum
Enum:
jumbo
no-jumbo
enable (optional)
String desc=physical port enable:type=enum
Enum:
enable
disable
reflect (optional)
String desc=physical port reflection:type=enum
Enum:
reflect
no-reflect
pause (optional)
Boolean desc=physical port pause
description (optional)
String desc=physical port description
lldp (optional)
Boolean desc=physical port LLDP enabled
loopback (optional)
String desc=physical port loopback:type=enum
Enum:
no-loopback
loopback
remote-loopback
routing (optional)
Boolean desc=routing
fec (optional)
String desc=port forward error correction (FEC) mode:type=enum
Enum:
fec
no-fec
status (optional)
String desc=physical port status:type=flag:filter=false
Enum:
phy-up
up
disabled
hw-nat-loop
mirror-loop
mirror-to
PN-switch
PN-fabric
PN-other
PN-cluster
PN-internal
host
uplink
STP-BPDUs
LLDP
trunk
l3-port
remote-l3-port
dhcp
dhcpsvr
blocked
no-BPDU
LACP-PDUs
vlag-active
vlag-blocked
stp-edge-port
LACP-wait
LACP-fallback
adjacency-wait
adjacency-check
vlag-wait
multicast-router
host-disabled
loop
congested
vxlan-loopback
vlan-up
vle
vbt-wait
phy-down
down
enabled
err-disabled
err-bpdu-guard
mac-violation
stp-bpdu-guard
stp-root-guard
defer-bringup-wait
rx-bw-threshold-exceeded
tx-bw-threshold-exceeded
bw-bps (optional)
Long desc=trunk bandwidth in bps:type=uint64 format: int64
stp-port-cost (optional)
Long desc=physical STP port cost:type=uint32:filter=false format: int64
lacp-individual (optional)
String desc=LACP ports operating individully:type=port-list
vlag-id (optional)
String desc=VLAG of this port:type=identifier:api-ref-path=/vlags:api-ref-model=vlag-show:api-ref-id=id:api-ref-val=name
trunk-hw-id (optional)
Integer desc=trunk hardware ID format: int32
stp-port-priority (optional)
Integer desc=STP port priority:type=uint16:filter=false format: int32
lport (optional)
Long desc=physical local port:type=uint32:filter=false format: int64
rswitch (optional)
Long desc=physical remote switch:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
rswitch-ip (optional)
String desc=remote switch IP address:type=IPv4 or IPv6 address:filter=false
rswitch-mac (optional)
String desc=remote switch MAC address:type=mac-address:filter=false
rem-rswitch-port-mac (optional)
String desc=remote physical port MAC Address:type=mac-address:filter=false
rswitch-default-vlan (optional)
Integer desc=remote switch default VLAN:type=uint16:filter=false format: int32
rport (optional)
Long desc=remote switch port:type=uint32:filter=false format: int64
vle-id (optional)
String desc=vle on this port:type=identifier:api-ref-path=/vles:api-ref-model=vle-show:api-ref-id=id:api-ref-val=name
updown_time (optional)
Long desc=updown time format: int64
in_use (optional)
Boolean desc=physical port inuse:filter=false
cluster-port (optional)
Boolean desc=port is a cluster port
rhost (optional)
String desc=physical remote host
hash-mode (optional)
String desc=Trunk hash mode:type=enum
Enum:
enhanced
l2-src
l2-dst
l2
l3-src
l3-dst
l3
resilient
lacp-mode (optional)
String desc=LACP mode of physical port:type=enum
Enum:
off
passive
active
lacp-timeout (optional)
String desc=LACP timeout - default slow:type=enum
Enum:
slow
fast
defer-bringup (optional)
Boolean desc=defer port bringup
host-enable (optional)
Boolean desc=Host facing port control setting
dscp-map (optional)
String desc=DSCP map name to enable on port:api-ref-path=/dscp-maps:api-ref-model=dscp-map-show:api-ref-id=name:api-ref-val=name
local-switching (optional)
String desc=no-local-switching port cannot bridge traffic to another no-local-switching port:type=enum
Enum:
local-switching
no-local-switching
allowed-tpid (optional)
String desc=Allowed TPID in addition to 0x8100 on Vlan header:type=flag
Enum:
vlan
q-in-q
q-in-q-old
fabric-guard (optional)
Boolean desc=Fabric guard configuration
unknown-ucast-level (optional)
String desc=unknown unicast level in % default 30%:filter=false
unknown-mcast-level (optional)
String desc=unknown multicast level in % default 30%:filter=false
broadcast-level (optional)
String desc=broadcast level in % - default 30%:filter=false
switch (optional)
Long desc=physical switch id:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
port-mac-address (optional)
String desc=physical port MAC Address:type=mac-address:filter=false
lacp-fallback (optional)
String desc=LACP fallback mode -- individual or bundled:type=enum
Enum:
bundle
individual
lacp-fallback-timeout (optional)
Long desc=LACP fallback timeout -- default is 50 seconds:range=[30,60] format: int64
egress-rate-limit (optional)
Long desc=max egress port data rate limit:type=uint64 format: int64
eth-mode (optional)
String desc=physical Ethernet mode:type=enum
Enum:
1000base-x
sgmii
xlaui
gmii
sfi
xfi
cx
kr4
sr4
lr4
er4
cr4
cx4
kx4
caui4
kr2
er2
cr2
sr2
lr2
xlaui2
cx2
sr
lr
er
cr
kx
kr
zr
base-x
sys-default
caui
aoc
xlppi
psm4
base_t
base_cx
base_lx
base_sx
acc
lacp-priority (optional)
Long desc=LACP priority from 1 to 65535 - default 32768:type=uint32:range=[1,65535] format: int64
edge-switch (optional)
Boolean desc=physical port edge switch
vxlan-termination (optional)
String desc=physical port vxlan termination setting:type=enum
Enum:
vxlan-termination
no-vxlan-termination
receive-only (optional)
String desc=physical port mirror only:type=enum
Enum:
mirror-only
no-mirror-receive-only
send-port (optional)
Long desc=send port:type=uint32 format: int64
loop-vlans (optional)
String desc=looping vlans:type=vlan-list
config (optional)
String desc=physical port config:type=flag:filter=false
Enum:
10m
100m
1g
2.5g
10g
25g
40g
50g
100g
loopback
mirror-only
autoneg
jumbo
vxlan-termination
no-local-switching
fec
backplane
200g
400g
remote-loopback

trunk-show-response - Up

trunk-stats-show - Up

display trunk statistics
api.switch-name (optional)
name
String desc=name
trunk-id
String desc=port numbers:type=port-list
description (optional)
String desc=physical port description
port-speed (optional)
Long desc=port speed:type=uint32:filter=false format: int64
counter (optional)
Integer desc=port counters format: int32
ibytes (optional)
Long desc=incoming bytes:type=uint64 format: int64
ibits (optional)
Long desc=incoming bits:type=uint64 format: int64
iUpkts (optional)
Long desc=incoming unicast packets:type=uint64 format: int64
iBpkts (optional)
Long desc=incoming broadcast packets:type=uint64 format: int64
Rx-bw-th-exceed-count (optional)
Long desc=count of rx bw threshold exceed events:type=uint64:filter=false format: int64
Tx-bw-th-exceed-count (optional)
Long desc=count of tx bw threshold exceed events:type=uint64:filter=false format: int64
oBpkts (optional)
Long desc=outgoing broadcast packets:type=uint64 format: int64
oMpkts (optional)
Long desc=outgoing multicast packets:type=uint64 format: int64
oPauseFs (optional)
Long desc=outgoing pause frames:type=uint64 format: int64
oCongDrops (optional)
Long desc=outgoing packets dropped due to congestion:type=uint64 format: int64
odiscards (optional)
Long desc=discarded outgoing packets:type=uint64 format: int64
oerrs (optional)
Long desc=outgoing packets with errors:type=uint64 format: int64
mtu-errs (optional)
Long desc=mtu errors:type=uint64 format: int64
HER-pkts (optional)
Long desc=head end replicated packets:type=uint64 format: int64
iMpkts (optional)
Long desc=incoming multicast packets:type=uint64 format: int64
iPauseFs (optional)
Long desc=incoming pause frames:type=uint64 format: int64
iCongDrops (optional)
Long desc=incoming packets dropped due to congestion:type=uint64 format: int64
idiscards (optional)
Long desc=discarded incoming packets:type=uint64 format: int64
ierrs (optional)
Long desc=incoming packets with errors:type=uint64 format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64 format: int64
obits (optional)
Long desc=outgoing bits:type=uint64 format: int64
oUpkts (optional)
Long desc=outgoing unicast packets:type=uint64 format: int64
bezel-port (optional)
String desc=bezel port
HER-bytes (optional)
Long desc=head end replicated bytes:type=uint64 format: int64
HER-bits (optional)
Long desc=head end replicated bits:type=uint64 format: int64
oPkts (optional)
Long desc=T4 out pkts includes HER,Unicast and BUM:type=uint64 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

trunk-stats-show-response - Up

tunnel-create - Up

create a tunnel
name
String desc=tunnel name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=local or cluster
Enum:
local
cluster
remote-ip
String desc=remote IP address:type=IPv4 or IPv6 address
local-ip
String desc=local IP address:type=IPv4 or IPv6 address
vrouter-name (optional)
String desc=name of the vrouter service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
peer-vrouter-name (optional)
String desc=name of the vrouter service on cluster peer:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[vrouter-name]:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name:api-ref-target=cluster-peer
next-hop (optional)
String desc=nexthop IP address:type=IPv4 or IPv6 address
next-hop-mac (optional)
String desc=nexthop MAC address:type=mac-address
bfd (optional)
Boolean desc=configure BFD in tunnel:default=false
flood-nh-ip (optional)
String desc=flood-nh IP address:type=IPv4 or IPv6 address
flood-nh-mac (optional)
String desc=flood-nh MAC address:type=mac-address
mac-learning (optional)
Boolean desc=Mac-learning enable or disable on tunnel:default=true
vnet-id (optional)
String desc=tunnel network VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

tunnel-history-settings-modify - Up

update tunnel history settings
enable (optional)
Boolean desc=enable or disable change logging:default=true
disk-space (optional)
Long desc=total disk-space allocated for all log files:type=uint64:default=52428800 format: int64
log-file-count (optional)
Integer desc=number of log files for log rotation:type=uint16:range=[1,20]:default=10 format: int32

tunnel-history-settings-show - Up

show tunnel history settings
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable change logging
disk-space (optional)
Long desc=total disk-space allocated for all log files:type=uint64 format: int64
log-file-count (optional)
Integer desc=number of log files for log rotation:type=uint16:range=[1,20] format: int32

tunnel-history-settings-show-response - Up

tunnel-history-show - Up

display historical tunnel info
api.switch-name (optional)
name
String desc=tunnel name
caller (optional)
String desc=feature that made the change for this entry:type=flag
Enum:
vxlan
logger
reason (optional)
String desc=reason for history entry:type=flag
Enum:
save
restart
add
modify
remove
remove-all
add-nh
remove-nh
changes (optional)
String desc=what changed in this entry:type=uint64
id (optional)
String desc=tunnel ID:type=identifier
scope (optional)
String desc=local or cluster
type (optional)
String desc=type:type=enum
Enum:
ip-in-ip
vxlan
nvgre
vxlan-evpn
vxlan_transparent
vnet-id (optional)
String desc=tunnel network VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
vrouter-name (optional)
String desc=name of the vrouter service:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
peer-vrouter-name (optional)
String desc=name of the vrouter service on cluster peer:requires=[vrouter-name]:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name:api-ref-target=cluster-peer
local-ip (optional)
String desc=local IP address:type=IPv4 or IPv6 address
remote-ip (optional)
String desc=remote IP address:type=IPv4 or IPv6 address
vrouter-hw-if-id (optional)
String desc=router interface:type=identifier:api-ref-path=/vrouter-hw-ifs:api-ref-model=vrouter-hw-if-show:api-ref-id=id:api-ref-val=name
tunnel-if-name (optional)
String desc=router interface vnic name
last-caller (optional)
String desc=most recent caller for this entry:type=flag
Enum:
vxlan
logger
last-reason (optional)
String desc=most recent reason for this entry:type=flag
Enum:
save
restart
add
modify
remove
remove-all
add-nh
remove-nh
next-hop (optional)
String desc=nexthop IP address:type=IPv4 or IPv6 address
next-hop-mac (optional)
String desc=nexthop MAC address:type=mac-address
nexthop-bd (optional)
String desc=nexthop Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
nexthop-vlan (optional)
Integer desc=nexthop vlan:type=uint16:range=[0,4095] format: int32
remote-switch (optional)
Long desc=remote switch name:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
vrid (optional)
Integer desc=vrouter hw id format: int32
tunnelID (optional)
Long desc=tunnel ID for a tunnel:type=uint32 format: int64
interface-mac (optional)
String desc=tunnel interface MAC:type=mac-address
bd (optional)
String desc=tunnel interface Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
interface-vlan (optional)
Integer desc=tunnel interface vlan:type=uint16:range=[0,4095] format: int32
active (optional)
Boolean desc=active yes or no
state (optional)
String desc=tunnel state:type=enum
Enum:
init
ok
error
update
bfd (optional)
Boolean desc=configure BFD in tunnel
bfd-state (optional)
String desc=state of the BFD session:type=enum
Enum:
unknown
admin-down
down
init
up
no-session
not-replicator-vtep
peer-bfd-state (optional)
String desc=cluster peer BFD session state:type=enum
Enum:
unknown
admin-down
down
init
up
no-session
not-replicator-vtep
error (optional)
String desc=tunnel errors
route-info (optional)
String desc=Route information for tunnel
ecmp-group (optional)
Integer desc=ECMP group format: int32
using-vxlan-loopback (optional)
Boolean desc=using vxlan loopback
ports (optional)
String desc=nexthop port map:type=port-list
nh-egress-id (optional)
Integer desc=hardware egress id format: int32
flood-nh-ip (optional)
String desc=flood-nh IP address:type=IPv4 or IPv6 address
flood-nh-vlan (optional)
Integer desc=flood-nh vlan:type=uint16:range=[0,4095] format: int32
flood-nh-port (optional)
Long desc=flood-nh port:type=uint32 format: int64
flood-nh-mac (optional)
String desc=flood-nh MAC address:type=mac-address
flood-nh-egress-id (optional)
Integer desc=flood-nh hardware egress id format: int32
auto-tunnel (optional)
Boolean desc=auto-tunnel or static tunnel
ecmp-nexthops (optional)
Boolean desc=filter to display single/mutiple route entries (per nexthop)
flood-nexthop (optional)
Boolean desc=filter to display just flood nexthop entry
mac-learning (optional)
Boolean desc=Mac-learning enable or disable on tunnel
vle_tunnel (optional)
Boolean desc=tunnel vxlan is vle type
count (optional)
Long desc=count for tunnel history:type=uint32 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

tunnel-history-show-response - Up

tunnel-modify - Up

modify a tunnel
bfd (optional)
Boolean desc=configure BFD in tunnel:default=false
mac-learning (optional)
Boolean desc=Mac-learning enable or disable on tunnel:default=true

tunnel-show - Up

display tunnels
api.switch-name (optional)
name
String desc=tunnel name
scope (optional)
String desc=local or cluster
Enum:
local
cluster
type (optional)
String desc=type:type=enum
Enum:
ip-in-ip
vxlan
nvgre
vxlan-evpn
vxlan_transparent
vrid (optional)
Integer desc=vrouter hw id format: int32
tunnelID (optional)
Long desc=tunnel ID for a tunnel:type=uint32 format: int64
active (optional)
Boolean desc=active yes or no
state (optional)
String desc=tunnel state:type=enum
Enum:
init
ok
error
update
ecmp-nexthops (optional)
Boolean desc=filter to display single/mutiple route entries (per nexthop)
vrouter-hw-if-id (optional)
String desc=router interface:type=identifier:api-ref-path=/vrouter-hw-ifs:api-ref-model=vrouter-hw-if-show:api-ref-id=id:api-ref-val=name
tunnel-if-name (optional)
String desc=router interface vnic name
interface-mac (optional)
String desc=tunnel interface MAC:type=mac-address
vnet-id (optional)
String desc=tunnel interface vnet:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=tunnel interface Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
interface-vlan (optional)
Integer desc=tunnel interface vlan:type=uint16:range=[0,4095] format: int32
bfd-state (optional)
String desc=state of the BFD session:type=enum
Enum:
unknown
admin-down
down
init
up
no-session
not-replicator-vtep
peer-bfd-state (optional)
String desc=cluster peer BFD session state:type=enum
Enum:
unknown
admin-down
down
init
up
no-session
not-replicator-vtep
route-info (optional)
String desc=Route information for tunnel
using-vxlan-loopback (optional)
Boolean desc=using vxlan loopback
ports (optional)
String desc=nexthop port map:type=port-list
nh-egress-id (optional)
Integer desc=hardware egress id format: int32
flood-nh-vlan (optional)
Integer desc=flood-nh vlan:type=uint16:range=[0,4095] format: int32
flood-nh-port (optional)
Long desc=flood-nh port:type=uint32 format: int64
flood-nh-egress-id (optional)
Integer desc=flood-nh hardware egress id format: int32
auto-tunnel (optional)
Boolean desc=auto-tunnel or static tunnel
flood-nexthop (optional)
Boolean desc=filter to display just flood nexthop entry
vle_tunnel (optional)
Boolean desc=tunnel vxlan is vle type
remote-switch (optional)
Long desc=remote switch name:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
ecmp-group (optional)
Integer desc=ECMP group format: int32
nexthop-bd (optional)
String desc=nexthop Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
nexthop-vlan (optional)
Integer desc=nexthop vlan:type=uint16:range=[0,4095] format: int32
error (optional)
String desc=tunnel errors
vrouter-name (optional)
String desc=name of the vrouter service:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
remote-ip (optional)
String desc=remote IP address:type=IPv4 or IPv6 address
peer-vrouter-name (optional)
String desc=name of the vrouter service on cluster peer:requires=[vrouter-name]:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name:api-ref-target=cluster-peer
next-hop (optional)
String desc=nexthop IP address:type=IPv4 or IPv6 address
next-hop-mac (optional)
String desc=nexthop MAC address:type=mac-address
bfd (optional)
Boolean desc=configure BFD in tunnel
flood-nh-ip (optional)
String desc=flood-nh IP address:type=IPv4 or IPv6 address
flood-nh-mac (optional)
String desc=flood-nh MAC address:type=mac-address
mac-learning (optional)
Boolean desc=Mac-learning enable or disable on tunnel
id (optional)
String desc=tunnel ID:type=identifier
local-ip (optional)
String desc=local IP address:type=IPv4 or IPv6 address

tunnel-show-response - Up

tunnel-stats-clear - Up

clear port statistics
tunnel-name
String desc=tunnel name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/tunnels:api-ref-model=tunnel-show:api-ref-id=name:api-ref-val=name

tunnel-stats-settings-modify - Up

modify tunnel settings for collecting statistics
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

tunnel-stats-settings-show - Up

display tunnel settings for collecting statistics
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

tunnel-stats-settings-show-response - Up

tunnel-stats-show - Up

display tunnel statistics
api.switch-name (optional)
tunnel-name
String desc=tunnel name:api-ref-path=/tunnels:api-ref-model=tunnel-show:api-ref-id=name:api-ref-val=name
counter (optional)
Integer desc=port counters format: int32
ibytes (optional)
Long desc=incoming bytes:type=uint64 format: int64
ibits (optional)
Long desc=incoming bits:type=uint64 format: int64
iUpkts (optional)
Long desc=incoming unicast packets:type=uint64 format: int64
iBpkts (optional)
Long desc=incoming broadcast packets:type=uint64 format: int64
oBpkts (optional)
Long desc=outgoing broadcast packets:type=uint64 format: int64
oMpkts (optional)
Long desc=outgoing multicast packets:type=uint64 format: int64
oPauseFs (optional)
Long desc=outgoing pause frames:type=uint64 format: int64
oCongDrops (optional)
Long desc=outgoing packets dropped due to congestion:type=uint64 format: int64
odiscards (optional)
Long desc=discarded outgoing packets:type=uint64 format: int64
oerrs (optional)
Long desc=outgoing packets with errors:type=uint64 format: int64
mtu-errs (optional)
Long desc=mtu errors:type=uint64 format: int64
HER-pkts (optional)
Long desc=head end replicated packets:type=uint64 format: int64
sw-inpkts (optional)
Long desc=number of incoming packets processed by nvOS:type=uint64 format: int64
sw-opkts (optional)
Long desc=number of outgoing packets processed by nvOS:type=uint64 format: int64
sw-idrops (optional)
Long desc=number of incoming packets dropped by nvOS:type=uint64 format: int64
sw-odrops (optional)
Long desc=number of outgoing packets dropped by nvOS:type=uint64 format: int64
iMpkts (optional)
Long desc=incoming multicast packets:type=uint64 format: int64
iPauseFs (optional)
Long desc=incoming pause frames:type=uint64 format: int64
iCongDrops (optional)
Long desc=incoming packets dropped due to congestion:type=uint64 format: int64
idiscards (optional)
Long desc=discarded incoming packets:type=uint64 format: int64
ierrs (optional)
Long desc=incoming packets with errors:type=uint64 format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64 format: int64
obits (optional)
Long desc=outgoing bits:type=uint64 format: int64
oUpkts (optional)
Long desc=outgoing unicast packets:type=uint64 format: int64
HER-bytes (optional)
Long desc=head end replicated bytes:type=uint64 format: int64
HER-bits (optional)
Long desc=head end replicated bits:type=uint64 format: int64
oPkts (optional)
Long desc=T4 out pkts includes HER,Unicast and BUM:type=uint64 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

tunnel-stats-show-response - Up

tunnel-vxlan-add - Up

add a VXLAN to a tunnel
vxlan
Long desc=VXLAN identifier:type=uint32:range=[0,16777215]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64

tunnel-vxlan-show - Up

display VXLANs for a tunnel
api.switch-name (optional)
vxlan
Long desc=VXLAN identifier:type=uint32:range=[0,16777215]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
hw_update_pending (optional)
Boolean desc=hw update for vxlan is pending
bd_deactivated (optional)
Boolean desc=static tunnel deactived in hw for this bd

tunnel-vxlan-show-response - Up

udf-create - Up

Create UDF qualifier list
scope
String desc=scope for udf
Enum:
local
fabric
offset
Long desc=udf offset (bytes):type=uint32:range=[0,128] format: int64
length
Long desc=udf length (bytes):type=uint32:range=[1,4] format: int64
name (optional)
String desc=udf name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
header (optional)
String desc=header from where offset is calculated:type=enum
Enum:
packet-start
l3-outer
l4-outer
l4-outer-tcp
l4-outer-udp
l3-outer-v4
l3-outer-v6
packet-start-untagged
packet-start-tagged

udf-modify - Up

Modify UDF qualifier list
offset (optional)
Long desc=udf offset (bytes):type=uint32:range=[0,128] format: int64
length (optional)
Long desc=udf length (bytes):type=uint32:range=[1,4] format: int64
header (optional)
String desc=header from where offset is calculated:type=enum
Enum:
packet-start
l3-outer
l4-outer
l4-outer-tcp
l4-outer-udp
l3-outer-v4
l3-outer-v6
packet-start-untagged
packet-start-tagged

udf-show - Up

Display UDF qualifier list
api.switch-name (optional)
name
String desc=udf name
scope (optional)
String desc=scope for udf
Enum:
local
fabric
offset (optional)
Long desc=udf offset (bytes):type=uint32:range=[0,128] format: int64
length (optional)
Long desc=udf length (bytes):type=uint32:range=[1,4] format: int64
header (optional)
String desc=header from where offset is calculated:type=enum
Enum:
packet-start
l3-outer
l4-outer
l4-outer-tcp
l4-outer-udp
l3-outer-v4
l3-outer-v6
packet-start-untagged
packet-start-tagged

udf-show-response - Up

uplink-group-port-add - Up

add ports to uplink group
ports
String desc=ports acting as uplinks:type=port-list

uplink-group-port-remove - Up

remove ports from uplink group
ports
String desc=ports acting as uplinks:type=port-list

uplink-group-port-show - Up

display uplink port group
api.switch-name (optional)
ports
String desc=ports acting as uplinks:type=port-list
downlink-bw (optional)
Long desc=the aggregated downlink port threshold (in mbps):type=uint32 format: int64
uplink-oversubscription (optional)
Boolean desc=The state of uplink oversubscription
uplink-bw (optional)
Long desc=the aggregated uplink port threshold (in mbps):type=uint32 format: int64

uplink-group-port-show-response - Up

user-create - Up

create an user and apply a role
name
String desc=username:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=local or fabric
Enum:
local
fabric
password
String desc=plain text password:password=true
pub-key (optional)
String desc=Public key filename:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
key-auth (optional)
Boolean desc=enable or disable key authentication
pass-auth (optional)
Boolean desc=enable or disable password authentication:default=true
role-id (optional)
String desc=initial role for user:type=identifier:api-ref-path=/roles:api-ref-model=role-show:api-ref-id=id:api-ref-val=name
login-fail-count (optional)
Long desc=Allowed limit for auth failures before locking user:type=uint32:default=0 format: int64
lock-account (optional)
Boolean desc=Lock user account upon reaching maximum login errors
minimum-pw-length (optional)
Integer desc=Minimum password length for user accounts:type=uint8:range=[6,65]:default=6 format: int32

user-modify - Up

update an user
password (optional)
String desc=plain text password:password=true
pub-key (optional)
String desc=Public key filename:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
key-auth (optional)
Boolean desc=enable or disable key authentication
pass-auth (optional)
Boolean desc=enable or disable password authentication:default=true
login-fail-count (optional)
Long desc=Allowed limit for auth failures before locking user:type=uint32:default=0 format: int64
lock-account (optional)
Boolean desc=Lock user account upon reaching maximum login errors
minimum-pw-length (optional)
Integer desc=Minimum password length for user accounts:type=uint8:range=[6,65]:default=6 format: int32

user-password-set - Up

set a user password
name
String desc=username:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=local or fabric
Enum:
local
fabric
password
String desc=plain text password:password=true
uid (optional)
Long desc=user ID:type=uint32 format: int64
type (optional)
String desc=User type:type=enum
Enum:
netvisor
unix
tacacs
web-token
mfg
server (optional)
String desc=TACACS server:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/aaa-tacacs:api-ref-model=aaa-tacacs-show:api-ref-id=name:api-ref-val=name
pub-key (optional)
String desc=Public key filename:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
key-auth (optional)
Boolean desc=enable or disable key authentication
pass-auth (optional)
Boolean desc=enable or disable password authentication:default=true
role-id (optional)
String desc=initial role for user:type=identifier:api-ref-path=/roles:api-ref-model=role-show:api-ref-id=id:api-ref-val=name
login-fail-count (optional)
Long desc=Allowed limit for auth failures before locking user:type=uint32:default=0 format: int64
lock-account (optional)
Boolean desc=Lock user account upon reaching maximum login errors
minimum-pw-length (optional)
Integer desc=Minimum password length for user accounts:type=uint8:range=[6,65]:default=6 format: int32

user-role-add - Up

add a role to a user
role-id (optional)
String desc=user role:type=identifier:api-ref-path=/roles:api-ref-model=role-show:api-ref-id=id:api-ref-val=name

user-role-show - Up

display user roles
api.switch-name (optional)
role-id
String desc=user role:type=identifier:api-ref-path=/roles:api-ref-model=role-show:api-ref-id=id:api-ref-val=name

user-role-show-response - Up

user-show - Up

display user information
api.switch-name (optional)
name
String desc=username
scope (optional)
String desc=local or fabric
Enum:
local
fabric
uid (optional)
Long desc=user ID:type=uint32 format: int64
type (optional)
String desc=User type:type=enum
Enum:
netvisor
unix
tacacs
web-token
mfg
server (optional)
String desc=TACACS server:api-ref-path=/aaa-tacacs:api-ref-model=aaa-tacacs-show:api-ref-id=name:api-ref-val=name
pub-key (optional)
String desc=Public key filename:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
key-auth (optional)
Boolean desc=enable or disable key authentication
pass-auth (optional)
Boolean desc=enable or disable password authentication
login-fail-count (optional)
Long desc=Allowed limit for auth failures before locking user:type=uint32 format: int64
lock-account (optional)
Boolean desc=Lock user account upon reaching maximum login errors
minimum-pw-length (optional)
Integer desc=Minimum password length for user accounts:type=uint8:range=[6,65] format: int32
key-type (optional)
String desc=SSH key type:type=enum
Enum:
rsa
ecdsa
none
key-bits (optional)
Integer desc=key bits; rsa min-2048, max-16384; ecdsa-256, 384 or 521 bits:range=[256,16384] format: int32
file-public-key (optional)
String desc=SSH public key file:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
file-private-key (optional)
String desc=SSH private key file:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name

user-show-response - Up

user-ssh-keygen-clear - Up

clear SSH public/private key
name
String desc=username:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

user-ssh-keygen-create - Up

Generate SSH keys
name
String desc=username:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
key-type
String desc=SSH key type:type=enum:default=rsa
Enum:
rsa
ecdsa
none
key-bits
Integer desc=key bits; rsa min-2048, max-16384; ecdsa-256, 384 or 521 bits:range=[256,16384]:default=2048 format: int32

user-ssh-keygen-export - Up

export SSH public key
name
String desc=username:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -

user-ssh-keygen-import - Up

import SSH keys
name
String desc=username:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
file-private-key
String desc=SSH private key file:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters:api-ref-path=/sftp-files:api-ref-model=sftp-files-show:api-ref-id=name:api-ref-val=name
passphrase (optional)
String desc=passphrase of SSH key:password=true

vcenter-connection-create - Up

create a vCenter remote connection
name
String desc=name of vCenter connection:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter
host
String desc=hostname of vCenter server to connect with
user
String desc=Authorized vCenter user name
password
String desc=plain text password:password=true
enable (optional)
Boolean desc=enable or disable vCenter connection:default=true
vlans (optional)
String desc=vCenter plugin VLANs for provisioning:type=vlan-list
network-provisioning (optional)
String desc=Network provisioning [none|l2-underlay|l3-underlay]:type=enum:default=none
Enum:
none
l2-underlay
l3-underlay

vcenter-connection-modify - Up

modify a vCenter connection information
host (optional)
String desc=hostname of vCenter server to connect with
user (optional)
String desc=Authorized vCenter user name
password (optional)
String desc=plain text password:password=true
enable (optional)
Boolean desc=enable or disable vCenter connection:default=true
vlans (optional)
String desc=vCenter plugin VLANs for provisioning:type=vlan-list
network-provisioning (optional)
String desc=Network provisioning [none|l2-underlay|l3-underlay]:type=enum:default=none
Enum:
none
l2-underlay
l3-underlay

vcenter-connection-show - Up

display vCenter connection information
api.switch-name (optional)
name
String desc=name of vCenter connection
host (optional)
String desc=hostname of vCenter server to connect with
user (optional)
String desc=Authorized vCenter user name
enable (optional)
Boolean desc=enable or disable vCenter connection
state (optional)
String desc=vCenter connection service state:type=enum
Enum:
init
ok
error
vlans (optional)
String desc=vCenter plugin VLANs for provisioning:type=vlan-list
connected-time (optional)
String desc=vCenter connection time
connection-error (optional)
String desc=vCenter connection error
network-provisioning (optional)
String desc=Network provisioning [none|l2-underlay|l3-underlay]:type=enum
Enum:
none
l2-underlay
l3-underlay

vcenter-connection-show-response - Up

vflow-class-create - Up

create a traffic class for a virtual flow
name
String desc=name for the vFlow class:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=scope - local or fabric
Enum:
local
fabric
priority
Long desc=priority between 2 (lowest) and 8 (highest):type=uint32:range=[1,8] format: int64

vflow-class-show - Up

display virtual flow class information
api.switch-name (optional)
name
String desc=name for the vFlow class
scope (optional)
String desc=scope - local or fabric
Enum:
local
fabric
type (optional)
String desc=type of vFlow class:type=enum
Enum:
system
user
cos (optional)
Integer desc=cos value for the flow class:type=uint8 format: int32
priority (optional)
Long desc=priority between 2 (lowest) and 8 (highest):type=uint32:range=[1,8] format: int64

vflow-class-show-response - Up

vflow-create - Up

create a virtual flow definition for L2 or L3 IP
name
String desc=name for the vFlow:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=scope is local or fabric
Enum:
local
fabric
vlan (optional)
Integer desc=VLAN for the vFlow:type=uint16:range=[0,4095] format: int32
dscp (optional)
Integer desc=6-bit Differentiated Services Code Point (DSCP) for the vFlow with range 0 to 63:type=uint8:range=[0,63]:precludes=[dscp-start,dscp-end,tos,tos-start,tos-end] format: int32
tos (optional)
Integer desc=ToS number for the vFlow.:type=uint8:precludes=[dscp,dscp-start,dscp-end,tos-start,tos-end] format: int32
dropped (optional)
Boolean desc=match dropped or forwarded packet
vrf (optional)
String desc=vrf,subnet belongs to:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[vrouter-name]:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
ttl (optional)
Integer desc=time-to-live:type=uint8 format: int32
proto (optional)
Integer desc=layer 3 protocol for the vFlow:type=uint8 format: int32
action (optional)
String desc=forwarding action to apply to the vFlow:type=enum
Enum:
none
drop
to-port
to-cpu
trap
copy-to-cpu
copy-to-port
setvlan
add-outer-vlan
set-tpid
to-port-set-vlan
to-span
set-metadata
set-dscp
set-dmac
to-next-hop-ip
set-dmac-to-port
to-ports-and-cpu
set-vlan-pri
set-smac
drop-cancel-trap
to-ecmp-group
redirect-to-vrouter
strip-outer-vlan
cancel-switch-to-cpu
metadata (optional)
Integer desc=metadata number for the vflow:type=uint16 format: int32
vxlan (optional)
Long desc=VXLAN id for the vflow:type=uint32:range=[0,16777215]:precludes=[bd] format: int64
transparency (optional)
String desc=Transparent for protocol packets:type=enum:default=disable
Enum:
enable
disable
tracking (optional)
String desc=VPG link state tracking:type=enum:default=disable
Enum:
disable
enable
enable (optional)
Boolean desc=enable or disable flows in hardware:default=true
dur (optional)
Long desc=minimum duration required for the flow to be captured (in seconds).:type=uint32 format: int64
precedence (optional)
Integer desc=traffic priority value between 2 and 15:type=uint16:range=[0,15]:default=2 format: int32
udf-name1 (optional)
String desc=udf name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/udfs:api-ref-model=udf-show:api-ref-id=name:api-ref-val=name
udf-data1 (optional)
String desc=udf data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name1]
udf-data1-mask (optional)
String desc=mask for udf-data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name1]
udf-name2 (optional)
String desc=udf name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/udfs:api-ref-model=udf-show:api-ref-id=name:api-ref-val=name
udf-data2 (optional)
String desc=udf data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name2]
udf-data2-mask (optional)
String desc=mask for udf-data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name2]
udf-name3 (optional)
String desc=udf name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/udfs:api-ref-model=udf-show:api-ref-id=name:api-ref-val=name
udf-data3 (optional)
String desc=udf data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name3]
udf-data3-mask (optional)
String desc=mask for udf-data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name3]
table-name (optional)
String desc=table name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vflow-tables:api-ref-model=vflow-table-show:api-ref-id=name:api-ref-val=name
flow-cb (optional)
String desc=CPU to process, vflow callback function:type=enum
Enum:
default-cb
arp-cb
bcast-cb
igmp-cb
pim-cb
dhcp-cb
dhcpv6-cb
dmac-miss-cb
l2-miss-cb
no-cb
wol-cb
cpu-class (optional)
String desc=CPU class name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/cpu-classes:api-ref-model=cpu-class-show:api-ref-id=name:api-ref-val=name
if (optional)
String desc=administrative service interface:type=enum:precludes=[in-port,vnet-id,bd,vlan,ether-type,out-port,src-mac,src-mac-mask,dst-mac,dst-mac-mask,src-port-mask,dst-port-mask,dscp-start,dscp-end,dscp,dscp-map,tos-start,tos-end,tos,vlan-pri,ttl,tcp-flags,flow-class,ingress-tunnel,egress-tunnel,bw-min,bw-max,burst-size,vrouter-name,cpu-class,dropped,mirror-id,metadata,transient,vxlan,vxlan-ether-type,vxlan-proto,udf-name1,udf-name2,udf-name3,udf-data1,udf-data2,udf-data3,udf-data1-mask,udf-data2-mask,udf-data3-mask,process-mirror,table-name]
Enum:
mgmt
data
phy-dst-port (optional)
Integer desc=packet destination port for the vflow:type=uint16 format: int32
l3-class-id (optional)
Integer desc=Dst L3 Class ID:type=uint16:range=[0,1023] format: int32
inner-vlan (optional)
Integer desc=Inner VLAN for the vFlow:type=uint16:range=[0,4095] format: int32
ether-type (optional)
String desc=EtherType for the vFlow:type=uint16:hex=0x[0-9a-fA-F]{4}
Enum:
ipv4
0x800
2048
arp
0x806
2054
wake
0x842
2114
rarp
0x8035
32821
vlan
0x8100
33024
ipv6
0x86dd
34525
lacp
0x8809
34825
mpls-uni
0x8847
34887
mpls-multi
0x8848
34888
jumbo
0x8870
34928
dot1X
0x888e
34958
aoe
0x88a2
34978
qinq
0x88a8
34984
lldp
0x88cc
35020
macsec
0x88e5
35045
ecp
0x8940
35136
ptp
0x88f7
35063
fcoe
0x8906
35078
fcoe-init
0x8914
35092
qinq-old
0x9100
37120
src-mac-mask (optional)
String desc=source MAC address to use as a wildcard mask:type=mac-address
dst-mac-mask (optional)
String desc=destination MAC address to use as a wildcard mask:type=mac-address
src-ip (optional)
String desc=source IP address for the vFlow:type=IPv4 or IPv6 address
dst-ip (optional)
String desc=destination IP address for the vFlow:type=IPv4 or IPv6 address
src-port-end (optional)
Integer desc=Layer 3 protocol src port end range for the vFlow:type=uint16:requires=[src-port]:precludes=[src-port-mask] format: int32
src-port-mask (optional)
String desc=source port mask:type=uint16:hex=0x[0-9a-fA-F]{4}:requires=[src-port]:precludes=[src-port-end]
dst-port-end (optional)
Integer desc=Layer 3 protocol dest port end range for the vFlow:type=uint16:requires=[dst-port]:precludes=[dst-port-mask] format: int32
dst-port-mask (optional)
String desc=destination port mask:type=uint16:hex=0x[0-9a-fA-F]{4}:requires=[dst-port]:precludes=[dst-port-end]
dscp-start (optional)
Integer desc=6-bit Differentiated Services Code Point (DSCP) start number:type=uint8:range=[0,63]:requires=[dscp-end]:precludes=[dscp,tos-start,tos-end,tos] format: int32
dscp-end (optional)
Integer desc=6-bit Differentiated Services Code Point (DSCP) end number:type=uint8:range=[0,63]:requires=[dscp-start]:precludes=[dscp,tos-start,tos-end,tos] format: int32
tos-start (optional)
Integer desc=start Type of Service (ToS) number:type=uint8:requires=[tos-end]:precludes=[dscp-start,dscp-end,dscp,tos] format: int32
tos-end (optional)
Integer desc=the ending Type of Service (ToS) number:type=uint8:requires=[tos-start]:precludes=[dscp-start,dscp-end,dscp,tos] format: int32
vlan-pri (optional)
Integer desc=priority for the VLAN - 0 to 7:type=uint8:range=[0,7] format: int32
inner-vlan-pri (optional)
Integer desc=priority for the VLAN - 0 to 7:type=uint8:range=[0,7] format: int32
internal-pri (optional)
byte[] desc=internal priority 0 to 7:range=[-1,7]:default=-1 format: byte
api.internal-pri (optional)
Enum:
none
api.proto (optional)
Enum:
tcp
udp
icmp
igmp
ip
icmpv6
ntp
dns
dhcp
dhcpv6
tcp-flags (optional)
String desc=TCP Control Flags:type=flag
Enum:
fin
syn
rst
push
ack
urg
ece
cwr
flow-class (optional)
String desc=vFlow class name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vflow-classes:api-ref-model=vflow-class-show:api-ref-id=name:api-ref-val=name
ingress-tunnel (optional)
String desc=tunnel for the ingress traffic:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/tunnels:api-ref-model=tunnel-show:api-ref-id=name:api-ref-val=name
egress-tunnel (optional)
String desc=tunnel for egress traffic:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/tunnels:api-ref-model=tunnel-show:api-ref-id=name:api-ref-val=name
bw-min (optional)
Long desc=minimum bandwidth in Gbps:type=uint64 format: int64
bw-max (optional)
Long desc=maximum bandwidth in Gbps:type=uint64 format: int64
burst-size (optional)
Long desc=Committed burst size in bytes:type=uint64:range=[0,134217728]:default=0 format: int64
api.burst-size (optional)
Enum:
auto
api.precedence (optional)
Enum:
default
action-value (optional)
Long desc=optional value argument between 1 and 64:type=uint32:requires=[action] format: int64
action-set-mac-value (optional)
String desc=MAC address value:type=mac-address:requires=[action]
action-to-next-hop-ip-value (optional)
String desc=next-hop IP address for packet redirection:type=IPv4 or IPv6 address:requires=[action]
action-to-ecmp-group-value (optional)
String desc=ECMP group for packet redirection:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[action]:api-ref-path=/static-ecmp-groups:api-ref-model=static-ecmp-group-show:api-ref-id=group-name:api-ref-val=group-name
action-to-ports-value (optional)
String desc=action to ports value:type=port-list:requires=[action]
override-sys-flows (optional)
Boolean desc=override system flows
mirror-id (optional)
String desc=mirror configuration name:type=identifier:api-ref-path=/mirrors:api-ref-model=mirror-show:api-ref-id=id:api-ref-val=name
log-stats (optional)
Boolean desc=log packet statistics for the flow:default=false
stats-interval (optional)
Integer desc=interval to update packet statistics for the log (in seconds):range=[1,604800]:default=60:requires=[log-stats] format: int32
vxlan-ether-type (optional)
String desc=EtherType for the VXLAN:type=uint16:hex=0x[0-9a-fA-F]{4}
Enum:
ipv4
0x800
2048
arp
0x806
2054
wake
0x842
2114
rarp
0x8035
32821
vlan
0x8100
33024
ipv6
0x86dd
34525
lacp
0x8809
34825
mpls-uni
0x8847
34887
mpls-multi
0x8848
34888
jumbo
0x8870
34928
dot1X
0x888e
34958
aoe
0x88a2
34978
qinq
0x88a8
34984
lldp
0x88cc
35020
macsec
0x88e5
35045
ecp
0x8940
35136
ptp
0x88f7
35063
fcoe
0x8906
35078
fcoe-init
0x8914
35092
qinq-old
0x9100
37120
from-tunnel-decap (optional)
String desc=Tunnel terminated vxlan packets:type=enum:default=none:requires=[vxlan]
Enum:
off
on
none
vxlan-proto (optional)
Integer desc=protocol type for the VXLAN:type=uint8 format: int32
api.vxlan-proto (optional)
Enum:
tcp
udp
icmp
igmp
ip
icmpv6
ntp
dns
dhcp
dhcpv6
stp-state (optional)
String desc=stp state:type=enum
Enum:
Disabled
Discarding
Learning
Forwarding
packet-res (optional)
String desc=Packet resolution in asic:type=enum
Enum:
l2-unicast
l2-unknown-unicast
l2-multicast
l2-unknown-multicast
l2-broadcast
l3-known-unicast
l3-unknown-unicast
fwding-type (optional)
String desc=asic forwarding type:type=enum
Enum:
vlan
vxlan
src-vpg (optional)
String desc=Source Virtual Port Group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[dst-vpg]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
dst-vpg (optional)
String desc=Destination Virtual Port Group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[src-vpg]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
bidir-vpg-1 (optional)
String desc=Bidirectional Virtual Port Group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[bidir-vpg-2]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
bidir-vpg-2 (optional)
String desc=Bidirectional Virtual Port Group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[bidir-vpg-1]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
dscp-map (optional)
String desc=DSCP map to apply on the flow. Please reapply if map priorities are updated:api-ref-path=/dscp-maps:api-ref-model=dscp-map-show:api-ref-id=name:api-ref-val=name
description (optional)
String desc=vFlow description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
vrouter-name (optional)
String desc=name of the vrouter service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[vrf]:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
vnet-id (optional)
String desc=VNET assigned to the vFlow:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain for the vFlow:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[vxlan]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
out-port (optional)
String desc=outgoing port for the vFlow:type=port-list:precludes=[if,src-vpg,dst-vpg]
in-port (optional)
String desc=incoming port for the vFlow:type=port-list:precludes=[if,src-vpg,dst-vpg]
src-mac (optional)
String desc=source MAC address for the vFlow:type=mac-address
dst-mac (optional)
String desc=destination MAC address for the vFlow:type=mac-address
src-ip-mask (optional)
String desc=source IP address wildcard mask for the vFlow:type=IPv4 or IPv6 address:requires=[src-ip]:mask-for=[src-ip]
src-port (optional)
Integer desc=Layer 3 protocol source port for the vFlow:type=uint16:requires=[proto] format: int32
dst-ip-mask (optional)
String desc=destination IP address wildcard mask for the vFlow:type=IPv4 or IPv6 address:requires=[dst-ip]:mask-for=[dst-ip]
dst-port (optional)
Integer desc=Layer 3 protocol destination port for the vFlow:type=uint16:requires=[proto] format: int32

vflow-mgmt-stats-clear - Up

clear management packet statistics for the vflow
name
String desc=name of the vFlow:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vflows:api-ref-model=vflow-show:api-ref-id=name:api-ref-val=name
vnet (optional)
String desc=VNET of the vFlow:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
id (optional)
String desc=id assigned to the vFlow:type=identifier
bytes (optional)
Long desc=total number of bytes:type=uint64 format: int64
mismatches (optional)
Long desc=number of mismatches:type=uint64 format: int64
drops (optional)
Long desc=number of dropped packets format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
pkts (optional)
Long desc=total number of packets:type=uint64 format: int64
cpu-pkts (optional)
Long desc=number of CPU packets:type=uint64 format: int64
cpu-bytes (optional)
Long desc=number of CPU bytes:type=uint64 format: int64
drop-bytes (optional)
Long desc=number of dropped bytes format: int64
policer-drops (optional)
Long desc=number of policer dropped packets:type=uint64 format: int64
policer-drop-bytes (optional)
Long desc=number of policer dropped bytes:type=uint64 format: int64
cpu-tx-pkts (optional)
Long desc=number of packets sent from CPU:type=uint64 format: int64
cpu-tx-bytes (optional)
Long desc=number of bytes sent from CPU:type=uint64 format: int64

vflow-mgmt-stats-show - Up

show mgmt flow stats
api.switch-name (optional)
name
String desc=name of the vFlow:api-ref-path=/vflows:api-ref-model=vflow-show:api-ref-id=name:api-ref-val=name
vnet (optional)
String desc=VNET of the vFlow:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
id (optional)
String desc=id assigned to the vFlow:type=identifier
bytes (optional)
Long desc=total number of bytes:type=uint64:filter=false format: int64
mismatches (optional)
Long desc=number of mismatches:type=uint64:filter=false format: int64
drops (optional)
Long desc=number of dropped packets:filter=false format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
pkts (optional)
Long desc=total number of packets:type=uint64:filter=false format: int64
cpu-pkts (optional)
Long desc=number of CPU packets:type=uint64:filter=false format: int64
cpu-bytes (optional)
Long desc=number of CPU bytes:type=uint64:filter=false format: int64
drop-bytes (optional)
Long desc=number of dropped bytes:filter=false format: int64
policer-drops (optional)
Long desc=number of policer dropped packets:type=uint64:filter=false format: int64
policer-drop-bytes (optional)
Long desc=number of policer dropped bytes:type=uint64:filter=false format: int64
cpu-tx-pkts (optional)
Long desc=number of packets sent from CPU:type=uint64:filter=false format: int64
cpu-tx-bytes (optional)
Long desc=number of bytes sent from CPU:type=uint64:filter=false format: int64

vflow-mgmt-stats-show-response - Up

vflow-modify - Up

modify a virtual flow
dscp (optional)
Integer desc=6-bit Differentiated Services Code Point (DSCP) for the vFlow with range 0 to 63:type=uint8:range=[0,63]:precludes=[dscp-start,dscp-end,tos,tos-start,tos-end] format: int32
tos (optional)
Integer desc=ToS number for the vFlow.:type=uint8:precludes=[dscp,dscp-start,dscp-end,tos-start,tos-end] format: int32
dropped (optional)
Boolean desc=match dropped or forwarded packet
vrf (optional)
String desc=vrf,subnet belongs to:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[vrouter-name]:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
ttl (optional)
Integer desc=time-to-live:type=uint8 format: int32
proto (optional)
Integer desc=layer 3 protocol for the vFlow:type=uint8 format: int32
action (optional)
String desc=forwarding action to apply to the vFlow:type=enum
Enum:
none
drop
to-port
to-cpu
trap
copy-to-cpu
copy-to-port
setvlan
add-outer-vlan
set-tpid
to-port-set-vlan
to-span
set-metadata
set-dscp
set-dmac
to-next-hop-ip
set-dmac-to-port
to-ports-and-cpu
set-vlan-pri
set-smac
drop-cancel-trap
to-ecmp-group
redirect-to-vrouter
strip-outer-vlan
cancel-switch-to-cpu
vxlan (optional)
Long desc=VXLAN id for the vflow:type=uint32:range=[0,16777215]:precludes=[bd] format: int64
transparency (optional)
String desc=Transparent for protocol packets:type=enum:default=disable
Enum:
enable
disable
tracking (optional)
String desc=VPG link state tracking:type=enum:default=disable
Enum:
disable
enable
enable (optional)
Boolean desc=enable or disable flows in hardware:default=true
precedence (optional)
Integer desc=traffic priority value between 2 and 15:type=uint16:range=[0,15]:default=2 format: int32
udf-name1 (optional)
String desc=udf name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/udfs:api-ref-model=udf-show:api-ref-id=name:api-ref-val=name
udf-data1 (optional)
String desc=udf data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name1]
udf-data1-mask (optional)
String desc=mask for udf-data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name1]
udf-name2 (optional)
String desc=udf name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/udfs:api-ref-model=udf-show:api-ref-id=name:api-ref-val=name
udf-data2 (optional)
String desc=udf data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name2]
udf-data2-mask (optional)
String desc=mask for udf-data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name2]
udf-name3 (optional)
String desc=udf name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/udfs:api-ref-model=udf-show:api-ref-id=name:api-ref-val=name
udf-data3 (optional)
String desc=udf data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name3]
udf-data3-mask (optional)
String desc=mask for udf-data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name3]
table-name (optional)
String desc=table name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vflow-tables:api-ref-model=vflow-table-show:api-ref-id=name:api-ref-val=name
cpu-class (optional)
String desc=CPU class name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/cpu-classes:api-ref-model=cpu-class-show:api-ref-id=name:api-ref-val=name
if (optional)
String desc=administrative service interface:type=enum:precludes=[in-port,vnet-id,bd,vlan,ether-type,out-port,src-mac,src-mac-mask,dst-mac,dst-mac-mask,src-port-mask,dst-port-mask,dscp-start,dscp-end,dscp,dscp-map,tos-start,tos-end,tos,vlan-pri,ttl,tcp-flags,flow-class,ingress-tunnel,egress-tunnel,bw-min,bw-max,burst-size,vrouter-name,cpu-class,dropped,mirror-id,metadata,transient,vxlan,vxlan-ether-type,vxlan-proto,udf-name1,udf-name2,udf-name3,udf-data1,udf-data2,udf-data3,udf-data1-mask,udf-data2-mask,udf-data3-mask,process-mirror,table-name]
Enum:
mgmt
data
phy-dst-port (optional)
Integer desc=packet destination port for the vflow:type=uint16 format: int32
l3-class-id (optional)
Integer desc=Dst L3 Class ID:type=uint16:range=[0,1023] format: int32
inner-vlan (optional)
Integer desc=Inner VLAN for the vFlow:type=uint16:range=[0,4095] format: int32
ether-type (optional)
String desc=EtherType for the vFlow:type=uint16:hex=0x[0-9a-fA-F]{4}
Enum:
ipv4
0x800
2048
arp
0x806
2054
wake
0x842
2114
rarp
0x8035
32821
vlan
0x8100
33024
ipv6
0x86dd
34525
lacp
0x8809
34825
mpls-uni
0x8847
34887
mpls-multi
0x8848
34888
jumbo
0x8870
34928
dot1X
0x888e
34958
aoe
0x88a2
34978
qinq
0x88a8
34984
lldp
0x88cc
35020
macsec
0x88e5
35045
ecp
0x8940
35136
ptp
0x88f7
35063
fcoe
0x8906
35078
fcoe-init
0x8914
35092
qinq-old
0x9100
37120
src-mac-mask (optional)
String desc=source MAC address to use as a wildcard mask:type=mac-address
dst-mac-mask (optional)
String desc=destination MAC address to use as a wildcard mask:type=mac-address
src-ip (optional)
String desc=source IP address for the vFlow:type=IPv4 or IPv6 address
dst-ip (optional)
String desc=destination IP address for the vFlow:type=IPv4 or IPv6 address
src-port-end (optional)
Integer desc=Layer 3 protocol src port end range for the vFlow:type=uint16:requires=[src-port]:precludes=[src-port-mask] format: int32
src-port-mask (optional)
String desc=source port mask:type=uint16:hex=0x[0-9a-fA-F]{4}:requires=[src-port]:precludes=[src-port-end]
dst-port-end (optional)
Integer desc=Layer 3 protocol dest port end range for the vFlow:type=uint16:requires=[dst-port]:precludes=[dst-port-mask] format: int32
dst-port-mask (optional)
String desc=destination port mask:type=uint16:hex=0x[0-9a-fA-F]{4}:requires=[dst-port]:precludes=[dst-port-end]
dscp-start (optional)
Integer desc=6-bit Differentiated Services Code Point (DSCP) start number:type=uint8:range=[0,63]:requires=[dscp-end]:precludes=[dscp,tos-start,tos-end,tos] format: int32
dscp-end (optional)
Integer desc=6-bit Differentiated Services Code Point (DSCP) end number:type=uint8:range=[0,63]:requires=[dscp-start]:precludes=[dscp,tos-start,tos-end,tos] format: int32
tos-start (optional)
Integer desc=start Type of Service (ToS) number:type=uint8:requires=[tos-end]:precludes=[dscp-start,dscp-end,dscp,tos] format: int32
tos-end (optional)
Integer desc=the ending Type of Service (ToS) number:type=uint8:requires=[tos-start]:precludes=[dscp-start,dscp-end,dscp,tos] format: int32
vlan-pri (optional)
Integer desc=priority for the VLAN - 0 to 7:type=uint8:range=[0,7] format: int32
inner-vlan-pri (optional)
Integer desc=priority for the VLAN - 0 to 7:type=uint8:range=[0,7] format: int32
internal-pri (optional)
byte[] desc=internal priority 0 to 7:range=[-1,7]:default=-1 format: byte
api.internal-pri (optional)
Enum:
none
api.proto (optional)
Enum:
tcp
udp
icmp
igmp
ip
icmpv6
ntp
dns
dhcp
dhcpv6
tcp-flags (optional)
String desc=TCP Control Flags:type=flag
Enum:
fin
syn
rst
push
ack
urg
ece
cwr
flow-class (optional)
String desc=vFlow class name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vflow-classes:api-ref-model=vflow-class-show:api-ref-id=name:api-ref-val=name
bw-min (optional)
Long desc=minimum bandwidth in Gbps:type=uint64 format: int64
bw-max (optional)
Long desc=maximum bandwidth in Gbps:type=uint64 format: int64
burst-size (optional)
Long desc=Committed burst size in bytes:type=uint64:range=[0,134217728]:default=0 format: int64
api.burst-size (optional)
Enum:
auto
api.precedence (optional)
Enum:
default
action-value (optional)
Long desc=optional value argument between 1 and 64:type=uint32:requires=[action] format: int64
action-set-mac-value (optional)
String desc=MAC address value:type=mac-address:requires=[action]
action-to-next-hop-ip-value (optional)
String desc=next-hop IP address for packet redirection:type=IPv4 or IPv6 address:requires=[action]
action-to-ecmp-group-value (optional)
String desc=ECMP group for packet redirection:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[action]:api-ref-path=/static-ecmp-groups:api-ref-model=static-ecmp-group-show:api-ref-id=group-name:api-ref-val=group-name
action-to-ports-value (optional)
String desc=action to ports value:type=port-list:requires=[action]
override-sys-flows (optional)
Boolean desc=override system flows
mirror-id (optional)
String desc=mirror configuration name:type=identifier:api-ref-path=/mirrors:api-ref-model=mirror-show:api-ref-id=id:api-ref-val=name
log-stats (optional)
Boolean desc=log packet statistics for the flow:default=false
stats-interval (optional)
Integer desc=interval to update packet statistics for the log (in seconds):range=[1,604800]:default=60:requires=[log-stats] format: int32
from-tunnel-decap (optional)
String desc=Tunnel terminated vxlan packets:type=enum:default=none:requires=[vxlan]
Enum:
off
on
none
src-vpg (optional)
String desc=Source Virtual Port Group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[dst-vpg]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
dst-vpg (optional)
String desc=Destination Virtual Port Group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[src-vpg]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
bidir-vpg-1 (optional)
String desc=Bidirectional Virtual Port Group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[bidir-vpg-2]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
bidir-vpg-2 (optional)
String desc=Bidirectional Virtual Port Group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[bidir-vpg-1]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
dscp-map (optional)
String desc=DSCP map to apply on the flow. Please reapply if map priorities are updated:api-ref-path=/dscp-maps:api-ref-model=dscp-map-show:api-ref-id=name:api-ref-val=name
description (optional)
String desc=vFlow description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
vrouter-name (optional)
String desc=name of the vrouter service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[vrf]:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
in-port (optional)
String desc=incoming port for the vFlow:type=port-list:precludes=[if,src-vpg,dst-vpg]
src-mac (optional)
String desc=source MAC address for the vFlow:type=mac-address
dst-mac (optional)
String desc=destination MAC address for the vFlow:type=mac-address
src-ip-mask (optional)
String desc=source IP address wildcard mask for the vFlow:type=IPv4 or IPv6 address:requires=[src-ip]:mask-for=[src-ip]
src-port (optional)
Integer desc=Layer 3 protocol source port for the vFlow:type=uint16:requires=[proto] format: int32
dst-ip-mask (optional)
String desc=destination IP address wildcard mask for the vFlow:type=IPv4 or IPv6 address:requires=[dst-ip]:mask-for=[dst-ip]
dst-port (optional)
Integer desc=Layer 3 protocol destination port for the vFlow:type=uint16:requires=[proto] format: int32

vflow-settings-modify - Up

update a user vflow setting
vxlan-analytics (optional)
Boolean desc=enable VXLAN analytics
enable-user-defined-flow (optional)
Boolean desc=Enable/Disable User Defined Flows:default=false
inflight-vxlan-analytics (optional)
Boolean desc=enable inflight VXLAN analytics:default=false
longlived-tcp-conn-stats (optional)
Boolean desc=enable long lived tcp connection stats:default=false

vflow-settings-show - Up

display user vflow settings
api.switch-name (optional)
vxlan-analytics (optional)
Boolean desc=enable VXLAN analytics
enable-user-defined-flow (optional)
Boolean desc=Enable/Disable User Defined Flows
inflight-vxlan-analytics (optional)
Boolean desc=enable inflight VXLAN analytics
longlived-tcp-conn-stats (optional)
Boolean desc=enable long lived tcp connection stats

vflow-settings-show-response - Up

vflow-show - Up

display virtual flow information
api.switch-name (optional)
name
String desc=name for the vFlow
id
String desc=ID assigned to the vFlow:type=identifier
scope (optional)
String desc=scope is local or fabric
Enum:
local
fabric
type (optional)
String desc=type of the vflow:type=flag
Enum:
ofp
vflow
ofp-default
acl-ip
acl-mac
vxlan
nat
qos
nat-twice
hog-violator
pbr
iptable
hidden (optional)
Boolean desc=vflow is hidden or not
vlan (optional)
Integer desc=VLAN for the vFlow:type=uint16:range=[0,4095] format: int32
dscp (optional)
Integer desc=6-bit Differentiated Services Code Point (DSCP) for the vFlow with range 0 to 63:type=uint8:range=[0,63]:precludes=[dscp-start,dscp-end,tos,tos-start,tos-end] format: int32
tos (optional)
Integer desc=ToS number for the vFlow.:type=uint8:precludes=[dscp,dscp-start,dscp-end,tos-start,tos-end] format: int32
dropped (optional)
Boolean desc=match dropped or forwarded packet
vrf (optional)
String desc=vrf,subnet belongs to:precludes=[vrouter-name]:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
ttl (optional)
Integer desc=time-to-live:type=uint8 format: int32
proto (optional)
Integer desc=layer 3 protocol for the vFlow:type=uint8 format: int32
action (optional)
String desc=forwarding action to apply to the vFlow:type=enum
Enum:
none
drop
to-port
to-cpu
trap
copy-to-cpu
copy-to-port
setvlan
add-outer-vlan
set-tpid
to-port-set-vlan
to-span
set-metadata
set-dscp
set-dmac
to-next-hop-ip
set-dmac-to-port
to-ports-and-cpu
set-vlan-pri
set-smac
drop-cancel-trap
to-ecmp-group
redirect-to-vrouter
strip-outer-vlan
cancel-switch-to-cpu
metadata (optional)
Integer desc=metadata number for the vflow:type=uint16 format: int32
vxlan (optional)
Long desc=VXLAN id for the vflow:type=uint32:range=[0,16777215]:precludes=[bd] format: int64
transparency (optional)
String desc=Transparent for protocol packets:type=enum
Enum:
enable
disable
tracking (optional)
String desc=VPG link state tracking:type=enum
Enum:
disable
enable
enable (optional)
Boolean desc=enable or disable flows in hardware
topology (optional)
String desc=topology the vflow belongs to
dur (optional)
Long desc=minimum duration required for the flow to be captured (in seconds).:type=uint32 format: int64
local-subnet (optional)
Boolean desc=use the local subnet or not
action-value1 (optional)
Long desc=second optional value argument for the forwarding action between 1 and 64:type=uint32:range=[1,4096]:requires=[action] format: int64
metadata-mask (optional)
Long desc=metadata mask for the vflow:type=uint32 format: int64
hw-stats (optional)
Boolean desc=enable or disable hardware statistics
vpn_id (optional)
String desc=vpn configured in the hardware for vflow:type=uint32:hex=0x[0-9a-fA-F]{8}
precedence (optional)
Integer desc=traffic priority value between 2 and 15:type=uint16:range=[0,15] format: int32
udf-name1 (optional)
String desc=udf name:api-ref-path=/udfs:api-ref-model=udf-show:api-ref-id=name:api-ref-val=name
udf-data1 (optional)
String desc=udf data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name1]
udf-data1-mask (optional)
String desc=mask for udf-data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name1]
udf-name2 (optional)
String desc=udf name:api-ref-path=/udfs:api-ref-model=udf-show:api-ref-id=name:api-ref-val=name
udf-data2 (optional)
String desc=udf data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name2]
udf-data2-mask (optional)
String desc=mask for udf-data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name2]
udf-name3 (optional)
String desc=udf name:api-ref-path=/udfs:api-ref-model=udf-show:api-ref-id=name:api-ref-val=name
udf-data3 (optional)
String desc=udf data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name3]
udf-data3-mask (optional)
String desc=mask for udf-data:type=uint32:hex=0x[0-9a-fA-F]{8}:requires=[udf-name3]
table-name (optional)
String desc=table name:api-ref-path=/vflow-tables:api-ref-model=vflow-table-show:api-ref-id=name:api-ref-val=name
flow-cb (optional)
String desc=CPU to process, vflow callback function:type=enum
Enum:
default-cb
arp-cb
bcast-cb
igmp-cb
pim-cb
dhcp-cb
dhcpv6-cb
dmac-miss-cb
l2-miss-cb
no-cb
wol-cb
cpu-class (optional)
String desc=CPU class name:api-ref-path=/cpu-classes:api-ref-model=cpu-class-show:api-ref-id=name:api-ref-val=name
if (optional)
String desc=administrative service interface:type=enum:precludes=[in-port,vnet-id,bd,vlan,ether-type,out-port,src-mac,src-mac-mask,dst-mac,dst-mac-mask,src-port-mask,dst-port-mask,dscp-start,dscp-end,dscp,dscp-map,tos-start,tos-end,tos,vlan-pri,ttl,tcp-flags,flow-class,ingress-tunnel,egress-tunnel,bw-min,bw-max,burst-size,vrouter-name,cpu-class,dropped,mirror-id,metadata,transient,vxlan,vxlan-ether-type,vxlan-proto,udf-name1,udf-name2,udf-name3,udf-data1,udf-data2,udf-data3,udf-data1-mask,udf-data2-mask,udf-data3-mask,process-mirror,table-name]
Enum:
mgmt
data
phy-dst-port (optional)
Integer desc=packet destination port for the vflow:type=uint16 format: int32
l3-class-id (optional)
Integer desc=Dst L3 Class ID:type=uint16:range=[0,1023] format: int32
inner-vlan (optional)
Integer desc=Inner VLAN for the vFlow:type=uint16:range=[0,4095] format: int32
ether-type (optional)
String desc=EtherType for the vFlow:type=uint16:hex=0x[0-9a-fA-F]{4}
Enum:
0x800
0x806
0x842
0x8035
0x8100
0x86dd
0x8809
0x8847
0x8848
0x8870
0x888e
0x88a2
0x88a8
0x88cc
0x88e5
0x8940
0x88f7
0x8906
0x8914
0x9100
src-mac-mask (optional)
String desc=source MAC address to use as a wildcard mask:type=mac-address
dst-mac-mask (optional)
String desc=destination MAC address to use as a wildcard mask:type=mac-address
src-ip (optional)
String desc=source IP address for the vFlow:type=IPv4 or IPv6 address
dst-ip (optional)
String desc=destination IP address for the vFlow:type=IPv4 or IPv6 address
src-port-end (optional)
Integer desc=Layer 3 protocol src port end range for the vFlow:type=uint16:requires=[src-port]:precludes=[src-port-mask] format: int32
src-port-mask (optional)
String desc=source port mask:type=uint16:hex=0x[0-9a-fA-F]{4}:requires=[src-port]:precludes=[src-port-end]
dst-port-end (optional)
Integer desc=Layer 3 protocol dest port end range for the vFlow:type=uint16:requires=[dst-port]:precludes=[dst-port-mask] format: int32
dst-port-mask (optional)
String desc=destination port mask:type=uint16:hex=0x[0-9a-fA-F]{4}:requires=[dst-port]:precludes=[dst-port-end]
dscp-start (optional)
Integer desc=6-bit Differentiated Services Code Point (DSCP) start number:type=uint8:range=[0,63]:requires=[dscp-end]:precludes=[dscp,tos-start,tos-end,tos] format: int32
dscp-end (optional)
Integer desc=6-bit Differentiated Services Code Point (DSCP) end number:type=uint8:range=[0,63]:requires=[dscp-start]:precludes=[dscp,tos-start,tos-end,tos] format: int32
tos-start (optional)
Integer desc=start Type of Service (ToS) number:type=uint8:requires=[tos-end]:precludes=[dscp-start,dscp-end,dscp,tos] format: int32
tos-end (optional)
Integer desc=the ending Type of Service (ToS) number:type=uint8:requires=[tos-start]:precludes=[dscp-start,dscp-end,dscp,tos] format: int32
vlan-pri (optional)
Integer desc=priority for the VLAN - 0 to 7:type=uint8:range=[0,7] format: int32
inner-vlan-pri (optional)
Integer desc=priority for the VLAN - 0 to 7:type=uint8:range=[0,7] format: int32
internal-pri (optional)
byte[] desc=internal priority 0 to 7:range=[-1,7] format: byte
tcp-flags (optional)
String desc=TCP Control Flags:type=flag
Enum:
fin
syn
rst
push
ack
urg
ece
cwr
flow-class (optional)
String desc=vFlow class name:api-ref-path=/vflow-classes:api-ref-model=vflow-class-show:api-ref-id=name:api-ref-val=name
ingress-tunnel (optional)
String desc=tunnel for the ingress traffic:api-ref-path=/tunnels:api-ref-model=tunnel-show:api-ref-id=name:api-ref-val=name
egress-tunnel (optional)
String desc=tunnel for egress traffic:api-ref-path=/tunnels:api-ref-model=tunnel-show:api-ref-id=name:api-ref-val=name
bw-min (optional)
Long desc=minimum bandwidth in Gbps:type=uint64 format: int64
bw-max (optional)
Long desc=maximum bandwidth in Gbps:type=uint64 format: int64
burst-size (optional)
Long desc=Committed burst size in bytes:type=uint64:range=[0,134217728] format: int64
action-value (optional)
Long desc=optional value argument between 1 and 64:type=uint32:requires=[action] format: int64
action-set-mac-value (optional)
String desc=MAC address value:type=mac-address:requires=[action]
action-to-next-hop-ip-value (optional)
String desc=next-hop IP address for packet redirection:type=IPv4 or IPv6 address:requires=[action]
action-to-ecmp-group-value (optional)
String desc=ECMP group for packet redirection:requires=[action]:api-ref-path=/static-ecmp-groups:api-ref-model=static-ecmp-group-show:api-ref-id=group-name:api-ref-val=group-name
action-to-ports-value (optional)
String desc=action to ports value:type=port-list:requires=[action]
override-sys-flows (optional)
Boolean desc=override system flows
mirror-id (optional)
String desc=mirror configuration name:type=identifier:api-ref-path=/mirrors:api-ref-model=mirror-show:api-ref-id=id:api-ref-val=name
log-stats (optional)
Boolean desc=log packet statistics for the flow
stats-interval (optional)
Integer desc=interval to update packet statistics for the log (in seconds):range=[1,604800]:requires=[log-stats] format: int32
vxlan-ether-type (optional)
String desc=EtherType for the VXLAN:type=uint16:hex=0x[0-9a-fA-F]{4}
Enum:
0x800
0x806
0x842
0x8035
0x8100
0x86dd
0x8809
0x8847
0x8848
0x8870
0x888e
0x88a2
0x88a8
0x88cc
0x88e5
0x8940
0x88f7
0x8906
0x8914
0x9100
from-tunnel-decap (optional)
String desc=Tunnel terminated vxlan packets:type=enum:requires=[vxlan]
Enum:
off
on
none
vxlan-proto (optional)
Integer desc=protocol type for the VXLAN:type=uint8 format: int32
stp-state (optional)
String desc=stp state:type=enum
Enum:
Disabled
Discarding
Learning
Forwarding
packet-res (optional)
String desc=Packet resolution in asic:type=enum
Enum:
l2-unicast
l2-unknown-unicast
l2-multicast
l2-unknown-multicast
l2-broadcast
l3-known-unicast
l3-unknown-unicast
fwding-type (optional)
String desc=asic forwarding type:type=enum
Enum:
vlan
vxlan
src-vpg (optional)
String desc=Source Virtual Port Group name:requires=[dst-vpg]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
dst-vpg (optional)
String desc=Destination Virtual Port Group name:requires=[src-vpg]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
bidir-vpg-1 (optional)
String desc=Bidirectional Virtual Port Group name:requires=[bidir-vpg-2]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
bidir-vpg-2 (optional)
String desc=Bidirectional Virtual Port Group name:requires=[bidir-vpg-1]:precludes=[in-port,out-port]:api-ref-path=/vpgs:api-ref-model=vpg-show:api-ref-id=name:api-ref-val=name
dscp-map (optional)
String desc=DSCP map to apply on the flow. Please reapply if map priorities are updated:api-ref-path=/dscp-maps:api-ref-model=dscp-map-show:api-ref-id=name:api-ref-val=name
tracking-status (optional)
String desc=VPG link state tracking status:type=enum
Enum:
unknown
disabled
remote-down
local-down
up
down
description (optional)
String desc=vFlow description
vrouter-name (optional)
String desc=name of the vrouter service:precludes=[vrf]:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
vnet-id (optional)
String desc=VNET assigned to the vFlow:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain for the vFlow:precludes=[vxlan]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
out-port (optional)
String desc=outgoing port for the vFlow:type=port-list:precludes=[if,src-vpg,dst-vpg]
in-port (optional)
String desc=incoming port for the vFlow:type=port-list:precludes=[if,src-vpg,dst-vpg]
src-mac (optional)
String desc=source MAC address for the vFlow:type=mac-address
dst-mac (optional)
String desc=destination MAC address for the vFlow:type=mac-address
src-ip-mask (optional)
String desc=source IP address wildcard mask for the vFlow:type=IPv4 or IPv6 address:requires=[src-ip]:mask-for=[src-ip]
src-port (optional)
Integer desc=Layer 3 protocol source port for the vFlow:type=uint16:requires=[proto] format: int32
dst-ip-mask (optional)
String desc=destination IP address wildcard mask for the vFlow:type=IPv4 or IPv6 address:requires=[dst-ip]:mask-for=[dst-ip]
dst-port (optional)
Integer desc=Layer 3 protocol destination port for the vFlow:type=uint16:requires=[proto] format: int32

vflow-show-response - Up

vflow-skip-stats-clear - Up

Clear vFlow Processing Skipped Statistics
name
String desc=name of the vFlow:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vflows:api-ref-model=vflow-show:api-ref-id=name:api-ref-val=name

vflow-skip-stats-show - Up

vFlow Processing Skipped Statistics
api.switch-name (optional)
name
String desc=name of the vFlow:api-ref-path=/vflows:api-ref-model=vflow-show:api-ref-id=name:api-ref-val=name
others (optional)
Long desc=skipped for other reason packets:type=uint64:filter=false format: int64
intsw (optional)
Long desc=skipped for intsw reason packets:type=uint64:filter=false format: int64
ttl (optional)
Long desc=skipped for ttl reason packets:type=uint64:filter=false format: int64
l2-to-cpu (optional)
Long desc=skipped for l2-to-cpu reason packets:type=uint64:filter=false format: int64
l2-to-cpu-check (optional)
Long desc=skipped for l2-cpu-to-check reason packets:type=uint64:filter=false format: int64
l3-miss (optional)
Long desc=skipped for l3-miss reason packets:type=uint64:filter=false format: int64
fwd-pkt (optional)
Long desc=skipped for fwd-pkt reason packets:type=uint64:filter=false format: int64
l3-to-cpu (optional)
Long desc=skipped for l3-to-cpu reason packets:type=uint64:filter=false format: int64
smac-copy-to-cpu (optional)
Long desc=skipped for smac-copy-to-cpu reason packets:type=uint64:filter=false format: int64
mcast-miss (optional)
Long desc=skipped for mcast-miss reason packets:type=uint64:filter=false format: int64
smac-miss (optional)
Long desc=skipped for smac-miss reason packets:type=uint64:filter=false format: int64
sw-tunnel (optional)
Long desc=skipped for sw-tunnel reason packets:type=uint64:filter=false format: int64
dmac-miss (optional)
Long desc=skipped for dmac-miss reason packets:type=uint64:filter=false format: int64

vflow-skip-stats-show-response - Up

vflow-stats-clear - Up

clear packet statistics for the vflow
name
String desc=name of the vFlow:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vflows:api-ref-model=vflow-show:api-ref-id=name:api-ref-val=name
vnet (optional)
String desc=VNET of the vFlow:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
id (optional)
String desc=id assigned to the vFlow:type=identifier
bytes (optional)
Long desc=total number of bytes:type=uint64 format: int64
mismatches (optional)
Long desc=number of mismatches:type=uint64 format: int64
drops (optional)
Long desc=number of dropped packets format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
pkts (optional)
Long desc=total number of packets:type=uint64 format: int64
cpu-pkts (optional)
Long desc=number of CPU packets:type=uint64 format: int64
cpu-bytes (optional)
Long desc=number of CPU bytes:type=uint64 format: int64
drop-bytes (optional)
Long desc=number of dropped bytes format: int64
policer-drops (optional)
Long desc=number of policer dropped packets:type=uint64 format: int64
policer-drop-bytes (optional)
Long desc=number of policer dropped bytes:type=uint64 format: int64
cpu-tx-pkts (optional)
Long desc=number of packets sent from CPU:type=uint64 format: int64
cpu-tx-bytes (optional)
Long desc=number of bytes sent from CPU:type=uint64 format: int64

vflow-stats-settings-modify - Up

modify vFlow statistics setting
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

vflow-stats-settings-show - Up

display vFlow statistics settings
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

vflow-stats-settings-show-response - Up

vflow-stats-show - Up

display packet statistics or logs for the vflow
api.switch-name (optional)
name
String desc=name of the vFlow:api-ref-path=/vflows:api-ref-model=vflow-show:api-ref-id=name:api-ref-val=name
vnet (optional)
String desc=VNET of the vFlow:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
id (optional)
String desc=id assigned to the vFlow:type=identifier
bytes (optional)
Long desc=total number of bytes:type=uint64:filter=false format: int64
mismatches (optional)
Long desc=number of mismatches:type=uint64:filter=false format: int64
drops (optional)
Long desc=number of dropped packets:filter=false format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
pkts (optional)
Long desc=total number of packets:type=uint64:filter=false format: int64
cpu-pkts (optional)
Long desc=number of CPU packets:type=uint64:filter=false format: int64
cpu-bytes (optional)
Long desc=number of CPU bytes:type=uint64:filter=false format: int64
drop-bytes (optional)
Long desc=number of dropped bytes:filter=false format: int64
policer-drops (optional)
Long desc=number of policer dropped packets:type=uint64:filter=false format: int64
policer-drop-bytes (optional)
Long desc=number of policer dropped bytes:type=uint64:filter=false format: int64
cpu-tx-pkts (optional)
Long desc=number of packets sent from CPU:type=uint64:filter=false format: int64
cpu-tx-bytes (optional)
Long desc=number of bytes sent from CPU:type=uint64:filter=false format: int64

vflow-stats-show-response - Up

vflow-table-profile-modify - Up

modify a vFlow table profile
enable (optional)
Boolean desc=enable or disable vflow profile table
hw-tbl (optional)
String desc=hardware table used by vFlow:type=enum
Enum:
switch-main
switch-hash
npu-main
npu-hash

vflow-table-profile-show - Up

display vFlow table profiles
api.switch-name (optional)
profile
String desc=type of vFlow profile:type=enum
Enum:
application
vxlan
nat
openflow
security
vxlan-encap
ipv4
ipv6
mac
npu-app
qos
ipv6-vcap
enable (optional)
Boolean desc=enable or disable vflow profile table
comment (optional)
String desc=comment on vFlow
configurable (optional)
Boolean desc=whether profile is configurable or not
flow-capacity (optional)
Long desc=total capacity assigned to vFlow:type=uint32 format: int64
flow-slices-needed (optional)
Long desc=number of vFlow slices needed for minimum tables:type=uint32 format: int64
flow-slices-used (optional)
Long desc=number of vFlow slices used in table:type=uint32 format: int64
hw-tbl (optional)
String desc=hardware table used by vFlow:type=enum
Enum:
switch-main
switch-hash
npu-main
npu-hash

vflow-table-profile-show-response - Up

vflow-table-show - Up

display vFlow tables
api.switch-name (optional)
name
String desc=vFlow name
id
String desc=ID assigned by nvOS:type=identifier
flow-max-per-group (optional)
Long desc=maximum number of entries:type=uint32 format: int64
flow-tbl-bank (optional)
String desc=vFlow table bank
capability (optional)
String desc=vFlow capability:type=enum
Enum:
none
set-metadata
match-metadata
flow-used (optional)
Long desc=number of vFlows used:type=uint32 format: int64
flow-tbl-slices (optional)
Long desc=total tables for slicing:type=uint32 format: int64
flow-profile (optional)
String desc=flow profile:type=enum
Enum:
application
vxlan
nat
openflow
security
vxlan-encap
ipv4
ipv6
mac
npu-app
qos
ipv6-vcap

vflow-table-show-response - Up

vlag-create - Up

create virtual link aggregation
name
String desc=the VLAG name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
port
Long desc=the local VLAG port:type=uint32:api-ref-path=/vlag-usable-ports:api-ref-model=vlag-usable-port-show:api-ref-id=intf:api-ref-val=name format: int64
peer-port
Long desc=the VLAG peer-port:type=uint32:api-ref-path=/vlag-usable-ports:api-ref-model=vlag-usable-port-show:api-ref-id=intf:api-ref-val=name:api-ref-target=cluster-peer format: int64
mode (optional)
String desc=the VLAG mode as active-active or active-standby:type=enum:default=active-active
Enum:
active-standby
active-active
lacp-mode (optional)
String desc=the LACP mode as off, passive or active:type=enum:default=off
Enum:
off
passive
active
lacp-timeout (optional)
String desc=the LACP timeout as slow or fast:type=enum:default=slow
Enum:
slow
fast
lacp-fallback (optional)
String desc=LACP fallback mode -- individual or bundled:type=enum:default=bundle
Enum:
bundle
individual
lacp-fallback-timeout (optional)
Long desc=LACP fallback timeout -- default is 50 seconds:range=[30,60]:default=50 format: int64
failover-move-L2 (optional)
Boolean desc=failover-move-L2 sends gratuitous APRs or not:default=false
lacp-port-priority (optional)
Long desc=LACP Port Priority:type=uint32:range=[1,65535]:default=32768 format: int64
peer-switch (optional)
Long desc=the VLAG peer-switch:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64

vlag-modify - Up

modify virtual link aggregation
lacp-mode (optional)
String desc=the LACP mode as off, passive or active:type=enum:default=off
Enum:
off
passive
active
lacp-timeout (optional)
String desc=the LACP timeout as slow or fast:type=enum:default=slow
Enum:
slow
fast
lacp-fallback (optional)
String desc=LACP fallback mode -- individual or bundled:type=enum:default=bundle
Enum:
bundle
individual
lacp-fallback-timeout (optional)
Long desc=LACP fallback timeout -- default is 50 seconds:range=[30,60]:default=50 format: int64
failover-move-L2 (optional)
Boolean desc=failover-move-L2 sends gratuitous APRs or not:default=false
lacp-port-priority (optional)
Long desc=LACP Port Priority:type=uint32:range=[1,65535]:default=32768 format: int64

vlag-show - Up

display virtual link aggregation information
api.switch-name (optional)
name
String desc=the VLAG name
mode (optional)
String desc=the VLAG mode as active-active or active-standby:type=enum
Enum:
active-standby
active-active
port (optional)
Long desc=the local VLAG port:type=uint32:api-ref-path=/vlag-usable-ports:api-ref-model=vlag-usable-port-show:api-ref-id=intf:api-ref-val=name format: int64
status (optional)
String desc=the VLAG status:type=enum
Enum:
peer-down
normal
lacp-individual (optional)
String desc=LACP ports operating individully:type=port-list
switch (optional)
Long desc=the local VLAG switch:type=uint32:filter=false:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
local-state (optional)
String desc=the VLAG local-state:type=flag
Enum:
enabled
up
coming-up
peer-state (optional)
String desc=the VLAG peer port state:type=flag
Enum:
enabled
up
coming-up
lacp-key (optional)
Integer desc=lacp-key:type=uint16 format: int32
lacp-system-id (optional)
Long desc=the LACP system-id:type=uint64 format: int64
peer-port (optional)
Long desc=the VLAG peer-port:type=uint32:filter=false:api-ref-path=/vlag-usable-ports:api-ref-model=vlag-usable-port-show:api-ref-id=intf:api-ref-val=name:api-ref-target=cluster-peer format: int64
lacp-mode (optional)
String desc=the LACP mode as off, passive or active:type=enum
Enum:
off
passive
active
lacp-timeout (optional)
String desc=the LACP timeout as slow or fast:type=enum
Enum:
slow
fast
lacp-fallback (optional)
String desc=LACP fallback mode -- individual or bundled:type=enum
Enum:
bundle
individual
lacp-fallback-timeout (optional)
Long desc=LACP fallback timeout -- default is 50 seconds:range=[30,60] format: int64
failover-move-L2 (optional)
Boolean desc=failover-move-L2 sends gratuitous APRs or not
lacp-port-priority (optional)
Long desc=LACP Port Priority:type=uint32:range=[1,65535] format: int64
peer-switch (optional)
Long desc=the VLAG peer-switch:type=uint32:filter=false:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
id (optional)
String desc=the ID assigned to the VLAG:type=identifier
cluster-id (optional)
String desc=the VLAG cluster name:type=identifier:api-ref-path=/clusters:api-ref-model=cluster-show:api-ref-id=id:api-ref-val=name

vlag-show-response - Up

vlag-stats-show - Up

display trunk statistics
api.switch-name (optional)
name
String desc=vlag name
port-speed (optional)
Long desc=port speed:type=uint32:filter=false format: int64
counter (optional)
Integer desc=port counters format: int32
ibytes (optional)
Long desc=incoming bytes:type=uint64 format: int64
ibits (optional)
Long desc=incoming bits:type=uint64 format: int64
iUpkts (optional)
Long desc=incoming unicast packets:type=uint64 format: int64
iBpkts (optional)
Long desc=incoming broadcast packets:type=uint64 format: int64
oBpkts (optional)
Long desc=outgoing broadcast packets:type=uint64 format: int64
oMpkts (optional)
Long desc=outgoing multicast packets:type=uint64 format: int64
oPauseFs (optional)
Long desc=outgoing pause frames:type=uint64 format: int64
oCongDrops (optional)
Long desc=outgoing packets dropped due to congestion:type=uint64 format: int64
odiscards (optional)
Long desc=discarded outgoing packets:type=uint64 format: int64
oerrs (optional)
Long desc=outgoing packets with errors:type=uint64 format: int64
mtu-errs (optional)
Long desc=mtu errors:type=uint64 format: int64
HER-pkts (optional)
Long desc=head end replicated packets:type=uint64 format: int64
iMpkts (optional)
Long desc=incoming multicast packets:type=uint64 format: int64
iPauseFs (optional)
Long desc=incoming pause frames:type=uint64 format: int64
iCongDrops (optional)
Long desc=incoming packets dropped due to congestion:type=uint64 format: int64
idiscards (optional)
Long desc=discarded incoming packets:type=uint64 format: int64
ierrs (optional)
Long desc=incoming packets with errors:type=uint64 format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64 format: int64
obits (optional)
Long desc=outgoing bits:type=uint64 format: int64
oUpkts (optional)
Long desc=outgoing unicast packets:type=uint64 format: int64
HER-bytes (optional)
Long desc=head end replicated bytes:type=uint64 format: int64
HER-bits (optional)
Long desc=head end replicated bits:type=uint64 format: int64
oPkts (optional)
Long desc=T4 out pkts includes HER,Unicast and BUM:type=uint64 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

vlag-stats-show-response - Up

vlan-create - Up

create a VLAN by id
scope
String desc=VLAN scope
Enum:
local
fabric
cluster
id
Integer desc=VLAN ID:type=uint16:range=[0,4095] format: int32
stats (optional)
Boolean desc=VLAN statistics:default=true
description (optional)
String desc=VLAN description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
public-vlan (optional)
Integer desc=Public VLAN for VNET VLAN:type=uint16:range=[0,4095] format: int32
vxlan-mode (optional)
String desc=VXLAN encapsulation mode.:type=enum:default=standard:requires=[vxlan]
Enum:
standard
transparent
ports (optional)
String desc=ports assigned to VLAN:type=port-list
port-desc (optional)
String desc=port assigned to VLAN
untagged-ports (optional)
String desc=untagged-ports assigned to VLAN:type=port-list
untagged-port-desc (optional)
String desc=untagged-port assigned to VLAN
auto-vxlan (optional)
Boolean desc=Automatically assign VXLAN and/or assign to VTEPs
replicators (optional)
String desc=Replicator Group:api-ref-path=/vtep-groups:api-ref-model=vtep-group-show:api-ref-id=name:api-ref-val=name
vxlan (optional)
Long desc=VXLAN identifier for tunnel, value 0 indicates unconfigure vxlan:type=uint32:range=[0,16777215] format: int64
vnet-id (optional)
String desc=VNET for this VLAN:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

vlan-create-1 - Up

create VLANs by range
range
String desc=Range of VLAN IDs:type=vlan-list
scope
String desc=VLAN scope
Enum:
local
fabric
cluster
stats (optional)
Boolean desc=VLAN statistics:default=true
description (optional)
String desc=VLAN description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
public-vlan (optional)
Integer desc=Public VLAN for VNET VLAN:type=uint16:range=[0,4095] format: int32
vxlan-mode (optional)
String desc=VXLAN encapsulation mode.:type=enum:default=standard:requires=[vxlan]
Enum:
standard
transparent
ports (optional)
String desc=ports assigned to VLAN:type=port-list
port-desc (optional)
String desc=port assigned to VLAN
untagged-ports (optional)
String desc=untagged-ports assigned to VLAN:type=port-list
untagged-port-desc (optional)
String desc=untagged-port assigned to VLAN
replicators (optional)
String desc=Replicator Group:api-ref-path=/vtep-groups:api-ref-model=vtep-group-show:api-ref-id=name:api-ref-val=name
vxlan (optional)
Long desc=VXLAN identifier for tunnel, value 0 indicates unconfigure vxlan:type=uint32:range=[0,16777215] format: int64
vnet-id (optional)
String desc=VNET for this VLAN:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

vlan-modify - Up

modify a VLAN
description (optional)
String desc=VLAN description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
public-vlan (optional)
Integer desc=Public VLAN for VNET VLAN:type=uint16:range=[0,4095] format: int32
replicators (optional)
String desc=Replicator Group:api-ref-path=/vtep-groups:api-ref-model=vtep-group-show:api-ref-id=name:api-ref-val=name
vxlan (optional)
Long desc=VXLAN identifier for tunnel, value 0 indicates unconfigure vxlan:type=uint32:range=[0,16777215] format: int64

vlan-port-add - Up

add a port to a VLAN
untagged (optional)
Boolean desc=untagged ports assigned to the VLAN
port-desc (optional)
String desc=port description
ports (optional)
String desc=ports:type=port-list

vlan-port-remove - Up

remove a port from a VLAN
port-desc
String desc=port description
ports
String desc=ports:type=port-list

vlan-port-show - Up

display ports for a VLAN
api.switch-name (optional)
port-desc
String desc=port description
ports
String desc=ports:type=port-list
untagged-ports (optional)
String desc=untagged ports assigned to VLAN:type=port-list
untagged-port-desc (optional)
String desc=untagged port assigned to VLAN

vlan-port-show-response - Up

vlan-show - Up

display VLAN information
api.switch-name (optional)
vnet-id
String desc=VNET for this VLAN:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
id
Integer desc=VLAN ID:type=uint16:range=[0,4095] format: int32
type (optional)
String desc=VLAN type:type=enum
Enum:
public
private
scope (optional)
String desc=VLAN scope
Enum:
local
fabric
cluster
active (optional)
Boolean desc=VLAN active status
stats (optional)
Boolean desc=VLAN statistics
flags (optional)
String desc=flags assigned to VLAN:type=flag
Enum:
fabric
l3-port
l3-vni
topology (optional)
String desc=topology vlan belongs to
description (optional)
String desc=VLAN description
ports-specified (optional)
Boolean desc=specified ports for VLAN
hw-member-ports (optional)
String desc=ports assigned to VLAN in the HW:type=port-list
vxlan-hybrid-mode (optional)
String desc=VXLAN encapsulation mapping to tunnel in hybrid mode:type=enum
Enum:
standard
transparent
hw-vpn (optional)
Integer desc=hardware VPN:type=uint16 format: int32
hw-mcast-group (optional)
Integer desc=hardware multicast group format: int32
repl-vtep (optional)
String desc=Replicator VTEP:type=IPv4 or IPv6 address
vrg-id (optional)
String desc=VRG assigned to VLAN:type=identifier:api-ref-path=/vrgs:api-ref-model=vrg-show:api-ref-id=id:api-ref-val=name
send-ports (optional)
String desc=send-ports assigned to VLAN:type=port-list
active-edge-ports (optional)
String desc=active-edge-ports assigned to VLAN:type=port-list
public-vlan (optional)
Integer desc=Public VLAN for VNET VLAN:type=uint16:range=[0,4095] format: int32
vxlan-mode (optional)
String desc=VXLAN encapsulation mode.:type=enum:requires=[vxlan]
Enum:
standard
transparent
ports (optional)
String desc=ports assigned to VLAN:type=port-list
port-desc (optional)
String desc=port assigned to VLAN
untagged-ports (optional)
String desc=untagged-ports assigned to VLAN:type=port-list
untagged-port-desc (optional)
String desc=untagged-port assigned to VLAN
auto-vxlan (optional)
Boolean desc=Automatically assign VXLAN and/or assign to VTEPs
replicators (optional)
String desc=Replicator Group:api-ref-path=/vtep-groups:api-ref-model=vtep-group-show:api-ref-id=name:api-ref-val=name
vxlan (optional)
Long desc=VXLAN identifier for tunnel, value 0 indicates unconfigure vxlan:type=uint32:range=[0,16777215] format: int64

vlan-show-response - Up

vlan-stats-clear - Up

clear VLAN statistics
vlan
Integer desc=VLAN id:type=uint16:range=[0,4095] format: int32

vlan-stats-settings-modify - Up

modify VLAN statistics collection settings
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

vlan-stats-settings-show - Up

display VLAN statistics settings
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

vlan-stats-settings-show-response - Up

vlan-stats-show - Up

display VLAN statistics
api.switch-name (optional)
vnet
String desc=VNET of the VLAN:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan
Integer desc=VLAN id:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=VXLAN id:type=uint32:range=[0,16777215] format: int64
public-vlan (optional)
Integer desc=public VLAN id:type=uint16:range=[0,4095] format: int32
ibytes (optional)
Long desc=number of incoming bytes for VLAN:type=uint64:filter=false format: int64
ibits (optional)
Long desc=number of incoming bits for VLAN:type=uint64 format: int64
ipkts (optional)
Long desc=number of incoming packets for VLAN:type=uint64:filter=false format: int64
idrops-bytes (optional)
Long desc=number of incoming dropped bytes for VLAN:type=uint64:filter=false format: int64
idrops-pkts (optional)
Long desc=number of incoming dropped packets for VLAN:type=uint64:filter=false format: int64
obytes (optional)
Long desc=number of outgoing bytes for VLAN:type=uint64:filter=false format: int64
obits (optional)
Long desc=number of outgoing bits for VLAN:type=uint64 format: int64
opkts (optional)
Long desc=number of outgoing packets for VLAN:type=uint64:filter=false format: int64
odrops-bytes (optional)
Long desc=number of outgoing dropped bytes for VLAN:type=uint64:filter=false format: int64
odrops-pkts (optional)
Long desc=number of outgoing dropped packets for VLAN:type=uint64:filter=false format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

vlan-stats-show-response - Up

vle-create - Up

create virtual link extension tracking
name
String desc=vle name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
tracking (optional)
Boolean desc=enable/disable tracking between vle ports:default=true
vxlan (optional)
Long desc=VNI to transport this VLE:type=uint32:range=[0,16777215]:requires=[tunnel-name]:precludes=[node-1,node-2,node-1-port,node-2-port,ports-state,node-1-port-desc,node-2-port-desc]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
node-2 (optional)
Long desc=vle node 2:type=uint32:requires=[node-1]:precludes=[tunnel-name,vxlan]:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
node-1-port (optional)
Long desc=node-1 port part of vle:type=uint32:default=4294967295:requires=[node-1,node-2]:precludes=[tunnel-name,vxlan] format: int64
node-2-port (optional)
Long desc=node-2 port part of vle:type=uint32:default=4294967295:requires=[node-1,node-2]:precludes=[tunnel-name,vxlan] format: int64
node-1-port-desc (optional)
String desc=node-1 port part of vle:default=:requires=[node-1,node-2]:precludes=[tunnel-name,vxlan]
node-2-port-desc (optional)
String desc=node-2 port part of vle:default=:requires=[node-1,node-2]:precludes=[tunnel-name,vxlan]
ports-state (optional)
String desc=ports admin control state:type=enum:default=override:precludes=[tunnel-name,vxlan]
Enum:
override
enable
disable
tunnel-name (optional)
String desc=Tunnel name to transport to other VLE EP:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:requires=[vxlan]:precludes=[node-1,node-2,node-1-port,node-2-port,ports-state,node-1-port-desc,node-2-port-desc]:api-ref-path=/tunnels:api-ref-model=tunnel-show:api-ref-id=name:api-ref-val=name
node-1 (optional)
Long desc=vle node 1:type=uint32:requires=[node-2]:precludes=[tunnel-name,vxlan]:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
vnet-id (optional)
String desc=VNET assigned to this vle:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

vle-modify - Up

modify virtual link extension
tracking (optional)
Boolean desc=enable/disable tracking between vle ports:default=true
ports-state (optional)
String desc=ports admin control state:type=enum:default=override:precludes=[tunnel-name,vxlan]
Enum:
override
enable
disable
vnet-id (optional)
String desc=VNET assigned to this vle:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

vle-show - Up

display virtual link extension
api.switch-name (optional)
name
String desc=vle name
status (optional)
String desc=vle status:type=enum
Enum:
unknown
remote-down
local-down
up
down
disabled
tracking (optional)
Boolean desc=enable/disable tracking between vle ports
topology (optional)
String desc=topology the vle belongs to
vxlan (optional)
Long desc=VNI to transport this VLE:type=uint32:range=[0,16777215]:requires=[tunnel-name]:precludes=[node-1,node-2,node-1-port,node-2-port,ports-state,node-1-port-desc,node-2-port-desc]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
node1-name (optional)
String desc=vle node-1 name:requires=[node-1,node-2]
node2-name (optional)
String desc=vle node-2 name:requires=[node-1,node-2]
elapsed-time (optional)
Long desc=time since vle creation format: int64
up-time (optional)
Long desc=time since last time vle was online format: int64
create-time (optional)
String desc=first time when vle status up:date=yyyy-mm-ddThh:mm:ss
node-2 (optional)
Long desc=vle node 2:type=uint32:requires=[node-1]:precludes=[tunnel-name,vxlan]:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
node-1-port (optional)
Long desc=node-1 port part of vle:type=uint32:requires=[node-1,node-2]:precludes=[tunnel-name,vxlan] format: int64
node-2-port (optional)
Long desc=node-2 port part of vle:type=uint32:requires=[node-1,node-2]:precludes=[tunnel-name,vxlan] format: int64
node-1-port-desc (optional)
String desc=node-1 port part of vle:requires=[node-1,node-2]:precludes=[tunnel-name,vxlan]
node-2-port-desc (optional)
String desc=node-2 port part of vle:requires=[node-1,node-2]:precludes=[tunnel-name,vxlan]
ports-state (optional)
String desc=ports admin control state:type=enum:precludes=[tunnel-name,vxlan]
Enum:
override
enable
disable
tunnel-name (optional)
String desc=Tunnel name to transport to other VLE EP:requires=[vxlan]:precludes=[node-1,node-2,node-1-port,node-2-port,ports-state,node-1-port-desc,node-2-port-desc]:api-ref-path=/tunnels:api-ref-model=tunnel-show:api-ref-id=name:api-ref-val=name
node-1 (optional)
Long desc=vle node 1:type=uint32:requires=[node-2]:precludes=[tunnel-name,vxlan]:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
vnet-id (optional)
String desc=VNET assigned to this vle:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
id (optional)
String desc=the ID assigned to the vle:type=identifier

vle-show-response - Up

vle-stats-clear - Up

clear vle statistics
vle-name (optional)
String desc=vle name

vle-stats-show - Up

display vle statistics
api.switch-name (optional)
port
Long desc=vle local port:type=uint32:filter=false format: int64
vle-name
String desc=vle name
counter (optional)
Integer desc=port counters format: int32
ibytes (optional)
Long desc=incoming bytes:type=uint64 format: int64
ibits (optional)
Long desc=incoming bits:type=uint64 format: int64
iUpkts (optional)
Long desc=incoming unicast packets:type=uint64 format: int64
iBpkts (optional)
Long desc=incoming broadcast packets:type=uint64 format: int64
oBpkts (optional)
Long desc=outgoing broadcast packets:type=uint64 format: int64
oMpkts (optional)
Long desc=outgoing multicast packets:type=uint64 format: int64
oPauseFs (optional)
Long desc=outgoing pause frames:type=uint64 format: int64
oCongDrops (optional)
Long desc=outgoing packets dropped due to congestion:type=uint64 format: int64
odiscards (optional)
Long desc=discarded outgoing packets:type=uint64 format: int64
oerrs (optional)
Long desc=outgoing packets with errors:type=uint64 format: int64
mtu-errs (optional)
Long desc=mtu errors:type=uint64 format: int64
HER-pkts (optional)
Long desc=head end replicated packets:type=uint64 format: int64
iMpkts (optional)
Long desc=incoming multicast packets:type=uint64 format: int64
iPauseFs (optional)
Long desc=incoming pause frames:type=uint64 format: int64
iCongDrops (optional)
Long desc=incoming packets dropped due to congestion:type=uint64 format: int64
idiscards (optional)
Long desc=discarded incoming packets:type=uint64 format: int64
ierrs (optional)
Long desc=incoming packets with errors:type=uint64 format: int64
obytes (optional)
Long desc=outgoing bytes:type=uint64 format: int64
obits (optional)
Long desc=outgoing bits:type=uint64 format: int64
oUpkts (optional)
Long desc=outgoing unicast packets:type=uint64 format: int64
HER-bytes (optional)
Long desc=head end replicated bytes:type=uint64 format: int64
HER-bits (optional)
Long desc=head end replicated bits:type=uint64 format: int64
oPkts (optional)
Long desc=T4 out pkts includes HER,Unicast and BUM:type=uint64 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

vle-stats-show-response - Up

vle-transparent-modify - Up

modify fabric VLE error transparent mode
mode
String desc=fabric wide transparent VLE mode enable/disable:type=enum:default=disable
Enum:
enable
disable

vle-transparent-port-add - Up

add local port to transparent VLE mode
port
String desc=port added to/removed from transparent VLE:type=port-list

vle-transparent-port-remove - Up

remove local port from transparent VLE mode
port
String desc=port added to/removed from transparent VLE:type=port-list

vle-transparent-port-show - Up

display local ports removed from transparent VLE mode
api.switch-name (optional)
port
String desc=port added to/removed from transparent VLE:type=port-list

vle-transparent-port-show-response - Up

vle-transparent-show - Up

display fabric VLE error transparent mode
api.switch-name (optional)
mode
String desc=fabric wide transparent VLE mode enable/disable:type=enum
Enum:
enable
disable

vle-transparent-show-response - Up

vnet-cli-alias-add - Up

add a CLI command alias in a VNET
name
String desc=name of the CLI command alias:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
command
String desc=CLI command that is aliased
description (optional)
String desc=description of the CLI command alias

vnet-cli-alias-modify - Up

modify a CLI command alias in a VNET
description (optional)
String desc=description of the CLI command alias
command (optional)
String desc=CLI command that is aliased

vnet-cli-alias-show - Up

show CLI command aliases for a VNET
api.switch-name (optional)
name
String desc=name of the CLI command alias
description (optional)
String desc=description of the CLI command alias
command (optional)
String desc=CLI command that is aliased

vnet-cli-alias-show-response - Up

vnet-create - Up

create a virtual network (VNET)
name
String desc=VNET name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope
String desc=VNET scope - local or fabric
Enum:
local
fabric
cluster
vlans (optional)
String desc=VLANs assigned to public VLAN VNET:type=vlan-list:precludes=[num-vlans]
admin (optional)
Long desc=VNET admin name:type=uint32:api-ref-path=/users:api-ref-model=user-show:api-ref-id=uid:api-ref-val=name format: int64
vrg-id (optional)
String desc=Virtual Resource Group (VRG) assigned to VNET:type=identifier:api-ref-path=/vrgs:api-ref-model=vrg-show:api-ref-id=id:api-ref-val=name
vlan-type (optional)
String desc=type of VLAN for this VNET:type=enum:default=public
Enum:
public
private
num-vlans (optional)
Integer desc=number of global VLANs assigned to VNET:type=uint16:range=[1,4094]:precludes=[vlans] format: int32
num-bridge-domains (optional)
Integer desc=number of Bridge-Domains allowed to create in the private vnet:type=uint16:range=[0,4094]:default=0 format: int32
public-vlans (optional)
String desc=Public VLANs assigned to private VLAN VNET:type=vlan-list
num-private-vlans (optional)
Integer desc=number of private VLANs VNET is allowed to create:type=uint16:range=[1,4094] format: int32
vxlans (optional)
Long desc=VXLAN IDs assigned to VNET:type=uint32:range=[0,16777215]:precludes=[shared-port-vlans] format: int64
vxlan-end (optional)
Long desc=VXLAN IDs assigned to VNET:type=uint32:range=[0,16777215]:requires=[vxlans]:precludes=[shared-port-vlans] format: int64
managed-ports (optional)
String desc=VNET exclusive ports:type=port-list
shared-ports (optional)
String desc=VNET shared ports:type=port-list
shared-port-vlans (optional)
String desc=VNET shared port vlans:type=vlan-list:precludes=[vxlans,vxlan-end]
config-admin (optional)
Boolean desc=VNET admin configured:default=true
create-vnet-mgr (optional)
Boolean desc=create default vnet-manager service:default=true
vnet-mgr-name (optional)
String desc=VNET manager name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
vnet-mgr-storage-pool (optional)
String desc=VNET manager storage pool:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name

vnet-manager-create - Up

create a VNET manager
name
String desc=name of service config:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter
vnet
String desc=vnet assigned to service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[scope]:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
state (optional)
String desc=state of service:type=enum
Enum:
disable
enable
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name

vnet-manager-interface-add - Up

add an interface to a VNET manager
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
exclusive (optional)
Boolean desc=exclusive interface:default=false:precludes=[l3-port]
assignment (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip,netmask]
Enum:
none
dhcp
dhcpv6
sriov-vf (optional)
Boolean desc=sriov vnic:default=false:precludes=[vm-nic-type,mirror-traffic]
mirror-traffic (optional)
Boolean desc=Mirror physical nic traffic to vnic:default=false:precludes=[sriov-vf]
vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[vlan]:precludes=[vnet-id]
Enum:
public
private
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan :default=false
vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
if (optional)
String desc=interface type:type=enum:precludes=[alias-on]
Enum:
mgmt
data
span
span2
span3
alias-on (optional)
String desc=alias name:precludes=[vlan,if,nic]
nic-config (optional)
Boolean desc=NIC config:default=true
vrrp-id (optional)
Long desc=ID assigned to VRRP:type=uint32:range=[0,255]:requires=[vrrp-primary] format: int64
vrrp-primary (optional)
String desc=VRRP primary interface
vrrp-adv-int (optional)
Integer desc=VRRP Advertisement Interval (ms, min 300, max 40950, default 1000):type=uint16:range=[300,40950] format: int32
vrrp-preempt-mode (optional)
String desc=Used to allow/prevent high prio BACKUP from becoming MASTER:type=enum:default=enable
Enum:
disable
enable
secondary-macs (optional)
String desc=secondary MAC addresses:pattern=^[a-fA-F0-9:,]+$|^none$|^$
if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
priority-tag (optional)
Boolean desc=Add priority tag on forwarded traffic:default=false

vnet-manager-interface-modify - Up

modify an interface to a VNET manager
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
exclusive (optional)
Boolean desc=exclusive interface:default=false:precludes=[l3-port]
assignment (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip,netmask]
Enum:
none
dhcp
dhcpv6
sriov-vf (optional)
Boolean desc=sriov vnic:default=false:precludes=[vm-nic-type,mirror-traffic]
mirror-traffic (optional)
Boolean desc=Mirror physical nic traffic to vnic:default=false:precludes=[sriov-vf]
vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[vlan]:precludes=[vnet-id]
Enum:
public
private
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan :default=false
vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
if (optional)
String desc=interface type:type=enum:precludes=[alias-on]
Enum:
mgmt
data
span
span2
span3
alias-on (optional)
String desc=alias name:precludes=[vlan,if,nic]
nic-config (optional)
Boolean desc=NIC config:default=true
vrrp-primary (optional)
String desc=VRRP primary interface
vrrp-adv-int (optional)
Integer desc=VRRP Advertisement Interval (ms, min 300, max 40950, default 1000):type=uint16:range=[300,40950] format: int32
vrrp-preempt-mode (optional)
String desc=Used to allow/prevent high prio BACKUP from becoming MASTER:type=enum:default=enable
Enum:
disable
enable
secondary-macs (optional)
String desc=secondary MAC addresses:pattern=^[a-fA-F0-9:,]+$|^none$|^$
if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
priority-tag (optional)
Boolean desc=Add priority tag on forwarded traffic:default=false

vnet-manager-interface-show - Up

display interfaces for VNET manager
api.switch-name (optional)
nic
String desc=virtual NIC assigned to interface
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
ip2 (optional)
String desc=Second IP address:type=IPv4 or IPv6 address:requires=[netmask2]:precludes=[assignment2]
netmask2 (optional)
Integer desc=Second IP netmask:type=netmask:requires=[ip2]:precludes=[assignment2]:mask-for=[ip2] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
mac (optional)
String desc=interface MAC address:type=mac-address
exclusive (optional)
Boolean desc=exclusive interface:precludes=[l3-port]
vrf (optional)
String desc=name of vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
public-vlan (optional)
Integer desc=interface public VLAN:type=uint16:range=[0,4095] format: int32
nic-state (optional)
String desc=NIC state:type=enum
Enum:
down
up
is-primary (optional)
Boolean desc=Primary VRRP interface
is-primary2 (optional)
Boolean desc=Primary VRRP interface for Second IP
is-vip (optional)
Boolean desc=VIP VRRP interface
pim-vlag-vlan (optional)
Boolean desc=VNIC is on a vlan with a VLAG
vrrp-state (optional)
String desc=state of VRRP:type=enum
Enum:
slave
master
assignment (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip,netmask]
Enum:
none
dhcp
dhcpv6
vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[vlan]:precludes=[vnet-id]
Enum:
public
private
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:precludes=[alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan
vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32
assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip2,netmask2]
Enum:
none
dhcp
dhcpv6
assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[linklocal]
Enum:
none
dhcp
dhcpv6
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32
if (optional)
String desc=interface type:type=enum:precludes=[alias-on]
Enum:
mgmt
data
span
span2
span3
alias-on (optional)
String desc=alias name:precludes=[vlan,if,nic]
nic-config (optional)
Boolean desc=NIC config
vrrp-id (optional)
Long desc=ID assigned to VRRP:type=uint32:range=[0,255]:requires=[vrrp-primary] format: int64
vrrp-primary (optional)
String desc=VRRP primary interface
vrrp-adv-int (optional)
Integer desc=VRRP Advertisement Interval (ms, min 300, max 40950, default 1000):type=uint16:range=[300,40950] format: int32
vrrp-preempt-mode (optional)
String desc=Used to allow/prevent high prio BACKUP from becoming MASTER:type=enum
Enum:
disable
enable
secondary-macs (optional)
String desc=secondary MAC addresses
if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
priority-tag (optional)
Boolean desc=Add priority tag on forwarded traffic

vnet-manager-interface-show-response - Up

vnet-manager-migrate - Up

migrate a VNET manager to another location
name
String desc=name of service config:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name

vnet-manager-modify - Up

modify a VNET manager
state (optional)
String desc=state of service:type=enum
Enum:
disable
enable
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name
gateway (optional)
String desc=gateway IP address for service:type=IPv4 or IPv6 address

vnet-manager-service-modify - Up

modify a VNET manager service
ssh (optional)
Boolean desc=Secure Shell - enable or disable
netconf (optional)
Boolean desc=NETCONF - enable or disable
icmp (optional)
Boolean desc=Internet Message Control Protocol (ICMP) - enable or disable
ntp (optional)
Boolean desc=Network Time Protocol - enable or disable

vnet-manager-service-show - Up

display services for a VNET manager
api.switch-name (optional)
if
String desc=administrative service interface
ssh (optional)
Boolean desc=Secure Shell - enable or disable
netconf (optional)
Boolean desc=NETCONF - enable or disable
icmp (optional)
Boolean desc=Internet Message Control Protocol (ICMP) - enable or disable
ntp (optional)
Boolean desc=Network Time Protocol - enable or disable

vnet-manager-service-show-response - Up

vnet-manager-show - Up

display VNET manager information
api.switch-name (optional)
name
String desc=name of service config
key (optional)
String desc=Vnet manager ssh host key
vnet-service (optional)
Boolean desc=service as dedicated or shared:filter=false
shared-vnet-mgr (optional)
String desc=vnet-manager to share with if shared service:filter=false:api-ref-path=/vnet-managers:api-ref-model=vnet-manager-show:api-ref-id=name:api-ref-val=name
state (optional)
String desc=state of service:type=enum:filter=false
Enum:
disable
enable
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:filter=false:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name
gateway (optional)
String desc=gateway IP address for service:type=IPv4 or IPv6 address:filter=false
is-global (optional)
Boolean desc=service is global
type (optional)
String desc=type of service:type=enum
Enum:
vnet-mgr
vrouter
netzone
orphaned
netvm
nat
ovs
scope (optional)
String desc=scope of service - fabric or local
Enum:
local
fabric
cluster
template (optional)
Boolean desc=template to load:filter=false:precludes=[load-template,scope,vnet]
failover-controller (optional)
Long desc=Switch coordinating the failover:type=uint32:filter=false format: int64
failover-action (optional)
String desc=Current state of the failover:type=enum:filter=false
Enum:
stop-old
start-new
restore-orig
sync
finished
id (optional)
String desc=ID assigned to service:type=identifier
vnet (optional)
String desc=vnet assigned to service:precludes=[scope]:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name

vnet-manager-show-response - Up

vnet-modify - Up

modify a virtual network (VNET)
vlans (optional)
String desc=VLANs assigned to public VLAN VNET:type=vlan-list:precludes=[num-vlans]
num-bridge-domains (optional)
Integer desc=number of Bridge-Domains allowed to create in the private vnet:type=uint16:range=[0,4094]:default=0 format: int32
public-vlans (optional)
String desc=Public VLANs assigned to private VLAN VNET:type=vlan-list
num-private-vlans (optional)
Integer desc=number of private VLANs VNET is allowed to create:type=uint16:range=[1,4094] format: int32
vxlans (optional)
Long desc=VXLAN IDs assigned to VNET:type=uint32:range=[0,16777215]:precludes=[shared-port-vlans] format: int64
vxlan-end (optional)
Long desc=VXLAN IDs assigned to VNET:type=uint32:range=[0,16777215]:requires=[vxlans]:precludes=[shared-port-vlans] format: int64
managed-ports (optional)
String desc=VNET exclusive ports:type=port-list
shared-ports (optional)
String desc=VNET shared ports:type=port-list
shared-port-vlans (optional)
String desc=VNET shared port vlans:type=vlan-list:precludes=[vxlans,vxlan-end]

vnet-port-add - Up

add a port to a VNET
vlans (optional)
String desc=VLANS for ports:type=vlan-list
ports (optional)
String desc=ports:type=port-list

vnet-port-show - Up

display ports for a VNET
api.switch-name (optional)
ports
String desc=ports:type=port-list
vlans (optional)
String desc=VLANS for ports:type=vlan-list

vnet-port-show-response - Up

vnet-public-vlans-modify - Up

modify VLANs reserved for VNETs
vlans (optional)
String desc=Public VLANs reserved for VNETs:type=vlan-list

vnet-public-vlans-show - Up

display VLANs reserved for VNETs
api.switch-name (optional)
vlans (optional)
String desc=Public VLANs reserved for VNETs:type=vlan-list

vnet-public-vlans-show-response - Up

vnet-show - Up

display VNET information
api.switch-name (optional)
name
String desc=VNET name
scope (optional)
String desc=VNET scope - local or fabric
Enum:
local
fabric
cluster
vlans (optional)
String desc=VLANs assigned to public VLAN VNET:type=vlan-list:precludes=[num-vlans]
admin (optional)
Long desc=VNET admin name:type=uint32:api-ref-path=/users:api-ref-model=user-show:api-ref-id=uid:api-ref-val=name format: int64
vrg_created_by_vnet (optional)
Boolean desc=VRG created by VNET
vnet_mgr_id (optional)
String desc=ID assigned to VNET manager:type=identifier:filter=false
vnet_mgr_zone_id (optional)
String desc=zone ID assigned to VNET manager:type=identifier:filter=false
vnet_mgr_location (optional)
Long desc=location assigned to VNET manager:type=uint32:filter=false format: int64
global (optional)
Boolean desc=VNET is global or not
admin_role (optional)
String desc=role assigned to VNET manager:type=identifier:filter=false
switch (optional)
Long desc=switch name where VNET configured:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
vrg-id (optional)
String desc=Virtual Resource Group (VRG) assigned to VNET:type=identifier:api-ref-path=/vrgs:api-ref-model=vrg-show:api-ref-id=id:api-ref-val=name
vlan-type (optional)
String desc=type of VLAN for this VNET:type=enum
Enum:
public
private
num-vlans (optional)
Integer desc=number of global VLANs assigned to VNET:type=uint16:range=[1,4094]:precludes=[vlans] format: int32
num-bridge-domains (optional)
Integer desc=number of Bridge-Domains allowed to create in the private vnet:type=uint16:range=[0,4094] format: int32
public-vlans (optional)
String desc=Public VLANs assigned to private VLAN VNET:type=vlan-list
num-private-vlans (optional)
Integer desc=number of private VLANs VNET is allowed to create:type=uint16:range=[1,4094] format: int32
vxlans (optional)
Long desc=VXLAN IDs assigned to VNET:type=uint32:range=[0,16777215]:precludes=[shared-port-vlans] format: int64
vxlan-end (optional)
Long desc=VXLAN IDs assigned to VNET:type=uint32:range=[0,16777215]:requires=[vxlans]:precludes=[shared-port-vlans] format: int64
managed-ports (optional)
String desc=VNET exclusive ports:type=port-list
shared-ports (optional)
String desc=VNET shared ports:type=port-list
shared-port-vlans (optional)
String desc=VNET shared port vlans:type=vlan-list:precludes=[vxlans,vxlan-end]
config-admin (optional)
Boolean desc=VNET admin configured:filter=false
create-vnet-mgr (optional)
Boolean desc=create default vnet-manager service:filter=false
vnet-mgr-name (optional)
String desc=VNET manager name:filter=false
vnet-mgr-storage-pool (optional)
String desc=VNET manager storage pool:filter=false:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name
id (optional)
String desc=ID assigned to VNET:type=identifier

vnet-show-response - Up

vnet-tunnel-network-add - Up

add a tunnel network to a VNET
network (optional)
String desc=network for tunnel:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=mask for tunnel network:type=netmask:mask-for=[network] format: int32
description (optional)
String desc=description of tunnel network

vnet-tunnel-network-modify - Up

modify a VNET tunnel network
description (optional)
String desc=description of tunnel network

vnet-tunnel-network-show - Up

show VNET tunnel networks
api.switch-name (optional)
network
String desc=network for tunnel:type=IPv4 or IPv6 address
netmask
Integer desc=mask for tunnel network:type=netmask:mask-for=[network] format: int32
description (optional)
String desc=description of tunnel network

vnet-tunnel-network-show-response - Up

vpg-create - Up

create a vpg
name
String desc=Virtual port group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
type
String desc=type:type=enum
Enum:
source
destination
bidirectional
port-desc (optional)
String desc=port assigned to vpg
monitor-ports (optional)
String desc=monitor ports:type=port-list
ports (optional)
String desc=ports assigned to vpg:type=port-list
vnet-id (optional)
String desc=VNET for this vpg:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

vpg-monitor-port-add - Up

add a monitor-port to a Virtual port group
monitor-ports (optional)
String desc=monitor ports:type=port-list

vpg-monitor-port-show - Up

display ports for a Virtual port group
api.switch-name (optional)
monitor-ports
String desc=monitor ports:type=port-list

vpg-monitor-port-show-response - Up

vpg-port-add - Up

add a port to a Virtual port group
port-desc (optional)
String desc=port description
ports (optional)
String desc=ports:type=port-list

vpg-port-show - Up

display ports for a Virtual port group
api.switch-name (optional)
port-desc
String desc=port description
ports
String desc=ports:type=port-list

vpg-port-show-response - Up

vpg-show - Up

display Virtual port group information
api.switch-name (optional)
name
String desc=Virtual port group name
scope (optional)
String desc=fabric
type (optional)
String desc=type:type=enum
Enum:
source
destination
bidirectional
vni (optional)
Long desc=VXLAN identifier for auto BD configuration:type=uint32:range=[0,16777215] format: int64
vlan (optional)
Integer desc=VLAN identifier for auto BD configuration:type=uint16:range=[0,4095] format: int32
port-desc (optional)
String desc=port assigned to vpg
monitor-ports (optional)
String desc=monitor ports:type=port-list
ports (optional)
String desc=ports assigned to vpg:type=port-list
vnet-id (optional)
String desc=VNET for this vpg:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

vpg-show-response - Up

vport-create - Up

create a virtual port to track information across nodes
mac
String desc=MAC address assigned to vPort:type=mac-address
vlan (optional)
Integer desc=VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=VXLAN assigned to vPort:type=uint32:range=[0,16777215] format: int64
vnet (optional)
String desc=VNET assigned to the vPort:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
ip (optional)
String desc=IP address assigned to vPort:type=IPv4 or IPv6 address
owner (optional)
Long desc=owner ID:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
hostname (optional)
String desc=Hypervisor or switch host name:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, and -:precludes=[config]
entity (optional)
String desc=VM or VM Kernel device name:precludes=[config]
power (optional)
String desc=vport entry power status:type=enum:precludes=[config]
Enum:
none
powered-off
powered-on
standby
suspended
unknown
running
waiting
terminated
failed
portgroup (optional)
String desc=Port Group name associated with VM MAC:precludes=[config]
vswitch (optional)
String desc=vswitch name associated with NIC:precludes=[config]
intf (optional)
Long desc=port that owns the vPort:type=uint32 format: int64
public-vlan (optional)
Integer desc=Public VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
num-ips (optional)
Integer desc=Number of IP addresses format: int32
config-intf (optional)
Long desc=interface configured for vPort:type=uint32:precludes=[config] format: int64
svc-name (optional)
String desc=vCenter connection service name:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and ''
cpus (optional)
Long desc=number of CPUs on VM:type=uint32:precludes=[config] format: int64
os (optional)
String desc=Hypervisor or VM guest OS:precludes=[config]
pg-vlans (optional)
String desc=Valid vlans for the Port Group:type=vlan-list
vs-type (optional)
String desc=Virtual Switch type:type=enum:precludes=[config]
Enum:
none
host-vs
distributed-vs
unknown
vnic-type (optional)
String desc=vNic type attached to VM/VM-Kernel:type=flag:precludes=[config]
Enum:
untagged
tagged
trunked
vm-mgmt
vm-kernel
vMotion
vSAN
FTL
rep
p-NFC
r-NFC
mgmt
unknown
rem-switch (optional)
Long desc=vPort remote switch:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
hw-index (optional)
Integer desc=hardware index format: int32
rt-if (optional)
String desc=router interface:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
hw-flags (optional)
String desc=vport hw flags:type=flag
Enum:
invalid-vlan
invalid-port
inner-vlan (optional)
Integer desc=Q-in-Q inner VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
bd (optional)
String desc=Bridge Domain assigned to vPort:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

vport-history-show - Up

display historical information about virtual ports
api.switch-name (optional)
mac
String desc=MAC address assigned to vPort:type=mac-address
vnet
String desc=VNET assigned to the vPort:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
bd
String desc=Bridge Domain assigned to vPort:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
vxlan
Long desc=VXLAN assigned to vPort:type=uint32:range=[0,16777215] format: int64
ip
String desc=IP address assigned to vPort:type=IPv4 or IPv6 address
vlan
Integer desc=VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
caller (optional)
String desc=feature that made the change for this entry:type=flag
Enum:
init
config
status
switch-cb
cluster
gre
ARP
router
flow-cb
vdp
vlag
port
inject
evict
vxlan
stats
vnm-vnic
adjacency
stp
trunk
intsw
ttl1
flood
flush
retire
loop
dhcp
fabric
table
l3-age-out
vlan
l2-checker
igmp
l2-age-out
port-mirror
mac-move
cluster-status
cluster-status-delete
vxlan-routing
subnet
br-dom
vrf
ND
VSG
excess-move-protection
retire-tunnel-up
evpnsnoop-browse
reason (optional)
String desc=reason for history entry:type=flag
Enum:
activate
deactivate
port-move
ip-move
ip-remove
batch-move
retire
break-loop
break-loop-timeout
create
modify
delete
policy
owner-status
remove-node
port-flags
check-owner
trunk-port-add
trunk-port-remove
move-router-if
age-out
hw-remove
restart
undo
flush
update-vxlan-vlan
needs-peer-status
owner-lost
owner-change
update-peer-only
user-delete
done
vm-metadata
excess-move-state-change
evpn-mac-move
changes (optional)
String desc=what changed in this entry:type=uint64
log-type (optional)
String desc=log-type for vPort history:type=enum
Enum:
l2-save
l3-save
restart
l2-modify
l2-delete
l3-modify
l3-delete
owner (optional)
Long desc=owner ID:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
inner-vlan (optional)
Integer desc=Q-in-Q inner VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
public-vlan (optional)
Integer desc=Public VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
num-ips (optional)
Integer desc=Number of IP addresses format: int32
config-intf (optional)
Long desc=interface configured for vPort:type=uint32:precludes=[config] format: int64
intf (optional)
Long desc=port that owns the vPort:type=uint32 format: int64
ports (optional)
String desc=ports assigned to vPort:type=port-list
state (optional)
String desc=vPort state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
local-intf (optional)
Long desc=vPort local interface:type=uint32:filter=false format: int64
local-ports (optional)
String desc=vPort local ports:type=port-list:filter=false
local-state (optional)
String desc=vPort local state:type=flag:filter=false
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
alt-owner (optional)
Long desc=Alternate cluster vPort owner:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
alt-owner-port (optional)
Long desc=Alternate cluster vPort port:type=uint32:filter=false format: int64
last-caller (optional)
String desc=most recent caller for this entry:type=flag
Enum:
init
config
status
switch-cb
cluster
gre
ARP
router
flow-cb
vdp
vlag
port
inject
evict
vxlan
stats
vnm-vnic
adjacency
stp
trunk
intsw
ttl1
flood
flush
retire
loop
dhcp
fabric
table
l3-age-out
vlan
l2-checker
igmp
l2-age-out
port-mirror
mac-move
cluster-status
cluster-status-delete
vxlan-routing
subnet
br-dom
vrf
ND
VSG
excess-move-protection
retire-tunnel-up
evpnsnoop-browse
last-reason (optional)
String desc=most recent reason for this entry:type=flag
Enum:
activate
deactivate
port-move
ip-move
ip-remove
batch-move
retire
break-loop
break-loop-timeout
create
modify
delete
policy
owner-status
remove-node
port-flags
check-owner
trunk-port-add
trunk-port-remove
move-router-if
age-out
hw-remove
restart
undo
flush
update-vxlan-vlan
needs-peer-status
owner-lost
owner-change
update-peer-only
user-delete
done
vm-metadata
excess-move-state-change
evpn-mac-move
alt-owner-ports (optional)
String desc=Alternate cluster vPort owner ports:type=port-list:filter=false
alt-owner-state (optional)
String desc=Alternate cluster vPort owner state:type=flag:filter=false
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
svc-name (optional)
String desc=vCenter connection service name
hostname (optional)
String desc=Hypervisor or switch host name:precludes=[config]
entity (optional)
String desc=VM or VM Kernel device name:precludes=[config]
power (optional)
String desc=vport entry power status:type=enum:precludes=[config]
Enum:
none
powered-off
powered-on
standby
suspended
unknown
running
waiting
terminated
failed
cpus (optional)
Long desc=number of CPUs on VM:type=uint32:precludes=[config] format: int64
os (optional)
String desc=Hypervisor or VM guest OS:precludes=[config]
portgroup (optional)
String desc=Port Group name associated with VM MAC:precludes=[config]
pg-vlans (optional)
String desc=Valid vlans for the Port Group:type=vlan-list
vswitch (optional)
String desc=vswitch name associated with NIC:precludes=[config]
vs-type (optional)
String desc=Virtual Switch type:type=enum:precludes=[config]
Enum:
none
host-vs
distributed-vs
unknown
vnic-type (optional)
String desc=vNic type attached to VM/VM-Kernel:type=flag:precludes=[config]
Enum:
untagged
tagged
trunked
vm-mgmt
vm-kernel
vMotion
vSAN
FTL
rep
p-NFC
r-NFC
mgmt
unknown
config (optional)
String desc=VM config:type=flag:precludes=[owner,local-intf,hostname,entity,cpus,portgroup,vswitch]
Enum:
none
owner
ip
port
hostname
entity
cpus
os
rem-switch (optional)
Long desc=vPort remote switch:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
rem-intf (optional)
Long desc=vPort remote interface:type=uint32 format: int64
rem-ports (optional)
String desc=vPort remote ports:type=port-list
peer-intf (optional)
Long desc=vPort peer interface:type=uint32 format: int64
peer-state (optional)
String desc=vPort peer state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
peer-owner-state (optional)
String desc=vPort peer owner state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
status (optional)
String desc=vPort status:type=flag
Enum:
phy-up
up
disabled
hw-nat-loop
mirror-loop
mirror-to
PN-switch
PN-fabric
PN-other
PN-cluster
PN-internal
host
uplink
STP-BPDUs
LLDP
trunk
l3-port
remote-l3-port
dhcp
dhcpsvr
blocked
no-BPDU
LACP-PDUs
vlag-active
vlag-blocked
stp-edge-port
LACP-wait
LACP-fallback
adjacency-wait
adjacency-check
vlag-wait
multicast-router
host-disabled
loop
congested
vxlan-loopback
vlan-up
vle
vbt-wait
phy-down
down
enabled
err-disabled
err-bpdu-guard
mac-violation
stp-bpdu-guard
stp-root-guard
defer-bringup-wait
rx-bw-threshold-exceeded
tx-bw-threshold-exceeded
vtep-ip (optional)
String desc=Remote VTEP IP address:type=IPv4 or IPv6 address
tunnel (optional)
String desc=vPort tunnel
create-time (optional)
String desc=vPort create-time:date=yyyy-mm-ddThh:mm:ss
last-seen (optional)
String desc=vPort last-seen:date=yyyy-mm-ddThh:mm:ss
last-seen-since (optional)
String desc=vPort last-seen since a specified time:date=yyyy-mm-ddThh:mm:ss
vxlan-lru (optional)
String desc=vPort VXLAN lru:date=yyyy-mm-ddThh:mm:ss
hit (optional)
Long desc=number of hits:type=uint32 format: int64
migrate (optional)
Long desc=number of times entry migrated:type=uint32 format: int64
drops (optional)
Long desc=number of dropped packets:type=uint32 format: int64
hw-index (optional)
Integer desc=hardware index format: int32
rt-if (optional)
String desc=router interface
hw-flags (optional)
String desc=vport hw flags:type=flag
Enum:
invalid-vlan
invalid-port
mc-index (optional)
Long desc=L2 multicast group index in hw:type=uint32 format: int64
count (optional)
Long desc=count for vPort history:type=uint32 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

vport-history-show-response - Up

vport-modify - Up

modify a vPort
owner (optional)
Long desc=owner ID:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
hostname (optional)
String desc=Hypervisor or switch host name:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, and -:precludes=[config]
entity (optional)
String desc=VM or VM Kernel device name:precludes=[config]
power (optional)
String desc=vport entry power status:type=enum:precludes=[config]
Enum:
none
powered-off
powered-on
standby
suspended
unknown
running
waiting
terminated
failed
portgroup (optional)
String desc=Port Group name associated with VM MAC:precludes=[config]
vswitch (optional)
String desc=vswitch name associated with NIC:precludes=[config]
config (optional)
String desc=VM config:type=flag:precludes=[owner,local-intf,hostname,entity,cpus,portgroup,vswitch]
Enum:
none
owner
ip
port
hostname
entity
cpus
os
intf (optional)
Long desc=port that owns the vPort:type=uint32 format: int64
public-vlan (optional)
Integer desc=Public VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
num-ips (optional)
Integer desc=Number of IP addresses format: int32
config-intf (optional)
Long desc=interface configured for vPort:type=uint32:precludes=[config] format: int64
svc-name (optional)
String desc=vCenter connection service name:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and ''
cpus (optional)
Long desc=number of CPUs on VM:type=uint32:precludes=[config] format: int64
os (optional)
String desc=Hypervisor or VM guest OS:precludes=[config]
pg-vlans (optional)
String desc=Valid vlans for the Port Group:type=vlan-list
vs-type (optional)
String desc=Virtual Switch type:type=enum:precludes=[config]
Enum:
none
host-vs
distributed-vs
unknown
vnic-type (optional)
String desc=vNic type attached to VM/VM-Kernel:type=flag:precludes=[config]
Enum:
untagged
tagged
trunked
vm-mgmt
vm-kernel
vMotion
vSAN
FTL
rep
p-NFC
r-NFC
mgmt
unknown
rem-switch (optional)
Long desc=vPort remote switch:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
hw-index (optional)
Integer desc=hardware index format: int32
rt-if (optional)
String desc=router interface:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
hw-flags (optional)
String desc=vport hw flags:type=flag
Enum:
invalid-vlan
invalid-port
inner-vlan (optional)
Integer desc=Q-in-Q inner VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32

vport-settings-modify - Up

modify vPort settings
vport-disk-space (optional)
Long desc=disk-space allocated to vPorts:type=uint64:default=524288000 format: int64
stats-max-memory (optional)
Long desc=maximum memory allowed for statistics:type=uint64:default=52428800 format: int64
stats-log-enable (optional)
Boolean desc=enable or disable statistics:default=false
stats-log-interval (optional)
Long desc=interval to collect statistics format: int64
stats-log-disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64
system-stats-max-memory (optional)
Long desc=maximum memory for system statistics:type=uint64:default=52428800 format: int64
system-stats-log-enable (optional)
Boolean desc=enable or disable statistics:default=false
system-stats-log-interval (optional)
Long desc=interval to collect statistics format: int64
system-stats-log-disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64
loop-prevent (optional)
Boolean desc=loop prevent:default=true
retry-interval (optional)
Integer desc=number of seconds before next update for entries with error:type=uint16:range=[15,3600]:default=60 format: int32
excess-mac-move-protect-enable (optional)
Boolean desc=enable or disable excess move protection:default=false
excess-mac-move-queue-protect (optional)
Boolean desc=enable or disable queue protection:default=false
excess-ip-move-protect-enable (optional)
Boolean desc=enable or disable excess move protection:default=false
excess-ip-move-queue-protect (optional)
Boolean desc=enable or disable queue protection:default=false

vport-settings-show - Up

display vPort settings
api.switch-name (optional)
excess-mac-move-queue-state (optional)
Boolean desc=cos queue protection state
excess-ip-move-queue-state (optional)
Boolean desc=cos queue protection state
vport-disk-space (optional)
Long desc=disk-space allocated to vPorts:type=uint64 format: int64
stats-max-memory (optional)
Long desc=maximum memory allowed for statistics:type=uint64 format: int64
stats-log-enable (optional)
Boolean desc=enable or disable statistics
stats-log-interval (optional)
Long desc=interval to collect statistics format: int64
stats-log-disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64
system-stats-max-memory (optional)
Long desc=maximum memory for system statistics:type=uint64 format: int64
system-stats-log-enable (optional)
Boolean desc=enable or disable statistics
system-stats-log-interval (optional)
Long desc=interval to collect statistics format: int64
system-stats-log-disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64
loop-prevent (optional)
Boolean desc=loop prevent
retry-interval (optional)
Integer desc=number of seconds before next update for entries with error:type=uint16:range=[15,3600] format: int32
excess-mac-move-protect-enable (optional)
Boolean desc=enable or disable excess move protection
excess-mac-move-queue-protect (optional)
Boolean desc=enable or disable queue protection
excess-ip-move-protect-enable (optional)
Boolean desc=enable or disable excess move protection
excess-ip-move-queue-protect (optional)
Boolean desc=enable or disable queue protection

vport-settings-show-response - Up

vport-show - Up

display vPort information
api.switch-name (optional)
mac
String desc=MAC address assigned to vPort:type=mac-address
vnet
String desc=VNET assigned to the vPort:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan
Integer desc=VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
vxlan
Long desc=VXLAN assigned to vPort:type=uint32:range=[0,16777215] format: int64
ip
String desc=IP address assigned to vPort:type=IPv4 or IPv6 address
bd
String desc=Bridge Domain assigned to vPort:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
owner (optional)
Long desc=owner ID:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
hostname (optional)
String desc=Hypervisor or switch host name:precludes=[config]
entity (optional)
String desc=VM or VM Kernel device name:precludes=[config]
power (optional)
String desc=vport entry power status:type=enum:precludes=[config]
Enum:
none
powered-off
powered-on
standby
suspended
unknown
running
waiting
terminated
failed
portgroup (optional)
String desc=Port Group name associated with VM MAC:precludes=[config]
vswitch (optional)
String desc=vswitch name associated with NIC:precludes=[config]
config (optional)
String desc=VM config:type=flag:precludes=[owner,local-intf,hostname,entity,cpus,portgroup,vswitch]
Enum:
none
owner
ip
port
hostname
entity
cpus
os
tunnel (optional)
String desc=vPort tunnel
peer-intf (optional)
Long desc=vPort peer interface:type=uint32 format: int64
local-intf (optional)
Long desc=vPort local interface:type=uint32:filter=false format: int64
local-ports (optional)
String desc=vPort local ports:type=port-list:filter=false
local-state (optional)
String desc=vPort local state:type=flag:filter=false
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
alt-owner (optional)
Long desc=Alternate cluster vPort owner:type=uint32:filter=false:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
alt-owner-port (optional)
Long desc=Alternate cluster vPort port:type=uint32:filter=false format: int64
alt-owner-ports (optional)
String desc=Alternate cluster vPort owner ports:type=port-list:filter=false
alt-owner-state (optional)
String desc=Alternate cluster vPort owner state:type=flag:filter=false
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
rem-intf (optional)
Long desc=vPort remote interface:type=uint32 format: int64
rem-ports (optional)
String desc=vPort remote ports:type=port-list
peer-state (optional)
String desc=vPort peer state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
peer-owner-state (optional)
String desc=vPort peer owner state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
status (optional)
String desc=vPort status:type=flag
Enum:
phy-up
up
disabled
hw-nat-loop
mirror-loop
mirror-to
PN-switch
PN-fabric
PN-other
PN-cluster
PN-internal
host
uplink
STP-BPDUs
LLDP
trunk
l3-port
remote-l3-port
dhcp
dhcpsvr
blocked
no-BPDU
LACP-PDUs
vlag-active
vlag-blocked
stp-edge-port
LACP-wait
LACP-fallback
adjacency-wait
adjacency-check
vlag-wait
multicast-router
host-disabled
loop
congested
vxlan-loopback
vlan-up
vle
vbt-wait
phy-down
down
enabled
err-disabled
err-bpdu-guard
mac-violation
stp-bpdu-guard
stp-root-guard
defer-bringup-wait
rx-bw-threshold-exceeded
tx-bw-threshold-exceeded
vtep-ip (optional)
String desc=Remote VTEP IP address:type=IPv4 or IPv6 address
create-time (optional)
String desc=vPort create-time:date=yyyy-mm-ddThh:mm:ss
last-seen (optional)
String desc=vPort last-seen:date=yyyy-mm-ddThh:mm:ss
last-seen-since (optional)
String desc=vPort last-seen since a specified time:date=yyyy-mm-ddThh:mm:ss
vxlan-lru (optional)
String desc=vPort VXLAN lru:date=yyyy-mm-ddThh:mm:ss
hit (optional)
Long desc=number of hits:type=uint32 format: int64
migrate (optional)
Long desc=number of times entry migrated:type=uint32 format: int64
drops (optional)
Long desc=number of dropped packets:type=uint32 format: int64
mc-index (optional)
Long desc=L2 multicast group index in hw:type=uint32 format: int64
ports (optional)
String desc=ports assigned to vPort:type=port-list
state (optional)
String desc=vPort state:type=flag
Enum:
active
aged-out-port-down
static
vrrp
tunnel
software
needs-peer-status
port-mac
hit
ageout-check
moving
loop-probe
local-tunnel
igmp-mac
user-flush
vxlan-loopback
router
update-peer-only
active-state-mismatch
peer-port-missing
peer-port-not-vlag
peer-port-not-orphaned
peer-port-not-cluster-link
sw-active
anycast
hsrp
invalid-vlan
owner-lost
cluster-link-down
vxlan-router
peer-force-resync
excess-mac-move-detected
excess-ip-move-detected
retry
evpn
evpn-wo-bgp
evpn-def-gw
evpn-delete
evpn-mac-move
T4-l2-l3
intf (optional)
Long desc=port that owns the vPort:type=uint32 format: int64
public-vlan (optional)
Integer desc=Public VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32
num-ips (optional)
Integer desc=Number of IP addresses format: int32
config-intf (optional)
Long desc=interface configured for vPort:type=uint32:precludes=[config] format: int64
svc-name (optional)
String desc=vCenter connection service name
cpus (optional)
Long desc=number of CPUs on VM:type=uint32:precludes=[config] format: int64
os (optional)
String desc=Hypervisor or VM guest OS:precludes=[config]
pg-vlans (optional)
String desc=Valid vlans for the Port Group:type=vlan-list
vs-type (optional)
String desc=Virtual Switch type:type=enum:precludes=[config]
Enum:
none
host-vs
distributed-vs
unknown
vnic-type (optional)
String desc=vNic type attached to VM/VM-Kernel:type=flag:precludes=[config]
Enum:
untagged
tagged
trunked
vm-mgmt
vm-kernel
vMotion
vSAN
FTL
rep
p-NFC
r-NFC
mgmt
unknown
rem-switch (optional)
Long desc=vPort remote switch:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
hw-index (optional)
Integer desc=hardware index format: int32
rt-if (optional)
String desc=router interface
hw-flags (optional)
String desc=vport hw flags:type=flag
Enum:
invalid-vlan
invalid-port
inner-vlan (optional)
Integer desc=Q-in-Q inner VLAN assigned to vPort:type=uint16:range=[0,4095] format: int32

vport-show-response - Up

vport-stats-report - Up

generate a vPort statistics report
ibytes
Long desc=number of incoming bytes:type=uint64 format: int64
ipkts
Long desc=number of incoming packets:type=uint64 format: int64
idiscards
Long desc=number of incoming packets discarded:type=uint64 format: int64
ierrs
Long desc=number of incoming packets with errors:type=uint64 format: int64
obytes
Long desc=number of outgoing bytes:type=uint64 format: int64
opkts
Long desc=number of outgoing packets:type=uint64 format: int64
odiscards
Long desc=number of outgoing packets discarded:type=uint64 format: int64
oerrs
Long desc=number of outgoing packets with errors:type=uint64 format: int64
ip (optional)
String desc=IP address statistics:type=IPv4 or IPv6 address
mac (optional)
String desc=MAC address assigned to vPort:type=mac-address
vlan (optional)
Integer desc=VLAN statistics:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=VXLAN statistics:type=uint32:range=[0,16777215] format: int64
entity (optional)
String desc=VM or VM Kernel device name
vs-type (optional)
String desc=Virtual Switch type:type=enum
Enum:
none
host-vs
distributed-vs
unknown
vnic-type (optional)
String desc=vNic attached to VM traffic type:type=flag
Enum:
untagged
tagged
trunked
vm-mgmt
vm-kernel
vMotion
vSAN
FTL
rep
p-NFC
r-NFC
mgmt
unknown

vport-stats-show - Up

display vPort statistics
api.switch-name (optional)
ip
String desc=IP address statistics:type=IPv4 or IPv6 address
mac
String desc=MAC address assigned to vPort:type=mac-address
vnet
String desc=VNET statistics:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan
Integer desc=VLAN statistics:type=uint16:range=[0,4095] format: int32
vxlan
Long desc=VXLAN statistics:type=uint32:range=[0,16777215] format: int64
bd
String desc=Bridge Domain connections:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
hostname (optional)
String desc=hostname statistics
entity (optional)
String desc=VM or VM Kernel device name
ibytes (optional)
Long desc=number of incoming bytes:type=uint64 format: int64
ipkts (optional)
Long desc=number of incoming packets:type=uint64 format: int64
idiscards (optional)
Long desc=number of incoming packets discarded:type=uint64 format: int64
ierrs (optional)
Long desc=number of incoming packets with errors:type=uint64 format: int64
obytes (optional)
Long desc=number of outgoing bytes:type=uint64 format: int64
opkts (optional)
Long desc=number of outgoing packets:type=uint64 format: int64
odiscards (optional)
Long desc=number of outgoing packets discarded:type=uint64 format: int64
oerrs (optional)
Long desc=number of outgoing packets with errors:type=uint64 format: int64
count (optional)
Long desc=count:type=uint32 format: int64
switch-id (optional)
Long desc=switch ID for collecting vPort statistics:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
vs-type (optional)
String desc=Virtual Switch type:type=enum
Enum:
none
host-vs
distributed-vs
unknown
vnic-type (optional)
String desc=vNic attached to VM traffic type:type=flag
Enum:
untagged
tagged
trunked
vm-mgmt
vm-kernel
vMotion
vSAN
FTL
rep
p-NFC
r-NFC
mgmt
unknown
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

vport-stats-show-response - Up

vport-system-stats-report - Up

generate a virtual port system statistics report
ip
String desc=IP address statistics:type=IPv4 or IPv6 address
vlan
Integer desc=VLAN Statistics:type=uint16:range=[0,4095] format: int32
uptime
Long desc=length of time system is up format: int64
used-mem
Long desc=memory used by system statistic:type=uint64 format: int64
used-mem-val
Long desc=amount of memory used:type=uint64 format: int64
used-swap
Long desc=used swap:type=uint64 format: int64
used-swap-val
Long desc=amount of used-swap:type=uint64 format: int64
paging
Long desc=swap scan rate:type=uint64 format: int64
cpu-user
Long desc=cpu-user:type=uint64 format: int64
cpu-sys
Long desc=system CPU:type=uint64 format: int64
cpu-idle
Long desc=CPU idle time:type=uint64 format: int64
vxlan (optional)
Long desc=VXLAN Statistics:type=uint32:range=[0,16777215] format: int64

vport-system-stats-show - Up

display virtual port system statistics
api.switch-name (optional)
ip
String desc=IP address statistics:type=IPv4 or IPv6 address
vnet
String desc=VNET statistics:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vlan
Integer desc=VLAN Statistics:type=uint16:range=[0,4095] format: int32
vxlan
Long desc=VXLAN Statistics:type=uint32:range=[0,16777215] format: int64
bd
String desc=Bridge Domain Statistics:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
hostname (optional)
String desc=hostname statistics
cpu-total (optional)
Long desc=total CPU:type=uint64:filter=false format: int64
count (optional)
Long desc=count:type=uint32 format: int64
uptime (optional)
Long desc=length of time system is up format: int64
used-mem (optional)
Long desc=memory used by system statistic:type=uint64:filter=false format: int64
used-mem-val (optional)
Long desc=amount of memory used:type=uint64:filter=false format: int64
used-swap (optional)
Long desc=used swap:type=uint64:filter=false format: int64
used-swap-val (optional)
Long desc=amount of used-swap:type=uint64:filter=false format: int64
paging (optional)
Long desc=swap scan rate:type=uint64 format: int64
cpu-user (optional)
Long desc=cpu-user:type=uint64:filter=false format: int64
cpu-sys (optional)
Long desc=system CPU:type=uint64:filter=false format: int64
cpu-idle (optional)
Long desc=CPU idle time:type=uint64:filter=false format: int64
switch-id (optional)
Long desc=switch-id time for collecting vPort statistics:type=uint32:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=id:api-ref-val=name format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

vport-system-stats-show-response - Up

vrf-create - Up

create vrf
name
String desc=vrf name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
scope (optional)
String desc=scope of the vrf:default=fabric
Enum:
local
fabric
cluster
enable (optional)
Boolean desc=enable/disable vrf routing:default=true
description (optional)
String desc=VRF description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
vrf-gw (optional)
String desc=gateway IP address:type=IPv4 or IPv6 address
vrf-gw2 (optional)
String desc=gateway IP address 2:type=IPv4 or IPv6 address
vrf-gw-ip6 (optional)
String desc=IPv6 gateway address:type=IPv4 or IPv6 address
vrf-gw2-ip6 (optional)
String desc=IPv6 gateway address 2:type=IPv4 or IPv6 address
l3-vni (optional)
Long desc=L3 VNID:type=uint32:range=[0,16777215] format: int64
anycast-mac-for-forwarding (optional)
Boolean desc=enable to use anycast mac for forwarding:default=false
vnet-id (optional)
String desc=VNET for the VRF:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

vrf-modify - Up

modify vrf
enable (optional)
Boolean desc=enable/disable vrf routing:default=true
description (optional)
String desc=VRF description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
vrf-gw (optional)
String desc=gateway IP address:type=IPv4 or IPv6 address
vrf-gw2 (optional)
String desc=gateway IP address 2:type=IPv4 or IPv6 address
vrf-gw-ip6 (optional)
String desc=IPv6 gateway address:type=IPv4 or IPv6 address
vrf-gw2-ip6 (optional)
String desc=IPv6 gateway address 2:type=IPv4 or IPv6 address
l3-vni (optional)
Long desc=L3 VNID:type=uint32:range=[0,16777215] format: int64
anycast-mac-for-forwarding (optional)
Boolean desc=enable to use anycast mac for forwarding:default=false

vrf-mroute-show - Up

display distrubuted multicast routes in forwarding information database
api.switch-name (optional)
srcip (optional)
String desc=source IP address:type=IPv4 or IPv6 address
vxlan (optional)
Long desc=VXLAN ID:type=uint32:range=[0,16777215]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
vlan (optional)
Integer desc=VLAN ID:type=uint16:range=[0,4095] format: int32
vrid (optional)
Integer desc=virtual router ID format: int32
flags (optional)
String desc=hardware flags:type=flag
Enum:
Trunk
Active
type (optional)
String desc=hardware router type:type=enum
Enum:
<*
G>
<*
G
V>
G>
G
V>
srcip-mask (optional)
Integer desc=source netmask:type=uint8 format: int32
group-mask (optional)
Integer desc=group net mask:type=uint8 format: int32
hw-group-id (optional)
String desc=group ID:type=uint32:hex=0x[0-9a-fA-F]{8}
vnet-id (optional)
String desc=VNET of the sending VLAN:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
send-vlan (optional)
Integer desc=sending VLAN:type=uint16:range=[0,4095] format: int32
send-bd (optional)
String desc=sending Bridge Domain
encap-id (optional)
Integer desc=encapsulation ID format: int32
group (optional)
String desc=group IP address:type=IPv4 or IPv6 address
ports (optional)
String desc=ports:type=port-list
bd (optional)
String desc=Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

vrf-multicast-flood-modify - Up

modify flooding over tunnels in Distributed Multicast Forwarding
scope (optional)
String desc=scope - fabric or local:type=enum
Enum:
local
fabric
enable (optional)
Boolean desc=enable or disable flooding over tunnels in Distrubuted Multicast Forwarding:default=false

vrf-multicast-flood-show - Up

display info about flooding over tunnels in Dist. Mcast Forwarding
api.switch-name (optional)
scope (optional)
String desc=scope - fabric or local:type=enum:filter=false
Enum:
local
fabric
enable (optional)
Boolean desc=enable or disable flooding over tunnels in Distrubuted Multicast Forwarding

vrf-multicast-igmp-modify - Up

modify IGMP's use of IPMC table in DMF Forwarding
scope (optional)
String desc=scope - fabric or local:type=enum
Enum:
local
fabric
use-table (optional)
Boolean desc=enable/disable IGMP's use of the IPMC Table in DMF Forwarding:default=false

vrf-multicast-igmp-show - Up

display info about IGMP's use of IPMC table in DMF Forwarding
api.switch-name (optional)
scope (optional)
String desc=scope - fabric or local:type=enum:filter=false
Enum:
local
fabric
use-table (optional)
Boolean desc=enable/disable IGMP's use of the IPMC Table in DMF Forwarding

vrf-multicast-modify - Up

modify Distributed Multicast Forwarding
scope (optional)
String desc=Distributed Multicast Forwarding scope - fabric or local:type=enum
Enum:
local
fabric
enable (optional)
Boolean desc=enable or disable Distrubuted Multicast Forwarding:default=false

vrf-multicast-show - Up

display information about Distributed Multicast Forwarding
api.switch-name (optional)
scope (optional)
String desc=Distributed Multicast Forwarding scope - fabric or local:type=enum:filter=false
Enum:
local
fabric
enable (optional)
Boolean desc=enable or disable Distrubuted Multicast Forwarding

vrf-route-add - Up

add vrf route
network
String desc=IP address:type=IPv4 or IPv6 address
netmask
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
router-mac (optional)
String desc=router mac address:type=mac-address
gateway-ip (optional)
String desc=gateway IP address:type=IPv4 or IPv6 address

vrf-route-remove - Up

remove vrf route
network
String desc=IP address:type=IPv4 or IPv6 address
netmask
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
gateway-ip
String desc=gateway IP address:type=IPv4 or IPv6 address

vrf-route-show - Up

display vrf routes
api.switch-name (optional)
network
String desc=IP address:type=IPv4 or IPv6 address
netmask
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
gateway-ip
String desc=gateway IP address:type=IPv4 or IPv6 address
scope (optional)
String desc=scope - local, cluster or fabric
active (optional)
Boolean desc=installed in rib or not
router-mac (optional)
String desc=router mac address:type=mac-address

vrf-show - Up

display vrf
api.switch-name (optional)
name
String desc=vrf name
vnet-id
String desc=VNET for the VRF:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
scope (optional)
String desc=scope of the vrf
Enum:
local
fabric
cluster
active (optional)
Boolean desc=active on switch
flags (optional)
String desc=vrf used by vrouter or subnet:type=flag
Enum:
subnet
vrouter
enable (optional)
Boolean desc=enable/disable vrf routing
vnet_name (optional)
String desc=VNET name for the VRF
anycast-mac (optional)
String desc=anycast mac address:type=mac-address
hw-router-mac (optional)
String desc=hardware router MAC address:type=mac-address
hw-vrid (optional)
Integer desc=hw_vrid associated with VRF:range=[0,15] format: int32
description (optional)
String desc=VRF description
vrf-gw (optional)
String desc=gateway IP address:type=IPv4 or IPv6 address
vrf-gw2 (optional)
String desc=gateway IP address 2:type=IPv4 or IPv6 address
vrf-gw-ip6 (optional)
String desc=IPv6 gateway address:type=IPv4 or IPv6 address
vrf-gw2-ip6 (optional)
String desc=IPv6 gateway address 2:type=IPv4 or IPv6 address
l3-vni (optional)
Long desc=L3 VNID:type=uint32:range=[0,16777215] format: int64
anycast-mac-for-forwarding (optional)
Boolean desc=enable to use anycast mac for forwarding

vrouter-bfd-flapcount-clear - Up

clear BFD neighbor flap count
vrf
String desc=name of vrf:default=default:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
all (optional)
Boolean desc=All Neighbors

vrouter-bfd-neighbor-flapcount-clear - Up

clear BFD neighbor flap count
neighbor
String desc=Neighbor IP address:type=IPv4 or IPv6 address
vrf
String desc=name of vrf:default=default:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-bfd-neighbor-show - Up

display BFD neighbors on a vRouter
api.switch-name (optional)
neighbor (optional)
String desc=neighbor IP address:type=IPv4 or IPv6 address
holdown (optional)
Long desc=detection time if BFD session is established:type=uint32 format: int64
multiplier (optional)
Integer desc=detection time multiplier:type=uint8 format: int32
state (optional)
String desc=state of the BFD session:type=enum
Enum:
unknown
admin-down
down
init
up
no-session
not-replicator-vtep
vrf (optional)
String desc=Virtual Routing and Forwarding instance
up/down (optional)
String desc=State of BFD neighbor
remote-router (optional)
String desc=remote router name derived from IP Address
out-addr (optional)
String desc=outgoing IP address:type=IPv4 or IPv6 address
local-discr (optional)
Long desc=local discriminator:type=uint32 format: int64
remote-discr (optional)
Long desc=remote discriminator:type=uint32 format: int64
flap-count (optional)
Long desc=flap count:type=uint32 format: int64
tx-int (optional)
Long desc=Minimum Tx interval in msec:type=uint32 format: int64
rx-int (optional)
Long desc=Minimum Rx interval in msec:type=uint32 format: int64
cumulative-count (optional)
Long desc=Cumulative flap count:type=uint32 format: int64
last-clear-time (optional)
String desc=Last time when the flap count was cleared
interface (optional)
String desc=interface of the connection

vrouter-bgp-add - Up

add Border Gateway Protocol neighbor to a vRouter
neighbor (optional)
String desc=IP address for BGP neighbor:type=IPv4 or IPv6 address:precludes=[l3-port]
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
prepend (optional)
Boolean desc=BGP next hop is self or not:default=true:requires=[local-as]
weight (optional)
Integer desc=default weight value between 0 and 65535 for the neighbor's routes:range=[-1,65535]:default=-1 format: int32
api.local-as (optional)
Enum:
external
internal
next-hop-self (optional)
Boolean desc=BGP next hop is self or not
replace-as (optional)
Boolean desc=BGP next hop is self or not
ebgp-multihop (optional)
Integer desc=value for external BGP from 1 to 255:type=uint16:range=[1,255] format: int32
update-source (optional)
String desc=IP address of BGP packets required for peering over loopback interface:type=IPv4 or IPv6 address:precludes=[update-source-interface]:api-ref-path=/vrouters/{vrouter-name}/loopback-interfaces:api-ref-model=vrouter-loopback-interface-show:api-ref-id=ip:api-ref-val=ip
update-source-interface (optional)
String desc=interface name of BGP packets required for peering over any interface:precludes=[update-source]
route-reflector-client (optional)
Boolean desc=set as route reflector client
override-capability (optional)
Boolean desc=override capability
soft-reconfig-inbound (optional)
Boolean desc=soft reset to reconfigure inbound traffic
max-prefix (optional)
Long desc=maximum number of prefixes:type=uint32 format: int64
max-prefix-warn-only (optional)
Boolean desc=warn if the maximum number of prefixes is exceeded
bfd (optional)
Boolean desc=BFD protocol support for fault detection
bfd-multihop (optional)
Boolean desc=always use BFD multi-hop port for fault detection
multi-protocol (optional)
String desc=Multi-protocol features:type=flag:default=ipv4-unicast
Enum:
ipv4-unicast
ipv6-unicast
l2vpn-evpn
api.weight (optional)
Enum:
none
default-originate (optional)
Boolean desc=announce default routes to the neighbor or not
neighbor-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds):type=uint32:range=[0,65535]:default=60:requires=[neighbor-holdtime] format: int64
neighbor-holdtime (optional)
Long desc=BGP Holdtime (seconds):type=uint32:range=[0,65535]:default=180 format: int64
connect-retry-interval (optional)
Long desc=BGP Connect retry interval (seconds):type=uint32:range=[0,65535]:default=15 format: int64
send-community (optional)
Boolean desc=send any community attribute to neighbor:default=true
l3-port (optional)
Long desc=l3 port for BGP session:type=uint32:default=4294967295:precludes=[neighbor]:api-ref-path=/l3port-usable-ports:api-ref-model=l3port-usable-port-show:api-ref-id=intf:api-ref-val=name format: int64
remote-as (optional)
Long desc=BGP remote AS from 1 to 4294967295 or external:range=[-2,4294967295] format: int64
api.remote-as (optional)
Enum:
external
internal
local-as (optional)
Long desc=BGP local AS from 1 to 4294967295 or external:range=[-2,4294967295] format: int64
unnumbered-interop (optional)
Boolean desc=Interop unnumbered BGP NBR, send LL and G NH both even if they are same:default=false
route-map-in (optional)
String desc=route map in for nbr:precludes=[no-route-map-in]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
route-map-out (optional)
String desc=route map out for nbr:precludes=[no-route-map-out]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
allowas-in (optional)
Boolean desc=Allow/reject routes with local AS in AS_PATH:precludes=[allowas-in-occurrences,allowas-in-origin]
allowas-in-occurrences (optional)
Long desc=Allow/reject routes with local AS in AS_PATH with max number of occurrences:type=uint32:range=[0,10]:precludes=[allowas-in,allowas-in-origin] format: int64
allowas-in-origin (optional)
Boolean desc=Allow/reject routes with local AS in AS_PATH if the route was orig. in my AS:precludes=[allowas-in-occurrences,allowas-in]
as-override (optional)
Boolean desc=Override ASNs in outbound updates if aspath equals remote-as
interface (optional)
String desc=Interface to reach the neighbor:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
advertisement-interval (optional)
Long desc=Minimum interval between sending BGP routing updates:type=uint32:range=[0,600] format: int64
description (optional)
String desc=Vrouter bgp neighbor description:default=none:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
password (optional)
String desc=password for MD5 BGP:password=true
prefix-list-in (optional)
String desc=prefixes used for filtering:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name
prefix-list-out (optional)
String desc=prefixes used for filtering outgoing packets:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name

vrouter-bgp-aggregate-address-add - Up

add BGP aggregate address to a vRouter
network
String desc=IP address for BGP Aggregate address:type=IPv4 or IPv6 address
netmask
Integer desc=Network mask for BGP Aggregate address:type=netmask:mask-for=[network] format: int32
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
origin (optional)
String desc=Origin code of BGP prefix:type=enum:default=none
Enum:
none
egp
igp
incomplete
route-map (optional)
String desc=Apply route map to aggregate network:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
suppress-map (optional)
String desc=Suppress the selected more specific routes:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
as-set (optional)
Boolean desc=Generate AS set path information
summary-only (optional)
Boolean desc=Filter more specific routes from updates:default=true
matching-MED-only (optional)
Boolean desc=Only aggregate routes with matching MED

vrouter-bgp-aggregate-address-modify - Up

modify BGP aggregate address information for a vRouter
origin (optional)
String desc=Origin code of BGP prefix:type=enum:default=none
Enum:
none
egp
igp
incomplete
route-map (optional)
String desc=Apply route map to aggregate network:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
suppress-map (optional)
String desc=Suppress the selected more specific routes:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
as-set (optional)
Boolean desc=Generate AS set path information
summary-only (optional)
Boolean desc=Filter more specific routes from updates:default=true
matching-MED-only (optional)
Boolean desc=Only aggregate routes with matching MED

vrouter-bgp-aggregate-address-show - Up

display BGP aggregate address information for a vRouter
api.switch-name (optional)
network
String desc=IP address for BGP Aggregate address:type=IPv4 or IPv6 address
netmask
Integer desc=Network mask for BGP Aggregate address:type=netmask:mask-for=[network] format: int32
vrf
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
origin (optional)
String desc=Origin code of BGP prefix:type=enum
Enum:
none
egp
igp
incomplete
route-map (optional)
String desc=Apply route map to aggregate network:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
suppress-map (optional)
String desc=Suppress the selected more specific routes:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
as-set (optional)
Boolean desc=Generate AS set path information
summary-only (optional)
Boolean desc=Filter more specific routes from updates
matching-MED-only (optional)
Boolean desc=Only aggregate routes with matching MED

vrouter-bgp-modify - Up

modify Border Gateway Protocol neighbor to a vRouter
prepend (optional)
Boolean desc=BGP next hop is self or not:default=true:requires=[local-as]
weight (optional)
Integer desc=default weight value between 0 and 65535 for the neighbor's routes:range=[-1,65535]:default=-1 format: int32
api.local-as (optional)
Enum:
external
internal
next-hop-self (optional)
Boolean desc=BGP next hop is self or not
replace-as (optional)
Boolean desc=BGP next hop is self or not
ebgp-multihop (optional)
Integer desc=value for external BGP from 1 to 255:type=uint16:range=[1,255] format: int32
update-source (optional)
String desc=IP address of BGP packets required for peering over loopback interface:type=IPv4 or IPv6 address:precludes=[update-source-interface]:api-ref-path=/vrouters/{vrouter-name}/loopback-interfaces:api-ref-model=vrouter-loopback-interface-show:api-ref-id=ip:api-ref-val=ip
update-source-interface (optional)
String desc=interface name of BGP packets required for peering over any interface:precludes=[update-source]
route-reflector-client (optional)
Boolean desc=set as route reflector client
override-capability (optional)
Boolean desc=override capability
soft-reconfig-inbound (optional)
Boolean desc=soft reset to reconfigure inbound traffic
max-prefix (optional)
Long desc=maximum number of prefixes:type=uint32 format: int64
max-prefix-warn-only (optional)
Boolean desc=warn if the maximum number of prefixes is exceeded
bfd (optional)
Boolean desc=BFD protocol support for fault detection
bfd-multihop (optional)
Boolean desc=always use BFD multi-hop port for fault detection
multi-protocol (optional)
String desc=Multi-protocol features:type=flag:default=ipv4-unicast
Enum:
ipv4-unicast
ipv6-unicast
l2vpn-evpn
api.weight (optional)
Enum:
none
default-originate (optional)
Boolean desc=announce default routes to the neighbor or not
neighbor-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds):type=uint32:range=[0,65535]:default=60:requires=[neighbor-holdtime] format: int64
neighbor-holdtime (optional)
Long desc=BGP Holdtime (seconds):type=uint32:range=[0,65535]:default=180 format: int64
connect-retry-interval (optional)
Long desc=BGP Connect retry interval (seconds):type=uint32:range=[0,65535]:default=15 format: int64
send-community (optional)
Boolean desc=send any community attribute to neighbor:default=true
remote-as (optional)
Long desc=BGP remote AS from 1 to 4294967295 or external:range=[-2,4294967295] format: int64
api.remote-as (optional)
Enum:
external
internal
local-as (optional)
Long desc=BGP local AS from 1 to 4294967295 or external:range=[-2,4294967295] format: int64
no-route-map-in (optional)
Boolean desc=Remove ingress route-map from BGP neighbor:precludes=[route-map-in]
no-route-map-out (optional)
Boolean desc=Remove egress route-map from BGP neighbor:precludes=[route-map-out]
unnumbered-interop (optional)
Boolean desc=Interop unnumbered BGP NBR, send LL and G NH both even if they are same:default=false
route-map-in (optional)
String desc=route map in for nbr:precludes=[no-route-map-in]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
route-map-out (optional)
String desc=route map out for nbr:precludes=[no-route-map-out]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
allowas-in (optional)
Boolean desc=Allow/reject routes with local AS in AS_PATH:precludes=[allowas-in-occurrences,allowas-in-origin]
allowas-in-occurrences (optional)
Long desc=Allow/reject routes with local AS in AS_PATH with max number of occurrences:type=uint32:range=[0,10]:precludes=[allowas-in,allowas-in-origin] format: int64
allowas-in-origin (optional)
Boolean desc=Allow/reject routes with local AS in AS_PATH if the route was orig. in my AS:precludes=[allowas-in-occurrences,allowas-in]
as-override (optional)
Boolean desc=Override ASNs in outbound updates if aspath equals remote-as
interface (optional)
String desc=Interface to reach the neighbor:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
advertisement-interval (optional)
Long desc=Minimum interval between sending BGP routing updates:type=uint32:range=[0,600] format: int64
description (optional)
String desc=Vrouter bgp neighbor description:default=none:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -
password (optional)
String desc=password for MD5 BGP:password=true
prefix-list-in (optional)
String desc=prefixes used for filtering:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name
prefix-list-out (optional)
String desc=prefixes used for filtering outgoing packets:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name

vrouter-bgp-neighbor-detail-show - Up

display BGP neighbor detail information
api.switch-name (optional)
neighbor
String desc=neighbor IP address:type=IPv4 or IPv6 address:api-ref-path=/vrouters/{vrouter-name}/bgp-neighbors:api-ref-model=vrouter-bgp-neighbor-show:api-ref-id=neighbor:api-ref-val=neighbor
nic
String desc=BGP on this interface
state (optional)
String desc=BGP state:type=enum
Enum:
idle
connect
active
open-sent
open-confirm
established
clearing
holdtime (optional)
Long desc=holdtime (seconds):type=uint32 format: int64
keepalive (optional)
Long desc=keepalive interval (seconds):type=uint32 format: int64
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
open-sent (optional)
Long desc=number of open messages sent:type=uint32 format: int64
open-rcvd (optional)
Long desc=number of open messages received:type=uint32 format: int64
notif-sent (optional)
Long desc=number of notification messages sent:type=uint32 format: int64
notif-rcvd (optional)
Long desc=number of notification messages received:type=uint32 format: int64
update-sent (optional)
Long desc=number of update messages sent:type=uint32 format: int64
update-rcvd (optional)
Long desc=number of update messages received:type=uint32 format: int64
keepalive-sent (optional)
Long desc=number of keepalive messages sent:type=uint32 format: int64
keepalive-rcvd (optional)
Long desc=number of keepalive messages received:type=uint32 format: int64
comm-attr-send-ipv4 (optional)
String desc=type of community attribute send to this neighbor for IPv4 unicast:type=enum
Enum:
both
standard
extended
prefix-accepted-ipv4 (optional)
Long desc=number of prefixes accepted for IPv4 unicast:type=uint32 format: int64
comm-attr-send-ipv6 (optional)
String desc=type of community attribute send to this neighbor for IPv6 unicast:type=enum
Enum:
both
standard
extended
prefix-accepted-ipv6 (optional)
Long desc=number of prefixes accepted for IPv6 unicast:type=uint32 format: int64
conn-established (optional)
Long desc=number of times a session has been successfully established:type=uint32 format: int64
conn-dropped (optional)
Long desc=number of times a session has failed or taken down:type=uint32 format: int64
last-reset (optional)
String desc=time since the session was last reset
start-due (optional)
Long desc=next start timer due in seconds:type=uint32 format: int64
connect-due (optional)
Long desc=next connect timer due in seconds:type=uint32 format: int64
remote-as (optional)
Long desc=neighbor AS:type=uint32 format: int64
remote-id (optional)
String desc=neighbor router id:type=IPv4 or IPv6 address
up-for (optional)
String desc=time the session has been up for
min-adv (optional)
Long desc=minimum advertisement interval (seconds):type=uint32 format: int64
local-as (optional)
Long desc=local AS:type=uint32 format: int64
last-read (optional)
String desc=time last received a message
l3-port (optional)
Long desc=Layer 3 port used for BGP:type=uint32 format: int64

vrouter-bgp-neighbor-failed-show - Up

display BGP neighbor failed summary
api.switch-name (optional)
neighbor (optional)
String desc=BGP neighbor:type=IPv4 or IPv6 address:api-ref-path=/vrouters/{vrouter-name}/bgp-neighbors:api-ref-model=vrouter-bgp-neighbor-show:api-ref-id=neighbor:api-ref-val=neighbor
reason (optional)
String desc=last reset due to:filter=false
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
remote-router (optional)
String desc=neighbor router name
estd-cnt (optional)
Long desc=number of times a session has been successfully established:type=uint32:filter=false format: int64
drop-cnt (optional)
Long desc=number of times a session has failed or taken down:type=uint32:filter=false format: int64
reset-time (optional)
String desc=duration since last reset:filter=false
nic (optional)
String desc=BGP on this interface
l3-port (optional)
Long desc=Layer 3 port used for BGP:type=uint32 format: int64

vrouter-bgp-neighbor-no-shutdown - Up

remove shutdown mode for bgp peer
neighbor (optional)
String desc=BGP neighbor:type=IPv4 or IPv6 address
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
l3-port (optional)
Long desc=Layer 3 port used for BGP:type=uint32 format: int64

vrouter-bgp-neighbor-reset - Up

reset information about BGP neighbors
neighbor (optional)
String desc=BGP neighbor:type=IPv4 or IPv6 address
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
l3-port (optional)
Long desc=Layer 3 port used for BGP:type=uint32 format: int64

vrouter-bgp-neighbor-reset-all - Up

reset information about all BGP neighbors
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-bgp-neighbor-show - Up

display BGP neighbor summary information
api.switch-name (optional)
neighbor
String desc=BGP neighbor:type=IPv4 or IPv6 address
nic
String desc=BGP on this interface
tblver (optional)
Long desc=version of the routing table:type=uint32 format: int64
inQ (optional)
Long desc=number of BGP packets queued for a neighbor:type=uint64 format: int64
outQ (optional)
Long desc=number of BGP packets queued for transmission to a neighbor:type=uint64 format: int64
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
ver (optional)
Long desc=BGP version:type=uint32 format: int64
state/pfxrcd (optional)
String desc=current state of BGP session
msg_rcvd (optional)
Long desc=number of messages received from the socket buffer:type=uint64 format: int64
msg_sent (optional)
Long desc=number of messages sent from the socket buffer:type=uint64 format: int64
up/down (optional)
String desc=state of BGP neighbor
remote-router (optional)
String desc=nbr router name
remote-as (optional)
Long desc=BGP neighbor AS:type=uint32 format: int64
description (optional)
String desc=vrouter bgp neighbor description
l3-port (optional)
Long desc=Layer 3 port used for BGP:type=uint32 format: int64

vrouter-bgp-neighbor-shutdown - Up

send bgp admin-down notification message to bgp peer
neighbor (optional)
String desc=BGP neighbor:type=IPv4 or IPv6 address
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
l3-port (optional)
Long desc=Layer 3 port used for BGP:type=uint32 format: int64

vrouter-bgp-network-add - Up

add Border Gateway Protocol network to a vRouter
network
String desc=IP address for BGP network:type=IPv4 or IPv6 address
netmask
Integer desc=BGP network mask:type=netmask:mask-for=[network] format: int32
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-bgp-network-show - Up

display Border Gateway Protocol network information for a vRouter
api.switch-name (optional)
network
String desc=IP address for BGP network:type=IPv4 or IPv6 address
netmask
Integer desc=BGP network mask:type=netmask:mask-for=[network] format: int32
vrf
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-bgp-path-list-show - Up

display BGP as path list
api.switch-name (optional)

vrouter-bgp-show - Up

display Border Gateway Protocol neighbor information for a vRouter
api.switch-name (optional)
neighbor
String desc=IP address for BGP neighbor:type=IPv4 or IPv6 address:precludes=[l3-port]
vrf
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
l3-port
Long desc=l3 port for BGP session:type=uint32:precludes=[neighbor]:api-ref-path=/l3port-usable-ports:api-ref-model=l3port-usable-port-show:api-ref-id=intf:api-ref-val=name format: int64
prepend (optional)
Boolean desc=BGP next hop is self or not:requires=[local-as]
weight (optional)
Integer desc=default weight value between 0 and 65535 for the neighbor's routes:range=[-1,65535] format: int32
next-hop-self (optional)
Boolean desc=BGP next hop is self or not
replace-as (optional)
Boolean desc=BGP next hop is self or not
ebgp-multihop (optional)
Integer desc=value for external BGP from 1 to 255:type=uint16:range=[1,255] format: int32
update-source (optional)
String desc=IP address of BGP packets required for peering over loopback interface:type=IPv4 or IPv6 address:precludes=[update-source-interface]:api-ref-path=/vrouters/{vrouter-name}/loopback-interfaces:api-ref-model=vrouter-loopback-interface-show:api-ref-id=ip:api-ref-val=ip
update-source-interface (optional)
String desc=interface name of BGP packets required for peering over any interface:precludes=[update-source]
route-reflector-client (optional)
Boolean desc=set as route reflector client
override-capability (optional)
Boolean desc=override capability
soft-reconfig-inbound (optional)
Boolean desc=soft reset to reconfigure inbound traffic
max-prefix (optional)
Long desc=maximum number of prefixes:type=uint32 format: int64
max-prefix-warn-only (optional)
Boolean desc=warn if the maximum number of prefixes is exceeded
bfd (optional)
Boolean desc=BFD protocol support for fault detection
bfd-multihop (optional)
Boolean desc=always use BFD multi-hop port for fault detection
multi-protocol (optional)
String desc=Multi-protocol features:type=flag
Enum:
ipv4-unicast
ipv6-unicast
l2vpn-evpn
default-originate (optional)
Boolean desc=announce default routes to the neighbor or not
neighbor-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds):type=uint32:range=[0,65535]:requires=[neighbor-holdtime] format: int64
neighbor-holdtime (optional)
Long desc=BGP Holdtime (seconds):type=uint32:range=[0,65535] format: int64
connect-retry-interval (optional)
Long desc=BGP Connect retry interval (seconds):type=uint32:range=[0,65535] format: int64
send-community (optional)
Boolean desc=send any community attribute to neighbor
remote-as (optional)
Long desc=BGP remote AS from 1 to 4294967295 or external:range=[-2,4294967295] format: int64
local-as (optional)
Long desc=BGP local AS from 1 to 4294967295 or external:range=[-2,4294967295] format: int64
unnumbered-interop (optional)
Boolean desc=Interop unnumbered BGP NBR, send LL and G NH both even if they are same
route-map-in (optional)
String desc=route map in for nbr:precludes=[no-route-map-in]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
route-map-out (optional)
String desc=route map out for nbr:precludes=[no-route-map-out]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
allowas-in (optional)
Boolean desc=Allow/reject routes with local AS in AS_PATH:precludes=[allowas-in-occurrences,allowas-in-origin]
allowas-in-occurrences (optional)
Long desc=Allow/reject routes with local AS in AS_PATH with max number of occurrences:type=uint32:range=[0,10]:precludes=[allowas-in,allowas-in-origin] format: int64
allowas-in-origin (optional)
Boolean desc=Allow/reject routes with local AS in AS_PATH if the route was orig. in my AS:precludes=[allowas-in-occurrences,allowas-in]
as-override (optional)
Boolean desc=Override ASNs in outbound updates if aspath equals remote-as
interface (optional)
String desc=Interface to reach the neighbor:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
advertisement-interval (optional)
Long desc=Minimum interval between sending BGP routing updates:type=uint32:range=[0,600] format: int64
description (optional)
String desc=Vrouter bgp neighbor description
prefix-list-in (optional)
String desc=prefixes used for filtering:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name
prefix-list-out (optional)
String desc=prefixes used for filtering outgoing packets:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name

vrouter-cached-routes-show - Up

display cached routes for a virtual router (vrouter)
api.switch-name (optional)
vrid (optional)
Integer desc=ID assigned to vRouter format: int32
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address
prelen (optional)
Long desc=prefix length:type=uint32:range=[0,128] format: int64
vlan (optional)
Integer desc=VLAN:type=uint16:range=[0,4095] format: int32
vxlan (optional)
Long desc=VXLANs:type=uint32 format: int64
nexthop (optional)
String desc=next-hop IP address:type=IPv4 or IPv6 address
index (optional)
Long desc=interface index in the zone/container:type=uint32 format: int64
age-in-seconds (optional)
Long desc=route age in seconds:type=uint64 format: int64
vnet-id (optional)
String desc=VNET of cached route:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

vrouter-community-list-add - Up

add a bgp community list
name
String desc=name for the community list:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
action
String desc=action to permit or deny route updates:type=enum
Enum:
permit
deny
style (optional)
String desc=style for community list (default standard):type=enum:default=standard
Enum:
standard
expanded
community-attribute (optional)
String desc=the community attribute to match on

vrouter-community-list-show - Up

display bgp community lists
api.switch-name (optional)
style
String desc=style for community list (default standard):type=enum
Enum:
standard
expanded
name
String desc=name for the community list
action
String desc=action to permit or deny route updates:type=enum
Enum:
permit
deny
community-attribute
String desc=the community attribute to match on

vrouter-create-1 - Up

create H/W vRouter
router-type
String desc=vRouter type:type=enum:default=hardware
Enum:
software
hardware
name
String desc=name of service config:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter
vnet
String desc=vnet assigned to service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[scope]:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
shared-vnet-mgr (optional)
String desc=vnet-manager to share with if shared service:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter:api-ref-path=/vnet-managers:api-ref-model=vnet-manager-show:api-ref-id=name:api-ref-val=name
state (optional)
String desc=state of service:type=enum
Enum:
disable
enable
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name
router-ipstack (optional)
String desc=vRouter ipstack:type=enum:default=frr
Enum:
quagga
frr
evpn-border (optional)
Boolean desc=evpn border node:default=false
evpn-export-all-leaked-networks (optional)
String desc=exporting leaked subnets to eVPN overlay:type=enum:default=permit
Enum:
permit
deny
evpn-dup-addr-max-moves (optional)
Long desc=evpn duplicate address max moves:type=uint32:range=[2,1000]:default=5 format: int64
evpn-dup-addr-moves-duration (optional)
Long desc=evpn duplicate address moves time duration (seconds):type=uint32:range=[2,1800]:default=180 format: int64
evpn-dup-addr-freeze (optional)
Integer desc=evpn duplicate address freeze duration (seconds):range=[-1,3600]:default=180 format: int32
api.evpn-dup-addr-freeze (optional)
Enum:
none
permanent
cluster-active-active-routing (optional)
Boolean desc=active-active routing with or without VRRP
bgp-redist-static-metric (optional)
Long desc=BGP route redistribution static metric:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-static-metric (optional)
Enum:
none
bgp-redist-connected-metric (optional)
Long desc=metric for redistributing BGP connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-connected-metric (optional)
Enum:
none
bgp-redist-rip-metric (optional)
Long desc=metric for redistributing RIP connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-rip-metric (optional)
Enum:
none
bgp-redist-ospf-metric (optional)
Long desc=metric for BGP to redistribute OSPF connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-ospf-metric (optional)
Enum:
none
bgp-cluster-id (optional)
String desc=IP address for BGP cluster ID:type=IPv4 or IPv6 address
bgp-bestpath-as-path (optional)
String desc=best path for BGP:type=flag
Enum:
ignore
multipath-relax
bgp-dampening (optional)
Boolean desc=dampening for BGP routes
bgp-delayed-startup (optional)
Integer desc=Delays forming peer adjacency on bootup:type=uint16:range=[0,36000]:default=0 format: int32
bgp-network-import-check (optional)
Boolean desc=Check BGP network route exists in IGP
bgp-update-delay-strict (optional)
Integer desc=Put bgp read-only mode on bootup, Recommend value less than l3-to-vlag-delay:type=uint16:range=[0,3600]:default=0 format: int32
bgp-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds) - default 60:type=uint32:range=[0,65535]:default=60:requires=[bgp-holdtime] format: int64
bgp-holdtime (optional)
Long desc=BGP Holdtime (seconds) - default 180:type=uint32:range=[0,65535]:default=180 format: int64
bgp-distance-external (optional)
Long desc=BGP distance for routes external to AS:type=uint32:range=[0,255]:requires=[bgp-distance-internal,bgp-distance-local] format: int64
bgp-distance-internal (optional)
Long desc=BGP distance for routes internal to AS:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-distance-local (optional)
Long desc=BGP distance for local routes:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
ospf-spf-delay (optional)
Long desc= Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000]:default=0 format: int64
ospf-spf-consec-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000]:default=50 format: int64
ospf-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000]:default=5000 format: int64
ospf6-spf-delay (optional)
Long desc=Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000]:default=0 format: int64
ospf6-spf-consecu-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000]:default=50 format: int64
ospf6-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000]:default=5000 format: int64
bgp-global-nh-preference (optional)
String desc=use global nexthop preference for choosing nexthop type in BGP-ipv6:type=enum:default=none
Enum:
none
true
false
rip-redistribute (optional)
String desc=redistribute RIP routes:type=flag
Enum:
static
connected
ospf
bgp
ospf-redistribute (optional)
String desc=redistribute OSPF routes:type=flag
Enum:
static
connected
rip
bgp
ospf-redist-static-metric (optional)
Integer desc=metric for OSPF redistribution of static routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-static-metric (optional)
Enum:
none
ospf-redist-static-metric-type (optional)
String desc=metric type for OSPF redistribution of static routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-connected-metric (optional)
Integer desc=metric for OSPF redistribution of connected routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-connected-metric (optional)
Enum:
none
ospf-redist-connected-metric-type (optional)
String desc=metric type for OSPF redistribution of connected routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-rip-metric (optional)
Integer desc=metric for OSPF redistribution of RIP routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-rip-metric (optional)
Enum:
none
ospf-redist-rip-metric-type (optional)
String desc=metric type for OSPF redistribution of RIP routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-bgp-metric (optional)
Integer desc=metric for OSPF redistribution of BGP routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-bgp-metric (optional)
Enum:
none
ospf-redist-bgp-metric-type (optional)
String desc=metric type for OSPF redistribution of BGP routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-distance-external (optional)
Long desc=OSPF distance for external routes:type=uint32:range=[0,255]:requires=[ospf-distance-internal,ospf-distance-local] format: int64
ospf-distance-internal (optional)
Long desc=OSPF distance for inter-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-distance-local (optional)
Long desc=OSPF distance for intra-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-stub-router-on-startup (optional)
Boolean desc=advertise self as stub router temporary on startup
ospf-stub-router-on-startup-period (optional)
Long desc=period to advertise self as stub router after startup:type=uint32:range=[5,86400] format: int64
ospf-bfd-all-if (optional)
Boolean desc=use BFD protocol for fault detection on all OSPF interfaces
ospf-default-information (optional)
String desc=control origination of default route:type=enum:default=none
Enum:
none
originate
always
ospf-default-info-originate-metric (optional)
Integer desc=metric for OSPF origination of default route:range=[-1,16777214]:default=-1 format: int32
api.ospf-default-info-originate-metric (optional)
Enum:
none
ospf-default-info-originate-metric-type (optional)
String desc=metric type for OSPF origination of default route:type=enum:default=2
Enum:
1
2
vrrp-track-port (optional)
String desc=track port for VRRP:type=port-list
bgp-default-shutdown (optional)
Boolean desc=Apply administrative shutdown to newly configured peers
bgp-snmp (optional)
Boolean desc=Enable BGP SNMP MIB
bgp-snmp-notification (optional)
Boolean desc=Enable BGP SNMP notifications
ospf-snmp (optional)
Boolean desc=Enable OSPF SNMP MIB
ospf-snmp-notification (optional)
Boolean desc=Enable OSPF SNMP notifications
ospf6-snmp (optional)
Boolean desc=Enable OSPFv3 SNMP MIB
ospf6-snmp-notification (optional)
Boolean desc=Enable OSPFv3 SNMP notifications
ip-snmp (optional)
Boolean desc=Enable ipForward SNMP MIB
no-bgp-redist-static-route-map (optional)
Boolean desc=Remove route map for BGP static redistribution:precludes=[bgp-redist-static-route-map]
no-bgp-redist-connected-route-map (optional)
Boolean desc=Remove route map for BGP connected redistribution:precludes=[bgp-redist-connected-route-map]
no-bgp-redist-ospf-route-map (optional)
Boolean desc=Remove route map for BGP OSPF redistribution:precludes=[bgp-redist-ospf-route-map]
bgp-graceful-shutdown (optional)
Boolean desc=BGP graceful shutdown RFC 8326
bgp-as (optional)
Long desc=BGP Autonomous System number from 1 to 4294967295:type=uint32:range=[1,4294967295] format: int64
bgp-redistribute (optional)
String desc=BGP route redistribution:type=flag
Enum:
static
connected
rip
ospf
bgp-max-paths (optional)
Integer desc=maximum BGP paths:type=uint16:range=[0,16]:default=1 format: int32
bgp-ibgp-multipath (optional)
Integer desc=number of IBGP multipath connections:type=uint16:range=[0,16] format: int32
router-id (optional)
String desc=OSPF and BGP router id:type=IPv4 or IPv6 address
hw-vrrp-id (optional)
Integer desc=VRRP ID assigned to the hardware vRouter:default=-1 format: int32

vrouter-create-2 - Up

create S/W vRouter
router-type
String desc=vRouter type:type=enum:default=software
Enum:
software
hardware
name
String desc=name of service config:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter
vnet
String desc=vnet assigned to service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[scope]:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
vnet-service (optional)
Boolean desc=service as dedicated or shared
shared-vnet-mgr (optional)
String desc=vnet-manager to share with if shared service:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter:api-ref-path=/vnet-managers:api-ref-model=vnet-manager-show:api-ref-id=name:api-ref-val=name
state (optional)
String desc=state of service:type=enum
Enum:
disable
enable
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name
router-ipstack (optional)
String desc=vRouter ipstack:type=enum:default=frr
Enum:
quagga
frr
evpn-border (optional)
Boolean desc=evpn border node:default=false
evpn-export-all-leaked-networks (optional)
String desc=exporting leaked subnets to eVPN overlay:type=enum:default=permit
Enum:
permit
deny
evpn-dup-addr-max-moves (optional)
Long desc=evpn duplicate address max moves:type=uint32:range=[2,1000]:default=5 format: int64
evpn-dup-addr-moves-duration (optional)
Long desc=evpn duplicate address moves time duration (seconds):type=uint32:range=[2,1800]:default=180 format: int64
evpn-dup-addr-freeze (optional)
Integer desc=evpn duplicate address freeze duration (seconds):range=[-1,3600]:default=180 format: int32
api.evpn-dup-addr-freeze (optional)
Enum:
none
permanent
cluster-active-active-routing (optional)
Boolean desc=active-active routing with or without VRRP
bgp-redist-static-metric (optional)
Long desc=BGP route redistribution static metric:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-static-metric (optional)
Enum:
none
bgp-redist-connected-metric (optional)
Long desc=metric for redistributing BGP connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-connected-metric (optional)
Enum:
none
bgp-redist-rip-metric (optional)
Long desc=metric for redistributing RIP connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-rip-metric (optional)
Enum:
none
bgp-redist-ospf-metric (optional)
Long desc=metric for BGP to redistribute OSPF connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-ospf-metric (optional)
Enum:
none
bgp-cluster-id (optional)
String desc=IP address for BGP cluster ID:type=IPv4 or IPv6 address
bgp-bestpath-as-path (optional)
String desc=best path for BGP:type=flag
Enum:
ignore
multipath-relax
bgp-dampening (optional)
Boolean desc=dampening for BGP routes
bgp-delayed-startup (optional)
Integer desc=Delays forming peer adjacency on bootup:type=uint16:range=[0,36000]:default=0 format: int32
bgp-network-import-check (optional)
Boolean desc=Check BGP network route exists in IGP
bgp-update-delay-strict (optional)
Integer desc=Put bgp read-only mode on bootup, Recommend value less than l3-to-vlag-delay:type=uint16:range=[0,3600]:default=0 format: int32
bgp-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds) - default 60:type=uint32:range=[0,65535]:default=60:requires=[bgp-holdtime] format: int64
bgp-holdtime (optional)
Long desc=BGP Holdtime (seconds) - default 180:type=uint32:range=[0,65535]:default=180 format: int64
bgp-distance-external (optional)
Long desc=BGP distance for routes external to AS:type=uint32:range=[0,255]:requires=[bgp-distance-internal,bgp-distance-local] format: int64
bgp-distance-internal (optional)
Long desc=BGP distance for routes internal to AS:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-distance-local (optional)
Long desc=BGP distance for local routes:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
ospf-spf-delay (optional)
Long desc= Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000]:default=0 format: int64
ospf-spf-consec-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000]:default=50 format: int64
ospf-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000]:default=5000 format: int64
ospf6-spf-delay (optional)
Long desc=Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000]:default=0 format: int64
ospf6-spf-consecu-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000]:default=50 format: int64
ospf6-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000]:default=5000 format: int64
bgp-global-nh-preference (optional)
String desc=use global nexthop preference for choosing nexthop type in BGP-ipv6:type=enum:default=none
Enum:
none
true
false
rip-redistribute (optional)
String desc=redistribute RIP routes:type=flag
Enum:
static
connected
ospf
bgp
ospf-redistribute (optional)
String desc=redistribute OSPF routes:type=flag
Enum:
static
connected
rip
bgp
ospf-redist-static-metric (optional)
Integer desc=metric for OSPF redistribution of static routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-static-metric (optional)
Enum:
none
ospf-redist-static-metric-type (optional)
String desc=metric type for OSPF redistribution of static routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-connected-metric (optional)
Integer desc=metric for OSPF redistribution of connected routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-connected-metric (optional)
Enum:
none
ospf-redist-connected-metric-type (optional)
String desc=metric type for OSPF redistribution of connected routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-rip-metric (optional)
Integer desc=metric for OSPF redistribution of RIP routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-rip-metric (optional)
Enum:
none
ospf-redist-rip-metric-type (optional)
String desc=metric type for OSPF redistribution of RIP routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-bgp-metric (optional)
Integer desc=metric for OSPF redistribution of BGP routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-bgp-metric (optional)
Enum:
none
ospf-redist-bgp-metric-type (optional)
String desc=metric type for OSPF redistribution of BGP routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-distance-external (optional)
Long desc=OSPF distance for external routes:type=uint32:range=[0,255]:requires=[ospf-distance-internal,ospf-distance-local] format: int64
ospf-distance-internal (optional)
Long desc=OSPF distance for inter-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-distance-local (optional)
Long desc=OSPF distance for intra-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-stub-router-on-startup (optional)
Boolean desc=advertise self as stub router temporary on startup
ospf-stub-router-on-startup-period (optional)
Long desc=period to advertise self as stub router after startup:type=uint32:range=[5,86400] format: int64
ospf-bfd-all-if (optional)
Boolean desc=use BFD protocol for fault detection on all OSPF interfaces
ospf-default-information (optional)
String desc=control origination of default route:type=enum:default=none
Enum:
none
originate
always
ospf-default-info-originate-metric (optional)
Integer desc=metric for OSPF origination of default route:range=[-1,16777214]:default=-1 format: int32
api.ospf-default-info-originate-metric (optional)
Enum:
none
ospf-default-info-originate-metric-type (optional)
String desc=metric type for OSPF origination of default route:type=enum:default=2
Enum:
1
2
vrrp-track-port (optional)
String desc=track port for VRRP:type=port-list
bgp-default-shutdown (optional)
Boolean desc=Apply administrative shutdown to newly configured peers
bgp-snmp (optional)
Boolean desc=Enable BGP SNMP MIB
bgp-snmp-notification (optional)
Boolean desc=Enable BGP SNMP notifications
ospf-snmp (optional)
Boolean desc=Enable OSPF SNMP MIB
ospf-snmp-notification (optional)
Boolean desc=Enable OSPF SNMP notifications
ospf6-snmp (optional)
Boolean desc=Enable OSPFv3 SNMP MIB
ospf6-snmp-notification (optional)
Boolean desc=Enable OSPFv3 SNMP notifications
ip-snmp (optional)
Boolean desc=Enable ipForward SNMP MIB
no-bgp-redist-static-route-map (optional)
Boolean desc=Remove route map for BGP static redistribution:precludes=[bgp-redist-static-route-map]
no-bgp-redist-connected-route-map (optional)
Boolean desc=Remove route map for BGP connected redistribution:precludes=[bgp-redist-connected-route-map]
no-bgp-redist-ospf-route-map (optional)
Boolean desc=Remove route map for BGP OSPF redistribution:precludes=[bgp-redist-ospf-route-map]
bgp-graceful-shutdown (optional)
Boolean desc=BGP graceful shutdown RFC 8326
bgp-as (optional)
Long desc=BGP Autonomous System number from 1 to 4294967295:type=uint32:range=[1,4294967295] format: int64
bgp-redistribute (optional)
String desc=BGP route redistribution:type=flag
Enum:
static
connected
rip
ospf
bgp-max-paths (optional)
Integer desc=maximum BGP paths:type=uint16:range=[0,16]:default=1 format: int32
bgp-ibgp-multipath (optional)
Integer desc=number of IBGP multipath connections:type=uint16:range=[0,16] format: int32
router-id (optional)
String desc=OSPF and BGP router id:type=IPv4 or IPv6 address

vrouter-create-3 - Up

create H/W vRouter
name
String desc=name of service config:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter
vnet
String desc=vnet assigned to service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[scope]:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
shared-vnet-mgr (optional)
String desc=vnet-manager to share with if shared service:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter:api-ref-path=/vnet-managers:api-ref-model=vnet-manager-show:api-ref-id=name:api-ref-val=name
state (optional)
String desc=state of service:type=enum
Enum:
disable
enable
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name
router-type (optional)
String desc=vRouter type:type=enum
Enum:
software
hardware
router-ipstack (optional)
String desc=vRouter ipstack:type=enum:default=frr
Enum:
quagga
frr
evpn-border (optional)
Boolean desc=evpn border node:default=false
evpn-export-all-leaked-networks (optional)
String desc=exporting leaked subnets to eVPN overlay:type=enum:default=permit
Enum:
permit
deny
evpn-dup-addr-max-moves (optional)
Long desc=evpn duplicate address max moves:type=uint32:range=[2,1000]:default=5 format: int64
evpn-dup-addr-moves-duration (optional)
Long desc=evpn duplicate address moves time duration (seconds):type=uint32:range=[2,1800]:default=180 format: int64
evpn-dup-addr-freeze (optional)
Integer desc=evpn duplicate address freeze duration (seconds):range=[-1,3600]:default=180 format: int32
api.evpn-dup-addr-freeze (optional)
Enum:
none
permanent
cluster-active-active-routing (optional)
Boolean desc=active-active routing with or without VRRP
bgp-redist-static-metric (optional)
Long desc=BGP route redistribution static metric:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-static-metric (optional)
Enum:
none
bgp-redist-connected-metric (optional)
Long desc=metric for redistributing BGP connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-connected-metric (optional)
Enum:
none
bgp-redist-rip-metric (optional)
Long desc=metric for redistributing RIP connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-rip-metric (optional)
Enum:
none
bgp-redist-ospf-metric (optional)
Long desc=metric for BGP to redistribute OSPF connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-ospf-metric (optional)
Enum:
none
bgp-cluster-id (optional)
String desc=IP address for BGP cluster ID:type=IPv4 or IPv6 address
bgp-bestpath-as-path (optional)
String desc=best path for BGP:type=flag
Enum:
ignore
multipath-relax
bgp-dampening (optional)
Boolean desc=dampening for BGP routes
bgp-delayed-startup (optional)
Integer desc=Delays forming peer adjacency on bootup:type=uint16:range=[0,36000]:default=0 format: int32
bgp-network-import-check (optional)
Boolean desc=Check BGP network route exists in IGP
bgp-update-delay-strict (optional)
Integer desc=Put bgp read-only mode on bootup, Recommend value less than l3-to-vlag-delay:type=uint16:range=[0,3600]:default=0 format: int32
bgp-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds) - default 60:type=uint32:range=[0,65535]:default=60:requires=[bgp-holdtime] format: int64
bgp-holdtime (optional)
Long desc=BGP Holdtime (seconds) - default 180:type=uint32:range=[0,65535]:default=180 format: int64
bgp-distance-external (optional)
Long desc=BGP distance for routes external to AS:type=uint32:range=[0,255]:requires=[bgp-distance-internal,bgp-distance-local] format: int64
bgp-distance-internal (optional)
Long desc=BGP distance for routes internal to AS:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-distance-local (optional)
Long desc=BGP distance for local routes:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
ospf-spf-delay (optional)
Long desc= Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000]:default=0 format: int64
ospf-spf-consec-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000]:default=50 format: int64
ospf-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000]:default=5000 format: int64
ospf6-spf-delay (optional)
Long desc=Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000]:default=0 format: int64
ospf6-spf-consecu-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000]:default=50 format: int64
ospf6-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000]:default=5000 format: int64
bgp-global-nh-preference (optional)
String desc=use global nexthop preference for choosing nexthop type in BGP-ipv6:type=enum:default=none
Enum:
none
true
false
rip-redistribute (optional)
String desc=redistribute RIP routes:type=flag
Enum:
static
connected
ospf
bgp
ospf-redistribute (optional)
String desc=redistribute OSPF routes:type=flag
Enum:
static
connected
rip
bgp
ospf-redist-static-metric (optional)
Integer desc=metric for OSPF redistribution of static routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-static-metric (optional)
Enum:
none
ospf-redist-static-metric-type (optional)
String desc=metric type for OSPF redistribution of static routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-connected-metric (optional)
Integer desc=metric for OSPF redistribution of connected routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-connected-metric (optional)
Enum:
none
ospf-redist-connected-metric-type (optional)
String desc=metric type for OSPF redistribution of connected routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-rip-metric (optional)
Integer desc=metric for OSPF redistribution of RIP routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-rip-metric (optional)
Enum:
none
ospf-redist-rip-metric-type (optional)
String desc=metric type for OSPF redistribution of RIP routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-bgp-metric (optional)
Integer desc=metric for OSPF redistribution of BGP routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-bgp-metric (optional)
Enum:
none
ospf-redist-bgp-metric-type (optional)
String desc=metric type for OSPF redistribution of BGP routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-distance-external (optional)
Long desc=OSPF distance for external routes:type=uint32:range=[0,255]:requires=[ospf-distance-internal,ospf-distance-local] format: int64
ospf-distance-internal (optional)
Long desc=OSPF distance for inter-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-distance-local (optional)
Long desc=OSPF distance for intra-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-stub-router-on-startup (optional)
Boolean desc=advertise self as stub router temporary on startup
ospf-stub-router-on-startup-period (optional)
Long desc=period to advertise self as stub router after startup:type=uint32:range=[5,86400] format: int64
ospf-bfd-all-if (optional)
Boolean desc=use BFD protocol for fault detection on all OSPF interfaces
ospf-default-information (optional)
String desc=control origination of default route:type=enum:default=none
Enum:
none
originate
always
ospf-default-info-originate-metric (optional)
Integer desc=metric for OSPF origination of default route:range=[-1,16777214]:default=-1 format: int32
api.ospf-default-info-originate-metric (optional)
Enum:
none
ospf-default-info-originate-metric-type (optional)
String desc=metric type for OSPF origination of default route:type=enum:default=2
Enum:
1
2
vrrp-track-port (optional)
String desc=track port for VRRP:type=port-list
bgp-default-shutdown (optional)
Boolean desc=Apply administrative shutdown to newly configured peers
bgp-snmp (optional)
Boolean desc=Enable BGP SNMP MIB
bgp-snmp-notification (optional)
Boolean desc=Enable BGP SNMP notifications
ospf-snmp (optional)
Boolean desc=Enable OSPF SNMP MIB
ospf-snmp-notification (optional)
Boolean desc=Enable OSPF SNMP notifications
ospf6-snmp (optional)
Boolean desc=Enable OSPFv3 SNMP MIB
ospf6-snmp-notification (optional)
Boolean desc=Enable OSPFv3 SNMP notifications
ip-snmp (optional)
Boolean desc=Enable ipForward SNMP MIB
no-bgp-redist-static-route-map (optional)
Boolean desc=Remove route map for BGP static redistribution:precludes=[bgp-redist-static-route-map]
no-bgp-redist-connected-route-map (optional)
Boolean desc=Remove route map for BGP connected redistribution:precludes=[bgp-redist-connected-route-map]
no-bgp-redist-ospf-route-map (optional)
Boolean desc=Remove route map for BGP OSPF redistribution:precludes=[bgp-redist-ospf-route-map]
bgp-graceful-shutdown (optional)
Boolean desc=BGP graceful shutdown RFC 8326
bgp-as (optional)
Long desc=BGP Autonomous System number from 1 to 4294967295:type=uint32:range=[1,4294967295] format: int64
bgp-redistribute (optional)
String desc=BGP route redistribution:type=flag
Enum:
static
connected
rip
ospf
bgp-max-paths (optional)
Integer desc=maximum BGP paths:type=uint16:range=[0,16]:default=1 format: int32
bgp-ibgp-multipath (optional)
Integer desc=number of IBGP multipath connections:type=uint16:range=[0,16] format: int32
router-id (optional)
String desc=OSPF and BGP router id:type=IPv4 or IPv6 address
hw-vrrp-id (optional)
Integer desc=VRRP ID assigned to the hardware vRouter:default=-1 format: int32

vrouter-create-4 - Up

create H/W vRouter for fabric communication
fabric-comm
Boolean desc=vRouter for fabric communication:precludes=[router-type]
name
String desc=name of service config:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter
shared-vnet-mgr (optional)
String desc=vnet-manager to share with if shared service:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter:api-ref-path=/vnet-managers:api-ref-model=vnet-manager-show:api-ref-id=name:api-ref-val=name
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name
router-ipstack (optional)
String desc=vRouter ipstack:type=enum:default=frr
Enum:
quagga
frr
evpn-border (optional)
Boolean desc=evpn border node:default=false
evpn-export-all-leaked-networks (optional)
String desc=exporting leaked subnets to eVPN overlay:type=enum:default=permit
Enum:
permit
deny
evpn-dup-addr-max-moves (optional)
Long desc=evpn duplicate address max moves:type=uint32:range=[2,1000]:default=5 format: int64
evpn-dup-addr-moves-duration (optional)
Long desc=evpn duplicate address moves time duration (seconds):type=uint32:range=[2,1800]:default=180 format: int64
evpn-dup-addr-freeze (optional)
Integer desc=evpn duplicate address freeze duration (seconds):range=[-1,3600]:default=180 format: int32
api.evpn-dup-addr-freeze (optional)
Enum:
none
permanent
cluster-active-active-routing (optional)
Boolean desc=active-active routing with or without VRRP
bgp-redist-static-metric (optional)
Long desc=BGP route redistribution static metric:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-static-metric (optional)
Enum:
none
bgp-redist-connected-metric (optional)
Long desc=metric for redistributing BGP connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-connected-metric (optional)
Enum:
none
bgp-redist-rip-metric (optional)
Long desc=metric for redistributing RIP connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-rip-metric (optional)
Enum:
none
bgp-redist-ospf-metric (optional)
Long desc=metric for BGP to redistribute OSPF connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-ospf-metric (optional)
Enum:
none
bgp-cluster-id (optional)
String desc=IP address for BGP cluster ID:type=IPv4 or IPv6 address
bgp-bestpath-as-path (optional)
String desc=best path for BGP:type=flag
Enum:
ignore
multipath-relax
bgp-dampening (optional)
Boolean desc=dampening for BGP routes
bgp-delayed-startup (optional)
Integer desc=Delays forming peer adjacency on bootup:type=uint16:range=[0,36000]:default=0 format: int32
bgp-network-import-check (optional)
Boolean desc=Check BGP network route exists in IGP
bgp-update-delay-strict (optional)
Integer desc=Put bgp read-only mode on bootup, Recommend value less than l3-to-vlag-delay:type=uint16:range=[0,3600]:default=0 format: int32
bgp-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds) - default 60:type=uint32:range=[0,65535]:default=60:requires=[bgp-holdtime] format: int64
bgp-holdtime (optional)
Long desc=BGP Holdtime (seconds) - default 180:type=uint32:range=[0,65535]:default=180 format: int64
bgp-distance-external (optional)
Long desc=BGP distance for routes external to AS:type=uint32:range=[0,255]:requires=[bgp-distance-internal,bgp-distance-local] format: int64
bgp-distance-internal (optional)
Long desc=BGP distance for routes internal to AS:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-distance-local (optional)
Long desc=BGP distance for local routes:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
ospf-spf-delay (optional)
Long desc= Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000]:default=0 format: int64
ospf-spf-consec-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000]:default=50 format: int64
ospf-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000]:default=5000 format: int64
ospf6-spf-delay (optional)
Long desc=Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000]:default=0 format: int64
ospf6-spf-consecu-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000]:default=50 format: int64
ospf6-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000]:default=5000 format: int64
bgp-global-nh-preference (optional)
String desc=use global nexthop preference for choosing nexthop type in BGP-ipv6:type=enum:default=none
Enum:
none
true
false
rip-redistribute (optional)
String desc=redistribute RIP routes:type=flag
Enum:
static
connected
ospf
bgp
ospf-redistribute (optional)
String desc=redistribute OSPF routes:type=flag
Enum:
static
connected
rip
bgp
ospf-redist-static-metric (optional)
Integer desc=metric for OSPF redistribution of static routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-static-metric (optional)
Enum:
none
ospf-redist-static-metric-type (optional)
String desc=metric type for OSPF redistribution of static routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-connected-metric (optional)
Integer desc=metric for OSPF redistribution of connected routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-connected-metric (optional)
Enum:
none
ospf-redist-connected-metric-type (optional)
String desc=metric type for OSPF redistribution of connected routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-rip-metric (optional)
Integer desc=metric for OSPF redistribution of RIP routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-rip-metric (optional)
Enum:
none
ospf-redist-rip-metric-type (optional)
String desc=metric type for OSPF redistribution of RIP routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-bgp-metric (optional)
Integer desc=metric for OSPF redistribution of BGP routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-bgp-metric (optional)
Enum:
none
ospf-redist-bgp-metric-type (optional)
String desc=metric type for OSPF redistribution of BGP routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-distance-external (optional)
Long desc=OSPF distance for external routes:type=uint32:range=[0,255]:requires=[ospf-distance-internal,ospf-distance-local] format: int64
ospf-distance-internal (optional)
Long desc=OSPF distance for inter-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-distance-local (optional)
Long desc=OSPF distance for intra-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-stub-router-on-startup (optional)
Boolean desc=advertise self as stub router temporary on startup
ospf-stub-router-on-startup-period (optional)
Long desc=period to advertise self as stub router after startup:type=uint32:range=[5,86400] format: int64
ospf-bfd-all-if (optional)
Boolean desc=use BFD protocol for fault detection on all OSPF interfaces
ospf-default-information (optional)
String desc=control origination of default route:type=enum:default=none
Enum:
none
originate
always
ospf-default-info-originate-metric (optional)
Integer desc=metric for OSPF origination of default route:range=[-1,16777214]:default=-1 format: int32
api.ospf-default-info-originate-metric (optional)
Enum:
none
ospf-default-info-originate-metric-type (optional)
String desc=metric type for OSPF origination of default route:type=enum:default=2
Enum:
1
2
vrrp-track-port (optional)
String desc=track port for VRRP:type=port-list
bgp-default-shutdown (optional)
Boolean desc=Apply administrative shutdown to newly configured peers
bgp-snmp (optional)
Boolean desc=Enable BGP SNMP MIB
bgp-snmp-notification (optional)
Boolean desc=Enable BGP SNMP notifications
ospf-snmp (optional)
Boolean desc=Enable OSPF SNMP MIB
ospf-snmp-notification (optional)
Boolean desc=Enable OSPF SNMP notifications
ospf6-snmp (optional)
Boolean desc=Enable OSPFv3 SNMP MIB
ospf6-snmp-notification (optional)
Boolean desc=Enable OSPFv3 SNMP notifications
ip-snmp (optional)
Boolean desc=Enable ipForward SNMP MIB
no-bgp-redist-static-route-map (optional)
Boolean desc=Remove route map for BGP static redistribution:precludes=[bgp-redist-static-route-map]
no-bgp-redist-connected-route-map (optional)
Boolean desc=Remove route map for BGP connected redistribution:precludes=[bgp-redist-connected-route-map]
no-bgp-redist-ospf-route-map (optional)
Boolean desc=Remove route map for BGP OSPF redistribution:precludes=[bgp-redist-ospf-route-map]
bgp-graceful-shutdown (optional)
Boolean desc=BGP graceful shutdown RFC 8326
bgp-as (optional)
Long desc=BGP Autonomous System number from 1 to 4294967295:type=uint32:range=[1,4294967295] format: int64
bgp-redistribute (optional)
String desc=BGP route redistribution:type=flag
Enum:
static
connected
rip
ospf
bgp-max-paths (optional)
Integer desc=maximum BGP paths:type=uint16:range=[0,16]:default=1 format: int32
bgp-ibgp-multipath (optional)
Integer desc=number of IBGP multipath connections:type=uint16:range=[0,16] format: int32
router-id (optional)
String desc=OSPF and BGP router id:type=IPv4 or IPv6 address
hw-vrrp-id (optional)
Integer desc=VRRP ID assigned to the hardware vRouter:default=-1 format: int32

vrouter-ecmp-cached-routes-show - Up

display ecmp cached routes for a virtual router (vrouter)
api.switch-name (optional)
vrid (optional)
Integer desc=ID assigned to vRouter format: int32
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address
prelen (optional)
Long desc=prefix length:type=uint32:range=[0,128] format: int64
nexthop (optional)
String desc=next-hop IP address:type=IPv4 or IPv6 address
vlan (optional)
Integer desc=VLAN:type=uint16:range=[0,4095] format: int32
age-in-seconds (optional)
Long desc=route age in seconds:type=uint64 format: int64

vrouter-ecmp-group-show - Up

display ECMP groups shared among different routes for a vrouter
api.switch-name (optional)
vrid (optional)
Integer desc=virtual router ID format: int32
nexthop_count (optional)
Integer desc=nexthop count format: int32
ecmp-ref-count (optional)
Integer desc=ECMP group reference count format: int32
ecmp-group (optional)
Integer desc=ECMP group format: int32
nexthop_ip (optional)
String desc=nexthop IP address:type=IPv4 or IPv6 address
hash-type (optional)
String desc=ECMP hash type:type=enum
Enum:
static-fixed
resilient
dynamic-normal

vrouter-evpn-arp-cache-show - Up

display zebra evpn arp cache data
api.switch-name (optional)
vni (optional)
Long desc=VXLAN identifier for tunnel, value 0 indicates unconfigure vxlan:type=uint32:range=[0,16777215] format: int64
ip (optional)
String desc=ip
mac (optional)
String desc=mac
state (optional)
String desc=state
local-seq (optional)
Long desc=local_seq:type=uint32 format: int64
remote-vtep (optional)
String desc=remote vtep
type (optional)
String desc=type
remote-seq (optional)
Long desc=remote seq:type=uint32 format: int64

vrouter-evpn-bgp-neighbor-no-shutdown - Up

remove shutdown mode for EVPN bgp peer
neighbor (optional)
String desc=BGP neighbor:type=IPv4 or IPv6 address
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
l3-port (optional)
Long desc=Layer 3 port used for BGP:type=uint32 format: int64

vrouter-evpn-bgp-neighbor-reset - Up

reset information about EVPN BGP neighbors
neighbor (optional)
String desc=BGP neighbor:type=IPv4 or IPv6 address
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
l3-port (optional)
Long desc=Layer 3 port used for BGP:type=uint32 format: int64

vrouter-evpn-bgp-neighbor-reset-all - Up

reset information about all EVPN BGP neighbors
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-evpn-bgp-neighbor-show - Up

display EVPN BGP neighbor summary information
api.switch-name (optional)
neighbor
String desc=BGP neighbor:type=IPv4 or IPv6 address
nic
String desc=BGP on this interface
tblver (optional)
Long desc=version of the routing table:type=uint32 format: int64
inQ (optional)
Long desc=number of BGP packets queued for a neighbor:type=uint64 format: int64
outQ (optional)
Long desc=number of BGP packets queued for transmission to a neighbor:type=uint64 format: int64
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
ver (optional)
Long desc=BGP version:type=uint32 format: int64
state/pfxrcd (optional)
String desc=current state of BGP session
msg_rcvd (optional)
Long desc=number of messages received from the socket buffer:type=uint64 format: int64
msg_sent (optional)
Long desc=number of messages sent from the socket buffer:type=uint64 format: int64
up/down (optional)
String desc=state of BGP neighbor
remote-router (optional)
String desc=nbr router name
remote-as (optional)
Long desc=BGP neighbor AS:type=uint32 format: int64
description (optional)
String desc=vrouter bgp neighbor description
l3-port (optional)
Long desc=Layer 3 port used for BGP:type=uint32 format: int64

vrouter-evpn-bgp-neighbor-shutdown - Up

send EVPN bgp admin-down notification message to EVPN bgp peer
neighbor (optional)
String desc=BGP neighbor:type=IPv4 or IPv6 address
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
l3-port (optional)
Long desc=Layer 3 port used for BGP:type=uint32 format: int64

vrouter-evpn-bgp-neighbor-summary-show - Up

display BGP evpn summary data
api.switch-name (optional)
neighbor (optional)
String desc=neighbor
ver (optional)
Long desc=ver:type=uint32 format: int64
state (optional)
String desc=state
pfxrcd (optional)
Long desc=pfxrcd:type=uint32 format: int64
msg-rcvd (optional)
Long desc=msg_rcvd:type=uint32 format: int64
msg-sent (optional)
Long desc=msg_sent:type=uint32 format: int64
InQ (optional)
Long desc=InQ:type=uint32 format: int64
OutQ (optional)
Long desc=OutQ:type=uint32 format: int64
up/down (optional)
String desc=up/down
as (optional)
Long desc=remote as:type=uint32 format: int64
Tb/Ver (optional)
Long desc=Tb/Ver:type=uint32 format: int64

vrouter-evpn-bgp-routes-show - Up

display BGP evpn data
api.switch-name (optional)
rd (optional)
String desc=route distinguisher
mac (optional)
String desc=mac:type=mac-address
ip (optional)
String desc=ip:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=ip subnet netmask:type=netmask:mask-for=[ip] format: int32
metric (optional)
Long desc=metric:type=uint32 format: int64
locprf (optional)
Long desc=locprf:type=uint32 format: int64
weight (optional)
Long desc=weight:type=uint32 format: int64
origin (optional)
String desc=origin
as-path (optional)
String desc=path
route-type (optional)
String desc=specific route type:type=enum
Enum:
2
3
5
extended-community (optional)
String desc=extended community
vni (optional)
String desc=VXLAN identifier for tunnel
best-route (optional)
Boolean desc=best EVPN route
next-hop (optional)
String desc=next hop

vrouter-evpn-bgp-vni-show - Up

display evpn vni data
api.switch-name (optional)
vni (optional)
Long desc=VXLAN identifier for tunnel, value 0 indicates unconfigure vxlan:type=uint32 format: int64
rd (optional)
String desc=route distinguisher
type (optional)
String desc=type L2/L3
import-rt (optional)
String desc=import rt
export-rt (optional)
String desc=export rt

vrouter-evpn-duplicate-mac-show - Up

BGP evpn duplicate MAC display
api.switch-name (optional)
seq (optional)
Long desc=sequence number assigned to the mac which denotes the number of moves:type=uint32:range=[1,4294967295] format: int64
host-mac (optional)
String desc=host mac address:type=mac-address

vrouter-evpn-vni-mac-show - Up

display zebra evpn mac data
api.switch-name (optional)
vni (optional)
Long desc=VXLAN identifier for tunnel, value 0 indicates unconfigure vxlan:type=uint32:range=[0,16777215] format: int64
mac (optional)
String desc=mac
vlan (optional)
Long desc=vlan:type=uint32 format: int64
type (optional)
String desc=type
local-seq (optional)
Long desc=local seq:type=uint32 format: int64
remote-seq (optional)
Long desc=remote seq:type=uint32 format: int64
intf/remote-vtep (optional)
String desc=intf

vrouter-fib-arps-show - Up

display forwarding information database ARP information
api.switch-name (optional)
vrid (optional)
Integer desc=virtual router ID format: int32
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address
vlan (optional)
Integer desc=VLAN:type=uint16:range=[0,4095] format: int32
mac (optional)
String desc=MAC address:type=mac-address
flags (optional)
String desc=hardware route flags:type=flag
Enum:
ECMP
Trunk
route-to-if
local-subnet
hit
KEEP-SMAC
KEEP-TTL
KEEP-VLAN
drop
evpn
vrf-subnet
if-id (optional)
Integer desc=interface ID:type=uint16 format: int32
egress-id (optional)
Long desc=egress ID:type=uint32 format: int64
ports (optional)
String desc=ports:type=port-list
vnet-id (optional)
String desc=VNET of the VLAN:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

vrouter-fib-routes-show - Up

display routes in forwarding information database
api.switch-name (optional)
vrid (optional)
Integer desc=ID assigned to vRouter:type=uint16 format: int32
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address
prelen (optional)
Long desc=prefix length:type=uint32:range=[0,128] format: int64
nexthop (optional)
String desc=next-hop IP address:type=IPv4 or IPv6 address
vlan (optional)
Integer desc=VLAN:type=uint16:range=[0,4095] format: int32
port (optional)
Long desc=port:type=uint32 format: int64
flags (optional)
String desc=flags:type=flag
Enum:
ECMP
Trunk
route-to-if
local-subnet
hit
KEEP-SMAC
KEEP-TTL
KEEP-VLAN
drop
evpn
vrf-subnet
state (optional)
String desc=hardware route state:type=enum
Enum:
up
admin-down
if-admin-down
if-vlan-down
nexthop-up
nexthop-down
nexthop-mac (optional)
String desc=next-hop MAC address:type=mac-address
if-ip (optional)
String desc=interface IP address:type=IPv4 or IPv6 address
intf-id (optional)
Integer desc=ID assigned to interface format: int32
ecmp-group (optional)
Integer desc=ECMP Group name format: int32
egress-id (optional)
Long desc=egress ID:type=uint32 format: int64
vnet-id (optional)
String desc=VNET of the VLAN:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=route Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

vrouter-igmp-static-join-add - Up

add an IGMP static join
name
String desc=IGMP group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
group-ip
String desc=IGMP group IP address:type=IPv4 or IPv6 address
source-ip
String desc=source IP address:type=IPv4 or IPv6 address
interface
String desc=IGMP interface:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic

vrouter-igmp-static-join-show - Up

display information about IGMP static join
api.switch-name (optional)
name
String desc=IGMP group name
group-ip (optional)
String desc=IGMP group IP address:type=IPv4 or IPv6 address
source-ip (optional)
String desc=source IP address:type=IPv4 or IPv6 address
interface (optional)
String desc=IGMP interface:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic

vrouter-interface-add - Up

add an interface to a vRouter
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
ip2 (optional)
String desc=Second IP address:type=IPv4 or IPv6 address:requires=[netmask2]:precludes=[assignment2]
netmask2 (optional)
Integer desc=Second IP netmask:type=netmask:requires=[ip2]:precludes=[assignment2]:mask-for=[ip2] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
exclusive (optional)
Boolean desc=exclusive interface:default=false:precludes=[l3-port]
pim (optional)
Boolean desc=VNIC is a pim interface:default=false
mtu (optional)
Integer desc=Interface MTU:type=uint16:range=[68,9398]:default=1500 format: int32
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[vlan]:precludes=[vnet-id]
Enum:
public
private
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan :default=false
vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
ipv6-unnumbered (optional)
Boolean desc=IPv6 address is LinkLocal only:requires=[l3-port]
if (optional)
String desc=interface type:type=enum:precludes=[alias-on]
Enum:
mgmt
data
span
span2
span3
alias-on (optional)
String desc=alias name:precludes=[vlan,if,nic]
nic-config (optional)
Boolean desc=NIC config:default=true
pim-dr-priority (optional)
Long desc=designated router priority for PIM interface:type=uint32:range=[1,4294967295]:default=1 format: int64
pim-cluster (optional)
Boolean desc=VNIC on exclusive transit VLAN:default=false
fabric-nic (optional)
Boolean desc=VNIC is on a vlan used for fabric setup:default=false
vrrp-id (optional)
Long desc=ID assigned to VRRP:type=uint32:range=[0,255]:requires=[vrrp-primary] format: int64
vrrp-primary (optional)
String desc=VRRP primary interface
vrrp-adv-int (optional)
Integer desc=VRRP Advertisement Interval (ms, min 300, max 40950, default 1000):type=uint16:range=[300,40950] format: int32
vrrp-preempt-mode (optional)
String desc=Used to allow/prevent high prio BACKUP from becoming MASTER:type=enum:default=enable
Enum:
disable
enable
l3-port (optional)
Long desc=Layer 3 port:type=uint32:default=4294967295:precludes=[exclusive]:api-ref-path=/l3port-usable-ports:api-ref-model=l3port-usable-port-show:api-ref-id=intf:api-ref-val=name format: int64
secondary-macs (optional)
String desc=secondary MAC addresses:pattern=^[a-fA-F0-9:,]+$|^none$|^$
if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
priority-tag (optional)
Boolean desc=Add priority tag on forwarded traffic:default=false

vrouter-interface-config-add - Up

add an interface configuration to a vRouter
l3-port (optional)
Long desc=l3 port for interface:type=uint32:default=4294967295:precludes=[nic]:api-ref-path=/l3port-usable-ports:api-ref-model=l3port-usable-port-show:api-ref-id=intf:api-ref-val=name format: int64
ospf-hello-interval (optional)
Long desc=OSPF hello interval from 1 to 65535 - default 10 (IPv4 or v6):type=uint32:range=[1,65535]:default=10 format: int64
ospf-dead-interval (optional)
Long desc=OSPF dead interval from 2 to 65535 - default 40 (IPv4 or v6):type=uint32:range=[2,65535]:default=40 format: int64
ospf-retransmit-interval (optional)
Long desc=OSPF retransmit interval from 3 to 65535 - default 5 (IPv4 or v6):type=uint32:range=[3,65535]:default=5 format: int64
ospf-priority (optional)
Integer desc=OSPF priority from 0 to 255 - default 1 (IPv4 or v6):type=uint16:range=[0,255]:default=1 format: int32
ospf-auth-key (optional)
String desc=OSPF authentication key (IPv4 only):precludes=[ospf-msg-digest-id,ospf-msg-digest-key]
ospf-cost (optional)
Long desc=OSPF Cost (IPv4 or v6):type=uint32:range=[0,65535] format: int64
ospf-msg-digest-id (optional)
Integer desc=OSPF digest ID from 0 to 255 (IPv4 only):type=uint16:range=[0,255]:precludes=[ospf-auth-key] format: int32
ospf-msg-digest-key (optional)
String desc=OSPF MSG digest key (IPv4 only):requires=[ospf-msg-digest-id]:precludes=[ospf-auth-key]
ospf-passive-if (optional)
Boolean desc=OSPF passive interface (IPv4 or v6)
ospf-network-type (optional)
String desc=OSPF network type (IPv4 or v6):type=enum:default=default
Enum:
default
point-to-point
ospf-bfd (optional)
String desc=BFD protocol support for OSPF fault detection:type=enum
Enum:
default
enable
disable
bfd-interval (optional)
Long desc=BFD desired transmit interval from 200 ms to 3000 ms - default 750 ms:type=uint32:range=[200,3000]:default=750 format: int64
bfd-min-rx (optional)
Long desc=BFD required minimum receive interval from 200 ms to 3000 ms - default 500 ms:type=uint32:range=[200,3000]:default=500 format: int64
bfd-multiplier (optional)
Integer desc=BFD detection multiplier from 2 to 20 - default 3:type=uint8:range=[2,20]:default=3 format: int32
suppress-ra (optional)
Boolean desc=Control transmit of IPv6 Router Advertisements:default=true
ra-interval (optional)
Long desc=Time interval between ipv6 router advertisements:type=uint32:range=[1,1800]:default=600 format: int64
ra-lifetime (optional)
Long desc=Time for which router is considered as default router:type=uint32:range=[0,9000]:default=1800 format: int64
nic (optional)
String desc=vnic name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[l3-port]:api-ref-path=/vrouters/{vrouter-name}/if-lists:api-ref-model=vrouter-if-list-show:api-ref-id=nic:api-ref-val=nic

vrouter-interface-config-modify - Up

modify an interface configuration to a vRouter
ospf-hello-interval (optional)
Long desc=OSPF hello interval from 1 to 65535 - default 10 (IPv4 or v6):type=uint32:range=[1,65535]:default=10 format: int64
ospf-dead-interval (optional)
Long desc=OSPF dead interval from 2 to 65535 - default 40 (IPv4 or v6):type=uint32:range=[2,65535]:default=40 format: int64
ospf-retransmit-interval (optional)
Long desc=OSPF retransmit interval from 3 to 65535 - default 5 (IPv4 or v6):type=uint32:range=[3,65535]:default=5 format: int64
ospf-priority (optional)
Integer desc=OSPF priority from 0 to 255 - default 1 (IPv4 or v6):type=uint16:range=[0,255]:default=1 format: int32
ospf-auth-key (optional)
String desc=OSPF authentication key (IPv4 only):precludes=[ospf-msg-digest-id,ospf-msg-digest-key]
ospf-cost (optional)
Long desc=OSPF Cost (IPv4 or v6):type=uint32:range=[0,65535] format: int64
ospf-msg-digest-id (optional)
Integer desc=OSPF digest ID from 0 to 255 (IPv4 only):type=uint16:range=[0,255]:precludes=[ospf-auth-key] format: int32
ospf-msg-digest-key (optional)
String desc=OSPF MSG digest key (IPv4 only):requires=[ospf-msg-digest-id]:precludes=[ospf-auth-key]
ospf-passive-if (optional)
Boolean desc=OSPF passive interface (IPv4 or v6)
ospf-network-type (optional)
String desc=OSPF network type (IPv4 or v6):type=enum:default=default
Enum:
default
point-to-point
ospf-bfd (optional)
String desc=BFD protocol support for OSPF fault detection:type=enum
Enum:
default
enable
disable
bfd-interval (optional)
Long desc=BFD desired transmit interval from 200 ms to 3000 ms - default 750 ms:type=uint32:range=[200,3000]:default=750 format: int64
bfd-min-rx (optional)
Long desc=BFD required minimum receive interval from 200 ms to 3000 ms - default 500 ms:type=uint32:range=[200,3000]:default=500 format: int64
bfd-multiplier (optional)
Integer desc=BFD detection multiplier from 2 to 20 - default 3:type=uint8:range=[2,20]:default=3 format: int32
suppress-ra (optional)
Boolean desc=Control transmit of IPv6 Router Advertisements:default=true
ra-interval (optional)
Long desc=Time interval between ipv6 router advertisements:type=uint32:range=[1,1800]:default=600 format: int64
ra-lifetime (optional)
Long desc=Time for which router is considered as default router:type=uint32:range=[0,9000]:default=1800 format: int64

vrouter-interface-config-raprefix-add - Up

add prefix advertised in RA
v6-ra-prefix
String desc=IPv6 prefix to include in Router Advertisement:type=IPv4 or IPv6 address
nic
String desc=vnic name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
prefix-netmask (optional)
Integer desc=v6 prefix netmask:type=netmask:default=64:requires=[v6-ra-prefix]:mask-for=[v6-ra-prefix] format: int32
autoconf (optional)
Boolean desc=given prefix can be used for IPv6 autoconf:requires=[v6-ra-prefix]

vrouter-interface-config-raprefix-show - Up

display prefixes advertised in RA
api.switch-name (optional)
v6-ra-prefix
String desc=IPv6 prefix to include in Router Advertisement:type=IPv4 or IPv6 address
nic
String desc=vnic name:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
prefix-netmask (optional)
Integer desc=v6 prefix netmask:type=netmask:requires=[v6-ra-prefix]:mask-for=[v6-ra-prefix] format: int32
autoconf (optional)
Boolean desc=given prefix can be used for IPv6 autoconf:requires=[v6-ra-prefix]

vrouter-interface-config-show - Up

display interface configuration for a vRouter
api.switch-name (optional)
l3-port
Long desc=l3 port for interface:type=uint32:precludes=[nic]:api-ref-path=/l3port-usable-ports:api-ref-model=l3port-usable-port-show:api-ref-id=intf:api-ref-val=name format: int64
nic
String desc=vnic name:precludes=[l3-port]:api-ref-path=/vrouters/{vrouter-name}/if-lists:api-ref-model=vrouter-if-list-show:api-ref-id=nic:api-ref-val=nic
vrf (optional)
String desc=name of vrf
ospf-hello-interval (optional)
Long desc=OSPF hello interval from 1 to 65535 - default 10 (IPv4 or v6):type=uint32:range=[1,65535] format: int64
ospf-dead-interval (optional)
Long desc=OSPF dead interval from 2 to 65535 - default 40 (IPv4 or v6):type=uint32:range=[2,65535] format: int64
ospf-retransmit-interval (optional)
Long desc=OSPF retransmit interval from 3 to 65535 - default 5 (IPv4 or v6):type=uint32:range=[3,65535] format: int64
ospf-priority (optional)
Integer desc=OSPF priority from 0 to 255 - default 1 (IPv4 or v6):type=uint16:range=[0,255] format: int32
ospf-auth-key (optional)
String desc=OSPF authentication key (IPv4 only):precludes=[ospf-msg-digest-id,ospf-msg-digest-key]
ospf-cost (optional)
Long desc=OSPF Cost (IPv4 or v6):type=uint32:range=[0,65535] format: int64
ospf-msg-digest-id (optional)
Integer desc=OSPF digest ID from 0 to 255 (IPv4 only):type=uint16:range=[0,255]:precludes=[ospf-auth-key] format: int32
ospf-msg-digest-key (optional)
String desc=OSPF MSG digest key (IPv4 only):requires=[ospf-msg-digest-id]:precludes=[ospf-auth-key]
ospf-passive-if (optional)
Boolean desc=OSPF passive interface (IPv4 or v6)
ospf-network-type (optional)
String desc=OSPF network type (IPv4 or v6):type=enum
Enum:
default
point-to-point
ospf-bfd (optional)
String desc=BFD protocol support for OSPF fault detection:type=enum
Enum:
default
enable
disable
bfd-interval (optional)
Long desc=BFD desired transmit interval from 200 ms to 3000 ms - default 750 ms:type=uint32:range=[200,3000] format: int64
bfd-min-rx (optional)
Long desc=BFD required minimum receive interval from 200 ms to 3000 ms - default 500 ms:type=uint32:range=[200,3000] format: int64
bfd-multiplier (optional)
Integer desc=BFD detection multiplier from 2 to 20 - default 3:type=uint8:range=[2,20] format: int32
suppress-ra (optional)
Boolean desc=Control transmit of IPv6 Router Advertisements
ra-interval (optional)
Long desc=Time interval between ipv6 router advertisements:type=uint32:range=[1,1800] format: int64
ra-lifetime (optional)
Long desc=Time for which router is considered as default router:type=uint32:range=[0,9000] format: int64

vrouter-interface-ip-add - Up

add an IP address on interface from a vRouter
nic
String desc=virtual NIC assigned to interface:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:mask-for=[ip] format: int32
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
type (optional)
String desc=ip address type primary/secondary:type=enum:default=primary
Enum:
primary
secondary

vrouter-interface-ip-show - Up

display IP addresses on a interface on a vRouter
api.switch-name (optional)
ip
String desc=IP address:type=IPv4 or IPv6 address:precludes=[assignment]
vrf
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
nic
String desc=virtual NIC assigned to interface:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:mask-for=[ip] format: int32
flags (optional)
String desc=ip address flags:type=flag
Enum:
duplicate
unavailable
assignment (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip,netmask]
Enum:
none
dhcp
dhcpv6
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
type (optional)
String desc=ip address type primary/secondary:type=enum
Enum:
primary
secondary

vrouter-interface-modify - Up

modify an interface on a vRouter
pim (optional)
Boolean desc=VNIC is a pim interface:default=false
mtu (optional)
Integer desc=Interface MTU:type=uint16:range=[68,9398]:default=1500 format: int32
wake-on-lan (optional)
Boolean desc=wake on lan :default=false
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
nic-config (optional)
Boolean desc=NIC config:default=true
pim-dr-priority (optional)
Long desc=designated router priority for PIM interface:type=uint32:range=[1,4294967295]:default=1 format: int64
pim-cluster (optional)
Boolean desc=VNIC on exclusive transit VLAN:default=false
fabric-nic (optional)
Boolean desc=VNIC is on a vlan used for fabric setup:default=false
vrrp-adv-int (optional)
Integer desc=VRRP Advertisement Interval (ms, min 300, max 40950, default 1000):type=uint16:range=[300,40950] format: int32
vrrp-preempt-mode (optional)
String desc=Used to allow/prevent high prio BACKUP from becoming MASTER:type=enum:default=enable
Enum:
disable
enable
priority-tag (optional)
Boolean desc=Add priority tag on forwarded traffic:default=false

vrouter-interface-show - Up

display interfaces on a vRouter
api.switch-name (optional)
nic
String desc=virtual NIC assigned to interface
l3-port
Long desc=Layer 3 port:type=uint32:precludes=[exclusive]:api-ref-path=/l3port-usable-ports:api-ref-model=l3port-usable-port-show:api-ref-id=intf:api-ref-val=name format: int64
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[assignment]
netmask (optional)
Integer desc=netmask:type=netmask:requires=[ip]:precludes=[assignment]:mask-for=[ip] format: int32
ip2 (optional)
String desc=Second IP address:type=IPv4 or IPv6 address:requires=[netmask2]:precludes=[assignment2]
netmask2 (optional)
Integer desc=Second IP netmask:type=netmask:requires=[ip2]:precludes=[assignment2]:mask-for=[ip2] format: int32
linklocal (optional)
String desc=IPv6 Link Local address:type=IPv4 or IPv6 address
mac (optional)
String desc=interface MAC address:type=mac-address
exclusive (optional)
Boolean desc=exclusive interface:precludes=[l3-port]
pim (optional)
Boolean desc=VNIC is a pim interface
mtu (optional)
Integer desc=Interface MTU:type=uint16:range=[68,9398] format: int32
vrf (optional)
String desc=name of vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
public-vlan (optional)
Integer desc=interface public VLAN:type=uint16:range=[0,4095] format: int32
nic-state (optional)
String desc=NIC state:type=enum
Enum:
down
up
is-primary (optional)
Boolean desc=Primary VRRP interface
is-primary2 (optional)
Boolean desc=Primary VRRP interface for Second IP
is-vip (optional)
Boolean desc=VIP VRRP interface
pim-vlag-vlan (optional)
Boolean desc=VNIC is on a vlan with a VLAG
vrrp-state (optional)
String desc=state of VRRP:type=enum
Enum:
slave
master
sriov-vf (optional)
Boolean desc=sriov vnic:precludes=[vm-nic-type,mirror-traffic]
mirror-traffic (optional)
Boolean desc=Mirror physical nic traffic to vnic:precludes=[sriov-vf]
vlan-type (optional)
String desc=interface VLAN type:type=enum:requires=[vlan]:precludes=[vnet-id]
Enum:
public
private
vnet-id (optional)
String desc=interface VLAN VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd (optional)
String desc=interface Bridge Domain:precludes=[alias-on]:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
wake-on-lan (optional)
Boolean desc=wake on lan
vlan (optional)
Integer desc=interface VLAN:type=uint16:range=[0,4095]:precludes=[alias-on] format: int32
assignment2 (optional)
String desc=type of IP address assignment:type=enum:precludes=[ip2,netmask2]
Enum:
none
dhcp
dhcpv6
assignment-linklocal (optional)
String desc=type of IPv6 linklocal address assignment:type=enum:precludes=[linklocal]
Enum:
none
dhcp
dhcpv6
vrrp-priority (optional)
Integer desc=VRRP priority for interface:type=uint8:range=[0,254] format: int32
sec-addresses (optional)
Integer desc=Number of IP and IPv6 addresses configured on this interface:type=uint8 format: int32
ipv6-unnumbered (optional)
Boolean desc=IPv6 address is LinkLocal only:requires=[l3-port]
if (optional)
String desc=interface type:type=enum:precludes=[alias-on]
Enum:
mgmt
data
span
span2
span3
alias-on (optional)
String desc=alias name:precludes=[vlan,if,nic]
nic-config (optional)
Boolean desc=NIC config
pim-dr-priority (optional)
Long desc=designated router priority for PIM interface:type=uint32:range=[1,4294967295] format: int64
pim-cluster (optional)
Boolean desc=VNIC on exclusive transit VLAN
fabric-nic (optional)
Boolean desc=VNIC is on a vlan used for fabric setup
vrrp-id (optional)
Long desc=ID assigned to VRRP:type=uint32:range=[0,255]:requires=[vrrp-primary] format: int64
vrrp-primary (optional)
String desc=VRRP primary interface
vrrp-adv-int (optional)
Integer desc=VRRP Advertisement Interval (ms, min 300, max 40950, default 1000):type=uint16:range=[300,40950] format: int32
vrrp-preempt-mode (optional)
String desc=Used to allow/prevent high prio BACKUP from becoming MASTER:type=enum
Enum:
disable
enable
secondary-macs (optional)
String desc=secondary MAC addresses
if-nat-realm (optional)
String desc=NAT interface realm:type=enum
Enum:
internal
external
priority-tag (optional)
Boolean desc=Add priority tag on forwarded traffic
vm-nic-type (optional)
String desc=interface NIC type:type=enum:precludes=[sriov-vf]
Enum:
e1000
virtio

vrouter-log-clear - Up

clear vrouter protocol logs
vrouter-name
String desc=name of the vrouter service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
protocol (optional)
String desc=vrouter protocol name:type=enum
Enum:
zebra
ospf
ospf6
bgp
bfd
rip
routesnoop
evpnsnoop

vrouter-log-show - Up

show vrouter protocol logs
api.switch-name (optional)
vrouter-name
String desc=name of the vrouter service:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
protocol (optional)
String desc=vrouter protocol name:type=enum
Enum:
zebra
ospf
ospf6
bgp
bfd
rip
routesnoop
evpnsnoop

vrouter-loopback-interface-add - Up

add a loopback interface to a vRouter
ip
String desc=loopback IP address:type=IPv4 or IPv6 address
index (optional)
Integer desc=loopback index from 1 to 255:type=uint16:range=[1,255] format: int32

vrouter-loopback-interface-show - Up

display a loopback interfaces on a vRouter
api.switch-name (optional)
index
Integer desc=loopback index from 1 to 255:type=uint16:range=[1,255] format: int32
ip (optional)
String desc=loopback IP address:type=IPv4 or IPv6 address
router-if (optional)
String desc=internal loopback IP bound to this router interface:api-ref-path=/vrouter-hw-ifs:api-ref-model=vrouter-hw-if-show:api-ref-id=name:api-ref-val=name

vrouter-mac-list-add - Up

add a mac list
name
String desc=name created for the mac list:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
action
String desc=the prefix list to permit or deny packets:type=enum
Enum:
permit
deny
mac
String desc=mac address assigned to the mac list:type=mac-address:precludes=[any]
seq
Long desc=sequence number assigned to the mac list - a value between 1 and 4294967295:type=uint32:range=[1,4294967295] format: int64

vrouter-mac-list-add-1 - Up

add a mac list
name
String desc=name created for the mac list:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
action
String desc=the prefix list to permit or deny packets:type=enum
Enum:
permit
deny
any
Boolean desc=apply to any mac address:precludes=[mac]
seq
Long desc=sequence number assigned to the mac list - a value between 1 and 4294967295:type=uint32:range=[1,4294967295] format: int64

vrouter-mac-list-modify - Up

modify a mac list to filter
action (optional)
String desc=the prefix list to permit or deny packets:type=enum
Enum:
permit
deny
mac (optional)
String desc=mac address assigned to the mac list:type=mac-address:precludes=[any]
any (optional)
Boolean desc=apply to any mac address:precludes=[mac]

vrouter-mac-list-show - Up

display mac lists that filter
api.switch-name (optional)
name
String desc=name created for the mac list
seq
Long desc=sequence number assigned to the mac list - a value between 1 and 4294967295:type=uint32:range=[1,4294967295] format: int64
action (optional)
String desc=the prefix list to permit or deny packets:type=enum
Enum:
permit
deny
mac (optional)
String desc=mac address assigned to the mac list:type=mac-address:precludes=[any]
any (optional)
Boolean desc=apply to any mac address:precludes=[mac]

vrouter-mfib-routes-show - Up

display multicast routes in forwarding information database
api.switch-name (optional)
srcip (optional)
String desc=source IP address:type=IPv4 or IPv6 address
vlan (optional)
Integer desc=VLAN ID:type=uint16:range=[0,4095] format: int32
vrid (optional)
Integer desc=virtual router ID format: int32
flags (optional)
String desc=hardware flags:type=flag
Enum:
Trunk
Active
type (optional)
String desc=hardware router type:type=enum
Enum:
<*
G>
<*
G
V>
G>
G
V>
srcip-mask (optional)
Integer desc=source netmask:type=uint8 format: int32
group-mask (optional)
Integer desc=group net mask:type=uint8 format: int32
hw-group-id (optional)
String desc=group ID:type=uint32:hex=0x[0-9a-fA-F]{8}
vnet-id (optional)
String desc=VNET of the sending VLAN:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
send-vlan (optional)
Integer desc=sending VLAN:type=uint16:range=[0,4095] format: int32
send-bd (optional)
String desc=sending Bridge Domain
encap-id (optional)
Integer desc=encapsulation ID format: int32
group (optional)
String desc=group IP address:type=IPv4 or IPv6 address
ports (optional)
String desc=ports:type=port-list
bd (optional)
String desc=Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

vrouter-migrate - Up

migrate a vRouter configuration
name
String desc=name of service config:pattern=^[a-zA-Z_-][a-zA-Z0-9_-]+$:pattern-help=letters, numbers, , _, and -. Must start with a letter
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name

vrouter-modify - Up

modify a vRouter
bgp-redist-static-route-map (optional)
String desc=route map for BGP redistribution of static routes:precludes=[no-bgp-redist-static-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
bgp-redist-connected-route-map (optional)
String desc=route map for BGP redistribution of connected routes:precludes=[no-bgp-redist-connected-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
bgp-redist-ospf-route-map (optional)
String desc=route map for BGP redistribution of OSPF routes:precludes=[no-bgp-redist-ospf-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
ospf-redist-connected-route-map (optional)
String desc=route map for OSPF redistribution of connected routes:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
ospf-redist-bgp-route-map (optional)
String desc=route map for OSPF redistribution of BGP routes:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
ospf-default-info-originate-route-map (optional)
String desc=route map for OSPF origination of default route:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
ospf-redist-static-route-map (optional)
String desc=route map for OSPF redistribution of static routes:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
state (optional)
String desc=state of service:type=enum
Enum:
disable
enable
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name
evpn-border (optional)
Boolean desc=evpn border node:default=false
evpn-export-all-leaked-networks (optional)
String desc=exporting leaked subnets to eVPN overlay:type=enum:default=permit
Enum:
permit
deny
evpn-dup-addr-max-moves (optional)
Long desc=evpn duplicate address max moves:type=uint32:range=[2,1000]:default=5 format: int64
evpn-dup-addr-moves-duration (optional)
Long desc=evpn duplicate address moves time duration (seconds):type=uint32:range=[2,1800]:default=180 format: int64
evpn-dup-addr-freeze (optional)
Integer desc=evpn duplicate address freeze duration (seconds):range=[-1,3600]:default=180 format: int32
api.evpn-dup-addr-freeze (optional)
Enum:
none
permanent
cluster-active-active-routing (optional)
Boolean desc=active-active routing with or without VRRP
bgp-redist-static-metric (optional)
Long desc=BGP route redistribution static metric:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-static-metric (optional)
Enum:
none
bgp-redist-connected-metric (optional)
Long desc=metric for redistributing BGP connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-connected-metric (optional)
Enum:
none
bgp-redist-rip-metric (optional)
Long desc=metric for redistributing RIP connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-rip-metric (optional)
Enum:
none
bgp-redist-ospf-metric (optional)
Long desc=metric for BGP to redistribute OSPF connected routes:range=[-1,4294967295]:default=-1 format: int64
api.bgp-redist-ospf-metric (optional)
Enum:
none
bgp-cluster-id (optional)
String desc=IP address for BGP cluster ID:type=IPv4 or IPv6 address
bgp-bestpath-as-path (optional)
String desc=best path for BGP:type=flag
Enum:
ignore
multipath-relax
bgp-dampening (optional)
Boolean desc=dampening for BGP routes
bgp-delayed-startup (optional)
Integer desc=Delays forming peer adjacency on bootup:type=uint16:range=[0,36000]:default=0 format: int32
bgp-network-import-check (optional)
Boolean desc=Check BGP network route exists in IGP
bgp-update-delay-strict (optional)
Integer desc=Put bgp read-only mode on bootup, Recommend value less than l3-to-vlag-delay:type=uint16:range=[0,3600]:default=0 format: int32
bgp-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds) - default 60:type=uint32:range=[0,65535]:default=60:requires=[bgp-holdtime] format: int64
bgp-holdtime (optional)
Long desc=BGP Holdtime (seconds) - default 180:type=uint32:range=[0,65535]:default=180 format: int64
bgp-distance-external (optional)
Long desc=BGP distance for routes external to AS:type=uint32:range=[0,255]:requires=[bgp-distance-internal,bgp-distance-local] format: int64
bgp-distance-internal (optional)
Long desc=BGP distance for routes internal to AS:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-distance-local (optional)
Long desc=BGP distance for local routes:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
ospf-spf-delay (optional)
Long desc= Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000]:default=0 format: int64
ospf-spf-consec-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000]:default=50 format: int64
ospf-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000]:default=5000 format: int64
ospf6-spf-delay (optional)
Long desc=Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000]:default=0 format: int64
ospf6-spf-consecu-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000]:default=50 format: int64
ospf6-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000]:default=5000 format: int64
bgp-global-nh-preference (optional)
String desc=use global nexthop preference for choosing nexthop type in BGP-ipv6:type=enum:default=none
Enum:
none
true
false
rip-redistribute (optional)
String desc=redistribute RIP routes:type=flag
Enum:
static
connected
ospf
bgp
ospf-redistribute (optional)
String desc=redistribute OSPF routes:type=flag
Enum:
static
connected
rip
bgp
ospf-redist-static-metric (optional)
Integer desc=metric for OSPF redistribution of static routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-static-metric (optional)
Enum:
none
ospf-redist-static-metric-type (optional)
String desc=metric type for OSPF redistribution of static routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-connected-metric (optional)
Integer desc=metric for OSPF redistribution of connected routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-connected-metric (optional)
Enum:
none
ospf-redist-connected-metric-type (optional)
String desc=metric type for OSPF redistribution of connected routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-rip-metric (optional)
Integer desc=metric for OSPF redistribution of RIP routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-rip-metric (optional)
Enum:
none
ospf-redist-rip-metric-type (optional)
String desc=metric type for OSPF redistribution of RIP routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-redist-bgp-metric (optional)
Integer desc=metric for OSPF redistribution of BGP routes (IPv4 only):range=[-1,16777214]:default=-1 format: int32
api.ospf-redist-bgp-metric (optional)
Enum:
none
ospf-redist-bgp-metric-type (optional)
String desc=metric type for OSPF redistribution of BGP routes (IPv4 only):type=enum:default=2
Enum:
1
2
ospf-distance-external (optional)
Long desc=OSPF distance for external routes:type=uint32:range=[0,255]:requires=[ospf-distance-internal,ospf-distance-local] format: int64
ospf-distance-internal (optional)
Long desc=OSPF distance for inter-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-distance-local (optional)
Long desc=OSPF distance for intra-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-stub-router-on-startup (optional)
Boolean desc=advertise self as stub router temporary on startup
ospf-stub-router-on-startup-period (optional)
Long desc=period to advertise self as stub router after startup:type=uint32:range=[5,86400] format: int64
ospf-bfd-all-if (optional)
Boolean desc=use BFD protocol for fault detection on all OSPF interfaces
ospf-default-information (optional)
String desc=control origination of default route:type=enum:default=none
Enum:
none
originate
always
ospf-default-info-originate-metric (optional)
Integer desc=metric for OSPF origination of default route:range=[-1,16777214]:default=-1 format: int32
api.ospf-default-info-originate-metric (optional)
Enum:
none
ospf-default-info-originate-metric-type (optional)
String desc=metric type for OSPF origination of default route:type=enum:default=2
Enum:
1
2
vrrp-track-port (optional)
String desc=track port for VRRP:type=port-list
bgp-default-shutdown (optional)
Boolean desc=Apply administrative shutdown to newly configured peers
bgp-snmp (optional)
Boolean desc=Enable BGP SNMP MIB
bgp-snmp-notification (optional)
Boolean desc=Enable BGP SNMP notifications
ospf-snmp (optional)
Boolean desc=Enable OSPF SNMP MIB
ospf-snmp-notification (optional)
Boolean desc=Enable OSPF SNMP notifications
ospf6-snmp (optional)
Boolean desc=Enable OSPFv3 SNMP MIB
ospf6-snmp-notification (optional)
Boolean desc=Enable OSPFv3 SNMP notifications
ip-snmp (optional)
Boolean desc=Enable ipForward SNMP MIB
no-bgp-redist-static-route-map (optional)
Boolean desc=Remove route map for BGP static redistribution:precludes=[bgp-redist-static-route-map]
no-bgp-redist-connected-route-map (optional)
Boolean desc=Remove route map for BGP connected redistribution:precludes=[bgp-redist-connected-route-map]
no-bgp-redist-ospf-route-map (optional)
Boolean desc=Remove route map for BGP OSPF redistribution:precludes=[bgp-redist-ospf-route-map]
bgp-graceful-shutdown (optional)
Boolean desc=BGP graceful shutdown RFC 8326
bgp-as (optional)
Long desc=BGP Autonomous System number from 1 to 4294967295:type=uint32:range=[1,4294967295] format: int64
bgp-redistribute (optional)
String desc=BGP route redistribution:type=flag
Enum:
static
connected
rip
ospf
bgp-max-paths (optional)
Integer desc=maximum BGP paths:type=uint16:range=[0,16]:default=1 format: int32
bgp-ibgp-multipath (optional)
Integer desc=number of IBGP multipath connections:type=uint16:range=[0,16] format: int32
router-id (optional)
String desc=OSPF and BGP router id:type=IPv4 or IPv6 address
hw-vrrp-id (optional)
Integer desc=VRRP ID assigned to the hardware vRouter:default=-1 format: int32

vrouter-mrib-routes-show - Up

display information about mrib table
api.switch-name (optional)
srcip
String desc=source IP:type=IPv4 or IPv6 address
vlan
Integer desc=VLAN:type=uint16:range=[0,4095] format: int32
group
String desc=group IP:type=IPv4 or IPv6 address
vrid (optional)
Integer desc=virtual router ID format: int32
flags (optional)
String desc=mRIB flags:type=flag
Enum:
in-hw
type (optional)
String desc=RIB route type:type=enum
Enum:
<*
G
V>
G
V>
vnic-vlan (optional)
Integer desc=VLAN assigned to VNIC:type=uint16 format: int32
hw-group-id (optional)
String desc=hardware group ID:type=uint32:hex=0x[0-9a-fA-F]{8}
vnic (optional)
String desc=VNIC name
ports (optional)
String desc=ports:type=port-list

vrouter-multicast-igmp-group-show - Up

display multicast IGMP routes on a vRouter
api.switch-name (optional)
address (optional)
String desc=local IP address:type=IPv4 or IPv6 address
vif (optional)
Long desc=virtual interface:type=uint32 format: int64
reporter (optional)
String desc=reporter IP address:type=IPv4 or IPv6 address
timer (optional)
Long desc=timer:type=uint32 format: int64
if-name (optional)
String desc=physical name of VIF

vrouter-multicast-route-show - Up

display multicast routes on a vRouter
api.switch-name (optional)
group (optional)
String desc=group IP address:type=IPv4 or IPv6 address
parent (optional)
Long desc=parent:type=uint32 format: int64
source (optional)
String desc=source IP address:type=IPv4 or IPv6 address
incoming-if (optional)
String desc=name of incoming interface
outgoing-ifs (optional)
String desc=name of outgoing interfaces
transit-vlan (optional)
Integer desc=transit vlan:type=uint16 format: int32
remote-source (optional)
Boolean desc=source is remote
oif-bitmap (optional)
Long desc=bitmap of VIFs to forward packets to:type=uint64 format: int64

vrouter-ospf-add - Up

add OSPF protocol to vRouter
network
String desc=OSPF network IP address:type=IPv4 or IPv6 address
netmask
Integer desc=OSPF network IP address netmask:type=netmask:mask-for=[network] format: int32
ospf-area
Long desc=stub area number for the configuration:type=uint32 format: int64
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-ospf-area-add - Up

add OSPF area to a vRouter
area
Long desc=OSPF area number:type=uint32 format: int64
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
stub-type (optional)
String desc=OSPF stub type:type=enum:default=none
Enum:
none
stub
stub-no-summary
nssa
nssa-no-summary
prefix-list-in (optional)
String desc=OSPF prefix list for filtering incoming packets:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name
prefix-list-out (optional)
String desc=OSPF prefix list for filtering outgoing packets:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name

vrouter-ospf-area-modify - Up

modify OSPF area to a vRouter
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
stub-type (optional)
String desc=OSPF stub type:type=enum:default=none
Enum:
none
stub
stub-no-summary
nssa
nssa-no-summary
prefix-list-in (optional)
String desc=OSPF prefix list for filtering incoming packets:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name
prefix-list-out (optional)
String desc=OSPF prefix list for filtering outgoing packets:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name

vrouter-ospf-area-show - Up

display OSPF areas on a vRouter
api.switch-name (optional)
area
Long desc=OSPF area number:type=uint32 format: int64
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
stub-type (optional)
String desc=OSPF stub type:type=enum
Enum:
none
stub
stub-no-summary
nssa
nssa-no-summary
prefix-list-in (optional)
String desc=OSPF prefix list for filtering incoming packets:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name
prefix-list-out (optional)
String desc=OSPF prefix list for filtering outgoing packets:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name

vrouter-ospf-interface-show - Up

display OSPF interfaces information on a vRouter
api.switch-name (optional)
nic
String desc=vnic name:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
ip (optional)
String desc=IP address:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=netmask:type=netmask:mask-for=[ip] format: int32
broadcast (optional)
String desc=broadcast address:type=IPv4 or IPv6 address
area (optional)
String desc=area id for this interface in IPv4 address format:type=IPv4 or IPv6 address
mtu (optional)
Integer desc=interface MTU:type=uint16 format: int32
state (optional)
String desc=OSPF interface state:type=enum
Enum:
down
loopback
waiting
point-to-point
dr-other
backup
dr
priority (optional)
Integer desc=priority:type=uint16 format: int32
cost (optional)
Long desc=cost:type=uint32 format: int64
hello (optional)
Long desc=hello interval:type=uint32 format: int64
dead (optional)
Long desc=dead interval:type=uint32 format: int64
retransmit (optional)
Long desc=retransmit interval:type=uint32 format: int64
neighbor (optional)
Long desc=neighbor count:type=uint32 format: int64
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
nic-state (optional)
String desc=vnic state:type=enum
Enum:
down
up
mtu-mismatch-detection (optional)
Boolean desc=MTU mistmatch detection
network-type (optional)
String desc=OSPF network type:type=enum
Enum:
point-to-point
broadcast
loopback
dr-id (optional)
String desc=designated router id:type=IPv4 or IPv6 address
dr-ip (optional)
String desc=designated router ip address:type=IPv4 or IPv6 address
bdr-id (optional)
String desc=backup designated router id:type=IPv4 or IPv6 address
bdr-ip (optional)
String desc=backup designated router ip address:type=IPv4 or IPv6 address
hello-due (optional)
String desc=hello due in
adjacent (optional)
Long desc=adjacent neighbor count:type=uint32 format: int64
router-id (optional)
String desc=router id:type=IPv4 or IPv6 address
l3-port (optional)
Long desc=Layer 3 port:type=uint32 format: int64

vrouter-ospf-neighbor-show - Up

display OSPF neighbors on a vRouter
api.switch-name (optional)
neighbor (optional)
String desc=OSPF neighbor IP address:type=IPv4 or IPv6 address
pri (optional)
Long desc=OSPF priority:type=uint32 format: int64
address (optional)
String desc=IP address:type=IPv4 or IPv6 address
vlan (optional)
Integer desc=VLAN:type=uint16:range=[0,4095] format: int32
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
State (optional)
String desc=OSPF state
l3-port (optional)
Long desc=l3 port:type=uint32 format: int64
dead-time (optional)
String desc=OSFP dead time
interface (optional)
String desc=OSFP interface

vrouter-ospf-show - Up

display OSPF protocol on a vRouter
api.switch-name (optional)
network
String desc=OSPF network IP address:type=IPv4 or IPv6 address
vrf
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
netmask (optional)
Integer desc=OSPF network IP address netmask:type=netmask:mask-for=[network] format: int32
ospf-area (optional)
Long desc=stub area number for the configuration:type=uint32 format: int64

vrouter-ospf6-add - Up

add OSPF6 protocol to vRouter
nic
String desc=OSPF6 control for this interface:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vrouters/{vrouter-name}/if-lists:api-ref-model=vrouter-if-list-show:api-ref-id=nic:api-ref-val=nic
ospf6-area
String desc=area id for this interface in IPv4 address format:type=IPv4 or IPv6 address
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-ospf6-interface-show - Up

display OSPF6 interfaces information on a vRouter
api.switch-name (optional)
nic
String desc=vnic name:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
ip6 (optional)
String desc=IPv6 address:type=IPv4 or IPv6 address
area (optional)
String desc=area id for this interface in IPv4 address format:type=IPv4 or IPv6 address
mtu (optional)
Integer desc=interface MTU:type=uint16 format: int32
state (optional)
String desc=OSPF interface state:type=enum
Enum:
down
loopback
waiting
point-to-point
dr-other
backup
dr
priority (optional)
Integer desc=priority:type=uint16 format: int32
cost (optional)
Long desc=cost:type=uint32 format: int64
hello (optional)
Long desc=hello interval:type=uint32 format: int64
dead (optional)
Long desc=dead interval:type=uint32 format: int64
retransmit (optional)
Long desc=retransmit interval:type=uint32 format: int64
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
nic-state (optional)
String desc=vnic state:type=enum
Enum:
down
up
mtu-mismatch-detection (optional)
Boolean desc=MTU mistmatch detection
dr-id (optional)
String desc=designated router id:type=IPv4 or IPv6 address
bdr-id (optional)
String desc=backup designated router id:type=IPv4 or IPv6 address
if-scoped-lsa (optional)
Long desc=number of interface LSAs scoped for the area:type=uint32 format: int64
ls-update (optional)
Long desc=number of pending LSAs for LSUpdate:type=uint32 format: int64
ls-ack (optional)
Long desc=number of pending LSAs for LSAck:type=uint32 format: int64
netmask-ip6 (optional)
Integer desc=IPv6 netmask:type=netmask:mask-for=[ip6] format: int32
link-local-ip (optional)
String desc=IPv6 link-local IP Address:type=IPv4 or IPv6 address
l3-port (optional)
Long desc=Layer 3 port:type=uint32 format: int64

vrouter-ospf6-neighbor-show - Up

display OSPF6 neighbors on a vRouter
api.switch-name (optional)
pri (optional)
Long desc=DR priority:type=uint32 format: int64
address (optional)
String desc=IP address:type=IPv4 or IPv6 address
vlan (optional)
Integer desc=VLAN:type=uint16:range=[0,4095] format: int32
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
l3-port (optional)
Long desc=l3 port:type=uint32 format: int64
state (optional)
String desc=State/Interface-state
dead-time (optional)
String desc=Dead time (age out time hh:mm:ss)
interface (optional)
String desc=Interface and state
duration (optional)
String desc=Duration (age hh:mm:ss)
neighbor-rid (optional)
String desc=Router Id:type=IPv4 or IPv6 address

vrouter-ospf6-show - Up

display OSPF6 protocol on a vRouter
api.switch-name (optional)
nic
String desc=OSPF6 control for this interface:api-ref-path=/vrouters/{vrouter-name}/if-lists:api-ref-model=vrouter-if-list-show:api-ref-id=nic:api-ref-val=nic
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
ospf6-area (optional)
String desc=area id for this interface in IPv4 address format:type=IPv4 or IPv6 address

vrouter-packet-relay-add - Up

add packet relay configuration for DHCP on vrouter
forward-proto
String desc=protocol type to forward packets:type=enum:default=dhcp:requires=[forward-ip]
Enum:
dhcp
forward-ip
String desc=forwarding IP address:type=IPv4 or IPv6 address:requires=[forward-proto]
nic
String desc=NIC:requires=[forward-proto,forward-ip]:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic

vrouter-packet-relay-show - Up

display packet relay configuration for DHCP on vrouter
api.switch-name (optional)
forward-proto
String desc=protocol type to forward packets:type=enum:requires=[forward-ip]
Enum:
dhcp
forward-ip
String desc=forwarding IP address:type=IPv4 or IPv6 address:requires=[forward-proto]
nic
String desc=NIC:requires=[forward-proto,forward-ip]:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-pim-config-show - Up

display pim parameters
api.switch-name (optional)
hello-interval
Long desc=hello interval in seconds:type=uint32:range=[1,300] format: int64
querier-timeout
Long desc=igmp querier timeout in seconds:type=uint32:range=[10,900] format: int64
query-interval
Long desc=igmp query interval in seconds:type=uint32:range=[1,300] format: int64

vrouter-pim-interface-show - Up

display PIM interfaces on a vRouter
api.switch-name (optional)
name (optional)
String desc=physical name of VIF
index (optional)
Integer desc=VIF index:type=uint8 format: int32
if-state (optional)
String desc=VIF flags:type=flag
Enum:
down
disabled
leaf
dr
no-nbrs
pim
vrrp-primary
suspended
local-address (optional)
String desc=local IP address:type=IPv4 or IPv6 address
vlan-id (optional)
Integer desc=Vlan ID for VIF :type=uint16:range=[0,4095] format: int32

vrouter-pim-join-show - Up

display multicast group membership
api.switch-name (optional)
source (optional)
String desc=source IP address:type=IPv4 or IPv6 address
upstream (optional)
String desc=upstream IP address:type=IPv4 or IPv6 address
group (optional)
String desc=group IP address:type=IPv4 or IPv6 address
incoming (optional)
Long desc=incoming:type=uint32 format: int64
mrt-state (optional)
String desc=MRT Entry Flags:type=flag
Enum:
spt
wc
rp
new
iif-reg
reg
cache
null-oif
reg-supp
asserted
sg
pmbr
clone
leaves-bitmap (optional)
Long desc=bitmap of leaf interfaces:type=uint32:filter=false format: int64
jp-timer (optional)
Integer desc=Periodic Join Prune timer:type=uint16 format: int32
rs-timer (optional)
Integer desc=Register Suppression timer:type=uint16 format: int32
incoming-if (optional)
String desc=incoming interface name
outgoing-ifs (optional)
String desc=name of outgoing interfaces
oifs-bitmap (optional)
Long desc=bitmap of outgoing interfaces:type=uint32:filter=false format: int64
joined-ifs (optional)
String desc=joined interfaces
joined-bitmap (optional)
Long desc=bitmap of joined interfaces:type=uint32:filter=false format: int64
pruned-ifs (optional)
String desc=pruned interfaces
pruned-bitmap (optional)
Long desc=bitmap of pruned interfaces:type=uint32:filter=false format: int64
asserted-ifs (optional)
String desc=asserted interfaces:filter=false
asserted-bitmap (optional)
Long desc=bitmap of asserted interfaces:type=uint32:filter=false format: int64
leaf-ifs (optional)
String desc=name of leaf interfaces
entry-timer (optional)
Integer desc=MRT Entry timer:type=uint16 format: int32

vrouter-pim-neighbor-show - Up

display PIM neighbors on a vRouter
api.switch-name (optional)
address (optional)
String desc=IP address of PIM neighbor:type=IPv4 or IPv6 address
neighbor (optional)
String desc=PIM neighbor:type=IPv4 or IPv6 address
uptime (optional)
String desc=PIM neighbor uptime
timer (optional)
String desc=timer for PIM neighbor
holdt (optional)
String desc=PIM neighbor hold time
dr-priority (optional)
Integer desc=priority format: int32
gen-id (optional)
String desc=generated ID:type=uint64:hex=0x[0-9a-fA-F]{16}
interface (optional)
String desc=PIM neighbor interface

vrouter-pim-rp-add - Up

add static RP address for a group range - default 224.0.0.0/4
rp-address
String desc=PIM-SIM RP IP address:type=IPv4 or IPv6 address
group (optional)
String desc=Group IP address - default is 224.0.0.0:type=IPv4 or IPv6 address:default=224.0.0.0:requires=[netmask]
netmask (optional)
Integer desc=Group IP address netmask - default is 4:type=netmask:default=4:requires=[group]:mask-for=[group] format: int32

vrouter-pim-rp-show - Up

display static RP addresses for a group range
api.switch-name (optional)
group
String desc=Group IP address - default is 224.0.0.0:type=IPv4 or IPv6 address:requires=[netmask]
netmask
Integer desc=Group IP address netmask - default is 4:type=netmask:requires=[group]:mask-for=[group] format: int32
rp-address
String desc=PIM-SIM RP IP address:type=IPv4 or IPv6 address

vrouter-pim-ssm-map-add - Up

add ssm map to table
id
Integer desc=SSM Map table id 1 to 255:type=uint16:range=[1,255] format: int32
group (optional)
String desc=PIM-SSM Map group address:type=IPv4 or IPv6 address
source (optional)
String desc=PIM-SSM Map source address:type=IPv4 or IPv6 address:requires=[group]

vrouter-pim-ssm-map-show - Up

display pim ssm map
api.switch-name (optional)
id
Integer desc=SSM Map table id 1 to 255:type=uint16:range=[1,255] format: int32
group
String desc=PIM-SSM Map group address:type=IPv4 or IPv6 address
source
String desc=PIM-SSM Map source address:type=IPv4 or IPv6 address:requires=[group]

vrouter-pim-ssm-range-add - Up

add pim ssm range - default 232.0.0.0/8
id
Integer desc=SSM Range table id 1 to 255:type=uint16:range=[1,255] format: int32
group (optional)
String desc=PIM-SSM range group address:type=IPv4 or IPv6 address:requires=[netmask]
netmask (optional)
Integer desc=Group IP address netmask - default is 8:type=netmask:requires=[group]:mask-for=[group] format: int32

vrouter-pim-ssm-range-show - Up

display pim ssm range
api.switch-name (optional)
id
Integer desc=SSM Range table id 1 to 255:type=uint16:range=[1,255] format: int32
group
String desc=PIM-SSM range group address:type=IPv4 or IPv6 address:requires=[netmask]
netmask
Integer desc=Group IP address netmask - default is 8:type=netmask:requires=[group]:mask-for=[group] format: int32

vrouter-prefix-list-add - Up

add a prefix list to filter route advertisements
name
String desc=name created for the prefix list:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
action
String desc=the prefix list to permit or deny packets:type=enum
Enum:
permit
deny
prefix
String desc=IP address assigned to the prefix list:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[any,anyv6]
netmask
Integer desc=netmask assigned to the IP address:type=netmask:requires=[prefix]:precludes=[any,anyv6]:mask-for=[prefix] format: int32
seq (optional)
Long desc=sequence number assigned to the prefix list - a value between 1 and 4294967295:type=uint32:range=[1,4294967295] format: int64
min-prefix-len (optional)
Integer desc=minimum prefix length from 0 to 32:type=uint8:range=[0,128]:precludes=[any,anyv6] format: int32
max-prefix-len (optional)
Integer desc=maximum prefix length from 0 to 32:type=uint8:range=[0,128]:precludes=[any,anyv6] format: int32

vrouter-prefix-list-add-1 - Up

add a prefix list to filter route advertisements
name
String desc=name created for the prefix list:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
action
String desc=the prefix list to permit or deny packets:type=enum
Enum:
permit
deny
any
Boolean desc=apply to any prefix list:precludes=[prefix,netmask,max-prefix-len,min-prefix-len,anyv6]
seq (optional)
Long desc=sequence number assigned to the prefix list - a value between 1 and 4294967295:type=uint32:range=[1,4294967295] format: int64

vrouter-prefix-list-add-2 - Up

add a prefix list to filter route advertisements
name
String desc=name created for the prefix list:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
action
String desc=the prefix list to permit or deny packets:type=enum
Enum:
permit
deny
anyv6
Boolean desc=apply to any ipv6 prefix list:precludes=[prefix,netmask,max-prefix-len,min-prefix-len,any]
seq (optional)
Long desc=sequence number assigned to the prefix list - a value between 1 and 4294967295:type=uint32:range=[1,4294967295] format: int64

vrouter-prefix-list-modify - Up

modify a prefix list to filter route advertisements
action (optional)
String desc=the prefix list to permit or deny packets:type=enum
Enum:
permit
deny
prefix (optional)
String desc=IP address assigned to the prefix list:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[any,anyv6]
netmask (optional)
Integer desc=netmask assigned to the IP address:type=netmask:requires=[prefix]:precludes=[any,anyv6]:mask-for=[prefix] format: int32
any (optional)
Boolean desc=apply to any prefix list:precludes=[prefix,netmask,max-prefix-len,min-prefix-len,anyv6]
anyv6 (optional)
Boolean desc=apply to any ipv6 prefix list:precludes=[prefix,netmask,max-prefix-len,min-prefix-len,any]
min-prefix-len (optional)
Integer desc=minimum prefix length from 0 to 32:type=uint8:range=[0,128]:precludes=[any,anyv6] format: int32
max-prefix-len (optional)
Integer desc=maximum prefix length from 0 to 32:type=uint8:range=[0,128]:precludes=[any,anyv6] format: int32

vrouter-prefix-list-show - Up

display prefix lists that filter route advertisements
api.switch-name (optional)
name
String desc=name created for the prefix list
seq
Long desc=sequence number assigned to the prefix list - a value between 1 and 4294967295:type=uint32:range=[1,4294967295] format: int64
action (optional)
String desc=the prefix list to permit or deny packets:type=enum
Enum:
permit
deny
prefix (optional)
String desc=IP address assigned to the prefix list:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[any,anyv6]
netmask (optional)
Integer desc=netmask assigned to the IP address:type=netmask:requires=[prefix]:precludes=[any,anyv6]:mask-for=[prefix] format: int32
any (optional)
Boolean desc=apply to any prefix list:precludes=[prefix,netmask,max-prefix-len,min-prefix-len,anyv6]
anyv6 (optional)
Boolean desc=apply to any ipv6 prefix list:precludes=[prefix,netmask,max-prefix-len,min-prefix-len,any]
min-prefix-len (optional)
Integer desc=minimum prefix length from 0 to 32:type=uint8:range=[0,128]:precludes=[any,anyv6] format: int32
max-prefix-len (optional)
Integer desc=maximum prefix length from 0 to 32:type=uint8:range=[0,128]:precludes=[any,anyv6] format: int32

vrouter-rib-history-settings-modify - Up

update rib history settings
enable (optional)
Boolean desc=enable or disable change logging:default=true
disk-space (optional)
Long desc=total disk-space allocated for all log files:type=uint64:default=52428800 format: int64
log-file-count (optional)
Integer desc=number of log files for log rotation:type=uint16:range=[1,20]:default=10 format: int32

vrouter-rib-history-settings-show - Up

show rib history settings
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable change logging
disk-space (optional)
Long desc=total disk-space allocated for all log files:type=uint64 format: int64
log-file-count (optional)
Integer desc=number of log files for log rotation:type=uint16:range=[1,20] format: int32

vrouter-rib-history-show - Up

display historical rib route data
api.switch-name (optional)
nexthop
String desc=next-hop IP address:type=IPv4 or IPv6 address
vnet-id
String desc=VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd
String desc=Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
vlan
Integer desc=VLAN:type=uint16:range=[0,4095] format: int32
ip
String desc=IP address:type=IPv4 or IPv6 address
prelen
Long desc=prefix length:type=uint32:range=[0,128] format: int64
caller (optional)
String desc=feature that made the change for this entry:type=flag
Enum:
init
control
logger
gre-tunnel
flush
user
static-route-init
router-if
vnet-service
l3-check
vrf
vxlan-routing
vsg
reason (optional)
String desc=reason for history entry:type=flag
Enum:
save
restart
add
modify
remove
remove-all
inject
evict
router-delete
changes (optional)
String desc=what changed in this entry:type=uint64
nexthops-in-hw (optional)
Integer desc=number of hardware next-hops format: int32
ecmp-group (optional)
Integer desc=ECMP group format: int32
egress-id (optional)
Integer desc=egress ID format: int32
flags (optional)
String desc=RIB route flags:type=flag
Enum:
ECMP
in-hw
in-cache-no-nexthop
in-cache-hw-full
in-cache-hw-fail
in-ecmp-cache
local-subnet
drop
evpn
intf-ip (optional)
String desc=interface IP address:type=IPv4 or IPv6 address
intf-id (optional)
Integer desc=router interface:api-ref-path=/vrouter-hw-ifs:api-ref-model=vrouter-hw-if-show:api-ref-id=hw-id:api-ref-val=hw-id format: int32
ecmp-nexthops (optional)
Boolean desc=filter to display single/mutiple route entries (per nexthop)
number-of-tunnels (optional)
Long desc=number of tunnels dependent on this route:type=uint32 format: int64
last-caller (optional)
String desc=most recent caller for this entry:type=flag
Enum:
init
control
logger
gre-tunnel
flush
user
static-route-init
router-if
vnet-service
l3-check
vrf
vxlan-routing
vsg
last-reason (optional)
String desc=most recent reason for this entry:type=flag
Enum:
save
restart
add
modify
remove
remove-all
inject
evict
router-delete
vrid (optional)
Integer desc=virtual router ID:range=[0,1024] format: int32
number-of-nexthops (optional)
Integer desc=number of next-hops in the route format: int32
address-type (optional)
String desc=address type IPv4/IPv6:type=enum
Enum:
IPv4
IPv6
count (optional)
Long desc=count for RIB history:type=uint32 format: int64
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]

vrouter-rib-routes-show - Up

display information about routing information databases
api.switch-name (optional)
ip
String desc=IP address:type=IPv4 or IPv6 address
prelen
Long desc=prefix length:type=uint32:range=[0,128] format: int64
nexthop
String desc=next-hop IP address:type=IPv4 or IPv6 address
vlan
Integer desc=VLAN:type=uint16:range=[0,4095] format: int32
vnet-id
String desc=VNET:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
bd
String desc=Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
vrid (optional)
Integer desc=virtual router ID:range=[0,1024] format: int32
flags (optional)
String desc=RIB route flags:type=flag
Enum:
ECMP
in-hw
in-cache-no-nexthop
in-cache-hw-full
in-cache-hw-fail
in-ecmp-cache
local-subnet
drop
evpn
number-of-nexthops (optional)
Integer desc=number of next-hops in the route format: int32
nexthops-in-hw (optional)
Integer desc=number of hardware next-hops format: int32
intf-ip (optional)
String desc=interface IP address:type=IPv4 or IPv6 address
ecmp-nexthops (optional)
Boolean desc=filter to display single/mutiple route entries (per nexthop)
number-of-tunnels (optional)
Long desc=number of tunnels dependent on this route:type=uint32 format: int64
address-type (optional)
String desc=address type IPv4/IPv6:type=enum
Enum:
IPv4
IPv6
intf-id (optional)
Integer desc=router interface:api-ref-path=/vrouter-hw-ifs:api-ref-model=vrouter-hw-if-show:api-ref-id=hw-id:api-ref-val=hw-id format: int32
ecmp-group (optional)
Integer desc=ECMP group format: int32
egress-id (optional)
Integer desc=egress ID format: int32

vrouter-rip-add - Up

add RIP to a vRouter
network
String desc=IP address:type=IPv4 or IPv6 address
netmask
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-rip-routes-show - Up

display RIP routes on a vRouter
api.switch-name (optional)
network
String desc=IP address:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
metric (optional)
Long desc=assigned metric for the RIP route:type=uint32 format: int64
source (optional)
String desc=source IP address of the RIP route:type=IPv4 or IPv6 address
tag (optional)
Long desc=tag number assigned to RIP route:type=uint32 format: int64
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
next-hop (optional)
String desc=IP address of the next hop in the RIP route:type=IPv4 or IPv6 address
attribute (optional)
String desc=attribute assigned to RIP route:type=enum
Enum:
normal
static
default
redistribute
interface
type (optional)
String desc=type of RIP route:type=enum
Enum:
rip
connected
static
ospf
bgp
missing
kernel-route
igmp
babel
pim
ospf6

vrouter-rip-show - Up

display RIP information for a vRouter
api.switch-name (optional)
network
String desc=IP address:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-route-map-add - Up

add a route map
name
String desc=name created for the route map:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
seq
Long desc=sequence number assigned to the route map - a value between 1 and 65535:type=uint32:range=[1,65535] format: int64
action
String desc=the route map to permit or deny packets:type=enum
Enum:
permit
deny
additive (optional)
Boolean desc=given community is appended to existing communities value
metric (optional)
Long desc=set metric:range=[-1,4294967295]:default=-1 format: int64
match-prefix (optional)
String desc=prefixes used for matching:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name
match-mac (optional)
String desc=macs used for matching:api-ref-path=/vrouters/{vrouter-name}/mac-lists:api-ref-model=vrouter-mac-list-show:api-ref-id=name:api-ref-val=name
match-community (optional)
String desc=match community name or none to unset (bgp only)
match-evpn-default-route (optional)
String desc=match 0.0.0.0 and/or :: route (bgp evpn route only):type=enum:default=none
Enum:
none
true
false
match-evpn-route-type (optional)
String desc=match evpn route type:type=enum:default=none
Enum:
none
type-2
type-3
type-5
match-evpn-vni (optional)
Long desc=match evpn vni :type=uint32:range=[0,16777215] format: int64
match-evpn-rd (optional)
String desc=match evpn Route Distinguisher(RD) e.g ASN:XX or A.B.C.D:XX:default=:pattern=^$|([0-9_.:]+$):pattern-help=numbers, ., :,
extended_comm_soo (optional)
String desc=Set Site Of Origin(SoO) extended community e.g ASN:XX or A.B.C.D:XX:default=:pattern=^$|([0-9_.:]+$):pattern-help=numbers, ., :,
exact-match (optional)
Boolean desc=exact match for community (bgp only):requires=[match-community]
community-attribute (optional)
String desc=set well-known community attribute (bgp only):type=enum:precludes=[community-attribute-generic]
Enum:
unset
none
no-export
no-advertise
internet
local-AS
community-attribute-generic (optional)
String desc=set generic community attribute like AA:NN or none (bgp only):precludes=[community-attribute]
comm-list-del (optional)
String desc=removes community values from bgp community attributes:api-ref-path=/vrouters/{vrouter-name}/community-lists:api-ref-model=vrouter-community-list-show:api-ref-id=name:api-ref-val=name
local-pref (optional)
Long desc=set local preference:range=[-1,4294967295]:default=-1 format: int64
api.local-pref (optional)
Enum:
none
ipv6-nh-prefer-global (optional)
String desc=set ipv6 next-hop prefer-global:type=enum:default=none
Enum:
none
true
false
api.metric (optional)
Enum:
none
metric-type (optional)
String desc=set metric-type:type=enum:default=none
Enum:
none
1
2
as-path-prepend (optional)
String desc=AS Number to prepend:pattern=^([0-9]+[,]?)*$:pattern-help=comma separated list of numbers:precludes=[as-path-prepend-last-as]
as-path-prepend-last-as (optional)
Long desc=Prepend the peer's AS-number:type=uint32:range=[1,10]:precludes=[as-path-prepend] format: int64
as-path-exclude (optional)
String desc=Exclude from the as-path:pattern=^([0-9]+[,]?)*$:pattern-help=comma separated list of numbers
origin (optional)
String desc=Origin of BGP prefix:type=enum:default=none
Enum:
none
egp
igp
incomplete

vrouter-route-map-modify - Up

modify a route map
action (optional)
String desc=the route map to permit or deny packets:type=enum
Enum:
permit
deny
additive (optional)
Boolean desc=given community is appended to existing communities value
metric (optional)
Long desc=set metric:range=[-1,4294967295]:default=-1 format: int64
match-prefix (optional)
String desc=prefixes used for matching:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name
match-mac (optional)
String desc=macs used for matching:api-ref-path=/vrouters/{vrouter-name}/mac-lists:api-ref-model=vrouter-mac-list-show:api-ref-id=name:api-ref-val=name
match-community (optional)
String desc=match community name or none to unset (bgp only)
match-evpn-default-route (optional)
String desc=match 0.0.0.0 and/or :: route (bgp evpn route only):type=enum:default=none
Enum:
none
true
false
match-evpn-route-type (optional)
String desc=match evpn route type:type=enum:default=none
Enum:
none
type-2
type-3
type-5
match-evpn-vni (optional)
Long desc=match evpn vni :type=uint32:range=[0,16777215] format: int64
match-evpn-rd (optional)
String desc=match evpn Route Distinguisher(RD) e.g ASN:XX or A.B.C.D:XX:default=:pattern=^$|([0-9_.:]+$):pattern-help=numbers, ., :,
extended_comm_soo (optional)
String desc=Set Site Of Origin(SoO) extended community e.g ASN:XX or A.B.C.D:XX:default=:pattern=^$|([0-9_.:]+$):pattern-help=numbers, ., :,
exact-match (optional)
Boolean desc=exact match for community (bgp only):requires=[match-community]
community-attribute (optional)
String desc=set well-known community attribute (bgp only):type=enum:precludes=[community-attribute-generic]
Enum:
unset
none
no-export
no-advertise
internet
local-AS
community-attribute-generic (optional)
String desc=set generic community attribute like AA:NN or none (bgp only):precludes=[community-attribute]
comm-list-del (optional)
String desc=removes community values from bgp community attributes:api-ref-path=/vrouters/{vrouter-name}/community-lists:api-ref-model=vrouter-community-list-show:api-ref-id=name:api-ref-val=name
local-pref (optional)
Long desc=set local preference:range=[-1,4294967295]:default=-1 format: int64
api.local-pref (optional)
Enum:
none
ipv6-nh-prefer-global (optional)
String desc=set ipv6 next-hop prefer-global:type=enum:default=none
Enum:
none
true
false
api.metric (optional)
Enum:
none
metric-type (optional)
String desc=set metric-type:type=enum:default=none
Enum:
none
1
2
as-path-prepend (optional)
String desc=AS Number to prepend:pattern=^([0-9]+[,]?)*$:pattern-help=comma separated list of numbers:precludes=[as-path-prepend-last-as]
as-path-prepend-last-as (optional)
Long desc=Prepend the peer's AS-number:type=uint32:range=[1,10]:precludes=[as-path-prepend] format: int64
as-path-exclude (optional)
String desc=Exclude from the as-path:pattern=^([0-9]+[,]?)*$:pattern-help=comma separated list of numbers
origin (optional)
String desc=Origin of BGP prefix:type=enum:default=none
Enum:
none
egp
igp
incomplete

vrouter-route-map-show - Up

display route maps
api.switch-name (optional)
name
String desc=name created for the route map
seq
Long desc=sequence number assigned to the route map - a value between 1 and 65535:type=uint32:range=[1,65535] format: int64
action (optional)
String desc=the route map to permit or deny packets:type=enum
Enum:
permit
deny
additive (optional)
Boolean desc=given community is appended to existing communities value
metric (optional)
Long desc=set metric:range=[-1,4294967295] format: int64
match-prefix (optional)
String desc=prefixes used for matching:api-ref-path=/vrouters/{vrouter-name}/prefix-lists:api-ref-model=vrouter-prefix-list-show:api-ref-id=name:api-ref-val=name
match-mac (optional)
String desc=macs used for matching:api-ref-path=/vrouters/{vrouter-name}/mac-lists:api-ref-model=vrouter-mac-list-show:api-ref-id=name:api-ref-val=name
match-community (optional)
String desc=match community name or none to unset (bgp only)
match-evpn-default-route (optional)
String desc=match 0.0.0.0 and/or :: route (bgp evpn route only):type=enum
Enum:
none
true
false
match-evpn-route-type (optional)
String desc=match evpn route type:type=enum
Enum:
none
type-2
type-3
type-5
match-evpn-vni (optional)
Long desc=match evpn vni :type=uint32:range=[0,16777215] format: int64
match-evpn-rd (optional)
String desc=match evpn Route Distinguisher(RD) e.g ASN:XX or A.B.C.D:XX
extended_comm_soo (optional)
String desc=Set Site Of Origin(SoO) extended community e.g ASN:XX or A.B.C.D:XX
exact-match (optional)
Boolean desc=exact match for community (bgp only):requires=[match-community]
community-attribute (optional)
String desc=set well-known community attribute (bgp only):type=enum:precludes=[community-attribute-generic]
Enum:
unset
none
no-export
no-advertise
internet
local-AS
community-attribute-generic (optional)
String desc=set generic community attribute like AA:NN or none (bgp only):precludes=[community-attribute]
comm-list-del (optional)
String desc=removes community values from bgp community attributes:api-ref-path=/vrouters/{vrouter-name}/community-lists:api-ref-model=vrouter-community-list-show:api-ref-id=name:api-ref-val=name
local-pref (optional)
Long desc=set local preference:range=[-1,4294967295] format: int64
ipv6-nh-prefer-global (optional)
String desc=set ipv6 next-hop prefer-global:type=enum
Enum:
none
true
false
metric-type (optional)
String desc=set metric-type:type=enum
Enum:
none
1
2
as-path-prepend (optional)
String desc=AS Number to prepend:precludes=[as-path-prepend-last-as]
as-path-prepend-last-as (optional)
Long desc=Prepend the peer's AS-number:type=uint32:range=[1,10]:precludes=[as-path-prepend] format: int64
as-path-exclude (optional)
String desc=Exclude from the as-path
origin (optional)
String desc=Origin of BGP prefix:type=enum
Enum:
none
egp
igp
incomplete

vrouter-routes-multicast-show - Up

display multicast routes for a vRouter
api.switch-name (optional)
source
String desc=IP address of the source:type=IPv4 or IPv6 address
group (optional)
String desc=IP address of the group:type=IPv4 or IPv6 address
proto (optional)
String desc=the protocol of the multicast route:type=enum
Enum:
rip
connected
static
ospf
bgp
missing
kernel-route
igmp
babel
pim
ospf6
iVifI (optional)
Long desc=a number assigned to iVifI:type=uint32 format: int64
oVifI (optional)
Long desc=a number assigned to oVifI:type=uint32 format: int64
ttl (optional)
Long desc=number of seconds assigned to time-to-live (ttl):type=uint32 format: int64
uptime (optional)
String desc=the length of time that the route is up
input (optional)
String desc=a string for the input
output (optional)
String desc=an output interface

vrouter-routes-show - Up

display information about all routes on one or all configured vRouters
api.switch-name (optional)
network
String desc=IP address:type=IPv4 or IPv6 address
netmask (optional)
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
distance (optional)
Integer desc=distance assigned to route from 1 to 255:type=uint16:range=[1,255] format: int32
metric (optional)
Long desc=metric assigned to the route:type=uint32 format: int64
vrf (optional)
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
next-hop (optional)
String desc=IP address assigned to the next hop:type=IPv4 or IPv6 address
interface (optional)
String desc=interface for the route
type (optional)
String desc=type of routes:type=enum
Enum:
rip
connected
static
ospf
bgp
missing
kernel-route
igmp
babel
pim
ospf6

vrouter-routes-stats-show - Up

display route stats for a virtual router (vrouter)
api.switch-name (optional)
fib-max-routes (optional)
Long desc=fib max number of routes:type=uint64 format: int64
fib-current-routes (optional)
Long desc=fib current number of routes:type=uint64 format: int64
rib-current-routes (optional)
Long desc=rib current number of routes:type=uint64 format: int64
cached-routes (optional)
Long desc=current number of regular cached routes:type=uint64:filter=false format: int64
peak-cached-routes (optional)
Long desc=max number of regular cached routes:type=uint64:filter=false format: int64
ecmp-cached-routes (optional)
Long desc=current number of ECMP cached routes:type=uint64:filter=false format: int64
peak-ecmp-cached-routes (optional)
Long desc=max number of ECMP cached routes:type=uint64:filter=false format: int64
nexthop-arp-fail (optional)
Long desc=Total number of ARP failures for nexthop:type=uint64:filter=false format: int64
hw-overflow (optional)
Long desc=Total number of HW route overflows:type=uint64:filter=false format: int64
hw-add-fail (optional)
Long desc=Total number of HW route addition failures:type=uint64:filter=false format: int64
ecmp-hw-group-fail (optional)
Long desc=Total number of ECMP HW group add failures:type=uint64:filter=false format: int64
vrouter-name (optional)
String desc=Name of vrouter

vrouter-show - Up

display information about vRouters
api.switch-name (optional)
name
String desc=name of service config
vrf (optional)
String desc=Name of the vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
proto-routing (optional)
String desc=unicast protocols service state:type=flag
Enum:
bgp
ospf
rip
static
bfd
ospf6
admin-control
evpnsnoop
hw-router-mac (optional)
String desc=hardware vRouter MAC address:type=mac-address
hw-vrid (optional)
Integer desc=ID assigned to hardware vRouter:range=[0,15] format: int32
bgp-redist-static-route-map (optional)
String desc=route map for BGP redistribution of static routes:precludes=[no-bgp-redist-static-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
bgp-redist-connected-route-map (optional)
String desc=route map for BGP redistribution of connected routes:precludes=[no-bgp-redist-connected-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
bgp-redist-ospf-route-map (optional)
String desc=route map for BGP redistribution of OSPF routes:precludes=[no-bgp-redist-ospf-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
ospf-redist-connected-route-map (optional)
String desc=route map for OSPF redistribution of connected routes:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
ospf-redist-bgp-route-map (optional)
String desc=route map for OSPF redistribution of BGP routes:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
ospf-default-info-originate-route-map (optional)
String desc=route map for OSPF origination of default route:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
ospf-redist-static-route-map (optional)
String desc=route map for OSPF redistribution of static routes:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
vnet-service (optional)
Boolean desc=service as dedicated or shared:filter=false
shared-vnet-mgr (optional)
String desc=vnet-manager to share with if shared service:filter=false:api-ref-path=/vnet-managers:api-ref-model=vnet-manager-show:api-ref-id=name:api-ref-val=name
state (optional)
String desc=state of service:type=enum:filter=false
Enum:
disable
enable
location (optional)
Long desc=location of service:type=uint32:api-ref-path=/fabric-nodes:api-ref-model=fabric-node-show:api-ref-id=id:api-ref-val=name format: int64
storage-pool (optional)
String desc=storage pool assigned to service:filter=false:api-ref-path=/storage-pools:api-ref-model=storage-pool-show:api-ref-id=name:api-ref-val=name
router-type (optional)
String desc=vRouter type:type=enum
Enum:
software
hardware
router-ipstack (optional)
String desc=vRouter ipstack:type=enum
Enum:
quagga
frr
evpn-border (optional)
Boolean desc=evpn border node
evpn-export-all-leaked-networks (optional)
String desc=exporting leaked subnets to eVPN overlay:type=enum
Enum:
permit
deny
evpn-dup-addr-max-moves (optional)
Long desc=evpn duplicate address max moves:type=uint32:range=[2,1000] format: int64
evpn-dup-addr-moves-duration (optional)
Long desc=evpn duplicate address moves time duration (seconds):type=uint32:range=[2,1800] format: int64
evpn-dup-addr-freeze (optional)
Integer desc=evpn duplicate address freeze duration (seconds):range=[-1,3600] format: int32
cluster-active-active-routing (optional)
Boolean desc=active-active routing with or without VRRP
bgp-redist-static-metric (optional)
Long desc=BGP route redistribution static metric:range=[-1,4294967295] format: int64
bgp-redist-connected-metric (optional)
Long desc=metric for redistributing BGP connected routes:range=[-1,4294967295] format: int64
bgp-redist-rip-metric (optional)
Long desc=metric for redistributing RIP connected routes:range=[-1,4294967295] format: int64
bgp-redist-ospf-metric (optional)
Long desc=metric for BGP to redistribute OSPF connected routes:range=[-1,4294967295] format: int64
bgp-cluster-id (optional)
String desc=IP address for BGP cluster ID:type=IPv4 or IPv6 address
bgp-bestpath-as-path (optional)
String desc=best path for BGP:type=flag
Enum:
ignore
multipath-relax
bgp-dampening (optional)
Boolean desc=dampening for BGP routes
bgp-delayed-startup (optional)
Integer desc=Delays forming peer adjacency on bootup:type=uint16:range=[0,36000] format: int32
bgp-network-import-check (optional)
Boolean desc=Check BGP network route exists in IGP
bgp-update-delay-strict (optional)
Integer desc=Put bgp read-only mode on bootup, Recommend value less than l3-to-vlag-delay:type=uint16:range=[0,3600] format: int32
bgp-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds) - default 60:type=uint32:range=[0,65535]:requires=[bgp-holdtime] format: int64
bgp-holdtime (optional)
Long desc=BGP Holdtime (seconds) - default 180:type=uint32:range=[0,65535] format: int64
bgp-distance-external (optional)
Long desc=BGP distance for routes external to AS:type=uint32:range=[0,255]:requires=[bgp-distance-internal,bgp-distance-local] format: int64
bgp-distance-internal (optional)
Long desc=BGP distance for routes internal to AS:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-distance-local (optional)
Long desc=BGP distance for local routes:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
ospf-spf-delay (optional)
Long desc= Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000] format: int64
ospf-spf-consec-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000] format: int64
ospf-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000] format: int64
ospf6-spf-delay (optional)
Long desc=Delay (msec) from first change received till SPF calculation:type=uint32:range=[0,600000] format: int64
ospf6-spf-consecu-delay (optional)
Long desc=Initial hold time (msec) between consecutive SPF calculations:type=uint32:range=[0,600000] format: int64
ospf6-spf-max-delay (optional)
Long desc=Maximum hold time (msec):type=uint32:range=[0,600000] format: int64
bgp-global-nh-preference (optional)
String desc=use global nexthop preference for choosing nexthop type in BGP-ipv6:type=enum
Enum:
none
true
false
rip-redistribute (optional)
String desc=redistribute RIP routes:type=flag
Enum:
static
connected
ospf
bgp
ospf-redistribute (optional)
String desc=redistribute OSPF routes:type=flag
Enum:
static
connected
rip
bgp
ospf-redist-static-metric (optional)
Integer desc=metric for OSPF redistribution of static routes (IPv4 only):range=[-1,16777214] format: int32
ospf-redist-static-metric-type (optional)
String desc=metric type for OSPF redistribution of static routes (IPv4 only):type=enum
Enum:
1
2
ospf-redist-connected-metric (optional)
Integer desc=metric for OSPF redistribution of connected routes (IPv4 only):range=[-1,16777214] format: int32
ospf-redist-connected-metric-type (optional)
String desc=metric type for OSPF redistribution of connected routes (IPv4 only):type=enum
Enum:
1
2
ospf-redist-rip-metric (optional)
Integer desc=metric for OSPF redistribution of RIP routes (IPv4 only):range=[-1,16777214] format: int32
ospf-redist-rip-metric-type (optional)
String desc=metric type for OSPF redistribution of RIP routes (IPv4 only):type=enum
Enum:
1
2
ospf-redist-bgp-metric (optional)
Integer desc=metric for OSPF redistribution of BGP routes (IPv4 only):range=[-1,16777214] format: int32
ospf-redist-bgp-metric-type (optional)
String desc=metric type for OSPF redistribution of BGP routes (IPv4 only):type=enum
Enum:
1
2
ospf-distance-external (optional)
Long desc=OSPF distance for external routes:type=uint32:range=[0,255]:requires=[ospf-distance-internal,ospf-distance-local] format: int64
ospf-distance-internal (optional)
Long desc=OSPF distance for inter-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-distance-local (optional)
Long desc=OSPF distance for intra-area routes:type=uint32:range=[0,255]:requires=[ospf-distance-external] format: int64
ospf-stub-router-on-startup (optional)
Boolean desc=advertise self as stub router temporary on startup
ospf-stub-router-on-startup-period (optional)
Long desc=period to advertise self as stub router after startup:type=uint32:range=[5,86400] format: int64
ospf-bfd-all-if (optional)
Boolean desc=use BFD protocol for fault detection on all OSPF interfaces
ospf-default-information (optional)
String desc=control origination of default route:type=enum
Enum:
none
originate
always
ospf-default-info-originate-metric (optional)
Integer desc=metric for OSPF origination of default route:range=[-1,16777214] format: int32
ospf-default-info-originate-metric-type (optional)
String desc=metric type for OSPF origination of default route:type=enum
Enum:
1
2
vrrp-track-port (optional)
String desc=track port for VRRP:type=port-list
bgp-default-shutdown (optional)
Boolean desc=Apply administrative shutdown to newly configured peers
bgp-snmp (optional)
Boolean desc=Enable BGP SNMP MIB
bgp-snmp-notification (optional)
Boolean desc=Enable BGP SNMP notifications
ospf-snmp (optional)
Boolean desc=Enable OSPF SNMP MIB
ospf-snmp-notification (optional)
Boolean desc=Enable OSPF SNMP notifications
ospf6-snmp (optional)
Boolean desc=Enable OSPFv3 SNMP MIB
ospf6-snmp-notification (optional)
Boolean desc=Enable OSPFv3 SNMP notifications
ip-snmp (optional)
Boolean desc=Enable ipForward SNMP MIB
no-bgp-redist-static-route-map (optional)
Boolean desc=Remove route map for BGP static redistribution:precludes=[bgp-redist-static-route-map]
no-bgp-redist-connected-route-map (optional)
Boolean desc=Remove route map for BGP connected redistribution:precludes=[bgp-redist-connected-route-map]
no-bgp-redist-ospf-route-map (optional)
Boolean desc=Remove route map for BGP OSPF redistribution:precludes=[bgp-redist-ospf-route-map]
bgp-graceful-shutdown (optional)
Boolean desc=BGP graceful shutdown RFC 8326
fabric-comm (optional)
Boolean desc=vRouter for fabric communication:precludes=[router-type]
gateway (optional)
String desc=gateway IP address for service:type=IPv4 or IPv6 address:filter=false
type (optional)
String desc=type of service:type=enum
Enum:
vnet-mgr
vrouter
netzone
orphaned
netvm
nat
ovs
scope (optional)
String desc=scope of service - fabric or local
Enum:
local
fabric
cluster
template (optional)
Boolean desc=template to load:filter=false:precludes=[load-template,scope,vnet]
failover-controller (optional)
Long desc=Switch coordinating the failover:type=uint32:filter=false format: int64
failover-action (optional)
String desc=Current state of the failover:type=enum:filter=false
Enum:
stop-old
start-new
restore-orig
sync
finished
id (optional)
String desc=ID assigned to service:type=identifier
bgp-as (optional)
Long desc=BGP Autonomous System number from 1 to 4294967295:type=uint32:range=[1,4294967295] format: int64
bgp-redistribute (optional)
String desc=BGP route redistribution:type=flag
Enum:
static
connected
rip
ospf
bgp-max-paths (optional)
Integer desc=maximum BGP paths:type=uint16:range=[0,16] format: int32
bgp-ibgp-multipath (optional)
Integer desc=number of IBGP multipath connections:type=uint16:range=[0,16] format: int32
router-id (optional)
String desc=OSPF and BGP router id:type=IPv4 or IPv6 address
hw-vrrp-id (optional)
Integer desc=VRRP ID assigned to the hardware vRouter format: int32
vnet (optional)
String desc=vnet assigned to service:precludes=[scope]:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name

vrouter-static-bfd-add - Up

add a static BFD session
src-ip
String desc=source IP address for the BFD session:type=IPv4 or IPv6 address
dst-ip
String desc=destination IP address for the BFD session:type=IPv4 or IPv6 address
type (optional)
String desc=BFD type:type=enum:default=single-hop
Enum:
single-hop
multi-hop
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-static-bfd-show - Up

display static BFD sessions
api.switch-name (optional)
vrf
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
src-ip
String desc=source IP address for the BFD session:type=IPv4 or IPv6 address
dst-ip
String desc=destination IP address for the BFD session:type=IPv4 or IPv6 address
type (optional)
String desc=BFD type:type=enum
Enum:
single-hop
multi-hop

vrouter-static-route-add - Up

static route with gateway
network
String desc=IP address:type=IPv4 or IPv6 address
netmask
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
gateway-ip
String desc=gateway IP address:type=IPv4 or IPv6 address:precludes=[drop]
distance (optional)
Integer desc=distance assigned to route from 1 to 255:type=uint16:range=[1,255]:default=1 format: int32
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
bfd-dst-ip (optional)
String desc=destination IP address for bfd monitoring:type=IPv4 or IPv6 address:precludes=[interface,drop]
interface (optional)
String desc=interface name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[bfd-dst-ip,drop]:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic

vrouter-static-route-add-1 - Up

static drop route
network
String desc=IP address:type=IPv4 or IPv6 address
netmask
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
drop
Boolean desc=Drop traffic matching this route:precludes=[gateway-ip,interface,bfd-dst-ip]
distance (optional)
Integer desc=distance assigned to route from 1 to 255:type=uint16:range=[1,255]:default=1 format: int32
vrf (optional)
String desc=name of vrf:pattern=^[a-zA-Z0-9_.:-]*$:pattern-help=letters, numbers, _, ., :, - and '':api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf

vrouter-static-route-modify - Up

modify a static route
distance
Integer desc=distance assigned to route from 1 to 255:type=uint16:range=[1,255]:default=1 format: int32

vrouter-static-route-show - Up

display static routes on a vRouter
api.switch-name (optional)
network
String desc=IP address:type=IPv4 or IPv6 address
netmask
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
vrf
String desc=name of vrf:api-ref-path=/vrouters/{vrouter-name}/vrfs:api-ref-model=vrouter-vrf-show:api-ref-id=vrf:api-ref-val=vrf
interface
String desc=interface name:precludes=[bfd-dst-ip,drop]:api-ref-path=/vrouters/{vrouter-name}/interfaces:api-ref-model=vrouter-interface-show:api-ref-id=nic:api-ref-val=nic
gateway-ip
String desc=gateway IP address:type=IPv4 or IPv6 address:precludes=[drop]
distance (optional)
Integer desc=distance assigned to route from 1 to 255:type=uint16:range=[1,255] format: int32
bfd (optional)
String desc=BFD protocol for gateway fault detection:type=enum
Enum:
single-hop
multi-hop
drop (optional)
Boolean desc=Drop traffic matching this route:precludes=[gateway-ip,interface,bfd-dst-ip]
bfd-dst-ip (optional)
String desc=destination IP address for bfd monitoring:type=IPv4 or IPv6 address:precludes=[interface,drop]
bfd-src-ip (optional)
String desc=source IP address for BFD session:type=IPv4 or IPv6 address

vrouter-vrf-add - Up

create a vRouter vrf
vrf
String desc=Name of the vrf:pattern=^[a-zA-Z0-9_.-]*$:pattern-help=letters, numbers, ., -, and '':api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
bgp-redist-static-metric (optional)
Long desc=BGP route redistribution static metric:range=[-1,4294967295] format: int64
api.bgp-redist-static-metric (optional)
Enum:
none
bgp-redist-connected-metric (optional)
Long desc=metric for redistributing BGP connected routes:range=[-1,4294967295] format: int64
api.bgp-redist-connected-metric (optional)
Enum:
none
bgp-redist-rip-metric (optional)
Long desc=metric for redistributing RIP connected routes:range=[-1,4294967295] format: int64
api.bgp-redist-rip-metric (optional)
Enum:
none
bgp-redist-ospf-metric (optional)
Long desc=metric for BGP to redistribute OSPF connected routes:range=[-1,4294967295] format: int64
api.bgp-redist-ospf-metric (optional)
Enum:
none
bgp-cluster-id (optional)
String desc=IP address for BGP cluster ID:type=IPv4 or IPv6 address
bgp-dampening (optional)
Boolean desc=dampening for BGP routes
bgp-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds) - default 60:type=uint32:range=[0,65535]:requires=[bgp-holdtime] format: int64
bgp-holdtime (optional)
Long desc=BGP Holdtime (seconds) - default 180:type=uint32:range=[0,65535] format: int64
bgp-distance-external (optional)
Long desc=BGP distance for routes external to AS:type=uint32:range=[0,255]:requires=[bgp-distance-internal,bgp-distance-local] format: int64
bgp-distance-internal (optional)
Long desc=BGP distance for routes internal to AS:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-distance-local (optional)
Long desc=BGP distance for local routes:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-default-shutdown (optional)
Boolean desc=Apply administrative shutdown to newly configured peers
no-bgp-redist-static-route-map (optional)
Boolean desc=Remove route map for BGP static redistribution:precludes=[bgp-redist-static-route-map]
no-bgp-redist-connected-route-map (optional)
Boolean desc=Remove route map for BGP connected redistribution:precludes=[bgp-redist-connected-route-map]
no-bgp-redist-ospf-route-map (optional)
Boolean desc=Remove route map for BGP OSPF redistribution:precludes=[bgp-redist-ospf-route-map]
bgp-graceful-shutdown (optional)
Boolean desc=BGP graceful shutdown RFC 8326
bgp-as (optional)
Long desc=BGP Autonomous System number from 1 to 4294967295:type=uint32:range=[1,4294967295] format: int64
bgp-redistribute (optional)
String desc=BGP route redistribution:type=flag
Enum:
static
connected
rip
ospf
router-id (optional)
String desc=OSPF and BGP router id:type=IPv4 or IPv6 address

vrouter-vrf-modify - Up

modify a vRouter vrf
bgp-redist-static-route-map (optional)
String desc=route map for BGP redistribution of static routes:precludes=[no-bgp-redist-static-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
bgp-redist-connected-route-map (optional)
String desc=route map for BGP redistribution of connected routes:precludes=[no-bgp-redist-connected-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
bgp-redist-ospf-route-map (optional)
String desc=route map for BGP redistribution of OSPF routes:precludes=[no-bgp-redist-ospf-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
bgp-redist-static-metric (optional)
Long desc=BGP route redistribution static metric:range=[-1,4294967295] format: int64
api.bgp-redist-static-metric (optional)
Enum:
none
bgp-redist-connected-metric (optional)
Long desc=metric for redistributing BGP connected routes:range=[-1,4294967295] format: int64
api.bgp-redist-connected-metric (optional)
Enum:
none
bgp-redist-rip-metric (optional)
Long desc=metric for redistributing RIP connected routes:range=[-1,4294967295] format: int64
api.bgp-redist-rip-metric (optional)
Enum:
none
bgp-redist-ospf-metric (optional)
Long desc=metric for BGP to redistribute OSPF connected routes:range=[-1,4294967295] format: int64
api.bgp-redist-ospf-metric (optional)
Enum:
none
bgp-cluster-id (optional)
String desc=IP address for BGP cluster ID:type=IPv4 or IPv6 address
bgp-dampening (optional)
Boolean desc=dampening for BGP routes
bgp-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds) - default 60:type=uint32:range=[0,65535]:requires=[bgp-holdtime] format: int64
bgp-holdtime (optional)
Long desc=BGP Holdtime (seconds) - default 180:type=uint32:range=[0,65535] format: int64
bgp-distance-external (optional)
Long desc=BGP distance for routes external to AS:type=uint32:range=[0,255]:requires=[bgp-distance-internal,bgp-distance-local] format: int64
bgp-distance-internal (optional)
Long desc=BGP distance for routes internal to AS:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-distance-local (optional)
Long desc=BGP distance for local routes:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-default-shutdown (optional)
Boolean desc=Apply administrative shutdown to newly configured peers
no-bgp-redist-static-route-map (optional)
Boolean desc=Remove route map for BGP static redistribution:precludes=[bgp-redist-static-route-map]
no-bgp-redist-connected-route-map (optional)
Boolean desc=Remove route map for BGP connected redistribution:precludes=[bgp-redist-connected-route-map]
no-bgp-redist-ospf-route-map (optional)
Boolean desc=Remove route map for BGP OSPF redistribution:precludes=[bgp-redist-ospf-route-map]
bgp-graceful-shutdown (optional)
Boolean desc=BGP graceful shutdown RFC 8326
bgp-as (optional)
Long desc=BGP Autonomous System number from 1 to 4294967295:type=uint32:range=[1,4294967295] format: int64
bgp-redistribute (optional)
String desc=BGP route redistribution:type=flag
Enum:
static
connected
rip
ospf
router-id (optional)
String desc=OSPF and BGP router id:type=IPv4 or IPv6 address

vrouter-vrf-show - Up

display vRouter vrf
api.switch-name (optional)
vrf
String desc=Name of the vrf:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
hw-vrid (optional)
Integer desc=hw_vrid associated with VRF:range=[0,15] format: int32
bgp-redist-static-route-map (optional)
String desc=route map for BGP redistribution of static routes:precludes=[no-bgp-redist-static-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
bgp-redist-connected-route-map (optional)
String desc=route map for BGP redistribution of connected routes:precludes=[no-bgp-redist-connected-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
bgp-redist-ospf-route-map (optional)
String desc=route map for BGP redistribution of OSPF routes:precludes=[no-bgp-redist-ospf-route-map]:api-ref-path=/vrouters/{vrouter-name}/route-maps:api-ref-model=vrouter-route-map-show:api-ref-id=name:api-ref-val=name
bgp-redist-static-metric (optional)
Long desc=BGP route redistribution static metric:range=[-1,4294967295] format: int64
bgp-redist-connected-metric (optional)
Long desc=metric for redistributing BGP connected routes:range=[-1,4294967295] format: int64
bgp-redist-rip-metric (optional)
Long desc=metric for redistributing RIP connected routes:range=[-1,4294967295] format: int64
bgp-redist-ospf-metric (optional)
Long desc=metric for BGP to redistribute OSPF connected routes:range=[-1,4294967295] format: int64
bgp-cluster-id (optional)
String desc=IP address for BGP cluster ID:type=IPv4 or IPv6 address
bgp-bestpath-as-path (optional)
String desc=best path for BGP:type=flag
Enum:
ignore
multipath-relax
bgp-dampening (optional)
Boolean desc=dampening for BGP routes
bgp-delayed-startup (optional)
Integer desc=Delays forming peer adjacency on bootup:type=uint16:range=[0,36000] format: int32
bgp-update-delay-strict (optional)
Integer desc=Put bgp read-only mode on bootup, Recommend value less than l3-to-vlag-delay:type=uint16:range=[0,3600] format: int32
bgp-keepalive-interval (optional)
Long desc=BGP Keepalive interval (seconds) - default 60:type=uint32:range=[0,65535]:requires=[bgp-holdtime] format: int64
bgp-holdtime (optional)
Long desc=BGP Holdtime (seconds) - default 180:type=uint32:range=[0,65535] format: int64
bgp-distance-external (optional)
Long desc=BGP distance for routes external to AS:type=uint32:range=[0,255]:requires=[bgp-distance-internal,bgp-distance-local] format: int64
bgp-distance-internal (optional)
Long desc=BGP distance for routes internal to AS:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-distance-local (optional)
Long desc=BGP distance for local routes:type=uint32:range=[0,255]:requires=[bgp-distance-external] format: int64
bgp-global-nh-preference (optional)
String desc=use global nexthop preference for choosing nexthop type in BGP-ipv6:type=enum
Enum:
none
true
false
bgp-default-shutdown (optional)
Boolean desc=Apply administrative shutdown to newly configured peers
no-bgp-redist-static-route-map (optional)
Boolean desc=Remove route map for BGP static redistribution:precludes=[bgp-redist-static-route-map]
no-bgp-redist-connected-route-map (optional)
Boolean desc=Remove route map for BGP connected redistribution:precludes=[bgp-redist-connected-route-map]
no-bgp-redist-ospf-route-map (optional)
Boolean desc=Remove route map for BGP OSPF redistribution:precludes=[bgp-redist-ospf-route-map]
bgp-graceful-shutdown (optional)
Boolean desc=BGP graceful shutdown RFC 8326
bgp-as (optional)
Long desc=BGP Autonomous System number from 1 to 4294967295:type=uint32:range=[1,4294967295] format: int64
bgp-redistribute (optional)
String desc=BGP route redistribution:type=flag
Enum:
static
connected
rip
ospf
bgp-max-paths (optional)
Integer desc=maximum BGP paths:type=uint16:range=[0,16] format: int32
bgp-ibgp-multipath (optional)
Integer desc=number of IBGP multipath connections:type=uint16:range=[0,16] format: int32
router-id (optional)
String desc=OSPF and BGP router id:type=IPv4 or IPv6 address

vsg-create - Up

create vrf service group
name (optional)
String desc=vrf service group name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
description (optional)
String desc=vsg description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -

vsg-modify - Up

modify vrf service group
description (optional)
String desc=vsg description:pattern=^$|([ a-zA-Z0-9_.:-]+$):pattern-help=letters, numbers, _, ., :, spaces, and -

vsg-network-add - Up

add subnet/network to vsg
vrf
String desc=vrf name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
subnet (optional)
String desc=subnet name or 'all' for all subnets:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:precludes=[network,netmask,network6,netmask6]:api-ref-path=/subnets:api-ref-model=subnet-show:api-ref-id=name:api-ref-val=name
network (optional)
String desc=network:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[subnet]
netmask (optional)
Integer desc=mask:type=netmask:requires=[network]:precludes=[subnet]:mask-for=[network] format: int32
network6 (optional)
String desc=ip subnet network:type=IPv4 or IPv6 address:requires=[netmask6]:precludes=[subnet]
netmask6 (optional)
Integer desc=ip subnet netmask:type=netmask:requires=[network6]:precludes=[subnet]:mask-for=[network6] format: int32
vnet-id (optional)
String desc=VNET for the VRF:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

vsg-network-show - Up

display subnet/network in vsg
api.switch-name (optional)
vrf
String desc=vrf name:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
subnet
String desc=subnet name or 'all' for all subnets:precludes=[network,netmask,network6,netmask6]:api-ref-path=/subnets:api-ref-model=subnet-show:api-ref-id=name:api-ref-val=name
network
String desc=network:type=IPv4 or IPv6 address:requires=[netmask]:precludes=[subnet]
netmask
Integer desc=mask:type=netmask:requires=[network]:precludes=[subnet]:mask-for=[network] format: int32
network6
String desc=ip subnet network:type=IPv4 or IPv6 address:requires=[netmask6]:precludes=[subnet]
netmask6
Integer desc=ip subnet netmask:type=netmask:requires=[network6]:precludes=[subnet]:mask-for=[network6] format: int32
vnet-id
String desc=VNET for the VRF:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
network-state (optional)
String desc=network state:type=enum
Enum:
init
ok
vxlan not found
vxlan deactivated
not-in-hw
vrouter interface exists

vsg-route-add - Up

add route to be leaked in vsg
vrf
String desc=vrf name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
network
String desc=IP address:type=IPv4 or IPv6 address
netmask
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
gateway-ip
String desc=gateway IP address:type=IPv4 or IPv6 address
vnet-id (optional)
String desc=VNET for the VRF:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

vsg-route-show - Up

show routes leaked in vsg
api.switch-name (optional)
vrf
String desc=vrf name:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
network
String desc=IP address:type=IPv4 or IPv6 address
netmask
Integer desc=netmask:type=netmask:mask-for=[network] format: int32
vnet-id
String desc=VNET for the VRF:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
gateway-ip
String desc=gateway IP address:type=IPv4 or IPv6 address

vsg-show - Up

display vrf service group
api.switch-name (optional)
name
String desc=vrf service group name
description (optional)
String desc=vsg description

vsg-vrf-add - Up

add vrf to vrf service group
vrf
String desc=vrf name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
type (optional)
String desc=vrf list type:type=enum:default=promiscuous
Enum:
promiscuous
isolated
export-leaked-networks (optional)
String desc=vrf export to protocols:type=enum:default=none
Enum:
none
evpn
vnet-id (optional)
String desc=VNET for the VRF:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name

vsg-vrf-show - Up

display vrf in vrf service group
api.switch-name (optional)
vrf
String desc=vrf name:api-ref-path=/vrfs:api-ref-model=vrf-show:api-ref-id=name:api-ref-val=name
vnet-id
String desc=VNET for the VRF:type=identifier:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=id:api-ref-val=name
type (optional)
String desc=vrf list type:type=enum
Enum:
promiscuous
isolated
export-leaked-networks (optional)
String desc=vrf export to protocols:type=enum
Enum:
none
evpn

vtep-auto-vlan-modify - Up

modify VLAN IDs for automatic assignment at fabric level
vlans (optional)
Integer desc=VLAN IDs for automatic assignment at fabric level:type=uint16:range=[0,4095]:default=2500 format: int32
vlan-end (optional)
Integer desc=VLAN IDs for automatic assignment at fabric level:type=uint16:range=[0,4095]:default=2999 format: int32

vtep-auto-vlan-show - Up

display VXLAN IDs for automatic assignment at fabric level
api.switch-name (optional)
vlans (optional)
Integer desc=VLAN IDs for automatic assignment at fabric level:type=uint16:range=[0,4095] format: int32
vlan-end (optional)
Integer desc=VLAN IDs for automatic assignment at fabric level:type=uint16:range=[0,4095] format: int32

vtep-auto-vxlan-modify - Up

modify VXLAN IDs for automatic vtep assignment
vxlans (optional)
Long desc=VXLAN IDs for automatic vtep assignment:type=uint32:range=[0,16777215]:default=12000000 format: int64
vxlan-end (optional)
Long desc=VXLAN IDs for automatic vtep assignment:type=uint32:range=[0,16777215]:default=12999999 format: int64

vtep-auto-vxlan-show - Up

display VXLAN IDs for automatic vtep assignment
api.switch-name (optional)
vxlans (optional)
Long desc=VXLAN IDs for automatic vtep assignment:type=uint32:range=[0,16777215] format: int64
vxlan-end (optional)
Long desc=VXLAN IDs for automatic vtep assignment:type=uint32:range=[0,16777215] format: int64

vtep-create - Up

create a vtep
name
String desc=vtep name:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -
ip
String desc=Primary IP address:type=IPv4 or IPv6 address
scope (optional)
String desc=scope of vtep:default=fabric
Enum:
local
fabric
location (optional)
Long desc=switch name:type=uint32:api-ref-path=/fabric-node-extendeds:api-ref-model=fabric-node-extended-show:api-ref-id=id:api-ref-val=name format: int64
description (optional)
String desc=vtep description
vrouter-name (optional)
String desc=name of the vrouter service:pattern=^[a-zA-Z0-9_.:-]+$:pattern-help=letters, numbers, _, ., :, and -:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
virtual-ip (optional)
String desc=Virtual/Secondary IP address:type=IPv4 or IPv6 address
mac-learning (optional)
Boolean desc=Mac-learning enable or disable:default=true

vtep-modify - Up

modify a vtep
mac-learning
Boolean desc=Mac-learning enable or disable:default=true

vtep-show - Up

display vteps
api.switch-name (optional)
name
String desc=vtep name
scope (optional)
String desc=scope of vtep
Enum:
local
fabric
location (optional)
Long desc=switch name:type=uint32:api-ref-path=/fabric-node-extendeds:api-ref-model=fabric-node-extended-show:api-ref-id=id:api-ref-val=name format: int64
ip (optional)
String desc=Primary IP address:type=IPv4 or IPv6 address
description (optional)
String desc=vtep description
vrouter-name (optional)
String desc=name of the vrouter service:api-ref-path=/vrouters:api-ref-model=vrouter-show:api-ref-id=name:api-ref-val=name
virtual-ip (optional)
String desc=Virtual/Secondary IP address:type=IPv4 or IPv6 address
mac-learning (optional)
Boolean desc=Mac-learning enable or disable
evpn-border (optional)
Boolean desc=vtep on evpn border or not
mac (optional)
String desc=MAC address assigned for this VTEP:type=mac-address

vtep-vxlan-add - Up

add a VXLAN to a vtep
vxlan
Long desc=VXLAN identifier:type=uint32:range=[0,16777215]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
isolated (optional)
Boolean desc=VXLAN VNI mode to be Isolated or not:default=false

vtep-vxlan-show - Up

display VXLANs for a vtep
api.switch-name (optional)
vxlan
Long desc=VXLAN identifier:type=uint32:range=[0,16777215]:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=vxlan:api-ref-val=vxlan format: int64
isolated (optional)
Boolean desc=VXLAN VNI mode to be Isolated or not
hw_update_pending (optional)
Boolean desc=hw update for vxlan is pending
bd_deactivated (optional)
Boolean desc=static tunnel deactived in hw for this bd

vxlan-dest-port-modify - Up

modify VXLAN destination ports
port (optional)
Integer desc=VXLAN destination port:type=uint16:default=4789 format: int32

vxlan-dest-port-show - Up

display VXLAN destination ports
api.switch-name (optional)
port (optional)
Integer desc=VXLAN destination port:type=uint16 format: int32
hw-config (optional)
Long desc=VXLAN destination port in HW:type=uint32 format: int64

vxlan-stats-clear - Up

clear VXLAN statistics
vnid
Long desc=VXLAN ID:type=uint32:range=[0,16777215] format: int64

vxlan-stats-settings-modify - Up

modify VXLAN statistics collection settings
enable (optional)
Boolean desc=enable or disable statistics:default=true
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64:default=52428800 format: int64

vxlan-stats-settings-show - Up

display VXLAN statistics settings
api.switch-name (optional)
enable (optional)
Boolean desc=enable or disable statistics
interval (optional)
Long desc=interval to collect statistics format: int64
disk-space (optional)
Long desc=disk-space allocated for statistics (including rotated log files):type=uint64 format: int64

vxlan-stats-show - Up

display VXLAN statistics
api.switch-name (optional)
vnid
Long desc=VXLAN ID:type=uint32:range=[0,16777215] format: int64
vnet (optional)
String desc=VNET of the VLAN:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
ibytes (optional)
Long desc=number of incoming bytes for VLAN:type=uint64:filter=false format: int64
ibits (optional)
Long desc=number of incoming bits for VLAN:type=uint64 format: int64
ipkts (optional)
Long desc=number of incoming packets for VLAN:type=uint64:filter=false format: int64
idrops-bytes (optional)
Long desc=number of incoming dropped bytes for VLAN:type=uint64:filter=false format: int64
idrops-pkts (optional)
Long desc=number of incoming dropped packets for VLAN:type=uint64:filter=false format: int64
obytes (optional)
Long desc=number of outgoing bytes for VLAN:type=uint64:filter=false format: int64
obits (optional)
Long desc=number of outgoing bits for VLAN:type=uint64 format: int64
opkts (optional)
Long desc=number of outgoing packets for VLAN:type=uint64:filter=false format: int64
odrops-bytes (optional)
Long desc=number of outgoing dropped bytes for VLAN:type=uint64:filter=false format: int64
odrops-pkts (optional)
Long desc=number of outgoing dropped packets for VLAN:type=uint64:filter=false format: int64
vxlan-name (optional)
String desc=VXLAN name:api-ref-path=/vlans:api-ref-model=vlan-show:api-ref-id=description:api-ref-val=description
start-time (optional)
String desc=start-time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[since-start,within-last]
end-time (optional)
String desc=end time of statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[older-than]
duration (optional)
Long desc=duration of statistic collection format: int64
interval (optional)
Long desc=interval between statistic collection format: int64
since-start (optional)
Boolean desc=statistics collected since start time:precludes=[start-time,within-last]
older-than (optional)
Long desc=statistics older than time:precludes=[end-time] format: int64
within-last (optional)
Long desc=statistics within last time:precludes=[start-time,since-start] format: int64
time (optional)
String desc=time to start statistic collection:date=yyyy-mm-ddThh:mm:ss:precludes=[start-time,end-time,duration,interval,since-start,older-than,within-last]
bd (optional)
String desc=vxlan Bridge Domain:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name
vlan (optional)
Integer desc=name of the VLAN:type=uint16:range=[0,4095] format: int32

web-cert-import - Up

import certificates from sftp directory
file-ca
String desc=Name of CA Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
file-server
String desc=Name of Server Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters
file-inter (optional)
String desc=Name of Intermediate CA Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters

web-cert-import-1 - Up

import certificates from sftp directory
file-server
String desc=Name of Server Certificate File:pattern=^/{0,1}([a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])(/[a-zA-Z0-9_:,-][a-zA-Z0-9_.:,-])*$:pattern-help=/-separated components consisting of letters, numbers, and '_.:,-' characters

web-cert-info-show - Up

display certificate information
api.switch-name (optional)
subject (optional)
String desc=The subject of the certificate
issuer (optional)
String desc=The issuer of the certificate
status (optional)
String desc=The expiration status of the certificate
cert-type (optional)
String desc=The type of certificate: CA, intermediate or server:type=enum
Enum:
ca
intermediate
server
valid-from (optional)
String desc=The time from which the certificate is valid.
valid-to (optional)
String desc=The time at which the certificate expires and is no longer valid.
serial-number (optional)
Long desc=The serial number of the certificate:type=uint64 format: int64

web-cert-request-show - Up

display certificate signing request
api.switch-name (optional)
cert-request (optional)
String desc=Certificate Signing Request

web-cert-self-signed-create - Up

create self-signed certificate; deletes existing certificates
country
String desc=Country Name (2 letter code)
state
String desc=State or Province Name
city
String desc=City Name
organization
String desc=Organization Name
organizational-unit
String desc=Organizational Unit Name
common-name
String desc=Common Name

web-cert-upload - Up

upload certificates through APIs
cert-ca
String desc=CA Certificate
cert-server
String desc=Server Certificate
cert-inter (optional)
String desc=Intermediate CA Certificate

web-cert-upload-1 - Up

upload certificates through APIs
cert-server
String desc=Server Certificate

xact-truncate-show - Up

display xact logs information
api.switch-name (optional)
duration (optional)
Long desc=duration to match format: int64
time (optional)
String desc=time of the event:filter=false
pid (optional)
Long desc=product ID generating log messages to match:type=uint32 format: int64
name (optional)
String desc=message name to match
code (optional)
Long desc=message code to match:type=uint64 format: int64
level (optional)
String desc=the level of severity to match:type=enum
Enum:
critical
error
warn
note
info
vnet (optional)
String desc=VNET to match:api-ref-path=/vnets:api-ref-model=vnet-show:api-ref-id=name:api-ref-val=name
user (optional)
String desc=username to match:api-ref-path=/users:api-ref-model=user-show:api-ref-id=name:api-ref-val=name
port (optional)
Long desc=port to match:type=uint32 format: int64
vlan (optional)
Integer desc=VLAN to match:type=uint16:range=[0,4095] format: int32
vxlan (optional)
String desc=VXLAN to match
args (optional)
String desc=arguments to match:filter=false
message (optional)
String desc=the message to match:filter=false
reverse (optional)
Boolean desc=reverse the order of the messages:requires=[starting-point,length,count]
end-time (optional)
String desc=end time to match:date=yyyy-mm-ddThh:mm:ss
program (optional)
String desc=name of the program used to generate log messages
remote_switch (optional)
String desc=remote switch node to match:api-ref-path=/nodes:api-ref-model=node-show:api-ref-id=name:api-ref-val=name
switch (optional)
String desc=switch to collect log events:filter=false
length (optional)
Long desc=message length to match:type=uint64:requires=[starting-point,count] format: int64
client-pid (optional)
Long desc=product ID to match:type=uint32 format: int64
starting-point (optional)
Long desc=message starting point to match:type=uint64:requires=[length,count] format: int64
client-addr (optional)
String desc=client IP address to match:type=IPv4 or IPv6 address
show-time (optional)
String desc=the time that the message appeared:filter=false
start-time (optional)
String desc=start-time to match:date=yyyy-mm-ddThh:mm:ss
bd (optional)
String desc=Bridge Domain to match:api-ref-path=/bridge-domains:api-ref-model=bridge-domain-show:api-ref-id=name:api-ref-val=name

Definitions

String

In computer programming, a string is traditionally a sequence of characters, either as a literal constant or as a variable.

Boolean

In computer science, the Boolean data type is a data type that has one of two possible values (usually denoted true and false), which is intended to represent the two truth values of logic and Boolean algebra.

Integer

An integer programming problem is a mathematical optimization or feasibility program in which some or all of the variables are restricted to be integers.