Multi-Tenant LoadMaster API

Transcription

1 Multi-Tenant LoadMaster API Interface Description VERSION: 5.0 UPDATED: JULY 2016

2 Table of Contents 1 Introduction Document Purpose Intended Audience The Multi-Tenant LoadMaster API Interface Notation Placeholder Text Parameter Types Security Enabling the Multi-Tenant LoadMaster API Interface Using Get and Set Commands Error Reports Command Syntax Initial Configuration Read the EULA Accept the EULA and Set the License Type Specify whether or not to use the Call Home Feature License the Multi-Tenant LoadMaster Set the Initial Password Instance Management Upload a VNF Package List the Installed VNF Packages Delete a VNF Package Create an Instance List the Instances Delete an Instance Retrieve the Currently Committed Resources Allow/Disallow Over Commitment of Resources Copyright KEMP Technologies, Inc. All Rights Reserved. 2

3 3.3.9 Retrieve the Instance Status Configure an Instance Start/Stop an Instance Enable/Disable AutoStart Add/Delete an Instance Interface Backup/Restore Instance Commands Template Management Upload a Template List Installed Templates List the Available and Installed Templates for an Instance Add/Remove Template(s) to/from an Instance Delete a Template Statistics Network Management Retrieve Interface Details Modify Interface Details Add/Remove Additional Addresses Create/Delete a VLAN Get/Set the Host Name Get/Set the Nameserver Get/Set the Search Domain Get/Set the Default Gateway Add/Delete Additional Routes System Management Retrieve the Firmware Version User Management License Management Shut Down/Reboot the Multi-Tenant LoadMaster Update the Multi-Tenant LoadMaster Firmware Restore a Firmware Version to the Multi-Tenant LoadMaster Backup/Restore Configuration Copyright KEMP Technologies, Inc. All Rights Reserved. 3

4 3.7.8 Configure Automatic Backups Date/Time Logging Management Manage System Logs Debugging Reset Statistics Get/Set Syslog Options Get/Set SNMP Options Get/Set Options Miscellaneous Options WUI Settings WUI Authentication and Authorization Options Remote Access Options Cipher Sets Network Options References Document History Copyright KEMP Technologies, Inc. All Rights Reserved. 4

5 Introduction 1 Introduction The KEMP Multi-Tenant LoadMaster Application Program Interface (API) is an interface designed to allow remote applications to access the Multi-Tenant LoadMaster in a simple and consistent manner. The interface is a REST-like interface. REST (Representational State Transfer) is a style of software architecture for distributed systems and is one of the predominant web service design models. The implementation of the Multi-Tenant LoadMaster API is based on the KEMP LoadMaster API. The infrastructure of these APIs is not fully RESTful compliant. For example, the PUT or DELETE HTTP methods are not supported. 1.1 Document Purpose This document describes the API interface to the KEMP Multi-Tenant LoadMaster product. It describes in detail how to configure the various features of the Multi-Tenant LoadMaster using the API. This document does not explain each of the features in detail. For further information, including details on configuring the KEMP Multi-Tenant LoadMaster using the Web User Interface (WUI), refer to the Multi-Tenant LoadMaster, Feature Description. 1.2 Intended Audience This document is intended to help anyone who wishes to configure the KEMP Multi-Tenant LoadMaster using API commands. Copyright KEMP Technologies, Inc. All Rights Reserved. 5

6 The Multi-Tenant LoadMaster API Interface 2 The Multi-Tenant LoadMaster API Interface The Multi-Tenant LoadMaster API works in a RESTful manner, allowing a user or application to pass HTTPS requests to the Multi-Tenant LoadMaster. The Multi-Tenant LoadMaster answers the request with a JavaScript Object Notation (JSON) formatted response. The HTTPS request needs to be in the following format: Value> The basic interface is a simple HTTPS GET operation where the command is specified by the URL. If any parameters are required by the operation, they are passed as QUERY parameters. The following points should be noted regarding the formatting of the HTTPS request: Only one command can be given at a time. The? character signifies the end of a command. The & character signifies the end of a parameter/value pair. If there are any unnecessary parameter/value pairs, they will be ignored. The order in which the parameter/value pairs appear does not matter. There cannot be any spaces within the query. Although some applications, like browsers, would convert spaces to HTML code prior to sending the string to the Multi-Tenant LoadMaster. 2.1 Notation Placeholder Text In the example commands in this document, text which is italicized and is surrounded by angular brackets indicates a value which needs to be entered, for example: " lue=<examplemessageoftheday>" In the example above, <Username>, <Password>, <MTIPAddress> and <ExampleMessageOfTheDay> all relate to values that should be entered, for example: " ue=example Message of the Day" Throughout this document, anywhere that the Multi-Tenant LoadMaster IP address needs to be entered will be indicated by <MTIPAddress>. Some of the commands and parameters are case sensitive. Copyright KEMP Technologies, Inc. All Rights Reserved. 6

