Kemp Support, how can we help?

The latest application delivery knowledge and expertise at your fingertips.

  1. Kemp Support
  2. Documentation
  3. Kemp 360 Central

Interface Description - Kemp 360 Central API

Updated: 

Contents

1 Introduction

This document describes the Kemp 360 Central RESTful Application Program Interface (API). This interface is designed to allow remote applications access to the Kemp 360 Central product in a simple and consistent manner. The output is provided in JavaScript Object Notation (JSON) format.

1.1 Document Purpose

This document describes the API to the Kemp 360 Central product. It describes how to configure the various features of Kemp 360 Central using the API.

This document only contains a subset of the API commands.

This document does not explain each of the features or options in detail. For further information, please refer to the Kemp 360 Central, Feature Description document on www.kemptechnologies.com/loadmaster-documentation.

1.2 Intended Audience

This document is intended to help anyone who wishes to configure Kemp 360 Central using the API.

2 The Kemp 360 Central API

2.1 Notation

In the following examples, text which is italicized indicates a value that must be entered, for example:

/api/v1/loadmaster/LoadMasterID/?&api_key=APIKey&username=Username

In the example above; LoadMasterID, APIKey and UsernameValue all relate to values that should be entered, for example 9, de26b104526be42ec7e0454d363345a15be4c453 and admin respectively, for example:

/api/v1/loadmaster/9/?&api_key=de26b104526be42ec7e0454d363345a15be4c453&username=admin

2.2 Kemp 360 Central API Overview

The Kemp 360 Central API enables a user or application to pass requests to the Kemp 360 Central product. Kemp 360 Central answers the request with a JSON response.

The Kemp 360 Central API commands can be run using cURL. Some GET requests can also be run by using a browser address bar.

Example syntax for a cURL command follows:

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/:ResourceName/?&api_key=APIKey&username=Username"

The Kemp 360 Central API commands are categorized by resource. The relevant resource name must be entered when running a Kemp 360 Central API command. The resources relate to the different areas that can be updated, for example:

To get a list of the resources run the following command:

curl -k "https://Kemp360CentralIPAddress/api/v1/"

2.2.1 Authentication

For security reasons, the api_key and the username must be included at the end of the command each time a command is run.

To generate the API key, run the authenticate command, for example:

curl -k -X POST -d '{"username":"Username","password":"Password"}' “https://Kemp360CentralIPAddress/api/v1/user/authenticate/”

The following is an example response:

{

    "apikey": "06dd33ffba437f858774c13419e982ae11a53c70",

    "success": true

}

The api_key is generated per user and per Kemp 360 Central machine and it will not change. So, you should only have to run the authenticate command once per Kemp 360 Central machine. The api_key that is generated can only be reused against the same Kemp 360 Central machine. If an incorrect api_key is entered, the user receives a 401 unauthorized error.

2.2.2 HTTP Methods

The HTTP methods of POST, GET, PUT and DELETE are used when running a command. They correspond to the Create, Read, Update and Delete (CRUD) operations, respectively.

You should note the following points regarding the formatting of the request:

  • Only one command can be given at a time
  • Multiple parameters can be set within the same command
  • The order in which the parameter/value pairs appear does not matter

2.2.3 Setting Parameters

Any parameters that must be specified can be passed in the payload, for example:

{

"username":"Username","password":"Password"

}

When there is more than one parameter in a request, individual parameters are separated using a comma (,).

To view the full list of valid parameters for a resource, run the schema command:

/api/v1/ResourceName/schema/?&api_key=APIKey&username=Username

For example, to view all parameters for the network resource:

curl -k -X GET "https://10.154.190.112/api/v1/network/schema/?username=admin&api_key=b4e336d84e6a0213e1b9d3c7e32152b7b51c6658"

2.2.4 Errors

If any issues occur when running the command, for example if any required parameters are missing, an error message appears.

The following is an example error message output:

HTTP/1.1 400 BAD REQUEST

Date: Fri, 14 Aug 2015 12:57:45 GMT

Server: Apache/2.4.7 (Ubuntu)

X-Frame-Options: SAMEORIGIN

Connection: close

Transfer-Encoding: chunked

Content-Type: application/json

{

"error": "The 'network' field has no data and doesn't allow a default or null value."

}

2.3 Kemp 360 Central API Commands

Details of the available Kemp 360 Central API commands are provided in the following sections.

2.3.1 Manage Kemp 360 Central Commands

You can use the 360 resource to perform some administrative tasks in Kemp 360 Central.

2.3.1.1 License Kemp 360 Central

The following section outlines all the commands that are required to license Kemp 360 Central.

  1. Accept the Welcome Page.

Example Command

curl -X PUT "https://Kemp360CentralIPAddress/api/v1/config/1/" -H "Content-Type: application/json" -k -v -d "{\"deployment_date\":\"null\",\"id\":\"1\",\"isAdminPassSet\":\"false\",\"isEulaAccepted\":\"true\",\"isLicensed\":\"false\",\"is_fingerprint_generated\":\"false\",\"resource_uri\":\"/api/v1/config/1/\"}"

Expected Output

HTTP/1.1 204 NO CONTENT

Date: Mon, 05 Mar 2018 09:46:27 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Content-Length: 0

Content-Type: text/html; charset=utf-8

*

2. Retrieve the API key. The API key is required in subsequent commands.

Example Command

curl -X POST "https://Kemp360CentralIPAddress/api/v1/user/authenticate/" -H "Content-Type: application/json" -k -v -d "{\"username\":\"admin\",\"password\":\"admin\"}"

Expected Output

HTTP/1.1 200 OK

Date: Mon, 05 Mar 2018 10:12:36 GMT

Server: Apache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Transfer-Encoding: chunked

Content-Type: application/json

{"apikey": "1d2046ad8e89a301edca3ce1cc5152fae949a216", "id": 1, "success": true}*

3. Configure the proxy. This command should be run as is.

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/360/unset_proxy/?api_key=1d2046ad8e89a301edca3ce1cc5152fae949a216&username=admin"

Expected Output

HTTP/1.1 200 OK

Date: Mon, 05 Mar 2018 10:15:01 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Cache-Control: no-cache

Transfer-Encoding: chunked

Content-Type: application/json

{"message": "Proxy parameters unset"}

4. License Kemp 360 Central.

This command allows the user to license their Kemp 360 Central. In the MELA case, the Contract ID is provided by Kemp Operations and is a mandatory parameter.

Example Command

curl -X POST "https://Kemp360CentralIPAddress/api/v1/360/license/?api_key=1d2046ad8e89a301edca3ce1cc5152fae949a216&username=admin" -H "Content-Type: application/json" -k -v -d "{\"kempid\":\"KempIDEmailAddress\",\"password\":\"KempIDPassword\",\"order_id\":\"ContractID\"}"

Expected Output

HTTP/1.1 200 OK

Date: Mon, 05 Mar 2018 10:21:45 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Content-Length: 54

Content-Type: application/json

{"message": "Kemp360 has been licensed successfully."}

5. Configure the admin username and password.

This is a two-step process, where initially the admin account is confirmed. Subsequently, the password is updated.

Example Command

curl -X POST "https://Kemp360CentralIPAddress/api/v1/user/authenticate/?api_key=1d2046ad8e89a301edca3ce1cc5152fae949a216&username=admin" -H "Content-Type: application/json" -k -v -d "{\"username\":\"admin\",\"password\":\"admin\"}"

Expected Output

HTTP/1.1 200 OK

Date: Mon, 05 Mar 2018 10:24:29 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{"apikey": "1d2046ad8e89a301edca3ce1cc5152fae949a216", "id": 1, "success": true}

Example Command

curl -X PUT "https://Kemp360CentralIPAddress/api/v1/user/1/?api_key=1d2046ad8e89a301edca3ce1cc5152fae949a216&username=admin" -H "Content-Type: application/json" -k -v -d "{\"password\":\"Kemp360CentralPassword\"}"

Expected Output

HTTP/1.1 200 OK

Date: Mon, 05 Mar 2018 10:30:44 GMT

Server: Apache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Transfer-Encoding: chunked

Content-Type: application/json

