VMware vRealize Orchestrator

1 Introduction

VMware vRealize Orchestrator allows administrators to develop complex automation tasks, then quickly access and launch workflows from the VMware vSphere client or various triggering mechanisms such as vROPs, vCAC, and so on.

Introduction.png

KEMP have developed a plugin for Orchestrator which acts as a front-end for the KEMP Java API commands. When this plugin is installed, users can perform a number of tasks on the LoadMaster using the Orchestrator interface. The plugin allows Orchestrator to send commands (via workflows) to and receive information back from the KEMP LoadMaster and GEO products.

1.1 Document Purpose

The purpose of this document is to describe how to install and use the KEMP Orchestrator plugin. The document provides step-by-step instructions on how to run the various KEMP workflows which are added when the plugin is installed.

1.2 Intended Audience

This document is intended to be used by anyone who would like to use Orchestrator to manage their LoadMasters.

1.3 Prerequisites

Below are some prerequisites to be aware of before using the KEMP Orchestrator plugin:

If using the default self-signed certificate which is generated by the LoadMaster, please ensure it is registered properly with the systems and that it is trusted. Please refer to VMware documentation, or your Operating System documentation, for instructions on how to do this.

If the certificate is not trusted there may be issues running the workflows.

If using an FQDN as opposed to an IP address, please ensure that the DNS is properly configured.

2 Install the KEMP Orchestrator Plugin

Before using Orchestrator to manage a KEMP LoadMaster, the KEMP Orchestrator plugin must be installed. To do that, first download the KEMP Orchestrator plugin from the VMware Solution Exchange. Then, follow the steps below:

1. In a web browser, navigate to the IP address of the Orchestrator server followed by the :8281 port.

Install the KEMP Orchestrator.png

2. Click the Orchestrator Configuration link.

Install the KEMP Orchestrator_1.png

3. Enter the Orchestrator credentials and click Login.

Install the KEMP Orchestrator_2.png

4. Select the Install Application tab.

5. Click the magnifying glass icon.

Install the KEMP Orchestrator_3.png

6. Browse to and select the KEMP Orchestrator plugin file (.vmo app file).

If you cannot see the plugin file, you may need to select All Files in the bottom-right corner.

7. Click Install in the bottom-right.

It might take a few seconds to upload the plugin before moving on to the next screen.

Install the KEMP Orchestrator_4.png

8. To accept the license agreement, click I accept the terms of the License Agreement.

Install the KEMP Orchestrator_5.png

9. The plugin is now installed, but before it can be used the Orchestrator service needs to be restarted. To do this, click Startup Options on the left.

Install the KEMP Orchestrator_6.png

10. Click Restart service.

Install the KEMP Orchestrator_7.png

11. Wait for the service to restart.

Install the KEMP Orchestrator_8.png

12. A message will appear when the service has been restarted.

The KEMP Orchestrator plugin should now be installed and ready to use.

3 Using the KEMP Orchestrator Plugin

3.1 Inventory

There is an Inventory section in Orchestrator which will list any LoadMasters that have been added to Orchestrator. There are also a number of KEMP directories which are created when the KEMP Orchestrator plugin is installed. To view these, follow the steps below:

Inventory.png

1. Select the Run mode from the drop-down in the top-left.

Inventory_1.png

2. Select the Inventory tab (icon of a jigsaw puzzle piece with a page behind it).

Inventory_2.png

When any KEMP files are uploaded to the Orchestrator, for example certificate or patch files, KEMP recommends saving those files in the relevant KEMP directories. The certificate and LoadMaster backups will automatically save into the relevant directories when the related workflows are run.

3.2 Workflows

After the plugin has been installed, a number of KEMP workflows will be available. These workflows can be used to perform various tasks in the LoadMaster.

The workflows can be accessed by following the steps below:

Inventory.png

1. Select the Run mode from the drop-down in the top-left.

Workflows.png

2. Select the Workflows tab (blue icon).

Workflows_1.png

3. Expand the Library directory.

4. Expand the KEMP directory.