7 The Multi-Tenant LoadMaster API Interface Parameter Types Throughout the document the parameter types are defined as follows: 2.2 Security Type Typical Values Boolean Y or N; y or n; 1 or 0; Integer <MinimumIntegerValue>- <MaximumIntegerValue> String "value" Address IP address File Some type of file Table 2-1: Parameter Type Notation An application can only access the Multi-Tenant LoadMaster via the standard WUI IP address. The user bal naturally has access to all functionality; other users have access to the subsystems that have been assigned to them via the Multi-Tenant LoadMaster permissions. Depending on security settings and whether the browser has ever connected to the WUI before adding login information may be required. In this case instead of a standard command format such as: The login information would need to be included, i.e. ers> 2.3 Enabling the Multi-Tenant LoadMaster API Interface The RESTful API interface is enabled or disabled via the Multi-Tenant LoadMaster WUI. By default the interface is disabled. To enable the RESTful API interface, complete the following steps: 1. Go to System Configuration > Miscellaneous Options > Remote Access in the main menu. Table 2-2: Enable API Interface 2. Select the Enable API Interface checkbox. Copyright KEMP Technologies, Inc. All Rights Reserved. 7

8 The Multi-Tenant LoadMaster API Interface 2.4 Using Get and Set Commands A large number of Multi-Tenant LoadMaster parameters can be managed using the get and set commands. These parameters are described throughout the document. Values of parameters can be obtained using the get command using the format: Name> Values of parameters can be set using the set command using the format: Name>&value=<ParameterValue> 2.5 Error Reports If an error occurs, for example if a request is missing a required parameter, an error report is generated such as the following: <Response stat="400" code="fail"> <Error> param: String Value missing </Error> The error code may change, depending on what the issue is. The HTTP status of the request also reflects the response code. Other error messages may be displayed if commands were unsuccessful for some reason, such as: <Response stat="400" code="fail"> <Error>unable to delete the LoadMaster-VLM image file</error> Copyright KEMP Technologies, Inc. All Rights Reserved. 8

9 3 3.1 Command Syntax A request is made up of two parts: the command and the parameters. s> When there is more than one parameter in a request, individual parameters are separated using an ampersand (&) symbol. 3.2 Initial Configuration A number of steps are involved in initially deploying a Multi-Tenant LoadMaster, such as accepting the End User License Agreement (EULA) and licensing the unit. Before the Multi- Tenant LoadMaster can be fully deployed, the user must display and accept the EULA. These initial configuration steps can either be performed via the WUI or the API. The API commands relating to initial configuration are listed in the sections below. Each of the commands in this section (apart from the licensing commands) can only be run before the Multi-Tenant LoadMaster is fully deployed. If these commands are run on a Multi-Tenant LoadMaster that has been fully deployed, an error will occur Read the EULA These commands should be run in sequential order. The ReadEula command displays the EULA and a magic cookie. The magic cookie is used for security reasons - it limits the possibility of remote attacks. If a command requires the magic cookie (like some of the other ones in the sections below) and does not get the correct magic cookie from the previous command, the command will fail. " Displays the EULA and the magic string. The EULA can be accepted using the AcceptEULA command which is detailed in Section The magic string is an automatically generated random string, for example c0a6fccc-1c53-4a26-8ed3-e0d0bb8e23f3. Please copy this string because it will be needed in the next command in order to set the license type. Copyright KEMP Technologies, Inc. All Rights Reserved. 9

10 3.2.2 Accept the EULA and Set the License Type Currently there are two Multi-Tenant LoadMaster license types available from KEMP. These are: 30 Day Trial License Permanent License The AcceptEULA command is used to enter the magic cookie key which is returned by the ReadEula command in order to accept the EULA and set the type of license used (trial or perm). <CorrectMagicString>&type=<Trial/Perm>" magic String The magic string which was returned when the ReadEULA command was run. For more information on the ReadEULA command, refer to Section type String The type of license to be applied. Valid values are: trial - 30 day trial. This is a temporary license used to evaluate the Multi-Tenant LoadMaster. perm - A purchased, permanent Multi-Tenant LoadMaster. Table 3-1: AcceptEULA parameters <Success><Data><Magic>c0a6fccc-1c53-4a26-8ed3-e0d0bb8e23f3</Magic> <Eula> As part of KEMPs continuous drive to offer better value and services to our customers KEMP has introduced a Call Home feature. The LoadMaster can utilize Call Home to get available license updates, information regarding any updated firmware for your product and provide system status information to KEMP. The system status information will include Throughput, Enabled Features, Virtual Services and Real Servers details but will not include any unique personal information or actual traffic from your network. Your LoadMaster will initiate a connection to KEMP once during any 24 hour interval. <b>note</b> Allowing Call Home is mandatory for Free LoadMaster versions. Copyright KEMP Technologies, Inc. All Rights Reserved. 10