{"email": "", "groups": ["/api/v1/resourcegroup/2/", "/api/v1/resourcegroup/1/"], "id": 1, "is_active": true, "is_superuser": true, "permissions": ["SystemSettings.read", "SystemSettings.write", "Monitoring", "ServiceConfiguration.read", "ServiceConfiguration.write"], "pk": "1", "resource_uri": "/api/v1/user/1/", "username": "admin"}

6. Confirm all the settings. This command should be run as is.

Example Command

curl -X PUT "https://Kemp360CentralIPAddress/api/v1/config/1/" -H "Content-Type: application/json" -k -v -d "{\"isAdminPassSet\":\"true\",\"isEulaAccepted\":\"true\",\"isLicensed\":\"true\",\"is_fingerprint_generated\":\"true\"}"

Expected Output

HTTP/1.1 204 NO CONTENT

Date: Mon, 05 Mar 2018 10:28:25 GMT

Server: Apache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Content-Length: 0

Content-Type: text/html; charset=utf-8

*

2.3.1.2 View the Details of a License

You can use a GET command to view the details of a Kemp 360 Central license.

/api/v1/360/license/details/

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/360/license/details/?&api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output

HTTP/1.1 200 OK

Date: Fri, 02 Mar 2018 11:10:51 GMT

Server: Apache

Cache-Control: no-cache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{"access_code": "8DPtDB4QvD", "asl_enabled": true, "asl_instance_grace_period": 30, "asl_instance_sku": "", "blob_create": "", "blob_delete": "", "fingerprint": "QNY34-Etl76-jS7uB-Myny5-rfk9X-82Cww-awft3-e", "id": 1, "ignore_kts_hwid": true, "is_mela": true, "is_tethered": false, "kemp360_ip": "10.0.0.16", "kts_mela_grace_period": 90, "license_expiration": "Unlimited", "license_name": "K360-MELA-VLM-WAF", "license_status": "Single Perm", "max_loadmaster_activations": 500, "max_loadmasters": 500, "serial_number": "KTS1082322", "status": "In Use", "support_expiration": "2019-07-20T00:00:00", "support_name": "Premium"}

2.3.1.3 Reboot Kemp 360 Central

You can use a GET method to reboot Kemp 360 Central.

/api/v1/360/reboot/?&api_key=APIKey&username=Username

Example Command

curl -k --dump-header - -X GET "https://10.154.190.179/api/v1/360/reboot/?&api_key=de26b104526be42ec7e0454d363345a15be4c453&username=admin"

Expected Output

{

    "message": "System rebooting."

}  

2.3.1.4 Shut Down Kemp 360 Central

You can use a GET method to shut down Kemp 360 Central.

This shuts down the Kemp 360 Central Virtual Machine. After shutting down, the Virtual Machine must be powered back on to turn the Kemp 360 Central instance back on.

/api/v1/360/shutdown/?&api_key=APIKey&username=Username

Example Command

curl -k --dump-header - -X GET "https://10.154.190.179/api/v1/360/shutdown/?&api_key=de26b104526be42ec7e0454d363345a15be4c453&username=admin"

Expected Output

{

    "message": "System shutting down."

}

2.3.1.5 Set the Email Options

To configure the email options for Kemp 360 Central, you can use a PUT method.

/api/v1/360/1/?api_key=APIKey&username=Username

Example Command

curl -X PUT "https://Kemp360CentralIPAddress/api/v1/360/1/?api_key=1d2046ad8e89a301edca3ce1cc5152fae949a216&username=admin" -H "Content-Type: application/json" -k -v -d "{\"email_host\":\"2.2.2.2\",\"email_port\":\"25\",\"email_address_list\":\"jbloggs@kemptechnologies.com\",\"from_email_address\":\"jbloggs@customernetwork.com\"}"

Available Parameters

Parameter

Parameter Type

Parameter Description

email_address_list

String

Semi-colon separated list of email addresses. This is mandatory.

email_host

String

The host to use for sending emails. Either an IP address or DNS style entry is acceptable for this parameter. This is mandatory.

email_port

Integer

The port to use for the SMTP host. This is the external SMTP server from which emails notifications are sent. This is mandatory.

email_host_user

String

Username to use for the SMTP host.

email_host_password

String

Password to use for the SMTP host.

email_use_tls

Boolean

Set this to 1 to use TLS as the SMTP secure connection type.

email_use_ssl

Boolean

Set this to 1 to use SSL as the SMTP secure connection type.

from_email_address

String

The email address that Kemp 360 Central uses to send email. This is mandatory.

Expected Output

HTTP/1.1 200 OK

Date: Mon, 05 Mar 2018 10:49:30 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{"created_at": "2018-01-09T18:43:48", "current_asl_instances": 0, "email_address_list": "jbloggs@kemptechnologies.com", "email_host": "2.2.2.2", "email_host_user": "", "email_port": 25, "email_use_ssl": false, "email_use_tls": false, "from_email_address": "jbloggs@customernetwork.com", "grace_period_active": false, "grace_period_expires": null, "id": 1, "pk": "1", "report_start_date": "2018-01-09T18:43:48", "resource_uri": "/api/v1/360/1/", "update_available": false, "updated_at": "2018-03-05T10:49:30.817437", "usage_report_bcc_address": "", "usage_report_via_alsi": true, "usage_report_via_smtp": false}

2.3.1.6 Download the System Logs

You can download syslogs by running the following command:

/api/v1/360/syslogs/?&api_key=APIKey&username=Username

Note that the system logs returned cover the period from when the Kemp 360 Central Virtual Machine was first booted to when the download system logs command is run.

Example Command

curl -k --dump-header - "https://Kemp360CentralIPAddress/api/v1/360/syslogs/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output

HTTP/1.1 200 OK

Date: Fri, 02 Mar 2018 11:12:57 GMT

Server: Apache

Cache-Control: no-cache

Content-Disposition: attachment; filename=syslog.log

X-Frame-Options: SAMEORIGIN

Vary: Accept,Accept-Encoding

Transfer-Encoding: chunked

Content-Type: text/plain

syslog

Jul 19 16:26:55 K360Central rsyslogd: [origin software="rsyslogd" swVersion="7.4.4" x-pid="1038" x-info="http://www.rsyslog.com"] start