5. Each of the sub-directories within the KEMP directory contain various workflows that can be run. To run a workflow:

a) Expand the relevant directory.

b) Select the relevant workflow.

Workflows_2.png

c) Click the green play icon (Start workflow) in the top-left.

d) A screen will then appear which will contain relevant fields relating to that workflow. Fill out the fields and click Submit.

The steps to run each of the workflows are the same, but the fields that appear on each of the screens will differ. Refer to the sections below for more information. The section names correspond to the directory names in Orchestrator.

3.3 Files

Files can be uploaded to and deleted from Orchestrator. For further details, refer to the sections below:

3.3.1 Delete Files

Delete Files.png

1. Click Not set.

Delete Files_1.png

2. Click Insert value.

Delete Files_2.png

3. Expand the KEMP directory.

4. Expand the relevant directory where the file is located.

5. Select the relevant file to be deleted.

6. Click Add.

Delete Files_3.png

7. Click Select.

Delete Files_4.png

8. Click Accept.

Delete Files_5.png

9. Click Submit.

Delete Files_6.png

10. Wait for the deletion to complete.

3.3.2 Upload Files

Upload Files.png

1. Click Not set in the Select files to be uploaded field.

Upload Files_1.png

2. Click Not set.

3. Browse to and select the relevant file to be uploaded.

Upload Files_2.png

4. Click Insert value.

Multiple files can be uploaded at the same time, if needed. Simply browse to and select another file and click Insert value to add it to the list of files to be uploaded.

Upload Files_3.png

5. Click Accept.

Upload Files_4.png

6. Click Not set in the Select the directory to store these files field.

Upload Files_5.png

7. Expand the KEMP directory.

8. Select the relevant directory to store the file in.

9. Click Select.

Upload Files_6.png

10. If you want to replace an existing file of the same name, select Yes.

11. Click Submit to upload.

Upload Files_7.png

The file will then be visible in the Inventory tab in the relevant directory.

3.3.2.1 Uploading Files which are Bigger than 2MB

There is a limit of 2MB on the file sizes that can be uploaded via the KEMP Orchestrator plugin. This means that firmware upgrade patch files are not able to be uploaded using the method listed in the section above. This section outlines a workaround that can be used to upload files greater than 2MB in size.

The following are valid LoadMaster directories on the Orchestrator server:

lm_config_backups

lm_certs

lm_certs_backups

lm_patches

You can use a number of options to copy/download the file to the Orchestrator Server. Two of the options - using SCP or using cURL, are outlined below.

3.3.2.1.1 Using SCP to Copy a File to the Orchestrator Server

This process requires SSH access to be enabled when deploying the Orchestrator appliance. Follow the steps below:

1. Navigate to the directory containing the file to transfer on the source machine.

2. Run the following command:

scp <File_To_Transfer> root@<Orchestrator_Server_IP_Address>:/var/lib/vco/app-server/temp/<LoadMaster_Directory>/<Filename>

In order for the files to be visible in the Orchestrator client, one of the four directories listed in the Uploading Files which are Bigger than 2MB section must be used in place of <LoadMaster_Directory>.

3. After authenticating with the server, the file transfer should proceed.

3.3.2.1.2 Use cURL to Download the File

The file must then be downloaded using a cURL command:

1. Connect to the Orchestrator server via SSH.

Unless additional users have been configured on the server, you must log in as root.

2. Navigate to /var/lib/vco/app-server/temp/<LoadMasterDirectory>

Replace <LoadMasterDirectory> with one of the directories listed in the Uploading Files which are Bigger than 2MB section.

3. Invoke cURL with the -o <Filename> parameter to transfer the output of the command to a file, for example:

curl -u user:password -o <NewFilename> <URL>/<File_To_Download>

3.3.2.1.3 Configuring Permissions

After the file has been successfully transferred, the permissions of the file must be modified in order for it to be accessible to the Orchestrator client. To modify the permissions, run the following command:

chown vco <FileName>

If this step is not performed, the files in question will not be visible in the Orchestrator client.