11 For more details on this visit <a href=" target="_blank"> </Eula> </Data> </Success> Another magic string is displayed in the output of this command. This is needed to run the AcceptEula2 command which is used to accept the terms of the EULA Specify whether or not to use the Call Home Feature The AcceptEULA2 command is used to specify whether or not to use the Call Home feature. =<CorrectMagicString>&accept=<0/1>" magic String The magic string which was returned when the AcceptEULA command was run. For more information on the AcceptEULA command, refer to Section accept String Specify whether or not to use the Call Home feature: 0 - Do not use the Call Home feature 1 - Use the Call Home feature Table 3-2: AcceptEULA2 parameters <Success>Command completed ok</success> License the Multi-Tenant LoadMaster Either online or offline licensing can be used to license the Multi-Tenant LoadMaster. Refer to the relevant section below to find out more information. Copyright KEMP Technologies, Inc. All Rights Reserved. 11

12 License using the Online Method The AlsiLicense command can be used to license the Multi-Tenant LoadMaster using the online method. This step must be performed before the Multi-Tenant LoadMaster password can be set. d=<kempid>&password=<kempidpassword>" Parameter Parameter Type Description Mandatory kempid String The KEMP ID is the address which was used when registering for a KEMP ID. password String The password of the KEMP ID account. Table 3-3: AlsiLicense Parameters <Success>Command completed ok</success> License using the Offline Method The Multi-Tenant LoadMaster can be licensed offline by using the license command. A Binary Large Object (BLOB) is needed in order to license using the offline method. The BLOB is sent via , when requested. For more information on licensing (including details on how to retrieve a BLOB), please refer to the Licensing, Feature Description. Copyright KEMP Technologies, Inc. All Rights Reserved. 12

13 Each time a license is updated a new BLOB is needed. The following is an example of a BLOB: Figure 3-1: BLOB The BLOB is the body of text from the word begin to the word end, as is highlighted in the example in Figure 3-1: BLOB. The BLOB must be copied and pasted into a text file (in the following example the file is called license.txt). There are a number of methods of using the license command for example, using a CURL command on Linux would look like the following: curl X POST - k " This command uploads the BLOB file to the Multi-Tenant LoadMaster. The example command above assumes that the license.txt file is in the current directory. If the license.txt file is stored elsewhere, specify the path to the file after symbol. Copyright KEMP Technologies, Inc. All Rights Reserved. 13

14 <Success>Command completed ok. Machine Successfully Licensed</Success> Set the Initial Password The SetInitialPasswd command is used to set the password of the default Multi-Tenant LoadMaster user (bal). curl X POST - k " <NewPassword>" passwd String This is the password for the default administrator user (bal). The password should contain at least 8 alphanumeric characters. Table 3-4: SetInitialPasswd Parameters Expected Output <Success>Command completed ok</success> 3.3 Instance Management Upload a VNF Package This command allows a new LoadMaster Virtualized Network Function (VNF) package to be uploaded to the Multi-Tenant LoadMaster. The command will POST the image file. curl X POST - data-binary "@<PathToFile\Filename.Extension>" k " <Success><templateid>6</templateid></Success> Copyright KEMP Technologies, Inc. All Rights Reserved. 14

15 3.3.2 List the Installed VNF Packages This command returns the list of the installed VNF packages which exist in the Multi-Tenant LoadMaster. The following is an example response with two images installed on the Multi-Tenant LoadMaster: <Success><DATA> <installedvnfs> <vnf> <id>10</id> <name>loadmaster-vlm</name> <version>7.1-30</version> </vnf> <vnf> <id>11</id> <name>loadmaster-vlm</name> <version>7.1-30</version> </vnf> <vnf> </installedvnfs> </DATA></Success> The following is an example response when no images are available inside the Multi-Tenant LoadMaster: <Success> <Data> </Data> </Success> Copyright KEMP Technologies, Inc. All Rights Reserved. 15

16 3.3.3 Delete a VNF Package This command deletes the specified VNF package from the Multi-Tenant LoadMaster. " eid=<vnftemplateid>" templateid String The ID of the VNF package. To retrieve the ID of a currently installed VNF package, run the listinstalledvnf command. Refer to Section for further information. Table 3-5: DeleteVNF parameters <Response stat="200" code="ok"> Create an Instance This command creates a tenant LoadMaster instance. " tgw=<defaultgatewayipaddress>&memory=<memoryvalue>&templateid=<vnftempl ateid>" dftgw Address The Default Gateway IP address. Copyright KEMP Technologies, Inc. All Rights Reserved. 16

17 memory Integer The memory requirement. Valid values are as follows: If you try to set the memory to a value that is too high, an error message will be displayed which returns the maximum memory available. templateid String The ID of the VNF package. To retrieve the ID of a currently installed VNF package, run the listinstalledvnf command. Refer to Section for further information. vnfname String The nickname for the VNF instance. No ipaddress Address The IP address of the LoadMaster instance. If this is not set, the IP address will default to /24. nics Integer The number of network cards for the LoadMaster instance. The default value for this is 1. Range: 1 to 9 cpus Integer Number of available CPUs for the LoadMaster instance. The default value for this is 1. The maximum is the number of CPUs on the Multi- Tenant LoadMaster. No No No Table 3-6: CreateInstance parameters <Success><instanceID>12</instanceID></Success> This instance ID is needed for both the instanceid and iid parameters in all relevant subsequent commands throughout this document. To retrieve the instance IDs, run the listinstances command which is detailed in Section Copyright KEMP Technologies, Inc. All Rights Reserved. 17