Jul 19 16:26:55 K360Central rsyslogd-2307: warning: ~ action is deprecated, consider using the 'stop' statement instead [try http://www.rsyslog.com/e/2307 ]

Jul 19 16:26:55 K360Central rsyslogd: rsyslogd's groupid changed to 104

Jul 19 16:26:55 K360Central rsyslogd: rsyslogd's userid changed to 101

Jul 19 16:26:55 K360Central kernel: [    0.000000] Initializing cgroup subsys cpuset

Jul 19 16:26:55 K360Central kernel: [    0.000000] Initializing cgroup subsys cpu

Jul 19 16:26:55 K360Central kernel: [    0.000000] Initializing cgroup subsys cpuacct

2.3.1.7 Download the Audit Logs

You can download the audit logs by running the following command:

/api/v1/360/auditlogs/?&api_key=APIKey&username=Username

Note that the audit logs returned cover the period from when the Kemp 360 Central Virtual Machine was first booted to when the download audit logs command is run.

Example Command

curl -k --dump-header - "https://Kemp360CentralIPAddress/api/v1/360/auditlogs/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Example Output

HTTP/1.1 200 OK

Date: Fri, 02 Mar 2018 11:14:29 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept,Accept-Encoding

Content-Disposition: attachment; filename=audit.log

Cache-Control: no-cache

Transfer-Encoding: chunked

Content-Type: text/plain

audit.log.1

[02/Mar/2018 07:30:03] INFO Database: HAPeer data written - {'preferred_master': False, 'ha_username': 'hauser', 'disable': False, 'retries': 0, 'last_heartbeat_sent': None, 'error_state': 1, 'last_heartbeat_received': None, 'ip_address': '127.0.0.1', 'state': 1, 'ssh_public_key': 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQChHyY7W65wHQFMrcO1S91VwpzD1Afi/5SLoN/SP1qLk2OjjXxCPd0PAGYE/lJjxmYk+pKNuXE4x++oItLjcv+tFY3M+HMCgqF/oRvspa3b5Wn2h7lHF5H3dEIrkyYalB362GuNp3rIdqwo6Lk4mlTbjbBpG3B2ZnabIY2ivOxhELl70JsTBq8abIN5ImpyQq3a0Sw+9r7WIp8jbQ+geiw5RIjbRwVJenlMbYBwpWzwyfozyUAgyyDEliRWpzjYkXN9Btqw1LCGMKTECOqqqThudn1J4g4PTC0uFrW+3DzpI4ATPgfQ7f4o+CuQJxYYNomPpDwE2vZWY1L0kGtxSQHd www-data@K360Central', 'last_sequence_sync': 0, 'last_sequence_no': 7306, 'id': 1, 'stats_timestamp_sync': 0, 'api_shared_key': '74246ec8d9253cde946e91aefa4f805be70b84fb', 'version': '1.21.0.1577', 'is_processing': True, 'local': True, 'last_heartbeat_response': None}

2.3.1.8 Download the Debug Logs

You can download the debug logs by running the following command:

/api/v1/360/debuglogs/?&api_key=APIKey&username=Username

Note that the debug logs returned cover the period from when the Kemp 360 Central Virtual Machine was first booted to when the download debug logs command is run.

Example Command

curl -k --dump-header - "https://Kemp360CentralIPAddress/api/v1/360/debuglogs/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Example Output

HTTP/1.1 200 OK

Date: Fri, 02 Mar 2018 11:15:23 GMT

Server: Apache

Cache-Control: no-cache

Content-Disposition: attachment; filename=debug.log

X-Frame-Options: SAMEORIGIN

Vary: Accept,Accept-Encoding

Transfer-Encoding: chunked

Content-Type: text/plain

debug.log.1

[01/Mar/2018 10:00:07] ERROR [poll:193] Error connecting to device ARM-MELA-HA-0 (10.0.0.23:8443) due to HTTPSConnectionPool(host='10.0.0.23', port=8443): Max retries exceeded with url: /access/get?param=version (Caused by NewConnectionError('<requests.packages.urllib3.connection.VerifiedHTTPSConnection object at 0x7f3e1ade88d0>: Failed to establish a new connection: [Errno 113] No route to host',))

[01/Mar/2018 10:00:07] ERROR [poll:193] Error connecting to device ARM-MELA-HA-1 (10.0.0.29:8443) due to HTTPSConnectionPool(host='10.0.0.29', port=8443): Max retries exceeded with url: /access/get?param=version (Caused by NewConnectionError('<requests.packages.urllib3.connection.VerifiedHTTPSConnection object at 0x7f3e1adf4358>: Failed to establish a new connection: [Errno 113] No route to host',))

[01/Mar/2018 10:00:08] ERROR [poll:193] Error connecting to device ARM-LM-SPLA02 (10.0.0.21:8443) due to HTTPSConnectionPool(host='10.0.0.21', port=8443): Max retries exceeded with url: /access/get?param=version (Caused by NewConnectionError('<requests.packages.urllib3.connection.VerifiedHTTPSConnection object at 0x7f3e1adf4d30>: Failed to establish a new connection: [Errno 113] No route to host',))

[01/Mar/2018 10:00:10] ERROR [poll:193] Error connecting to device ARM-LM-SPLA03 (10.0.0.28:8443) due to HTTPSConnectionPool(host='10.0.0.28', port=8443): Max retries exceeded with url: /access/get?param=version (Caused by NewConnectionError('<requests.packages.urllib3.connection.VerifiedHTTPSConnection object at 0x7f3e1ade8470>: Failed to establish a new connection: [Errno 113] No route to host',))

2.3.2 Network Commands

The Network resource allows several operations to be performed in relation to the network(s) in Kemp 360 Central.

2.3.2.1 Retrieve Details of the Network(s)

You can use a GET method to retrieve details of the network(s).

/api/v1/network/?&api_key=APIKey&username=Username

The next example retrieves a full list of details for all networks that have been added to Kemp 360 Central. The output includes an id. This id number can be used to retrieve details of one specific network by entering the ID number after the resource name, for example - the following command displays details for the network with ID number 2:

/api/v1/network/2/?&api_key=de26b104526be42ec7e0454d363345a15be4c453&username=admin

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/network/2/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output 

HTTP/1.1 200 OK

Date: Wed, 15 Aug 2018 07:42:24 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Cache-Control: no-cache

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{"cidr": 24, "created_at": "2018-08-14T07:49:26", "id": 3, "info": {"broadcast": "10.35.29.255", "hosts": 254, "max": "10.35.29.254", "min": "10.35.29.1", "netmask": "255.255.255.0", "wildcard": "0.0.0.255"}, "iprange": "10.35.29.0", "loadmasters": [{"asl_instance": true, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": true}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": true}, "logs": {"read": true, "write": true}, "reboot": {"read": true, "write": true}, "restore": {"read": true, "write": true}, "shutdown": {"read": true, "write": true}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": true}, "virtual_services": {"read": true, "write": true}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-14T08:08:46", "critical_host_syslog": "", "datahash": "b'\\x8c\\x89?\\x8c\\x8f\\xb2\\x10\\xfb\\x84\\xa7\\xe58\\x8f9\\x96\\xf3\\xfb\\xe9S\\x17'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 5, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.3", "last_stats": null, "last_stats_time": "2018-08-14T08:08:46", "last_up": "2018-08-15T07:42:02", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/3/", "nickname": null, "notice_host_syslog": "", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/5/", "service_groups": ["/api/v1/servicegroup/33/", "/api/v1/servicegroup/34/"], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-14T09:42:07", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.2.40.0.15707.RELEASE", "warn_host_syslog": ""}, {"asl_instance": false, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": false}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": false}, "logs": {"read": true, "write": false}, "reboot": {"read": true, "write": false}, "restore": {"read": true, "write": false}, "shutdown": {"read": true, "write": false}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": false}, "virtual_services": {"read": true, "write": false}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-15T07:32:20", "critical_host_syslog": "", "datahash": "b'\\x19O\\xfb\\x86\\x88\\x90\\n\\xd9Nu^\\x8a\\x99\\xa5C\\x9e!pKK'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 8, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.138", "last_stats": null, "last_stats_time": "2018-08-15T07:32:17", "last_up": "2018-08-15T07:42:02", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/3/", "nickname": null, "notice_host_syslog": "", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/8/", "service_groups": ["/api/v1/servicegroup/35/", "/api/v1/servicegroup/38/", "/api/v1/servicegroup/39/", "/api/v1/servicegroup/40/"], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-15T07:32:21", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.1.35.4.15528.RELEASE", "warn_host_syslog": ""}], "network": 1, "nickname": null, "resource_uri": "/api/v1/network/3/", "updated_at": "2018-08-14T07:49:26"}

2.3.2.2 Show the Status of all Networks

You can use a GET method to retrieve details of the network(s).

/api/v1/network/?&api_key=APIKey&username=Username

The next example retrieves a full list of details for all networks that were added to Kemp 360 Central.

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/network/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output

HTTP/1.1 200 OK