3.4 LoadMasters

In the LoadMasters directory, there are a number of workflows that can be executed which relate to managing LoadMasters, such as adding and removing LoadMasters from Orchestrator. For details on each of the LoadMaster workflows, refer to the sections below.

Before any of the other LoadMaster workflows can be run on a LoadMaster, the relevant LoadMaster needs to be added to Orchestrator. The first section below provides details on the Add LoadMaster workflow.

3.4.1 Add LoadMaster

A LoadMaster can be added to Orchestrator using the Add LoadMaster workflow. A LoadMaster must be added to Orchestrator before any workflows can be run on that LoadMaster.

Add LoadMaster.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click LoadMaster Configuration.

Add LoadMaster_1.png

4. Enter a recognizable name in the Enter a unique identifier for the LoadMaster text box. This is a friendly name for the LoadMaster, which appears in Orchestrator.

5. Enter the IP address of the LoadMaster to be added.

6. Enter the HTTPS port to use to connect to the LoadMaster.

If you cannot see the port field, you may need to install the latest KEMP package. To do this, select the Administer option from the drop-down at the top, go to the Packages tab on the left, select the com.kemptechnologies package, click the Import package icon and import the latest KEMP package. Both the .dar and the .package files must be updated. The latest KEMP package is available on the KEMP Technologies website.

7. Click Submit.

Add LoadMaster_2.png

8. Wait for the LoadMaster to be added.

Add LoadMaster_3.png

The LoadMaster will then be listed in the KEMP directory in the Inventory tab.

3.4.2 Add Certificate

Before uploading a certificate to the LoadMaster, the certificate file must first be uploaded to Orchestrator. For step-by-step instructions on how to upload a file, refer to the Upload Files section.

Add Certificate.png

When uploading a certificate file via Orchestrator (or via the KEMP API), both the certificate and key must be concatenated into the one file. The certificate file must be listed on top, followed by the private key at the bottom - this is the format which is required by the API which is what the KEMP Orchestrator plugin is based upon. An example file is shown in the screenshot above.

After a certificate file has been uploaded to Orchestrator, it can then be uploaded to the LoadMaster using the Add Certificate workflow.

Add Certificate_1.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

This is the certificate file used to authenticate to the LoadMaster - this is not the field used to upload a new certificate.

3. Click Not set in the Select the LoadMaster to add the certificate to field.

Add Certificate_2.png

4. Expand the KEMP directory.

5. Select the relevant LoadMaster.

6. Click Select.

Add Certificate_3.png

7. Click Certificate Configuration.

Add Certificate_4.png

8. Click Not set.

Add Certificate_5.png

9. Expand the KEMP directory.

10. Expand the Certificates directory.

11. Select the relevant certificate.

12. Click Select.

Add Certificate_6.png

13. Enter the passphrase which was used when creating the certificate in the Enter the passphrase for this certificate text box.

14. Enter a recognizable name for the certificate in the Enter a LoadMaster identifier for this certificate text box. This is a friendly name for the certificate which will be displayed in the LoadMaster.

15. If replacing an existing certificate of the same name, select Yes.

16. Click Submit.

3.4.3 Backup Certificates

The certificates on a LoadMaster can be backed up via Orchestrator. To do this, run the Backup Certificates workflow.

Backup Certificates.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the LoadMaster to perform the backup on field.

Backup Certificates_1.png

4. Expand the KEMP directory.

5. Select the relevant LoadMaster.

6. Click Select.

Backup Certificates_2.png

7. Enter a passphrase to secure this backup file.

8. Click Submit.

Backup Certificates_3.png

9. Wait for the backup to complete.

Backup Certificates_4.png

The backup will be saved to the LoadMaster Backups directory in the Inventory tab.

3.4.4 Backup LoadMaster

The LoadMaster configuration can be backed up via Orchestrator. To do this, run the Backup LoadMaster workflow.

Backup LoadMaster.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the LoadMaster to perform this backup on field.

Backup LoadMaster_1.png