18 3.3.5 List the Instances This command returns the details about the installed VNF instances. This command can either be run without any parameters to display details for all instances, or an instanceid can be specified to display details about a particular instance. instanceid Integer The ID of the relevant instance. No Table 3-7: ListInstances parameters <Success><DATA> <VNF> <Id>21</Id> <Name>VLM-2 Company 1</Name> <Status>idle</Status> <IPAddress> </IPAddress> <Autostart>no</Autostart> </VNF> </DATA></Success> The tenant status can be idle or running Delete an Instance This command can be used to delete an instance. An instance cannot be deleted if it is running. Stop the instance before deleting by running the stopinstance command, if needed. For further information on the stopinstance command, refer to Section " stanceid=<instanceid>" Copyright KEMP Technologies, Inc. All Rights Reserved. 18

19 instanceid Integer The ID of the instance to be deleted. The instance ID can be retrieved by running the listinstances command. For more information, refer to Section Table 3-8: DeleteInstance parameters <Success>Command completed ok</success> Retrieve the Currently Committed Resources This command returns the currently committed resources, i.e. how many cores and how much memory is currently in use. " Expected Output <Success><Data><currentCpus>1</currentCpus> <currentmemory>512</currentmemory> </Data> </Success> The currentmemory displays the amount of memory used Allow/Disallow Over Commitment of Resources The get/set commands can be used to allow or disallow the over commitment of resources. Allowing over commitment of resources can have an impact on performance. Copyright KEMP Technologies, Inc. All Rights Reserved. 19

20 Get (Retrieve) res" Set (Configure) res&value=<0/1>" param String The name of the parameter to be retrieved/configured. In this case, it should be set to overcomres. value String The value to set the parameter to. In this case, specify whether or not to allow over commitment of resources. 0/no - Disallow 1/yes - Allow Table 3-9: Allow/Disallow Over Committment of Resoucres parameters - if setting. No - if getting. Get (Retrieve) <Success> <Data> <overcomres>no</overcomres> </Data> </Success> Set (Configure) <Success>Command completed ok</success> Copyright KEMP Technologies, Inc. All Rights Reserved. 20

21 3.3.9 Retrieve the Instance Status This command returns the status of a specified instance. " stanceid=<instanceid>" Expected Ouput <Success> <Data> <instancestatus>running</instancestatus> </Data> </Success> The tenant status can be running or idle Configure an Instance This command can be used to configure an instance. An instance cannot be configured if it is running. To stop an instance, run the stopinstance command. For further information, refer to Section " fid=<interfaceid>&iid=<vlminstanceid>" vnfname String The nickname for the VNF instance. memory Integer The memory requirement. Valid values are as follows: Copyright KEMP Technologies, Inc. All Rights Reserved. 21

22 cpus Integer Number of available CPUs for the LoadMaster instance. The default value for this is 1. The maximum is the number of CPUs on the Multi- Tenant LoadMaster. intf String The VNF network interface, in the format eth<number>, for example eth1. This must correspond to an existing interface in the Multi- Tenant LoadMaster. ispi Boolean Specify whether it Is a physical or virtual interface: 0 - Virtual 1 - Physical No intfid Integer The physical or virtual interface ID. iid Integer The VLM instance ID. This can be retrieved by running the listinstances command. For further information, refer to Section Table 3-10: ConfigureInstance parameters All mandatory parameters must be set, even if only one parameter value is being changed. <Success>Configuration Updated</Success> Start/Stop an Instance These commands will start/stop an instance. " tanceid=<instanceid>" " anceid=<instanceid>" Copyright KEMP Technologies, Inc. All Rights Reserved. 22

23 instanceid Integer The ID of the instance to be started/stopped. The instance ID can be retrieved by running the listinstances command. For more information, refer to Section Table 3-11: Start/stop an instance parameters Expected Output <Response stat="200" code="ok"> Enable/Disable AutoStart This command can be used to specify whether or not an instance should automatically start after a system reboot. " <VLMInstanceID>&autostart=<0/1>" iid Integer The VLM instance ID. This can be retrieved by running the listinstances command. For further information, refer to Section autostart Boolean Specify whether or not an instance should automatically start after a system reboot: 0/no - Do not automatically start 1/yes - Do automatically start Table 3-12: AutoInstance parameters <Success>Command completed ok</success> Copyright KEMP Technologies, Inc. All Rights Reserved. 23

24 Add/Delete an Instance Interface These commands can be used to add or delete an interface to/from a VNF instance. Add " iid=<vlminstanceid>" Delete " iid=<vlminstanceid>" An instance interface cannot be deleted if the instance is running. To stop an instance, run the stopinstance command. For more information, refer to Section Running the delinstanceiface command will delete the interface which was last added. It is not possible to delete the eth0 interface. iid Integer The VLM instance ID. This can be retrieved by running the listinstances command. For further information, refer to Section Figure 3-2: Add/Delete Instance Interface parameters Add <Success>VNF network interface Created</Success> Delete <Success>VNF network interface Deleted</Success> Copyright KEMP Technologies, Inc. All Rights Reserved. 24