Date: Wed, 15 Aug 2018 07:41:26 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Cache-Control: no-cache

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{"meta": {"limit": 1000, "next": null, "offset": 0, "previous": null, "total_count": 2}, "objects": [{"cidr": 0, "created_at": "2018-01-31T08:26:10", "id": 1, "info": {"broadcast": "255.255.255.255", "hosts": 4294967294, "max": "255.255.255.254", "min": "0.0.0.1", "netmask": "0.0.0.0", "wildcard": "255.255.255.255"}, "iprange": "0.0.0.0", "loadmasters": [], "network": 0, "nickname": "All Networks", "resource_uri": "/api/v1/network/1/", "updated_at": "2018-01-31T08:26:10"}, {"cidr": 24, "created_at": "2018-08-14T07:49:26", "id": 3, "info": {"broadcast": "10.35.29.255", "hosts": 254, "max": "10.35.29.254", "min": "10.35.29.1", "netmask": "255.255.255.0", "wildcard": "0.0.0.255"}, "iprange": "10.35.29.0", "loadmasters": [{"asl_instance": true, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": true}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": true}, "logs": {"read": true, "write": true}, "reboot": {"read": true, "write": true}, "restore": {"read": true, "write": true}, "shutdown": {"read": true, "write": true}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": true}, "virtual_services": {"read": true, "write": true}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-14T08:08:46", "critical_host_syslog": "", "datahash": "b'\\x8c\\x89?\\x8c\\x8f\\xb2\\x10\\xfb\\x84\\xa7\\xe58\\x8f9\\x96\\xf3\\xfb\\xe9S\\x17'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 5, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.3", "last_stats": null, "last_stats_time": "2018-08-14T08:08:46", "last_up": "2018-08-15T07:41:03", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/3/", "nickname": null, "notice_host_syslog": "", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/5/", "service_groups": ["/api/v1/servicegroup/33/", "/api/v1/servicegroup/34/"], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-14T09:42:07", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.2.40.0.15707.RELEASE", "warn_host_syslog": ""}, {"asl_instance": false, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": false}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": false}, "logs": {"read": true, "write": false}, "reboot": {"read": true, "write": false}, "restore": {"read": true, "write": false}, "shutdown": {"read": true, "write": false}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": false}, "virtual_services": {"read": true, "write": false}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-15T07:32:20", "critical_host_syslog": "", "datahash": "b'\\x19O\\xfb\\x86\\x88\\x90\\n\\xd9Nu^\\x8a\\x99\\xa5C\\x9e!pKK'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 8, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.138", "last_stats": null, "last_stats_time": "2018-08-15T07:32:17", "last_up": "2018-08-15T07:41:03", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/3/", "nickname": null, "notice_host_syslog": "", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/8/", "service_groups": ["/api/v1/servicegroup/35/", "/api/v1/servicegroup/38/", "/api/v1/servicegroup/39/", "/api/v1/servicegroup/40/"], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-15T07:32:21", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.1.35.4.15528.RELEASE", "warn_host_syslog": ""}], "network": 1, "nickname": null, "resource_uri": "/api/v1/network/3/", "updated_at": "2018-08-14T07:49:26"}]}

2.3.2.3 Add a Network

You can use the POST method to add a new network to Kemp 360 Central.

/api/v1/network/?&api_key=APIKey&username=Username

Example Command

curl -X POST "https://Kemp360CentralIPAddress/api/v1/network/?api_key=1d2046ad8e89a301edca3ce1cc5152fae949a216&username=admin" -H "Content-Type: application/json" -k –v -d "{\"iprange\":\"10.154.50.0\",\"cidr\":\"16\"}"

Available Parameters

Parameter

Parameter Type

Parameter Description

nickname

String

A friendly name for the network.

CIDR

Integer

The Classless Inter-Domain Routing (CIDR) number of the network.

id

Integer

The unique ID number of the network. The network is automatically assigned the next increment of available ID numbers. Kemp recommends not setting the ID number as it is set automatically when a network is added.

iprange

String

The starting IP address of the network in the format IPAddress:CIDR.

network

Integer

Optional; To make the network a sub-network of another network, specify the relevant network or sub-network ID in this parameter.

Expected Output

HTTP/1.1 201 CREATED

Date: Mon, 05 Mar 2018 11:38:24 GMT

Server: Apache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Location: https://Kemp360CentralIPAddress/api/v1/network/2/

Transfer-Encoding: chunked

Content-Type: application/json

{"cidr": 16, "created_at": "2018-03-05T11:38:24.369962", "id": 2, "info": {"broadcast": "10.154.255.255", "hosts": 65534, "max": "10.154.255.254", "min": "10.154.0.1", "netmask": "255.255.0.0", "wildcard": "0.0.255.255"}, "iprange": "10.154.0.0", "loadmasters": [], "network": 1, "nickname": null, "resource_uri": "/api/v1/network/2/", "updated_at": "2018-03-05T11:38:24.370000"}

2.3.2.4 Update a Network

You can use the PUT method to update the details of a network.

/api/v1/network/NetworkID/?&api_key=de26b104526be42ec7e0454d363345a15be4c453&username=Username

Example Command

curl -X PUT "https://Kemp360CentralIPAddress/api/v1/network/2/?api_key=1d2046ad8e89a301edca3ce1cc5152fae949a216&username=admin" -H "Content-Type: application/json" -k –v -d "{\"nickname\":\"Production\"}"

Available Parameters

Parameter

Parameter Type

Parameter Description

nickname

String

A friendly name for the network.

CIDR

Integer

The CIDR number of the network.

id

Integer

The unique ID number of the network. The network is automatically assigned the next increment of available ID numbers. Kemp recommends not setting the ID number because it is set automatically when a network is added.

loadmasters

Related

Details about the LoadMasters that have been added to the network.

Expected Output

HTTP/1.1 200 OK

Date: Mon, 05 Mar 2018 11:41:21 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{"cidr": 16, "created_at": "2018-03-05T11:38:24", "id": 2, "info": {"broadcast": "10.154.255.255", "hosts": 65534, "max": "10.154.255.254", "min": "10.154.0.1", "netmask": "255.255.0.0", "wildcard": "0.0.255.255"}, "iprange": "10.154.0.0", "loadmasters": [], "network": 1, "nickname": "Production", "pk": "2", "resource_uri": "/api/v1/network/2/", "updated_at": "2018-03-05T11:41:21.540755"}

2.3.2.5 Delete a Network

You can use the DELETE method to remove a network from Kemp 360 Central.

/api/v1/network/NetworkID/?&api_key=APIKey&username=Username

Example Command

curl -k --dump-header - -X DELETE "https://Kemp360CentralIPAddress/api/v1/network/13/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output

HTTP/1.1 204 NO CONTENT

Date: Fri, 02 Mar 2018 11:28:44 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Content-Length: 0

Content-Type: text/html; charset=utf-8

2.3.3 LoadMaster Commands

The LoadMaster resource allows several operations to be performed in relation to the LoadMaster(s) that have been added to Kemp 360 Central.

2.3.3.1 Retrieve Details of the LoadMaster(s)

You can use a GET method to retrieve details of the LoadMaster(s).

/api/v1/loadmaster/?&api_key=APIKey&username=Username

The above example retrieves a full list of details for all LoadMasters were added to Kemp 360 Central. The output includes an id. This id number can be used to retrieve details of one specific LoadMaster by entering the ID number after the resource name, for example - the following command displays details for the LoadMaster with ID number 2:

/api/v1/loadmaster/2/?&api_key=de26b104526be42ec7e0454d363345a15be4c453&username=admin

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/loadmaster/2/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output

HTTP/1.1 200 OK

Date: Fri, 02 Mar 2018 09:36:45 GMT

Server: Apache

Cache-Control: no-cache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Transfer-Encoding: chunked

Content-Type: application/json

{"asl_instance": true, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": true}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": true}, "logs": {"read": true, "write": true}, "reboot": {"read": true, "write": true}, "restore": {"read": true, "write": true}, "shutdown": {"read": true, "write": true}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": true}, "virtual_services": {"read": true, "write": true}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2017-07-20T17:14:24", "critical_host_syslog": "", "datahash": "b'\\xaf\\x9a\\xdf:\\t\\x14N\\xdd\\x82\\xe72<\\x10\\xe3\\xbdf\\x8e\\xf40\\x0b'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 2, "info_host_syslog": "10.0.0.16", "ip_address": "10.0.0.23", "last_stats": null, "last_stats_time": "2017-07-20T17:14:24", "last_up": "2017-12-01T13:21:02", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/2/", "nickname": "ARM-MELA-HA-0", "notice_host_syslog": "", "port": 8443, "public_access_address": "arm-mela-ha-0.westeurope.cloudapp.azure.com:8443", "resource_uri": "/api/v1/loadmaster/2/", "service_groups": ["/api/v1/servicegroup/4/", "/api/v1/servicegroup/5/", "/api/v1/servicegroup/6/"], "source": "from360", "status_uri": null, "system_status": "DOWN", "updated_at": "2017-12-01T13:00:05", "valid_parent_networks": [{"cidr": 24, "id": 2, "iprange": "10.0.0.0", "nickname": "AZURE ARM - West Europe", "resource_uri": "/api/v1/network/2/"}], "version": "7.2.39.0.15451.RELEASE", "warn_host_syslog": ""}