4. Expand the KEMP directory.

5. Select the relevant LoadMaster.

6. Click Select.

Backup LoadMaster_2.png

7. Click Submit.

Backup LoadMaster_3.png

The backup will be stored in the LoadMaster Backups directory in the Inventory tab. The backup can be restored to a LoadMaster via Orchestrator. For instructions on how to do this, refer to the Reboot LoadMaster section.

3.4.5 Delete Certificate

Certificates can be deleted from the LoadMaster by running the Delete Certificates workflow.

Delete Certificate.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the LoadMaster to delete a certificate from field.

Delete Certificate_1.png

4. Expand the KEMP directory.

5. Select the relevant LoadMaster.

6. Click Select.

Delete Certificate_2.png

7. Enter the identifier of the certificate to be deleted.

8. Click Submit.

Delete Certificate_3.png

9. Wait for the deletion to finish.

3.4.6 Disable API

The API interface on the LoadMaster can be disabled via Orchestrator.

If the API is disabled, most of the workflows will not work. The only workflows that will work when the API is disabled are Add LoadMaster and Enable API.

Disable API.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the LoadMaster to disable the API of field.

Disable API_1.png

4. Expand the KEMP directory.

5. Select the relevant LoadMaster.

6. Click Select.

Disable API_2.png

7. Click Submit.

Disable API_3.png

8. Wait for the API to be disabled.

3.4.7 Enable API

The API interface of a LoadMaster which exists in Orchestrator can be enabled via Orchestrator. The API interface needs to be enabled on a LoadMaster for most of the workflows to run. To enable the API, run the Enable API command.

Enable API.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the LoadMaster to enable the API of field.

Enable API_1.png

4. Expand the KEMP directory.

5. Select the relevant LoadMaster.

6. Click Select.

Enable API_2.png

7. Click Submit.

3.4.8 Get Parameter

The Get Parameter workflow can be used to retrieve a number of LoadMaster field values. For a list of parameter names that can be retrieved, refer to Appendix A - Get and Set Parameters.

Get Parameter.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the LoadMaster to be queried field.

Get Parameter_1.png

4. Expand the KEMP directory.

5. Select the LoadMaster to retrieve the value from.

6. Click Select.

Get Parameter_2.png

7. Enter the relevant parameter name in the Enter the name of the parameter to be read field.

8. Click Submit.

Get Parameter_3.png

9. To view the value, select the Variables tab at the bottom.

10. The parameters and their values will be displayed.

3.4.9 Install Patch

The LoadMaster firmware can be updated with a firmware patch file via Orchestrator. Before uploading the firmware patch file to the LoadMaster, first it must be uploaded to Orchestrator. For step-by-step instructions on how to upload a file, refer to the Upload Files section.

After a firmware patch file has been uploaded to Orchestrator, run the Install Patch workflow to update the LoadMaster.

Install Patch.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the LoadMaster to be patched field.

Install Patch_1.png

4. Expand the KEMP directory.

5. Select the LoadMaster to be patched.

6. Click Select.

Install Patch_2.png

7. Click Not set in the Select the patch to apply field.

8. Expand the KEMP directory.

9. Expand the Patches directory.

10. Select the relevant patch file.

11. Click Select.

12. Select Yes to reboot the LoadMaster after the patch has been uploaded.

The LoadMaster must be rebooted after the patch file has been installed in order for the changes to be applied correctly.

13. Click Submit.

14. Wait for the installation and reboot to complete.

3.4.10 Reboot LoadMaster

A LoadMaster which exists in Orchestrator can be rebooted via Orchestrator. To reboot a LoadMaster, run the Reboot LoadMaster workflow.

Reboot LoadMaster.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the LoadMaster to be rebooted field.

Reboot LoadMaster_1.png

4. Select the relevant LoadMaster to be rebooted.

5. Click Select.

Reboot LoadMaster_2.png

6. Click Submit.

7. Wait for the LoadMaster to reboot.

3.4.11 Remove LoadMaster

A LoadMaster can be removed from Orchestrator by running the Remove LoadMaster command.