25 Backup/Restore Instance Commands The sub-sections below contain details about commands relating to the backing up and restoring of instances List Backup Instances This command lists any existing backups for the specified instance. e?iid=<vnfinstanceid>" iid Integer The VLM instance ID. This can be retrieved by running the listinstances command. For further information, refer to Section Table 3-13: ListBackupInstance parameters <Success><DATA><backup_0>LMBackups_2015_10_20.14_33</backup_0><backup_1>LMBacku ps_2015_10_20.14_52</backup_1></data></success> The date and timestamp in the backup filename is in the format YYYY_MM_DD.HH_mm Back Up an Instance This command backs up the specified instance. The backup name includes a date and timestamp. This has a granularity of one minute. If more than one backup is created in the same minute, the original backup (with the same name) will be overwritten. If there is more than one minute between backup attempts, a separate file will be created. " d=<vnfinstanceid>" Copyright KEMP Technologies, Inc. All Rights Reserved. 25

26 iid Integer The VLM instance ID. This can be retrieved by running the listinstances command. For further information, refer to Section Table 3-14: BackupInstance parameters <Success>Successfully Created a Backup</Success> Restore a Backup Instance This command restores a backup instance. " ance?iid=<vnfinstanceid>&bckname=<backupname>" iid Integer The VLM instance ID. This can be retrieved by running the listinstances command. For further information, refer to Section bckname String The name of the backup to be restored. Note: This is case sensitive. Table 3-15: RestoreBackupInstance parameters <Success>Successfully Restored the Backup </Success> Copyright KEMP Technologies, Inc. All Rights Reserved. 26

27 Delete a Backup This command deletes the specified backup. " nce?iid=<vnfinstanceid>&bckname=<backupname>" iid Integer The VLM instance ID. This can be retrieved by running the listinstances command. For further information, refer to Section bckname String The name of the backup to be deleted. Note: This is case sensitive. Table 3-16: DeleteBackupInstance parameters <Success>Backup deleted</success> Download a Backup This command downloads the specified backup file to the local machine. " tance?iid=<vlminstanceid>&bckname=<backupname>" iid Integer The VLM instance ID. This can be retrieved by running the listinstances command. For further information, refer to Section Copyright KEMP Technologies, Inc. All Rights Reserved. 27

28 bckname String The name of the backup to be downloaded. Note: This is case sensitive. Table 3-17: DownloadBackupInstance parameters When this command is run, the backup file will be downloaded. The download location is handled by whatever program is making the API call. 3.4 Template Management Upload a Template This command uploads a template file to the Multi-Tenant LoadMaster. curl X POST - data-binary "@<PathToFile\Filename.Extension>" k " <Response stat="200" code="ok"> List Installed Templates This command returns a list of templates which are installed on the Multi-Tenant LoadMaster. Due to security reasons, the listtemplates command does not work when run in a browser. Use a curl command to run this command. " <Success><Data> <template> <name>exchange 2013 HTTPS<name> <description>handles all HTTPS services including Autodiscover, OWA, OA, AS, ECP, EWS. Includes an HTTP redirector virtual service. Requires version (Version 1.9)<description> </template> <template> Copyright KEMP Technologies, Inc. All Rights Reserved. 28

29 <name>exchange 2013 HTTPS Offloaded<name> <description>handles all HTTPS services including AS, ECP, EWS, EAS, MAPI, OA, OAB, OWA and PS. Includes an HTTP redirector virtual service. Requires LoadMaster version a and Exchange 2013 SP1. (Version 1.9)<description> </template> <template> <name>exchange 2013 HTTPS Reencrypted<name> <description>handles all HTTPS services including AS, ECP, EWS, EAS, MAPI, OA, OAB, OWA and PS. Includes an HTTP redirector virtual service. Requires LoadMaster version a and Exchange 2013 SP1. (Version 1.9)<description> </template> <template> <name>exchange 2013 SMTP<name> <description>handles SMTP connections to Edge or Hub Transport servers. (Version 1.9)<description> </template> </Data> Command completed ok</success> List the Available and Installed Templates for an Instance This command lists the available and installed templates for an instance. ance?iid=<vlminstanceid>" iid Integer The VLM instance ID. This can be retrieved by running the listinstances command. For further information, refer to Section Table 3-18: ListTemplatesInstance parameters <Success><Data> <AvailableTemplates> <name>fujifilm Synapse</name> <name>sap Business Objects Explorer Offloaded</name> <name>sap Business Objects Explorer Re-encrypted</name> <name>sap CRM Offloaded</name> <name>sap CRM Re-encrypted</name> <name>sap Enterprise Portal Offloaded</name> <name>sap Enterprise Portal Re-encrypted</name> </AvailableTemplates> <InstalledTemplates> <name>greenway PrimeSuite</name> <name>oracle EBS HTTP</name> <name>oracle EBS HTTPS</name> <name>vmware Horizon View Connection Pool</name> <name>vmware Horizon View Security Pool</name> </InstalledTemplates> Copyright KEMP Technologies, Inc. All Rights Reserved. 29