2.3.3.2 Show the Status of All LoadMasters in a Network

You can use a GET command to display the status of all LoadMasters in a network.

/api/v1/network/NetworkID/all_loadmasters/

The possible statuses are UP, DOWN and PROGRESS:

UP means the LoadMaster is contactable.

DOWN means the LoadMaster is uncontactable.

PROGRESS means the LoadMaster is down but is rebooting.

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/network/1/all_loadmasters/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output

HTTP/1.1 200 OK

Date: Wed, 15 Aug 2018 07:38:24 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Cache-Control: no-cache

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{"loadmasters": [{"asl_instance": true, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": true}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": true}, "logs": {"read": true, "write": true}, "reboot": {"read": true, "write": true}, "restore": {"read": true, "write": true}, "shutdown": {"read": true, "write": true}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": true}, "virtual_services": {"read": true, "write": true}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-14T08:08:46", "critical_host_syslog": "", "datahash": "b'\\x8c\\x89?\\x8c\\x8f\\xb2\\x10\\xfb\\x84\\xa7\\xe58\\x8f9\\x96\\xf3\\xfb\\xe9S\\x17'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 5, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.3", "last_stats": null, "last_stats_time": "2018-08-14T08:08:46", "last_up": "2018-08-15T07:38:03", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/3/", "nickname": null, "notice_host_syslog": "", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/5/", "service_groups": ["/api/v1/servicegroup/33/", "/api/v1/servicegroup/34/"], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-14T09:42:07", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.2.40.0.15707.RELEASE", "warn_host_syslog": ""}, {"asl_instance": false, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": false}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": false}, "logs": {"read": true, "write": false}, "reboot": {"read": true, "write": false}, "restore": {"read": true, "write": false}, "shutdown": {"read": true, "write": false}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": false}, "virtual_services": {"read": true, "write": false}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-15T07:32:20", "critical_host_syslog": "", "datahash": "b'\\x19O\\xfb\\x86\\x88\\x90\\n\\xd9Nu^\\x8a\\x99\\xa5C\\x9e!pKK'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 8, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.138", "last_stats": null, "last_stats_time": "2018-08-15T07:32:17", "last_up": "2018-08-15T07:38:03", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/3/", "nickname": null, "notice_host_syslog": "", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/8/", "service_groups": ["/api/v1/servicegroup/35/", "/api/v1/servicegroup/38/", "/api/v1/servicegroup/39/", "/api/v1/servicegroup/40/"], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-15T07:32:21", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.1.35.4.15528.RELEASE", "warn_host_syslog": ""}]}

2.3.3.3 Add a LoadMaster to Kemp 360 Central

You can use a POST method to add a LoadMaster to Kemp 360 Central.

/api/v1/loadmaster/?&api_key=APIKey&username=Username

Example Command

curl -X POST "https://Kemp360CentralIPAddress/api/v1/loadmaster/?api_key=18f1c7933621e2e1e7738f178dccc603110d785c&username=admin" -H "Content-Type: application/json" -k –v -d "{\"ip_address\":\"10.35.29.138\",\"lmusername\":\"bal\",\"password\":\"3fourall\",\"nickname\":\"standby\",\"network\":\"/api/v1/network/4/\"}"

Available Parameters

Parameter

Parameter Type

Parameter Description

id

Integer

This is the unique identifier (ID) number of the LoadMaster.

ip_address

String

The IP address of the LoadMaster.

lmusername

String

The LoadMaster username.

message_of_the_day

String

Message of the day text, which is displayed on the home page of the LoadMaster WUI. If no message is set, a default message of “This device is being managed by Kemp 360 Central” is displayed.

network

Related

The Uniform Resource Identifier (URI) of the network, that is /api/v1/network/NetworkID/

Note: You must add a network to Kemp 360 Central before a LoadMaster can be added.

nickname

String

A friendly name to identify the LoadMaster in Kemp 360 Central. If a nickname is not set the LoadMaster’s IP address is used as the nickname.

password

String

The password to access the LoadMaster.

syslogemergency

String

Use this option to set the host(s) that receives Emergency events only. Entries must be space separated. Up to 10 entries are supported.

syslogcritical

String

Use this option to set the host(s) that receives Emergency and Critical events. Entries must be space separated. Up to 10 entries are supported.

syslogerror

String

Use this option to set the host(s) that receives Emergency, Critical, and Error events. Entries must be space separated. Up to 10 entries are supported.

syslogwarn

String

Use this option to set the host(s) that receives Emergency, Critical, Error, and Warning events. Entries must be space separated. Up to 10 entries are supported.

syslognotice

String

Use this option to set the host(s) that receives Emergency, Critical, Error, Warning, and Notice events. Entries must be space separated. Up to 10 entries are supported.

sysloginfo

String

Use this option to set the host(s) that receives All events. Entries must be space separated. Up to 10 entries are supported.

Expected Output

HTTP/1.1 201 CREATED

Date: Tue, 14 Aug 2018 09:26:10 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Location: https://<<Kemp 360 Central IP Address>>/api/v1/loadmaster/7/

Transfer-Encoding: chunked

Content-Type: application/json

{"asl_instance": false, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": false}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": false}, "logs": {"read": true, "write": false}, "reboot": {"read": true, "write": false}, "restore": {"read": true, "write": false}, "shutdown": {"read": true, "write": false}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": false}, "virtual_services": {"read": true, "write": false}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-14T09:26:13.488491", "critical_host_syslog": "", "datahash": "b\"\\xeb\\x9dG\\x01\\xea\\tG\\x12\\xd3\\xa3\\x19\\x9c8\\x03\\x12>'\\xb3\\x89\\x82\"", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 7, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.138", "last_stats": null, "last_stats_time": "2018-08-14T09:26:10.720818", "last_up": "2018-08-14T09:26:13.465921", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/3/", "nickname": "standby", "notice_host_syslog": "", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/7/", "service_groups": [], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-14T09:26:14.797900", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.1.35.4.15528.RELEASE", "warn_host_syslog": "", "warning_messages": []}

2.3.3.4 Update a LoadMaster

You can use the PUT method to update the LoadMaster details in the below table.

/api/v1/loadmaster/LoadMasterID/?&api_key=APIKey&username=Username

Example Command

curl -X PUT "https://Kemp360CentralIPAddress/api/v1/loadmaster/5/?api_key=18f1c7933621e2e1e7738f178dccc603110d785c&username=admin" -H "Content-Type: application/json" -k -v -d "{\"message_of_the_day\":\"the world is a vampire\"}"

Available Parameters

Parameter

Parameter Type

Parameter Description

id

Integer

This is the unique identifier (ID) number of the LoadMaster.

lmusername

String

The LoadMaster username.

message_of_the_day

String

Message of the day text which is displayed on the home page of the LoadMaster WUI. If no message is set a default message of “This device is being managed by Kemp 360 Central” is displayed.

nickname

String

A friendly name to identify the LoadMaster in Kemp 360 Central. If a nickname is not set the LoadMaster’s IP address is used as the nickname.

password

String

The password to access the LoadMaster.

Expected Output

HTTP/1.1 200 OK

Date: Tue, 14 Aug 2018 09:42:06 GMT

Server: Apache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Transfer-Encoding: chunked

Content-Type: application/json

{"asl_instance": true, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": true}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": true}, "logs": {"read": true, "write": true}, "reboot": {"read": true, "write": true}, "restore": {"read": true, "write": true}, "shutdown": {"read": true, "write": true}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": true}, "virtual_services": {"read": true, "write": true}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-14T08:08:46", "critical_host_syslog": "", "datahash": "b'\\x8c\\x89?\\x8c\\x8f\\xb2\\x10\\xfb\\x84\\xa7\\xe58\\x8f9\\x96\\xf3\\xfb\\xe9S\\x17'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 5, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.3", "last_stats": null, "last_stats_time": "2018-08-14T08:08:46", "last_up": "2018-08-14T09:42:07.530471", "lmusername": null, "management_interface": 0, "message_of_the_day": "the world is a vampire", "network": "/api/v1/network/3/", "nickname": null, "notice_host_syslog": "", "pk": "5", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/5/", "service_groups": [], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-14T09:42:07.557726", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.2.40.0.15707.RELEASE", "warn_host_syslog": "", "warning_messages": []}

