Documentation Powered by ReDoc

Monitor Service (2.6.0)

Download OpenAPI specification:Download

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

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

Monitor K3s

Get K3S pod.

Get K3s pod monitoring information.

query Parameters
namespace
required
string

Responses

200

OK

404

Not found in the system.

500

Unexpected error.

default

Unexpected error.

get/monitor/k3s/pod
http://monitor-service:8078/v1/monitor/k3s/pod

Response samples

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

Get K3s node label.

Get K3s node label.

Responses

200

OK

404

Not found in the system.

500

Unexpected error.

default

Unexpected error.

get/monitor/k3s/nodes
http://monitor-service:8078/v1/monitor/k3s/nodes

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "nodes":
    [
    ]
}

Get K3s cluster resources.

Get K3s cluster resources.

query Parameters
namespace
required
string

Namespace of the pod.

Responses

200

OK

404

No backup tar provided.

500

Unexpected error.

default

Unexpected error.

get/monitor/k3s/resources
http://monitor-service:8078/v1/monitor/k3s/resources

Response samples

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

Monitor Service

Get K3s information.

Get K3s monitoring information.

Responses

200

OK

404

No backup tar provided.

500

Unexpected error.

default

Unexpected error.

get/monitor/status/k3s
http://monitor-service:8078/v1/monitor/status/k3s

Response samples

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

Get MariaDB information.

Get MariaDB monitoring information.

Responses

200

OK

404

No backup tar provided.

500

Unexpected error.

default

Unexpected error.

get/monitor/status/mariadb
http://monitor-service:8078/v1/monitor/status/mariadb

Response samples

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

Get GlusterFS information.

Get GlusterFS monitoring information.

Responses

200

OK

404

No backup tar provided.

500

Unexpected error.

default

Unexpected error.

get/monitor/status/glusterfs
http://monitor-service:8078/v1/monitor/status/glusterfs

Response samples

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

Get Keepalived information.

Get Keepalived monitoring information.

Responses

200

OK

404

No backup tar provided.

500

Unexpected error.

default

Unexpected error.

get/monitor/status/keepalived
http://monitor-service:8078/v1/monitor/status/keepalived

Response samples

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

Get EFA status.

Status of EFA.

Responses

200

OK

500

Unexpected error.

default

Unexpected error.

get/monitor/status/efa
http://monitor-service:8078/v1/monitor/status/efa

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "nodes":
    [
    ]
}

Get service information.

Get all service monitoring information.

Responses

200

OK

404

No backup tar provided.

500

Unexpected error.

default

Unexpected error.

get/monitor/status
http://monitor-service:8078/v1/monitor/status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "services":
    [
    ]
}

Config

Get setup configuration.

Get setup configuration.

Responses

200

OK

404

No found in the system.

500

Unexpected error.

default

Unexpected error.

get/monitor/deployment
http://monitor-service:8078/v1/monitor/deployment

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "setupconfig":
    [
    ],
  • "nodes":
    {
    }
}

Get all status.

Get all status.

Responses

200

OK

404

No found in the system.

500

Unexpected error.

default

Unexpected error.

get/monitor/all
http://monitor-service:8078/v1/monitor/all

Response samples

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

Redeploy

Redeploy

Redeploy EFA after TPVM upgrade.

query Parameters
cleanRedeploy
boolean

Removes all app data prior to redeploying EFA.

Responses

202

Accepted

401

Authorization information is missing or invalid.

404

Not found.

500

Unexpected error.

default

Unexpected error.

post/monitor/redeploy
http://monitor-service:8078/v1/monitor/redeploy

Response samples

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

Redeploy status.

Get status of redeploy operation.

path Parameters
redeployId
required
string

Responses

200

Redeploy operation status.

404

No restore operation with given ID.

500

Unexpected error.

default

Unexpected error.

get/monitor/redeploy/{redeployId}
http://monitor-service:8078/v1/monitor/redeploy/{redeployId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "initiated",
  • "message": "string"
}

SupportSave

Get support.

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

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error.

get/system/supportsave
http://monitor-service:8078/v1/system/supportsave

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
Copy
 Expand all Collapse all
{
  • "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

Configuration backup request.

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

Responses

200

OK

401

Authorization information is missing or invalid.

404

Not found.

500

Unexpected error.

default

Unexpected error.

post/system/backup
http://monitor-service:8078/v1/system/backup

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

202

Accepted

401

Authorization information is missing or invalid.

404

No backup tar provided.

500

Unexpected error.

default

Unexpected error.

post/system/restore
http://monitor-service:8078/v1/system/restore

Request samples

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

Response samples

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

Restore status.

Get status of restore operation.

path Parameters
restoreId
required
string

Responses

200

Restore operation status.

404

No restore operation with given ID.

500

Unexpected error.

default

Unexpected error.

get/system/restore/{restoreId}
http://monitor-service:8078/v1/system/restore/{restoreId}

Response samples

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

Restore history.

Get list of all restore operations.

Responses

200

Restore history.

404

No restore operation is performed.

500

Unexpected error.

default

Unexpected error.

get/system/restore-history
http://monitor-service:8078/v1/system/restore-history

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ]
}