Remove LoadMaster.png

1. Click Not set.

Remove LoadMaster_1.png

2. Select the relevant LoadMaster.

3. Click Select.

Remove LoadMaster_2.png

4. Click Submit.

Remove LoadMaster_3.png

5. Wait for the LoadMaster to be removed.

3.4.12 Restore Certificates

If a certificate backup file exists in Orchestrator, it can be restored to a LoadMaster. To back up the certificates on a LoadMaster, refer to the Backup Certificates section. To restore the certificates, run the Restore Certificates command.

Restore Certificates.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set.

Restore Certificates_1.png

4. Expand the KEMP directory.

5. Select the relevant LoadMaster.

6. Click Select.

Restore Certificates_2.png

7. Click Backup Options.

Restore Certificates_3.png

8. Click Not set.

Restore Certificates_4.png

9. Expand the KEMP directory.

10. Expand the Certificate Backups directory.

11. Select the relevant backup.

12. Click Select.

Restore Certificates_5.png

13. Enter the passphrase used to secure the backup file.

14. Specify which certificates to restore.

15. Click Submit.

Restore Certificates_6.png

16. Wait for the certificates to restore.

3.4.13 Restore LoadMaster

Before restoring a LoadMaster configuration, a backup configuration must be available in Orchestrator. To back up a LoadMaster configuration in Orchestrator, refer to the Backup LoadMaster section.

When a backup configuration exists in Orchestrator, run the Restore LoadMaster workflow to restore the configuration.

A GEO LoadMaster backup configuration cannot be restored on a non-GEO LoadMaster configuration

Restore LoadMaster.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the LoadMaster to restore field.

Restore LoadMaster_1.png

4. Expand the KEMP directory.

5. Select the relevant LoadMaster.

6. Click Select.

Restore LoadMaster_2.png

7. Click Backup Options.

Restore LoadMaster_3.png

8. Click Not set.

Restore LoadMaster_4.png

9. Expand the KEMP directory.

10. Expand the LoadMaster Backups directory.

11. Select the relevant backup.

12. Click Select.

Restore LoadMaster_5.png

13. Specify the configurations to be restored by selecting Yes for the relevant options.

14. If restoring the base LoadMaster configuration, another field will appear asking if the LoadMaster should be rebooted after restoration. If restoring the base configuration, please set this to Yes as the LoadMaster needs to be rebooted for the changes to be applied.

15. Click Submit.

16. Wait for the restoration to complete.

3.4.14 Set Credentials

When a LoadMaster is added to Orchestrator via the Add LoadMaster command, the credentials are set. If, for any reason, the LoadMaster credentials which are saved in Orchestrator need to be updated (for example if the credentials have changed), the Set Credentials workflow can be run.

Set Credentials.png

1. Click Not set in the Select the LoadMaster to set the credentials of field.

Set Credentials_1.png

2. Expand the KEMP directory.

3. Select the relevant LoadMaster.

4. Click Select.

Set Credentials_2.png

5. Enter the updated LoadMaster credentials.

6. Click Submit.

3.4.15 Set Parameter

The Set Parameter workflow can be used to set a number of LoadMaster field values. For a list of parameter names that can be set, refer to Appendix A - Get and Set Parameters.

Set Parameter.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the LoadMaster to be modified field.

Set Parameter_1.png

4. Expand the KEMP directory.

5. Select the relevant LoadMaster.

6. Click Select.

Set Parameter_2.png

7. Click Parameter Configuration.

Set Parameter_3.png

8. Enter the name of the parameter to be modified.

9. Enter the new value for the specified parameter.

10. Click Submit.

Set Parameter_4.png

11. Wait for the parameter to be set.

3.5 Virtual Services

A number of tasks can be performed in relation to Virtual Services, such as adding and removing them. Refer to the sections below for further details.

3.5.1 Add Virtual Service

A Virtual Service can be added to a LoadMaster via Orchestrator by running the Add Virtual Service command.

Add Virtual Service.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Virtual Service Configuration.