2.3.3.5 Delete a LoadMaster

You can use the DELETE method to remove a LoadMaster from Kemp 360 Central.

/api/v1/loadmaster/LoadMasterID/?&api_key=APIKey&username=Username

Example Command

curl -k --dump-header - -X DELETE "https://Kemp360CentralIPAddress/api/v1/loadmaster/1/?&api_key=de26b104526be42ec7e0454d363345a15be4c453&username=admin"

Expected Output

HTTP/1.1 204 NO CONTENT 

Date: Mon, 17 Aug 2015 09:23:20 GMT

Server: Apache/2.4.7 (Ubuntu)

Vary: Accept

X-Frame-Options: SAMEORIGIN

Content-Length: 0

Content-Type: text/html; charset=utf-8

2.3.3.6 Reboot a LoadMaster

You can use the special reboot command to reboot a LoadMaster. The LoadMaster ID and reboot must be specified after loadmaster, as shown in the following example

/api/v1/loadmaster/LoadMasterID/reboot/?&api_key=APIKey&username=Username

To check the status of a LoadMaster during or after the reboot, run the command detailed in the Retrieve Details of the LoadMaster(s) section.

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/loadmaster/3/reboot/?&api_key=1d2046ad8e89a301edca3ce1cc5152fae949a216&username=admin"

Expected Output

HTTP/1.1 200 OK

Date: Tue, 06 Mar 2018 13:33:40 GMT

Server: Apache

Cache-Control: no-cache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{"message": "LoadMaster rebooting."}    

2.3.3.7 Reboot Multiple LoadMasters

You can use the POST command to reboot multiple LoadMasters simultaneously:

/api/v1/loadmaster/reboot_many/?username=Username&api_key=APIKey

Example Command

curl -k --dump-header - -X POST --data '[1,3]' "https:// 10.154.190.179/api/v1/loadmaster/reboot_many/?username=admin&api_key= de26b104526be42ec7e0454d363345a15be4c453"

1 and 3 are the IDs of the LoadMasters to be rebooted. To retrieve the LoadMaster IDs, run the command detailed in the Show the Status of All LoadMasters in a Network section.

Example Output

HTTP/1.1 200 OK

Date: Tue, 17 Nov 2015 13:36:33 GMT

Server: Apache/2.4.7 (Ubuntu)

X-Frame-Options: SAMEORIGIN

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

[

    {

        "lm": 2,

        "message": "LoadMaster rebooting.",

        "status_code": 200

    },

    {

        "lm": 3,

        "message": "LoadMaster rebooting.",

        "status_code": 200

    }

]  

2.3.3.8 Update the LoadMaster Firmware

Before updating the LoadMaster firmware, a firmware update file must be available in Kemp 360 Central. The following sections provide details on each of the commands relating to firmware updates.

2.3.3.9 Retrieve Details of the Firmware Update Files

You can use the GET command to retrieve details of any firmware patch files that already exist in Kemp 360 Central:

/api/v1/patch/?&api_key=APIKey&username=Username

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/patch/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output

HTTP/1.1 200 OK

Date: Fri, 02 Mar 2018 12:22:48 GMT

Server: Apache

Cache-Control: no-cache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Transfer-Encoding: chunked

Content-Type: application/json

{

    "meta": {

        "limit": 20,

        "next": null,

        "offset": 0,

        "previous": null,

        "total_count": 1

    },

    "objects": [

        {

            "arch": "x86_64            ",

            "created_at": "2017-09-04T09:35:12",

            "id": 1,

"patch": "./7.2.39.0.15451.RELEASE.20170705-1427-PATCH-VLM-AZURE",

            "resource_uri": "/api/v1/patch/1/",

            "updated_at": "2017-09-04T09:35:12",

            "version": "7.2.39.0.15451.RELEASE"

        }

    ]

}

The id number of the firmware patch file is displayed - this ID is needed when running the command to update the LoadMaster firmware.

2.3.3.10 Upload a Firmware Patch File

To upload a firmware patch file to Kemp 360 Central, use a command like the following:

/api/v1/patch/username=Username&api_key=APIKey

Example Command

curl -k --dump-header - -F "patch=@C:\temp\7.2.41.1.16002.RELEASE.20180215-0627-PATCH-64-MULTICORE" "https://Kemp360CentralIPAddress/api/v1/patch/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Available Parameters

The only available parameter for this command is patch. Please specify the path to the patch file, followed by the filename of the firmware update patch file. If you are using Windows, please enter double backslashes in the path.

Expected Output

HTTP/1.1 100 Continue

HTTP/1.1 201 CREATED

Date: Fri, 02 Mar 2018 12:32:46 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Location: https://<<Kemp 360 Central IP Address>>/api/v1/patch/2/

Content-Length: 0

Content-Type: text/html; charset=utf-8

2.3.3.11 Delete a Firmware Patch File

You can use the DELETE method to remove a patch file from Kemp 360 Central.

/api/v1/patch/PatchID/?&api_key=APIKey&username=Username

Example Command

curl -k --dump-header - -X DELETE "https://Kemp360CentralIPAddress/api/v1/patch/2/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output

HTTP/1.1 204 NO CONTENT

Date: Fri, 02 Mar 2018 12:39:06 GMT

Server: Apache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Content-Length: 0

Content-Type: text/html; charset=utf-8

2.3.3.12 Update the LoadMaster

After uploading a firmware patch to Kemp 360 Central, run the following command to update the firmware on the LoadMaster:

/api/v1/loadmaster/LoadMasterID/firmware_update/FirmwareID/

The LoadMaster is automatically rebooted after the firmware update.

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/loadmaster/3/firmware_update/?&fw_id=1&api_key=1d2046ad8e89a301edca3ce1cc5152fae949a216&username=admin"

Expected Output

HTTP/1.1 200 OK

Date: Tue, 06 Mar 2018 13:28:27 GMT

Server: Apache

Cache-Control: no-cache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{"message": "LoadMaster firmware updated."}

2.3.3.13 Backup/Restore

To restore a LoadMaster’s settings, a backup file must first be uploaded to Kemp 360 Central.

Before a backup can be uploaded to Kemp 360 Central, users must first create the backup.

2.3.3.14 List all Backups

Use a GET command to retrieve a list of all available backups.

/api/v1/backup

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/backup/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output

HTTP/1.1 200 OK

Date: Fri, 02 Mar 2018 10:23:40 GMT

Server: Apache

Cache-Control: no-cache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Transfer-Encoding: chunked

Content-Type: application/json

{

    "meta": {

        "limit": 20,

        "next": null,

        "offset": 0,

        "previous": null,

        "total_count": 1

    },

    "objects": [

        {

"backup": "./10.0.0.30_2017-12-20_085826.backup",

            "created_at": "2017-12-20T08:58:27",

            "id": 1,

            "resource_uri": "/api/v1/backup/1/",

            "updated_at": "2017-12-20T08:58:27"

        }

    ]

}                               

2.3.3.15 List the Details of a Specific Backup Using an ID

Use a GET command to retrieve details of a specific backup.

/api/v1/backup/id/

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/backup/1/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Available Parameters

The only available parameter for this command is id. Users should first identify the ID number of the backup for which they want to retrieve details from. To retrieve the backup ID number, run the command to list all backups. For further information, refer to the List all Backups section.

Expected Output

HTTP/1.1 200 OK

Date: Fri, 02 Mar 2018 10:26:29 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Cache-Control: no-cache

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{

    "backup": "./10.0.0.30_2017-12-20_085826.backup",

    "created_at": "2017-12-20T08:58:27",

    "id": 1,

    "resource_uri": "/api/v1/backup/1/",

    "updated_at": "2017-12-20T08:58:27"

}

2.3.3.16 Back up a LoadMaster

Kemp 360 Central allows users to back up and restore LoadMaster settings.

