Documentation Powered by ReDoc

Monitor Service (2.5.5)

Download OpenAPI specification:Download

Extreme Networks: support@extremenetworks.com URL: http://www.extremenetworks.com License: Apache license

This is the spec that defines the API provided by the application to validate authorization for the passed role

Monitor K3s

getK3sPod

Get K3s Pod Monitoring Info

query Parameters
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "namespace": "string",
  • "pods": [
    ]
}

getK3sNodeLabel

Get K3s Node Label

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ]
}

getK3sClusterResources

Get K3s cluster resources

query Parameters
namespace
required
string

Namespace of the pod

Responses

Response samples

Content type
application/json
{
  • "statefulSetApps": {
    },
  • "replicaSetApps": {
    },
  • "deploymentApps": {
    },
  • "servicePods": {
    },
  • "pods": {
    }
}

Monitor Service

getK3sInfo

Get K3s Monitoring Info

Responses

Response samples

Content type
application/json
{
  • "serviceName": "string",
  • "version": "string",
  • "active": "string",
  • "status": "string",
  • "memory": "string",
  • "cpu": "string",
  • "nodeIP": "string"
}

getMariaDBInfo

Get Maria DB Monitoring Info

Responses

Response samples

Content type
application/json
{
  • "serviceName": "string",
  • "version": "string",
  • "active": "string",
  • "status": "string",
  • "memory": "string",
  • "cpu": "string",
  • "nodeIP": "string"
}

getGlusterFSInfo

Get Gluster FS Monitoring Info

Responses

Response samples

Content type
application/json
{
  • "serviceName": "string",
  • "version": "string",
  • "active": "string",
  • "status": "string",
  • "memory": "string",
  • "cpu": "string",
  • "nodeIP": "string"
}

getKeepAlivedInfo

Get Keep Alive D Monitoring Info

Responses

Response samples

Content type
application/json
{
  • "serviceName": "string",
  • "version": "string",
  • "active": "string",
  • "status": "string",
  • "memory": "string",
  • "cpu": "string",
  • "nodeIP": "string"
}

Get EFA Status

Status of EFA

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ]
}

getServiceInfo

Get All Service Monitoring Info

Responses

Response samples

Content type
application/json
{
  • "services": [
    ]
}

Config

getSetupConfig

Get Setup Config

Responses

Response samples

Content type
application/json
{
  • "setupconfig": [
    ],
  • "nodes": {
    }
}

getAllStatus

Get all status

Responses

Response samples

Content type
application/json
{
  • "deploymentConfig": {
    },
  • "resources": {
    },
  • "servicesStatus": {
    },
  • "nodes": {
    },
  • "pods": [
    ]
}

Redeploy

redeploy

Redeploy EFA after TPVM upgrade

query Parameters
cleanRedeploy
boolean

Removes all apps data prior to redeploying EFA

Responses

Response samples

Content type
application/json
{
  • "id": "ade23a74-4ead-11eb-ae93-0242ac130002"
}

redeploy status

Get status of redeploy operation

path Parameters
redeployId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "initiated",
  • "message": "string"
}

SupportSave

getSupport

Capture the supportsave data and return the file name in the response

Request Body schema: application/json

SupportSave request

fabric
string
device-ips
string
fabric-all
boolean

Responses

Request samples

Content type
application/json
{
  • "fabric": "string",
  • "device-ips": "10.24.131.3,162.101.21.2,192.24.32.204",
  • "fabric-all": true
}

Response samples

Content type
application/json
{
  • "ss_file_name": "/var/log/efa/efa_2020-11-16T23:33:03.logs.zip"
}

Backup

create backup

Backup all EFA configurations

Request Body schema: application/json

Config Backup request

fabric
string
device-ips
Array of strings unique
remote
boolean
fabric-all
boolean

Responses

Request samples

Content type
application/json
{
  • "fabric": "string",
  • "device-ips": [
    ],
  • "remote": true,
  • "fabric-all": true
}

Response samples

Content type
application/json
{
  • "location": "/var/log/efa/backup/EFA-2020-11-16T23.33.03.tar"
}

