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.

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

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

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

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

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

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

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

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.

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.

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

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

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

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.

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"

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"

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.

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

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

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:

For details on the command used to retrieve the ID of the LoadMaster, refer to the Show the Status of All LoadMasters in a Network section.
For details on the command used to retrieve the ID of the backup, refer to the List all Backups section.

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

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

Templates

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"

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"

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

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

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

Interface Description Kemp 360 Central API