To restore a LoadMaster’s settings, a backup file must first exist in Kemp 360 Central.

There are two ways to create a LoadMaster backup. The method to use depends on whether the LoadMaster to be backed up exists in Kemp 360 Central:

  • LoadMaster exists in Kemp 360 Central: Back up using Kemp 360 Central.
  • LoadMaster does not exist in Kemp 360 Central: Back up using the LoadMaster User Interface (UI) and upload the backup file to Kemp 360 Central.

2.3.3.17 Back up using Kemp 360 Central

You can use a GET command to back up a LoadMaster using Kemp 360 Central.

/api/v1/loadmaster/LoadMasterID/backup

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/loadmaster/19/backup/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Example Output

HTTP/1.1 200 OK

Date: Fri, 02 Mar 2018 10:34:25 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Cache-Control: no-cache

Transfer-Encoding: chunked

Content-Type: application/json

{"message": "LoadMaster backup created."}

2.3.3.18 Back up using the LoadMaster UI and Upload the Backup File to Kemp 360 Central

If the LoadMaster being backed up does not exist in Kemp 360 Central, the backup must be created using the LoadMaster rather than Kemp 360 Central.

After the backup file is downloaded from the LoadMaster, users should make a note of the path (on their local machine) to the backup file they want to upload to Kemp 360 Central.

You can use a POST command to upload a backup file to Kemp 360 Central.

/api/v1/backup/

Example Command

curl -k --dump-header - -F "backup=@C:\temp\LMBackups_arm-lm-spla39_2018_03_02.13_17" "https://Kemp360CentralIPAddress/api/v1/backup/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output

HTTP/1.1 100 Continue

HTTP/1.1 201 CREATED

Date: Fri, 02 Mar 2018 13:32:31 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Location: https://<<Kemp 360 Central IP Address>>/api/v1/backup/4/

Content-Length: 0

Content-Type: text/html; charset=utf-8

2.3.3.19 Restore a Backup

You can use a GET command to restore an existing backup file (which exists in Kemp 360 Central) to a LoadMaster.

/api/v1/loadmaster/id/restore_backup/?backup_id=id

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/loadmaster/5/restore_backup/?&backup_id=1&api_key=18f1c7933621e2e1e7738f178dccc603110d785c&username=admin"

Available Parameters

The ID of the LoadMaster and the ID of the backup are required parameters for restoring a backup:

Expected Output

HTTP/1.1 200 OK

Date: Tue, 14 Aug 2018 09:01:54 GMT

Server: Apache

Vary: Accept

Cache-Control: no-cache

X-Frame-Options: SAMEORIGIN

Transfer-Encoding: chunked

Content-Type: application/json

{"message": "LoadMaster backup restored."}

2.3.3.20 Delete a Backup

Use a DELETE command to delete a backup.

/api/v1/backup/id/

Example Command

curl -k --dump-header - -X DELETE "https://Kemp360CentralIPAddress/api/v1/backup/2/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Available Parameters

The only available parameter for this command is id.  Users should first identify the id number of the backup for which they wish to retrieve details.  To retrieve the backup ID number, run the command to list all backups. For further information, refer to the List all Backups section.

Expected Output

HTTP/1.1 204 NO CONTENT

Date: Fri, 02 Mar 2018 10:40:34 GMT

Server: Apache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Content-Length: 0

Content-Type: text/html; charset=utf-8

2.3.3.21 Templates

2.3.3.22 Show Templates Available for a Kemp 360 Central Machine

Use a GET command to retrieve the list of templates available for a Kemp 360 Central machine.

/api/v1/template/

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/template/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

When running this command, enter the IPv4 address of the Kemp 360 Central machine.

Expected Output

HTTP/1.1 200 OK

Date: Fri, 02 Mar 2018 10:45:25 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Cache-Control: no-cache

Transfer-Encoding: chunked

Content-Type: application/json

{

    "meta": {

        "limit": 20,

        "next": null,

        "offset": 0,

        "previous": null,

        "total_count": 2

    },

    "objects": [

        {

            "created_at": "2018-03-02T10:44:55",

            "id": 1,

            "resource_uri": "/api/v1/template/1/",

            "template": "./Exchange_2016_Additional.tmpl",

            "updated_at": "2018-03-02T10:44:55"

        },

        {

            "created_at": "2018-03-02T10:45:02",

            "id": 2,

            "resource_uri": "/api/v1/template/2/",

            "template": "./Exchange_2016_Core.tmpl",

            "updated_at": "2018-03-02T10:45:02"

        }

    ]

}

2.3.3.23 Show the Details of a Specific Template

Use a GET command to retrieve the details of a specific template.

/api/v1/template/id

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/template/1/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

When running this command, enter the IPv4 address of the Kemp 360 Central machine and the ID number of the template for which you require details. To retrieve the template ID, run the command which lists all templates. For further information, refer to the Show Templates Available for a Kemp 360 Central Machine section.

Expected Output

HTTP/1.1 200 OK

Date: Fri, 02 Mar 2018 10:47:53 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Cache-Control: no-cache

Transfer-Encoding: chunked

Content-Type: application/json

{

    "created_at": "2018-03-02T10:44:55",

    "id": 1,

    "resource_uri": "/api/v1/template/1/",

    "template": "./Exchange_2016_Additional.tmpl",

    "updated_at": "2018-03-02T10:44:55"

}

2.3.3.24 Upload a Template to Kemp 360 Central

You can use this command to upload a template to Kemp 360 Central.

Example Command

curl -k --dump-header - -F "template=@C:\temp\Exchange_2016_ESP.tmpl" "https://Kemp360CentralIPAddress/api/v1/template/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

Expected Output

HTTP/1.1 100 Continue

HTTP/1.1 201 CREATED

Date: Fri, 02 Mar 2018 10:52:37 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Vary: Accept

Location: https://<<Kemp 360 Central IP Address>>/api/v1/template/3/

Content-Length: 0

Content-Type: text/html; charset=utf-8

2.3.3.25 Upload a Template to a LoadMaster

You can use a GET command to upload a template to a LoadMaster.

/api/v1/loadmaster/LoadMasterID/upload_template/?template_id=TemplateID/

Example Command

curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/loadmaster/5/upload_template/?&template_id=1&api_key=18f1c7933621e2e1e7738f178dccc603110d785c&username=admin"

Expected Output

HTTP/1.1 200 OK

Date: Tue, 14 Aug 2018 08:50:17 GMT

Server: Apache

Cache-Control: no-cache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Transfer-Encoding: chunked

Content-Type: application/json

{"message": "Template ./Exchange_2016_ESP.tmpl uploaded."}

2.3.3.26 Delete a Template

You can use a DELETE command to delete a template.

/api/v1/template/id/

Example Command

curl -k --dump-header - -X DELETE "https://Kemp360CentralIPAddress/api/v1/template/1/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"

When running this command, enter the IPv4 address of the Kemp 360 Central machine and the ID number of the template you want to delete. To retrieve the template ID, run the command that lists all templates. For further information, refer to the Show Templates Available for a Kemp 360 Central Machine section.

Expected Output

HTTP/1.1 204 NO CONTENT

Date: Fri, 02 Mar 2018 11:04:23 GMT

Server: Apache

Vary: Accept

X-Frame-Options: SAMEORIGIN

Content-Length: 0

Content-Type: text/html; charset=utf-8

2.3.4 License an Activation Server Local (ASL) LoadMaster

The following section outlines the commands to programmatically provision an ASL LoadMaster. Each of these commands immediately activates the LoadMaster.

This automatically creates a network in Kemp 360 Central. There is no requirement to create a network.

2.3.4.1 Activation Server IP

The aslactivate command updates the Activation Server IP Address and activates the LoadMaster:

curl –k –u username:password "https://LoadMasterIPAddress/access/aslactivate?aslipaddr=IPAddress"

The equivalent command from the Windows command line is:

curl "https://LoadMasterIPAddress/access/aslactivate?aslipaddr=Kemp360CentralIPAddress" -H "Content-Type: application/json" –k -v

This returns the settings of all the parameters that are configured. The same format response is returned in all cases.