Add Virtual Service_1.png

4. Click Not set.

Add Virtual Service_2.png

5. Expand the KEMP directory.

6. Select the relevant LoadMaster.

7. Click Select.

Add Virtual Service_3.png

8. Enter a valid IP address in the Enter the IP address of the Virtual Service text box.

9. Enter the desired port in the Enter the port of the Virtual Service text box.

10. Select the relevant protocol from the drop-down list.

11. Click Submit.

3.5.2 Assign Virtual Service Certificates

Certificates can be assigned to a Virtual Service via Orchestrator. To do this, run the Assign Virtual Service Certificates command.

Assign Virtual Service Certificates.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the Virtual Service to assign certificates to field.

Assign Virtual Service Certificates_1.png

4. Expand the KEMP directory.

5. Expand the relevant LoadMaster.

6. Select the relevant Virtual Service.

7. Click Select.

Assign Virtual Service Certificates_2.png

8. Click Not set in the Enter the certificate identifiers to assign to the Virtual Service field.

Assign Virtual Service Certificates_3.png

9. In the New value text box, enter the certificate identifier (friendly name) of the certificate to be assigned.

10. Click Insert value.

11. Click Accept.

Assign Virtual Service Certificates_4.png

12. Click Submit.

3.5.3 Modify Virtual Service Name

The name of a Virtual Service can be modified using the Modify Virtual Service Name workflow.

Modify Virtual Service Name.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the Virtual Service to be renamed field.

Modify Virtual Service Name_1.png

4. Expand the KEMP directory.

5. Expand the relevant LoadMaster.

6. Select the relevant Virtual Service.

7. Click Select.

Modify Virtual Service Name_2.png

8. Enter the new name for the Virtual Service.

9. Click Submit.

3.5.4 Remove Virtual Service

A Virtual Service can be deleted via Orchestrator by running the Remove Virtual Service workflow.

Remove Virtual Service.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the Virtual Service to be removed field.

Remove Virtual Service_1.png

4. Expand the KEMP directory.

5. Expand the relevant LoadMaster.

6. Select the relevant Virtual Service.

7. Click Select.

Remove Virtual Service_2.png

8. Click Submit.

3.6 Sub Virtual Services

A number of tasks can be performed in relation to SubVSes, such as adding and removing a SubVS. Refer to the sections below for further details.

3.6.1 Add SubVS

A SubVS can be added by running the Add SubVS workflow.

Add SubVS.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the Virtual Service to add a SubVS to field.

Add SubVS_1.png

4. Expand the KEMP directory.

5. Expand the relevant LoadMaster.

6. Select the relevant Virtual Service.

7. Click Select.

Add SubVS_2.png

8. Click Submit.

3.6.2 Modify SubVS Name

The name of a SubVS can be modified using the Modify SubVS Name workflow.

Modify SubVS Name.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the SubVS to be renamed field.

Modify SubVS Name_1.png

4. Expand the KEMP directory.

5. Expand the relevant LoadMaster.

6. Select the relevant SubVS.

7. Click Select.

Modify SubVS Name_2.png

8. Enter the new name for the SubVS.

9. Click Submit.

3.6.3 Remove SubVS

A SubVS can be deleted via Orchestrator by running the Remove SubVS command.

Remove SubVS.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the SubVS to be removed field.

Remove SubVS_1.png

4. Expand the KEMP directory.

5. Expand the relevant LoadMaster.

6. Expand the relevant Virtual Service.

7. Select the relevant SubVS.

8. Click Select.

Remove SubVS_2.png

9. Click Submit.

3.7 Real Servers

A number of tasks can be performed in relation to Real Servers, such as adding a Real Server to a Virtual Service or removing a Real Server. Refer to the sections below for further details.

3.7.1 Add Real Server to Sub Virtual Service

A Real Server can be added to a SubVS by running the Add Real Server to Sub Virtual Service workflow.

Add Real Server to Sub Virtual.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Real Server Configuration.

Add Real Server to Sub Virtual_1.png