30 </Data> </Success> Add/Remove Template(s) to/from an Instance These commands can be used to add or remove template(s) to/from an instance. A template(s) cannot be added/remove to/from an instance when the instance is running. To stop an instance, run the stopinstance command. For further information, refer to Section " stance?iid=<vlminstanceid>&tcmd=<add/rem>&tnames=<templatenames>" iid Integer The VLM instance ID. This can be retrieved by running the listinstances command. For further information, refer to Section tcmd String Specify the action to perform: add - Add the template(s) rem - Remove the template(s) tnames String Specify the name(s) of the template(s) to be added/removed. Multiple templates can be specified in a comma-separated list. Note: The names are case sensitive - please ensure to specify the exact template name in order for this command to work. Table 3-19: ConfigTemplatesInstance parameters <Success>Command completed ok</success> Copyright KEMP Technologies, Inc. All Rights Reserved. 30

31 3.4.5 Delete a Template This command removes an existing template file. " ame=<templatename>" tname String Specify the name of the template to be removed. Note: The name is case sensitive - please ensure to specify the exact template name in order for this command to work. Table 3-20: DeleteTemplate parameters <Response stat="200" code="ok"> 3.5 Statistics This command can be used to retrieve the Multi-Tenant LoadMaster statistics. " <Success> <Data> <CPU> <total> <User>0</User> <System>0</System> <Idle>100</Idle> <IOWaiting>0</IOWaiting> </total> <cpu0> <User>0</User> <System>0</System> <HWInterrupts>0</HWInterrupts> <SWInterrupts>0</SWInterrupts> <Idle>100</Idle> <IOWaiting>0</IOWaiting> </cpu0> <cpu1> Copyright KEMP Technologies, Inc. All Rights Reserved. 31

32 <User>0</User> <System>0</System> <HWInterrupts>0</HWInterrupts> <SWInterrupts>0</SWInterrupts> <Idle>99</Idle> <IOWaiting>0</IOWaiting> </cpu1> <cpu2> <User>0</User> <System>0</System> <HWInterrupts>0</HWInterrupts> <SWInterrupts>0</SWInterrupts> <Idle>100</Idle> <IOWaiting>0</IOWaiting> </cpu2> <cpu3> <User>0</User> <System>0</System> <HWInterrupts>0</HWInterrupts> <SWInterrupts>0</SWInterrupts> <Idle>99</Idle> <IOWaiting>0</IOWaiting> </cpu3> </CPU> <Memory> <memused>559056</memused> <percentmemused>6</percentmemused> <memfree> </memfree> <percentmemfree>94</percentmemfree> </Memory> <Network> <eth0> <speed>1000</speed> <in>0.0</in> <out>0.0</out> </eth0> <eth1> <speed>1000</speed> <in>0.0</in> <out>0.0</out> </eth1> </Network> </Data> </Success> 3.6 Network Management Retrieve Interface Details This command retrieves the details of the specified Multi-Tenant LoadMaster interface. ce=<interfaceid>" Copyright KEMP Technologies, Inc. All Rights Reserved. 32

33 interface Integer The ID number of the relevant Multi- Tenant LoadMaster interface. This number corresponds to the number after eth in the WUI, for example eth0 has an ID of 0. Table 3-21: ShowIface parameters <Success><Data><Interface> <Id>0</Id> <IPAddress> /24</IPAddress> <Mtu>1500</Mtu> <InterfaceType>Port</InterfaceType> <DefaultInterface>yes</DefaultInterface> </Interface> </Data> </Success> Copyright KEMP Technologies, Inc. All Rights Reserved. 33

34 3.6.2 Modify Interface Details This command can be used to modify the settings of an interface. e=<interfaceid>&addr=<ipaddress/prefix>" interface Integer The ID number of the relevant interface. addr Address The IP address of the interface followed by the CIDR in the format <IPAddress/Prefix>. mtu Integer The maximum size of the Ethernet frame that will be sent from this interface. Range: 512 to 9216 The MTU size may need to be low, depending on which network adapter is chosen for the Multi-Tenant LoadMaster. For example, an E1000 network adapter may limit the MTU to 1500 but a VMXNET 3 network adapter may have a maximum of gwiface Boolean Specifies if this is a network gateway interface or not. 0 - Not a network gateway interface 1 - Is a network gateway interface Table 3-22: ModIface parameters No No No <Success>Command completed ok</success> Copyright KEMP Technologies, Inc. All Rights Reserved. 34

35 3.6.3 Add/Remove Additional Addresses These commands can be used to add or remove additional addresses. erface=<interfaceid>&addr=<ipaddress/prefix>" erface=<interfaceid>&addr=<ipaddress/prefix>" interface Integer The ID number of the relevant interface. addr Address The IPv4 or IPv6 address of the additional address. Table 3-23: Add/Remove Additional Addresses parameters <Success>Command completed ok</success> Create/Delete a VLAN These commands can be used to add/delete a VLAN. " =<InterfaceID>&vlanId=<VLANID>" " =<InterfaceID>" Copyright KEMP Technologies, Inc. All Rights Reserved. 35