Restore

restore

Restore all EFA configurations

Request Body schema: application/json
tar_name
required
string

Name of the backup archive file.

Responses

Request samples

Content type
application/json
{
  • "tar_name": "EFA-2020-11-16T23.33.03.tar"
}

Response samples

Content type
application/json
{
  • "id": "ade23a74-4ead-11eb-ae93-0242ac130002"
}

restore status

Get status of restore operation

path Parameters
restoreId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "initiated",
  • "issuedAt": "string",
  • "message": "string",
  • "request": {
    }
}

restore history

Get list of all restore operations

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

SubInterface

getSubInterface

Get specified Subinterface or all Subinterfaces

query Parameters
name
string

Name of subinterface

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

createSubInterface

Create SubInterface

Request Body schema: application/json

Create a Subinterface

name
required
string

Name of the Subinterface

vlan_id
required
integer

Vlan Id of Subinterface

ip_subnet
required
string

IP address including subnet mask of Subinterface

Responses

Request samples

Content type
application/json
{
  • "name": "eth0.20",
  • "vlan_id": 20,
  • "ip_subnet": "192.168.2.1/24"
}

Response samples

Content type
application/json
{
  • "vlan_id": 20,
  • "ip_subnet": "192.168.2.1/24",
  • "interface": "eth0",
  • "name": "eth0.20"
}

deleteSubInterface

Delete subinterface

query Parameters
name
required
string

Name of the subinterface

Responses

Response samples

Content type
application/json
{
  • "vlan_id": 20,
  • "ip_subnet": "192.168.2.1/24",
  • "interface": "eth0",
  • "name": "eth0.20"
}

StaticIPs

getStaticIPs

Get StaticIPs of SubInterface

Responses

Response samples

Content type
application/json
[
  • {
    }
]

addStaticIPs

Adding StaticIPs to SubInterface

Request Body schema: application/json

Adding StaticIPs

subinterface
required
string

Name of the subinterface where the static IPs will be assigned

ip1
required
string

first Static IP Address+mask in CIDR format

ip2
required
string

Second Static IP Address+mask in CIDR format

Responses

Request samples

Content type
application/json
{
  • "subinterface": "efa-sub-200",
  • "ip1": "192.168.102.1/24",
  • "ip2": "192.168.102.2/24"
}

Response samples

Content type
application/json
{
  • "subinterface": "efa-sub-200",
  • "node1": {
    },
  • "node2": {
    }
}

removeStaticIPs

Removing StaticIPs of SubInterface

query Parameters
name
required
string

Name of the subinterface

Responses

Response samples

Content type
application/json
{
  • "subinterface": "efa-sub-200",
  • "node1": {
    },
  • "node2": {
    }
}

VirtualRoute

getVirtualRoute

Get specified VirtualRoute or all VirtualRoutes

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

createVirtualRoute

Create VirtualRoute

Request Body schema: application/json

Create a VirtualRoute

route_src
required
string

IP address of VirtualRoute src

route_to
required
string

CIDR spec of VirtualRoute target network

route_via
required
string

IP address of VirtualRoute next-hop

Responses

Request samples

Content type
application/json
{
  • "route_src": "192.168.34.40",
  • "route_to": "10.20.0.0/16",
  • "route_via": "192.168.34.45"
}

Response samples

Content type
application/json
{
  • "route_src": "192.168.34.40",
  • "route_to": "10.20.0.0/16",
  • "route_via": "192.168.34.45"
}

deleteVirtualRoute

Delete virtualroute

Request Body schema: application/json

Delete a VirtualRoute

route_src
required
string

IP address of VirtualRoute src

route_to
required
string

CIDR spec of VirtualRoute target network

route_via
required
string

IP address of VirtualRoute next-hop

Responses

Request samples

Content type
application/json
{
  • "route_src": "192.168.34.40",
  • "route_to": "10.20.0.0/16",
  • "route_via": "192.168.34.45"
}

Response samples

Content type
application/json
{
  • "route_src": "192.168.34.40",
  • "route_to": "10.20.0.0/16",
  • "route_via": "192.168.34.45"
}