4. Click Not set.

Add Real Server to Sub Virtual_2.png

5. Expand the KEMP directory.

6. Expand the relevant LoadMaster.

7. Expand the relevant Virtual Service.

8. Select the relevant SubVS.

9. Click Select.

Add Real Server to Sub Virtual_3.png

10. Enter the IP address of the Real Server to be added.

11. Enter the port of the Real Server.

12. Click Submit.

3.7.2 Add Real Server to Virtual Service

A Real Server can be added to a Virtual Service via Orchestrator by running the Add Real Server to Virtual Service workflow.

Add Real Server to Virtual.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Real Server Configuration.

Add Real Server to Virtual_1.png

4. Click Not set.

Add Real Server to Virtual_2.png

5. Expand the KEMP directory.

6. Expand the relevant LoadMaster.

7. Select the relevant Virtual Service.

8. Click Select.

Add Real Server to Virtual_3.png

9. Enter the IP address of the Real Server.

10. Enter the port of the Real Server.

11. Click Submit.

3.7.3 Remove Real Server

A Real Server can be removed by running the Remove Real Server workflow.

Remove Real Server.png

1. Enter the username and password to access the LoadMaster.

2. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).

3. Click Not set in the Select the Real Server to be removed field.

Remove Real Server_1.png

4. Expand the KEMP directory.

5. Expand the relevant LoadMaster.

6. Expand the Virtual Service and/or SubVS.

7. Select the relevant Real Server.

8. Click Select.

Remove Real Server_2.png

9. Click Submit.

4 Uninstall the KEMP Orchestrator Plugin

There are three steps that need to be completed in order to uninstall the KEMP Orchestrator plugin. Refer to the sections below for step-by-step instructions.

4.1 Uninstall the Workflows

The first step is to uninstall the workflows. To do this, follow the steps below:

Uninstall the Workflows.png

1. Select Design from the drop-down menu in the top-left of the screen.

Uninstall the Workflows_1.png

2. Select the packages tab (orange icon).

Uninstall the Workflows_2.png

3. Right-click com.kemptechnologies and select Delete element with content.

Uninstall the Workflows_3.png

4. Click DELETE ALL.

Uninstall the Workflows_4.png

5. Wait for the deletion to complete.

Now that the workflows have been uninstalled, the KEMP plugin can be uninstalled. Follow the steps in the next section to do this.

4.2 Remove the KEMP Orchestrator Plugin

Then, after uninstalling the workflows - follow these steps:

1. Remotely connect to the Orchestrator server.

2. Navigate to the Orchestrator plugins folder:

cd /var/lib/vco/app-server/plugins

3. Remove the KEMP Orchestrator plugin by running the following command:

rm <KEMPPluginFilename>.dar

Now that the KEMP Orchestrator plugin has been removed, the service needs to be restarted for the changes to be applied.

4.3 Restart the Service

After uninstalling, restart the service to complete the uninstallation. To do that, follow the steps below:

1. In a web browser, navigate to the IP address of the Orchestrator server followed by the :8281 port.

Install the KEMP Orchestrator.png

2. Click the Orchestrator Configuration link.

Install the KEMP Orchestrator_1.png

3. Enter the Orchestrator credentials and click Login.

Install the KEMP Orchestrator_5.png

4. Click Startup Options on the left.

Install the KEMP Orchestrator_6.png

5. Click Restart service.

Restart the Service.png

6. Wait for the service to restart.

Install the KEMP Orchestrator_8.png

A message will appear when the service has been restarted.

5 Appendix A - Get and Set Parameters

A number of LoadMaster fields can be retrieved and set using the Get Parameter and Set Parameter workflows. The fields are retrieved and set using API parameters. The list of API parameters that can be used are listed below. For descriptions of what each of the parameters correspond to, please refer to the Java API, Interface Description or the RESTful API, Interface Description.

dfltgw

dfltgwv6

admingw

snat

hatimeout

hawait

haprefered

hamode

haif

havhid

hastyle

hainitial

tcpfailover

