API docs by Redocly

Monitor Service (3.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.

Service

Enable and start service.

Authorizations:
bearerAuth
query Parameters
service
required
string

Name of the service to enable

Responses

Response samples

Content type
application/json
{
  • "message": "Device is already registered in inventory",
  • "code": 101
}

Disable and stop service.

Authorizations:
bearerAuth
query Parameters
service
required
string

Name of the service to disable

Responses

Response samples

Content type
application/json
{
  • "message": "Device is already registered in inventory",
  • "code": 101
}

Monitor K3s

Get K3S pod.

Get K3s pod monitoring information.

query Parameters
namespace
required
string

Responses

Response samples

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

Options K3S pod.

Options K3s pod monitoring information.

Responses

Get K3s node label.

Get K3s node label.

Responses

Response samples

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

Get K3s cluster resources.

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

Get K3s information.

Get K3s monitoring information.

Responses

Response samples

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

Get MariaDB information.

Get MariaDB monitoring information.

Responses

Response samples

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

Get GlusterFS information.

Get GlusterFS monitoring information.

Responses

Response samples

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

Get Keepalived information.

Get Keepalived monitoring information.

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": [
    ]
}

Get service information.

Get all service monitoring information.

Responses

Response samples

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

Options Servoce.

Options Service monitoring information.

Responses

Monitor efa

Options efa pod.

Options efa pod monitoring information.

Responses

Config

Get setup configuration.

Get setup configuration.

Responses

Response samples

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

Get all status.

Get all status.

Responses

Response samples

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

Monitor Deployment

Options monitor Deployment.

Options monitoring deployment information.

Responses

Redeploy

Redeploy

Redeploy EFA after TPVM upgrade.

Authorizations:
bearerAuth
query Parameters
cleanRedeploy
boolean

Removes all app 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.

Authorizations:
bearerAuth
path Parameters
redeployId
required
string

Responses

Response samples

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

ActiveTpvmReboot

ActiveTpvmReboot

Reboot Active TPVM

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": true
}

Certificate

Get expiry date of EFA certificates

Get expiry date of EFA certificates

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Renew EFA certificates

Renew EFA certificates

Authorizations:
bearerAuth
query Parameters
certType
string

Regenerate certificates

Responses

Response samples

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

Install 3rd Party Certificates

Install 3rd Party Certificates

Authorizations:
bearerAuth
Request Body schema: application/json
required

Install 3rd Party Certificates

certificate
string

Custom Certificate in pem format to be installed for EFA

key
string

Custom Key in pem format to be installed for EFA

cacert
string

Custom CA Certificate in pem format to be installed for EFA

Responses

Request samples

Content type
application/json
{
  • "certificate": "string",
  • "key": "string",
  • "cacert": "string"
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Alert

Send an alert to EFA (including health-related alerts)

Send an alert to EFA (including health-related alerts). This API is available to authenticated clients only.

Authorizations:
bearerAuth
query Parameters
alert
string

A base64-encoded JSON document representing the alert.

Responses

Response samples

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

Send an alert to EFA from local clients (including health-related alerts)

Send an alert to EFA (including health-related alerts). This API is available to local (on-machine) clients only, via the Monitor service's restricted Unix-domain socket.

query Parameters
alert
string

A base64-encoded JSON document representing the alert.

Responses

Response samples

Content type
application/json
{
  • "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
file-name
string

Optional file name. If provided, same name will be used

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,
  • "file-name": "string"
}

Response samples

Content type
application/json
{
  • "ss_file_name": "/var/log/efa/efa_2020-11-16T23:33:03.logs.zip",
  • "ss_file_name_remote": "10.37.34.151:/home/user/defect_logs/efa_2023-02-28T08-24-37.821.logs.zip"
}

SupportSaveList

Get support.

Capture the supportsavelist data and return the file name(s) and date in the response.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Backup

Create backup.

Backup all EFA configurations.

Authorizations:
bearerAuth
Request Body schema: application/json
optional

Configuration 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"
}

BackupList

Get backup files list.

Capture the backup list filename,version and its captured user response.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Restore

Restore

Restore all EFA configurations.

Authorizations:
bearerAuth
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.

Authorizations:
bearerAuth

Responses

Response samples

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