SubInterface

Get subinterface.

Get specified subinterface or all subinterfaces.

query Parameters
name
string

Name of subinterface.

Responses

200

OK

401

Authorization information is missing or invalid.

404

Subinterface is not found in the system.

500

Unexpected error.

default

Unexpected error.

get/mgmt/subinterface
http://monitor-service:8078/v1/mgmt/subinterface

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ]
}

Create subinterface.

Create subinterface.

Request Body schema: application/json

Create a subinterface.

name
required
string

Name of the subinterface.

vlan_id
required
integer

VLAN ID of the subinterface.

ip_subnet
required
string

IP address including subnet mask of subinterface.

Responses

200

OK

401

Authorization information is missing or invalid.

409

A subinterface with the specified name already exists.

500

Unexpected error.

default

Unexpected error.

post/mgmt/subinterface
http://monitor-service:8078/v1/mgmt/subinterface

Request samples

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

Response samples

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

Delete subinterface.

Delete subinterface.

query Parameters
name
required
string

Name of the subinterface.

Responses

200

OK

401

Authorization information is missing or invalid.

409

A subinterface with the specified name is not found.

500

Unexpected error.

default

Unexpected error.

delete/mgmt/subinterface
http://monitor-service:8078/v1/mgmt/subinterface

Response samples

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

StaticIPs

Get static IPs.

Get static IPs of subinterface.

Responses

200

OK

401

Authorization information is missing or invalid.

404

Static IPs are not found in the subinterface.

500

Unexpected error.

default

Unexpected error.

get/mgmt/subinterface/staticips
http://monitor-service:8078/v1/mgmt/subinterface/staticips

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add static IPs.

Adding static IPs to subinterface.

Request Body schema: application/json

Adding static IPs.

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

200

OK

401

Authorization information is missing or invalid.

409

Specified static IPs already exists.

500

Unexpected error.

default

Unexpected.

post/mgmt/subinterface/staticips
http://monitor-service:8078/v1/mgmt/subinterface/staticips

Request samples

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

Response samples

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

Remove static IPs.

Removing static IPs of subinterface.

query Parameters
name
required
string

Name of the subinterface.

Responses

200

OK

401

Authorization information is missing or invalid.

409

Specified static IPs doesn't exist.

500

Unexpected error.

default

Unexpected error.

delete/mgmt/subinterface/staticips
http://monitor-service:8078/v1/mgmt/subinterface/staticips

Response samples

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

VirtualRoute

Get virtual route.

Get specified virtual route or all virtual routes.

Responses

200

OK

401

Authorization information is missing or invalid.

404

Virtual route is not found in the system.

500

Unexpected error.

default

Unexpected error.

get/mgmt/virtualroute
http://monitor-service:8078/v1/mgmt/virtualroute

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ]
}

Create virtual route.

Create VirtualRoute

Request Body schema: application/json

Create a virtual route.

route_src
required
string

IP address of virtual route source.

route_to
required
string

CIDR spec of virtual route target network.

route_via
required
string

IP address of virtual route next-hop.

Responses

200

OK

401

Authorization information is missing or invalid.

409

A VirtualRoute with the specified name already exists.

500

Unexpected error.

default

Unexpected error.

post/mgmt/virtualroute
http://monitor-service:8078/v1/mgmt/virtualroute

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
Copy
 Expand all Collapse all
{
  • "route_src": "192.168.34.40",
  • "route_to": "10.20.0.0/16",
  • "route_via": "192.168.34.45"
}

Delete virtual route.

Delete virtual route.

Request Body schema: application/json

Delete a virtual route.

route_src
required
string

IP address of virtual route source.

route_to
required
string

CIDR spec of virtual route target network.

route_via
required
string

IP address of virtual route next-hop.

Responses

200

OK

401

Authorization information is missing or invalid.

409

A virtual route with the specified name is not found.

500

Unexpected error.

default

Unexpected error.

delete/mgmt/virtualroute
http://monitor-service:8078/v1/mgmt/virtualroute

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
Copy
 Expand all Collapse all
{
  • "route_src": "192.168.34.40",
  • "route_to": "10.20.0.0/16",
  • "route_via": "192.168.34.45"
}