36 interface Integer If creating - this should be the ID number of the relevant interface. If deleting - this should be the VLAN ID. vlanid Integer The ID number of the VLAN. if creating. Table 3-24: Create/Delete VLAN parameters No if deleting. Create <Success>Created VLAN Interface id 2</Success> Delete <Success>Command completed ok</success> Get/Set the Host Name The host name can be retrieved/configured using the get/set commands. Set (Configure) " e&value=<hostnamevalue>" Get (Retrieve) " e" param String The name of the parameter to be retrieved/configured. In this case, it should be set to hostname. Copyright KEMP Technologies, Inc. All Rights Reserved. 36

37 value String The value to set the parameter to. In this case, enter the desired host name. Table 3-25: Get/Set the Host Name parameters - if setting. No - if getting. Set (Configure) <Response stat="200" code="ok"> <Success>Command completed ok</success> Get (Retrieve) <Response stat="200" code="ok"> <Success><Data>hostname</Data> </Success> Get/Set the Nameserver The nameserver can be retrieved/configured using the get/set commands. Set (Configure) " er&value=<dnsserveripaddress>" Get (Retrieve) " er" param String The name of the parameter to be retrieved/configured. In this case, it should be set to namserver. Copyright KEMP Technologies, Inc. All Rights Reserved. 37

38 value String The value to set the parameter to. In this case, enter the IP address of a DNS server which is to be used to resolve names locally on the Multi-Tenant LoadMaster. Up to three IP addresses can be specified using a commaseparated list. To delete the list of nameservers, set the parameter value to an empty string. Table 3-26: Get/Set the Nameserver parameters - if setting. No - if getting. Set (Configure) <Response stat="200" code="ok"> <Success>Command completed ok</success> Get (Retrieve) <Success> <Data> <namserver> </namserver> </Data> </Success> Get/Set the Search Domain The get/set commands can be used to retrieve or configure the domain name to be prepended to requests to the DNS name server. Set (Configure) " ist&value=<domainname>" Get (Retrieve) " ist" Copyright KEMP Technologies, Inc. All Rights Reserved. 38

39 param String The name of the parameter to be retrieved/configured. In this case, it should be set to searchlist. value String The value to set the parameter to. In this case, enter the domain name that is to be prepended to requests to the DNS nameserver. Multiple domain names can be entered by using a comma-separated list. - if setting. No - if getting. Table 3-27: Get/Set the Search Domain parameters Set (Configure) <Response stat="200" code="ok"> <Success>Command completed ok</success> Get (Retrieve) <Success> <Data> <searchlist>example.com</searchlist> </Data> </Success> Get/Set the Default Gateway Get/Set the IPv4 Default Gateway The get/set commands can be used to retrieve or configure the IPv4 default gateway. Set (Configure) " value=<defaultgatewayipaddress>" Get (Retrieve) " Copyright KEMP Technologies, Inc. All Rights Reserved. 39

40 param String The name of the parameter to be retrieved/configured. In this case, it should be set to dfltgw. value String The value to set the parameter to. In this case, enter the IPv4 default gateway that is to be used for communicating with the internet. - if setting. No - if getting. Table 3-28: Get/Set the IPv4 Default Gateway parameters Set (Configure) <Response stat="200" code="ok"> <Success>Set IPv4 default gateway to </Success> Get (Retrieve) <Response stat="200" code="ok"> <Success><Data><dfltgw> </dfltgw></Data> </Success> Get/Set the IPv6 Default Gateway The get/set commands can be used to retrieve or configure the IPv6 default gateway. Set (Configure) " 6&value=<IPv6DefaultGateway>" Get (Retrieve) " Copyright KEMP Technologies, Inc. All Rights Reserved. 40

41 param String The name of the parameter to be retrieved/configured. In this case, it should be set to dfltgwv6. value String The value to set the parameter to. In this case, enter the IPv6 default gateway that is to be used for communicating with the internet. - if setting. No - if getting. Table 3-29: Get/Set the IPv6 Default Gateway parameters Set (Configure) <Response stat="200" code="ok"> <Success>Set IPv6 default gateway to fdce:9b36:e54f:110::40:14/64</success> Get (Retrieve) <Response stat="200" code="ok"> <Success><Data><dfltgw>fdce:9b36:e54f:110::40:14/64</dfltgw></Data> </Success> Add/Delete Additional Routes These commands can be used to add/delete additional routes. Add " stinationipaddress>&gateway=<gatewayipaddress>" Delete " stinationipaddress>" Copyright KEMP Technologies, Inc. All Rights Reserved. 41