curl –k –u username:password "https://LoadMasterIPAddress/access/aslactivate?aslipaddr=172.20.1.200"

<Response stat="200" code="ok">

<Success>

<Data>

<aslipaddr>172.20.1.200</aslipaddr>

<aslname>LM-ACT-SERVER-DEFAULT</aslname>

<aslport>8443</aslport>

</Data>

</Success>

</Response>

2.3.4.2 Activation Server Port

This command updates the Activate Server Port and activates the LoadMaster:

curl –k –u username:password https://LoadMasterIPAddress/access/aslactivate?aslport=Port

The equivalent command from the Windows command line is:

curl "https://LoadMasterIPAddress/access/aslactivate?aslport=Port" -H "Content-Type: application/json" –k -v

2.3.4.3 Activation Server Hostname

This command updates the Activation Server Hostname and activates the LoadMaster:

curl –k –u username:password https://LoadMasterIPAddress/access/aslactivate?aslname=FQDN

The equivalent command from the Windows command line is:

curl "https://LoadMasterIPAddress/access/aslactivate?aslname=FQDN" -H "Content-Type: application/json" –k -v

The default value for this field is always LM-ACT-SERVER-DEFAULT.

2.3.4.4 Set all Parameters

This command sets all the ASL LoadMaster settings (Server IP, Server Port, Server Hostname) and activates the LoadMaster:

curl –k –u username:password https://LoadMasterIPAddress/access/aslactivate?aslname=FQDN&aslport=Port&aslipaddr=IPAddress

The equivalent command from the Windows command line is:

curl "https://LoadMasterIPAddress/access/aslactivate?aslname=FQDN&aslport=Port&aslipaddr=IPAddress" -H "Content-Type: application/json" –k –v

2.3.4.5 Set the ASL LoadMaster Password

This command sets the ASL LoadMaster password (at the time of initial licensing):

curl -k –u username:password "https://LoadMasterIPAddress/access/set_initial_passwd?passwd=Password"

The equivalent command from the Windows command line is:

curl "https://LoadMasterIPAddress/access/set_initial_passwd?passwd=LoadMasterPassword" -H "Content-Type: application/json" –k –v -d "{\"username\":\"bal\",\"password\":\"LoadMasterPassword\"}"

The password is for the default administrator user (that is, the bal user). The password should contain at least eight alphanumeric characters.

2.3.5 ASL LoadMaster Commands

2.3.5.1 Detailed List of ASL Instances

You can retrieve the detailed list of ASL instances that are under Kemp 360 Central control using the API key and the following command:

Example Command

curl -X GET "https://Kemp360CentralIPAddress/api/v1/asl-instance/?api_key=18f1c7933621e2e1e7738f178dccc603110d785c&username=admin" -H "Content-Type: application/json" -k -v -d "{\"username\":\"admin\",\"password\":\"Kemp360CentralPassword\"}"

This returns an empty list, as below, if there are no ASL instances active.

{"meta": {"limit": 1000, "next": null, "offset": 0, "previous": null, "total_count": 0}, "objects": []}

The "limit" is set to 1000 by default and means that the API attempts to return information for 1000 ASL instances. This can be changed by using "&limit=n", where n defines the number of ASL instances information to be returned. For example, if you want the first 10 ASL LoadMaster details, then you use the following command:

curl -X GET "https://Kemp360CentralIPAddress/api/v1/asl-instance/?api_key=45e8679e3d71fba960e3796a73601dd206aef85e&username=admin&limit=10" -H "Content-Type: application/json" -k -v -d "{\"username\":\"admin\",\"password\":\"Kemp360CentralPassword\"}"

When there are ASL LoadMasters active, the following information is returned:

HTTP/1.1 200 OK

Date: Wed, 15 Aug 2018 08:22:52 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Cache-Control: no-cache

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{"meta": {"limit": 1000, "next": null, "offset": 0, "previous": null, "total_count": 2}, "objects": [{"activation_date": "2018-08-15T07:54:09", "boot_time": "2018-03-05T13:34:46", "call_home_time": "2018-08-15T07:54:09", "created_at": "2018-02-10T10:57:17", "id": 1, "kill_time": "2018-08-14T08:08:03", "lm_version": "7.2.40.0.15707.RELEASE", "mac_address": "00505684e8ef", "resource_uri": "/api/v1/asl-instance/1/", "status": "ACTIVE", "updated_at": "2018-08-15T07:54:09", "vlm_name": "VMWARE"}, {"activation_date": "2018-08-14T08:08:46", "boot_time": "2018-03-05T13:34:47", "call_home_time": "2018-08-15T08:09:09", "created_at": "2018-02-10T11:02:17", "id": 2, "kill_time": "2018-08-14T07:05:19", "lm_version": "7.2.40.0.15707.RELEASE", "mac_address": "00505684e247", "resource_uri": "/api/v1/asl-instance/2/", "status": "ACTIVE", "updated_at": "2018-08-15T08:09:09", "vlm_name": "VMWARE"}]}

There is an "offset" parameter that defines the offset from the limit. For example, if the "limit" is set to 10 and the "offset" is set to 20, you get the ASL LoadMaster details from 10 to 30.

curl -X GET "https://Kemp360CentralIPAddress/api/v1/asl-instance/?api_key=45e8679e3d71fba960e3796a73601dd206aef85e&username=admin&limit=10&offset=20" -H "Content-Type: application/json" -k -v -d "{\"username\":\"admin\",\"password\":\"Kemp360CentralPassword\"}"

2.3.5.2 Single ASL LoadMaster

The details for a single ASL LoadMaster instance can be retrieved

Example Command

curl -X GET "https://Kemp360CentralIPAddress/api/v1/asl-instance/1/?api_key=18f1c7933621e2e1e7738f178dccc603110d785c&username=admin" -H "Content-Type: application/json" -k -v -d "{\"username\":\"admin\",\"password\":\"Kemp360CentralPassword\"}"

The ‘1’ denotes the LoadMaster that the password is to be changed on. This information is available from the retrieve list command, parameter ‘id’.

Expected Output

HTTP/1.1 200 OK

Date: Wed, 15 Aug 2018 08:15:00 GMT

Server: Apache

X-Frame-Options: SAMEORIGIN

Cache-Control: no-cache

Vary: Accept

Transfer-Encoding: chunked

Content-Type: application/json

{"activation_date": "2018-08-15T07:54:09", "boot_time": "2018-03-05T13:34:46", "call_home_time": "2018-08-15T07:54:09", "created_at": "2018-02-10T10:57:17", "id": 1, "kill_time": "2018-08-14T08:08:03", "lm_version": "7.2.40.0.15707.RELEASE", "mac_address": "00505684e8ef", "resource_uri": "/api/v1/asl-instance/1/", "status": "ACTIVE", "updated_at": "2018-08-15T07:54:09", "vlm_name": "VMWARE"}

2.3.5.3 Download ASL Data

The detailed list of ASL LoadMasters is available with the following command.

Example Command

curl -X GET "https://Kemp360CentralIPAddress/api/v1/360/download_asl_data/?api_key=18f1c7933621e2e1e7738f178dccc603110d785c&username=admin" -H "Content-Type: application/json" -k -v -d "{\"username\":\"admin\",\"password\":\"Kemp360CentralPassword\"}"

Expected Output

Device ID,MAC Address,Status,Activation Date,Boot Time,Kill Time,LM Version

1,000d3a23c068,ACTIVE,2016-06-15 13:55:59+00:00,2016-06-15 13:15:47+00:00,,7.1.34.1.12856.RELEASE

If the ASL LoadMaster is removed from Kemp 360 Central, then the following information is returned.

Expected Output

Device ID,MAC Address,Status,Activation Date,Boot Time,Kill Time,LM Version

Device Removed,000d3a23c068,DISABLED,2016-06-15 13:55:59+00:00,2016-06-15 13:15:47+00:00,2016-06-15 14:36:20+00:00,7.1.34.1.12856.RELEASE

References

Unless otherwise specified, the following documents can be found at http://kemptechnologies.com/documentation.

Last Updated Date

This document was last updated on 19 February 2019.

 

Download PDF File

Comments

In this document