SubInterface

Get subinterface.

Get specified subinterface or all subinterfaces.

Authorizations:
bearerAuth
query Parameters
name
string

Name of subinterface.

Responses

Response samples

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

Create subinterface.

Create subinterface.

Authorizations:
bearerAuth
Request Body schema: application/json
required

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.

ipv6_subnet
string

IPv6 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",
  • "ipv6_subnet": "2000::1/64"
}

Response samples

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

Delete subinterface.

Delete subinterface.

Authorizations:
bearerAuth
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",
  • "ipv6_subnet": "2000::1/64",
  • "interface": "eth0",
  • "name": "eth0.20"
}

StaticIPs

Get static IPs.

Get static IPs of subinterface.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add static IPs.

Adding static IPs to subinterface.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Adding static IPs.

subinterface
required
string

Name of the subinterface where the static IPs will be assigned.

ip1
required
string

First static IPv4 address+mask in CIDR format.

ip2
required
string

Second static IPv4 address+mask in CIDR format.

ip3
string

First static IPv6 address+mask in CIDR format.

ip4
string

Second static IPv6 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",
  • "ip3": "2000::1/64",
  • "ip4": "2000::2/64"
}

Response samples

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

Remove static IPs.

Removing static IPs of subinterface.

Authorizations:
bearerAuth
query Parameters
name
required
string

Name of the subinterface.

Responses

Response samples

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

VirtualRoute

Get virtual route.

Get specified virtual route or all virtual routes.

Authorizations:
bearerAuth

Responses

Response samples

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

Create virtual route.

Create VirtualRoute

Authorizations:
bearerAuth
Request Body schema: application/json
required

Create a virtual route.

route_src
required
string

IPv4/IPv6 address of virtual route source.

route_to
required
string

IPv4/IPv6 CIDR spec of virtual route target network.

route_via
required
string

IPv4/IPv6 address of virtual route next-hop.

Responses

Request samples

Content type
application/json
{
  • "route_src": "192.168.34.40 or 2000::1",
  • "route_to": "10.20.0.0/16 or 3000::/64",
  • "route_via": "192.168.34.45 or 2000::2"
}

Response samples

Content type
application/json
{
  • "route_src": "192.168.34.40 or 2000::1",
  • "route_to": "10.20.0.0/16 or 3000::/64",
  • "route_via": "192.168.34.45 or 2000::2"
}

Delete virtual route.

Delete virtual route.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Delete a virtual route.

route_src
required
string

IPv4/IPv6 address of virtual route source.

route_to
required
string

IPv4/IPv6 CIDR spec of virtual route target network.

route_via
required
string

IPv4/IPv6 address of virtual route next-hop.

Responses

Request samples

Content type
application/json
{
  • "route_src": "192.168.34.40 or 2000::1",
  • "route_to": "10.20.0.0/16 or 3000::/64",
  • "route_via": "192.168.34.45 or 2000::2"
}

Response samples

Content type
application/json
{
  • "route_src": "192.168.34.40 or 2000::1",
  • "route_to": "10.20.0.0/16 or 3000::/64",
  • "route_via": "192.168.34.45 or 2000::2"
}

Health

getHealth

Gets the HQI (Health Quality Indicator) of the EFA System

query Parameters
resource
string

Health resource path associated to the alert being sent

detail
boolean
Default: false

Detail of health resource associated with the alert

Responses

Response samples

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

getHealthDetail

Gets HQI values at Certificate and any metadata providing details for health deterioration

query Parameters
resource
string

Health resource path associated to the alert being sent

Responses

Response samples

Content type
application/json
{
  • "Resource": "/App/System/Security/Certificate",
  • "HQI": {
    },
  • "Contributors": [
    ],
  • "StatusText": "Provided resource is invalid"
}

getHealthInventory

A list of possible health resources

query Parameters
resource
string

Health resource path associated to the alert being sent

Responses

Response samples

Content type
application/json
[
  • "/App/System"
]

clearHealth

clear health of subtree for given resource

query Parameters
resource
string

Resource path associated with cleared resource

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "error": "Unknown error"
}

Health Detail Options

Options support for the Health Detail

Options support for the Health Detail

Responses

users

Get host users.

Get host users on the system.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]