42 dest Address The destination network which needs to be accessed. gateway Address The gateway on the local network, which allows access to the destination network. Table 3-30: Add/Delete Additional Routes parameters - if adding. No - if removing.. <Response stat="200" code="ok"> <Success>Command completed ok</success> 3.7 System Management Retrieve the Firmware Version The get command can be used to retrieve the currently installed Multi-Tenant LoadMaster firmware version. " " <Success> <Data> <version> </version> </Data> </Success> User Management Change the System Password This command can be used to change the password of the default bal user. " d?currpassword=<currentpassword>&password=<newpassword>" Copyright KEMP Technologies, Inc. All Rights Reserved. 42

43 currpassword String The current password for the default bal user. password String The new password for the default bal user. Table 3-31: UserSetSysPassword parameters <Success>Password Changed</Success> Add a New Local User This command adds a new local user. " =<Username>&password=<Password>&radius=<0/1>" user String The username of the new user being created. password String The password of the new user being created. radius Boolean Specify whether or not RADIUS server authentication will be used when this user is logging on. The RADIUS server details must be configured in order to enable this option. 0 - Disabled 1 - Enabled Table 3-32: UserAddLocal parameters <Success>Command completed ok</success> Copyright KEMP Technologies, Inc. All Rights Reserved. 43

44 List All Local Users This command lists all local users and their permissions. <Success> <Data> <User> <Name>ExampleUser</Name> <Perms>,backup,certs,cert3,certbackup</Perms> </User> </Data> </Success> Display Permissions for a Particular Local User This command displays permissions for a particular local user. " ername>" user String The username of the user to display the permissions for. Table 3-33: UserShow parameters <Success> <Data> <User> <Name>ExampleUser</Name> <Perms>,backup,certs,cert3,certbackup</Perms> </User> </Data> </Success> Copyright KEMP Technologies, Inc. All Rights Reserved. 44

45 Set Permissions for a Local User This command can be used to set permissions for a specified local user. " =<Username>&perms=<CommaSeparatedListOfPermissions>" user String The username of the user to set the permissions for. perms String A comma-separated list of permissions. The valid values for this parameter are below: - backup - certs - certs3 (for Intermediate Certificates) - certbackup - users - root Table 3-34: UserSetPerms parameters <Success>Command completed ok</success> Delete a Local User This command deletes the specified local user. " =<Username>" Copyright KEMP Technologies, Inc. All Rights Reserved. 45

46 user String The username of the user to be deleted. Table 3-35: UserAddLocal parameters <Success>Command completed ok</success> Change the Password of a Local User This command can be used to change the password of a local user. " user String The username of the user to change the password for. password String The new password for the specified user. radius Boolean Specify whether or not RADIUS server authentication will be used when this user is logging on. The RADIUS server details must be configured in order to enable this option. 0 - Disabled 1 - Enabled Table 3-36: UserChangeLocPass parameters <Success>Reset Password for ExampleUser</Success> License Management The commands used to update the Multi-Tenant LoadMaster license are the same as those used when initially licensing. For further information, refer to Section Copyright KEMP Technologies, Inc. All Rights Reserved. 46

47 3.7.4 Shut Down/Reboot the Multi-Tenant LoadMaster The commands below can be used to shut down and reboot the Multi-Tenant LoadMaster. If the shut down command is run, the Multi Tenancy machine will need to be powered back on to regain access. <Response stat="200" code="ok"> <Success>Command completed ok</success> Copyright KEMP Technologies, Inc. All Rights Reserved. 47

48 3.7.5 Update the Multi-Tenant LoadMaster Firmware This command can be used to update the firmware version on the Multi-Tenant LoadMaster. curl X POST - data-binary "@<PathToFile\Filename.Extension>" k <Response stat="200" code="ok"> <Success>Command completed ok</success> The Multi-Tenant LoadMaster needs to be rebooted in order for the firmware update to be applied. Refer to Section for details on the reboot command Restore a Firmware Version to the Multi-Tenant LoadMaster The following command allows the previous version of firmware to be restored. curl k " <Response stat="200" code="ok"> <Success>Previous version of Software restored Please reboot to reactivate</success> The Multi-Tenant LoadMaster needs to be rebooted in order for the firmware change to be applied. Refer to Section for details on the reboot command. If there is no previous firmware version available, an error message will be returned and the Multi-Tenant LoadMaster will be inaccessible for approximately two minutes Backup/Restore Configuration These commands can be used to back up the system configuration or to restore a previously saved configuration of the Multi-Tenant LoadMaster. Copyright KEMP Technologies, Inc. All Rights Reserved. 48

49 Backup Restore curl -X POST --data-binary -k Type Integer Enter 1 as the value for this parameter. Table 3-37: Restore parameters <Response stat="200" code="ok"> <Success>Command completed ok</success> Configure Automatic Backups The get/set commands can be used to configure automatic backups of the Multi-Tenant LoadMaster. The automatic backup is performed at the specified time and is saved on a remote host (via FTP). The automatic backup configuration can be managed using set/get commands. " nable&value=yes" backupenable Boolean 0 - Disabled 1 - Enabled backupday Integer 0 - Daily 1 - Monday etc. 7 - Sunday No No Copyright KEMP Technologies, Inc. All Rights Reserved. 49