cookieupdate

vmac

sshaccess

sshport

sshv1prot

wuiaccess

mcast

wuiiface

wuiport

sshiface

hoverhelp

routefilter

transparent

alwayspersist

expect100

localbind

addcookieport

subnetoriginating

nonlocalrs

multigw

addforwardheader

conntimeout

authtimeout

finalpersist

tcptimestamp

paranoia

cachesize

hostcache

resetclose

rfcconform

keepalive

backupday

backupenable

backuphost

backuphour

backupminute

backuppassword

backuppath

backupuser

backupuser

emailuser

emaildomain

emailpassword

emailserver

emailsslmode

emailport

emailcritical

emailemergency

emailerror

emailinfo

emailnotice

emailwarn

addvia

allowupload

dropatdrainend

droponfail

closeonerror

limitinput

rsarelocal

slowstart

subnetorigin

syslogcritical

syslogemergency

syslogerror

sysloginfo

syslognotice

syslogwarn

sslrenegotiate

emailenable

irqbalance

snmpenable

snmpV3enable

snmpv3user

snmpv3userpasswd

snmpcontact

snmpcommunity

snmplocation

snmpHaTrap

snmpv1sink

snmpv2sink

snmpclient

snmptrapenable

motd

wuidisplaylines

linearesplogs

onlydefaultroutes

sessionauthmode

sessionidletime

sessionmaxfailattempts

sessioncontrol

sessionlocalauth

ntphost

netconsole

netconsoleinterface

namserver

radiusbackupport

radiusbackupsecret

radiusbackupserver

radiusport

radiussecret

radiusserver

radiusrevalidateinterval

ldapserver

ldapbackupserver

ldapsecurity

ldaprevalidateinterval

geoclients

geopartners

geosshport

ha1hostname

ha2hostname

hostname

searchlist

timezone

admincert

localcert

time

ntphost

version

Tethering

multihomedwui

logsplitinterval

allowemptyposts

OCSPPort

OCSPUseSSL

OCSPOnServerFail

OCSPServer

OCSPUrl

SSLStapling

SSLRefreshInterval

L7LimitInput

sdnstatsmode

6 Appendix B - Memory and CPU Usage Details

The memory and CPU utilization details relating to the KEMP Orchestrator plugin are summarized in the tables below.

The below table shows the specifications of the Orchestrator server that was used when running the tests.

Specification

Type

Hypervisor

VMware vSphere

Memory

3GB

CPU

Dual-core @ 2.0GHz

The below table shows the approximate range of memory usage when the plugin is and is not installed.

Plugin Installed?

Memory Usage

Without plugin installed

381MB -> 395MB

With plugin installed

394MB -> 410MB

With plugin installed (load: ~600 objects)

454MB -> 463MB

The below table shows the CPU usage percentages in various states.

State

CPU Usage

Without plugin installed

~1%

With plugin installed

~1%

Expanding tree view (load: ~100 objects)

~8%

Expanding tree view (load: ~500 objects)

~19%

Empty workflow

~13%

Configure Server Availability workflow

~17%

Add LoadMaster workflow (load: 0 objects)

~17%

Add LoadMaster workflow (load: ~500 objects)

~40%

Remove LoadMaster workflow (load: 0 objects)

~17%

Remove LoadMaster workflow (load: ~500 objects)

~28%

References

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

Java API, Interface Description

RESTful API, Interface Description

Document History

 

Date

Change

Reason for Change

Version

Resp.

Aug 2015

Initial draft

First draft of document

1.0

LB

Sep 2015

Minor update

Enhancements made

2.0

LB

Oct 2015

Minor update

Additional information added

3.0

LB

Nov 2015

Minor updates

Enhancements made

4.0

LB

Jan 2016

Minor updates

Updated Copyright Notices

5.0

LB

Jan 2017

Release updates

Updates for 7.2.37 release

6.0

LB

July 2017 Minor updates Enhancements made 7.0 LB

 

 

 

Was this article helpful?

0 out of 0 found this helpful

Comments