Mar 28, 2016

How to Install and Use The KEMP Orchestrator Plugin on VMware vRealize Orchestrator

The purpose of this article is to describe how to install and use the KEMP Orchestrator plugin. The article provides step-by-step instructions on how to run the various KEMP workflows which are added when the plugin is installed.
This tutorial is intended to be used by anyone who would like to use Orchestrator to manage their LoadMasters.

 

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, etc.

Figure 1‑1: Topology

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 via the Orchestrator interface. The plugin allows Orchestrator to send commands (via workflows) to and receive information back from the KEMP LoadMaster and GEO products.

 

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.

 

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.

Figure 2‑1: Orchestrator Configuration
  1. Click the Orchestrator Configuration link.

Figure 2‑2: Log in
  1. Enter the Orchestrator credentials and click Login.

Figure 2‑3: Install Application
  1. Select the Install Application tab.
  2. Click the magnifying glass icon.

Figure 2‑4: Install
  1. 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.
  1. Click Installin the bottom-right.
It might take a few seconds to upload the plugin before moving on to the next screen.

Figure 2‑5: License agreement options
  1. To accept the license agreement, click I accept the terms of the License Agreement.

Figure 2‑6: Startup Options
  1. 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.

Figure 2‑7: Restart service
  1. Click Restart service.

Figure 2‑8: Restarting service
  1. Wait for the service to restart.

Figure 2‑9: Server restart complete
  1. A message will appear when the service has been restarted.
The KEMP Orchestrator plugin should now be installed and ready to use.

 

Using the KEMP Orchestrator Plugin

 

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:


Figure 3‑1: Run mode
  1. Select the Run modefrom the drop-down in the top-left.

Figure 3‑2: Inventory
  1. Select the Inventory tab (icon of a jigsaw puzzle piece with a page behind it).

Figure 3‑3: KEMP directories

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.

 

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:

Figure 3‑4: Run mode
  1. Select theRun modefrom the drop-down in the top-left.

Figure 3‑5: Workflows
  1. Select the Workflows tab (blue icon).

Figure 3‑6: Directories
  1. Expand the Library directory.
  2. Expand the KEMP directory.
  1. Each of the sub-directories within the KEMP directory contain various workflows that can be run. To run a workflow:
  1. Expand the relevant directory.
  2. Select the relevant workflow.

Figure 3‑7: Start workflow
  1. Click the green play icon (Start workflow) in the top-left.
  2. 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.

Files

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

Delete Files


Figure 3‑8: Delete Files
  1. Click Not set.

Figure 3‑9: Insert value
  1. Click Insert value.

Figure 3‑10: Select file
  1. Expand the KEMP directory.
  2. Expand the relevant directory where the file is located.
  3. Select the relevant file to be deleted.
  4. Click Add.

Figure 3‑11: Select
  1. Click Select.

Figure 3‑12: Accept
  1. Click Accept.

Figure 3‑13: Submit
  1. Click Submit.

Figure 3‑14: Deletion completed
  1. Wait for the deletion to complete.

Upload Files


Figure 3‑15: Upload Files
  1. Click Not set in the Select files to be uploadedfield.

Figure 3‑16: Not set
  1. Click Not set.
  2. Browse to and select the relevant file to be uploaded.

Figure 3‑17: Insert value
  1. 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.

Figure 3‑18: Accept
  1. Click Accept.

Figure 3‑19: Directory
  1. Click Not set in the Select the directory to store these filesfield.

Figure 3‑20: Certificates
  1. Expand the KEMP directory.
  2. Select the relevant directory to store the file in.
  3. Click Select.

Figure 3‑21: Submit
  1. If you want to replace an existing file of the same name, select Yes.
  2. Click Submit to upload.

Figure 3‑22: Inventory

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


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.

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 Above Step must be used in place of <LoadMaster_Directory>.
  1. After authenticating with the server, the file transfer should proceed.

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.
  1. Navigate to /var/lib/vco/app-server/temp/<LoadMasterDirectory>
Replace <LoadMasterDirectory> with one of the directories listed in above step.
  1. 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>

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.

 

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.


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.

Figure 3‑23: Credentials
  1. Enter the usernameand passwordto 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.

Figure 3‑24: LoadMaster Configuration
  1. Enter a recognizable name in the Enter a unique identified for the LoadMastertext box. This is a friendly name for the LoadMaster which will appear in Orchestrator.
  2. Enter the IP addressof the LoadMaster to be added.
  3. Click Submit.

Figure 3‑25: Success
  1. Wait for the LoadMaster to be added.

Figure 3‑26: Inventory

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

 

Add Certificate

Before uploading a certificate to the LoadMaster, the certificate file must first be uploaded to Orchestrator.


Figure 3‑27: Example certificate file

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.

Figure 3‑28: Add Certificate
  1. Enter the usernameand passwordto 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.
  1. Click Not set in the Select the LoadMaster to add the certificate tofield.

Figure 3‑29: Select the LoadMaster
  1. Expand the KEMP directory.
  2. Select the relevant LoadMaster.
  3. Click Select.

Figure 3‑30: Certificate Configuration
  1. Click Certificate Configuration.

Figure 3‑31: Select certificate file to be added
  1. Click Not set.

Figure 3‑32: Select the certificate
  1. Expand the KEMP directory.
  2. Expand the Certificates directory.
  3. Select the relevant certificate.
  4. Click Select.

Figure 3‑33: Certificate Parameters
  1. Enter the passphrasewhich was used when creating the certificate in the Enter the passphrase for this certificatetext box.
  2. Enter a recognizable name for the certificate in the Enter a LoadMaster identifier for this certificatetext box. This is a friendly name for the certificate which will be displayed in the LoadMaster.
  3. If replacing an existing certificate of the same name, select Yes.
  4. Click Submit.

Backup Certificates

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

Figure 3‑34: Backup Certificates parameters
  1. Enter the usernameand passwordto 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).
  1. Click Not set in the Select the LoadMaster to perform the backup on field.

Figure 3‑35: Select the LoadMaster
  1. Expand the KEMP directory.
  2. Select the relevant LoadMaster.
  3. Click Select.

Figure 3‑36: Submit
  1. Enter a passphrase to secure this backup file.
  2. Click Submit.

Figure 3‑37: Backing up
  1. Wait for the backup to complete.

Figure 3‑38: Inventory

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


Backup LoadMaster

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

Figure 3‑39: Backup LoadMaster certificates
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  1. Click Not set in the Select the LoadMaster to perform this backup on field.

Figure 3‑40: Select LoadMaster
  1. Expand the KEMP directory.
  2. Select the relevant LoadMaster.
  3. Click Select.

Figure 3‑41: Submit
  1. Click Submit.

Figure 3‑42: Inventory

The backup will be stored in the LoadMaster Backups directory in the Inventory tab. The backup can be restored to a LoadMaster via Orchestrator.


Delete Certificate

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

Figure 3‑43: Delete Certificate parameters
  1. Enter the usernameand passwordto 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).
  1. Click Not set in the Select the LoadMaster to delete a certificate from field.

Figure 3‑44: Select the certificate
  1. Expand the KEMP directory.
  2. Select the relevant LoadMaster.
  3. Click Select.

Figure 3‑45: Certificate Identifier
  1. Enter the identifier of the certificate to be deleted.
  2. Click Submit.

Figure 3‑46: Deleting certificate
  1. Wait for the deletion to finish.


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.

Figure 3‑47: Disable API parameters
  1. Enter the usernameand passwordto 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).
  1. Click Not set in the Select the LoadMaster to disable the API of field.

Figure 3‑48: Select the LoadMaster
  1. Expand the KEMP directory.
  2. Select the relevant LoadMaster.
  3. Click Select.

Figure 3‑49: Submit
  1. Click Submit.

Figure 3‑50: Disabling API
  1. Wait for the API to be disabled.

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.

Figure 3‑51: Enable API parameters
  1. Enter the usernameand passwordto 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.

Figure 3‑52: Select the LoadMaster
  1. Expand the KEMP directory.
  2. Select the relevant LoadMaster.
  3. Click Select.

Figure 3‑53: Submit
  1. Click Submit.

Get Parameter

The Get Parameter workflow can be used to retrieve a number of LoadMaster field values.


Figure 3‑54: Get Parameter fields
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  1. Click Not set in the Select the LoadMaster to be queried field.

Figure 3‑55: Select a LoadMaster
  1. Expand the KEMP directory.
  2. Select the LoadMaster to retrieve the value from.
  3. Click Select.

Figure 3‑56: Parameter name
  1. Enter the relevant parameter name in the Enter the name of the parameter to be read field.
  2. Click Submit.

Figure 3‑57: Value
  1. To view the value, select the Variables tab at the bottom.
  2. The parameters and their values will be displayed.

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.


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

Figure 3‑58: Common Parameters
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  1. Click Not set in the Select the LoadMaster to be patched field.

Figure 3‑59: Select the LoadMaster
  1. Expand the KEMP directory.
  2. Select the LoadMaster to be patched.
  3. Click Select.

Figure 3‑60: Select the patch
  1. Click Not set in the Select the patch to apply field.
  2. Expand the KEMP directory.
  3. Expand the Patches directory.
  4. Select the relevant patch file.
  5. Click Select.
  6. 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.
  1. Click Submit.
  2. Wait for the installation and reboot to complete.


Reboot LoadMaster

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

Figure 3‑61: Reboot LoadMaster parameters
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  1. Click Not set in the Select the LoadMaster to be rebooted field.

Figure 3‑62: Select the LoadMaster
  1. Select the relevant LoadMaster to be rebooted.
  2. Click Select.

Figure 3‑63: Submit
  1. Click Submit.
  2. Wait for the LoadMaster to reboot.

Remove LoadMaster

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

Figure 3‑64: Remove LoadMaster parameter
  1. Click Not set.

Figure 3‑65: Select LoadMaster
  1. Select the relevant LoadMaster.
  2. Click Select.

Figure 3‑66: Submit
  1. Click Submit.

Figure 3‑67: Removing LoadMaster
  1. Wait for the LoadMaster to be removed.

Restore Certificates

If a certificate backup file exists in Orchestrator, it can be restored to a LoadMaster. run the Restore Certificates command.

Figure 3‑68: Restore Certificates parameters
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  1. Click Not set.

Figure 3‑69: Select the LoadMaster
  1. Expand the KEMP directory.
  2. Select the relevant LoadMaster.
  3. Click Select.

Figure 3‑70: Backup Options
  1. Click Backup Options.

Figure 3‑71: Select the backup
  1. Click Not set.

Figure 3‑72: Select the backup
  1. Expand the KEMP directory.
  2. Expand the Certificate Backups directory.
  3. Select the relevant backup.
  4. Click Select.

Figure 3‑73: Backup Options
  1. Enter the passphrase used to secure the backup file.
  2. Specify which certificates to restore.
  3. Click Submit.

Figure 3‑74: Restoring certificates
  1. Wait for the certificates to restore.

Restore LoadMaster

Before restoring a LoadMaster configuration, a backup configuration must be available in Orchestrator.

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

Figure 3‑75: Restore LoadMaster
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  2. Click Not set in the Select the LoadMaster to restore field.

Figure 3‑76: Select the LoadMaster
  1. Expand the KEMP directory.
  2. Select the relevant LoadMaster.
  3. Click Select.

Figure 3‑77: Backup Options
  1. Click Backup Options.

Figure 3‑78: Select the configuration
  1. Click Not set.

Figure 3‑79: Select the backup
  1. Expand the KEMP directory.
  2. Expand the LoadMaster Backups directory.
  3. Select the relevant backup.
  4. Click Select.

Figure 3‑80: Backup Options
  1. Specify the configurations to be restored by selecting Yes for the relevant options.
  2. 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.
  3. Click Submit.
  4. Wait for the restoration to complete.


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.

Figure 3‑81: Set Credentials parameters
  1. Click Not set in the Select the LoadMaster to set the credentials of field.

Figure 3‑82: Select the LoadMaster
  1. Expand the KEMP directory.
  2. Select the relevant LoadMaster.
  3. Click Select.

Figure 3‑83: Enter updated credentials
  1. Enter the updated LoadMaster credentials.
  2. Click Submit.

 

Set Parameter

The Set Parameter workflow can be used to set a number of LoadMaster field values.


Figure 3‑84: Set Parameter fields
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  2. Click Not set in the Select the LoadMaster to be modified field.

Figure 3‑85: Select the LoadMaster
  1. Expand the KEMP directory.
  2. Select the relevant LoadMaster.
  3. Click Select.

Figure 3‑86: Parameter Configuration
  1. Click Parameter Configuration.

Figure 3‑87: Parameter Configuration
  1. Enter the name of the parameter to be modified.
  2. Enter the new value for the specified parameter.
  3. Click Submit.

Figure 3‑88: Setting parameter
  1. Wait for the parameter to be set.

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.


Add Virtual Service

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

Figure 3‑89: Authentication Parameters
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  2. Click Virtual Service Configuration.

Figure 3‑90: Virtual Service Configuration
  1. Click Not set.

Figure 3‑91: Select the LoadMaster
  1. Expand the KEMP directory.
  2. Select the relevant LoadMaster.
  3. Click Select.

Figure 3‑92: Details
  1. Enter a valid IP address in the Enter the IP address of the Virtual Service text box.
  2. Enter the desired port in the Enter the port of the Virtual Service text box.
  3. Select the relevant protocol from the drop-down list.
  4. Click Submit.


Assign Virtual Service Certificates

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

Figure 3‑93: Virtual Service Certificates parameters
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  1. Click Not set in the Select the Virtual Service to assign certificates to field.

Figure 3‑94: Select the Virtual Service
  1. Expand the KEMP directory.
  2. Expand the relevant LoadMaster.
  3. Select the relevant Virtual Service.
  4. Click Select.

Figure 3‑95: Certificate Identifier
  1. Click Not set in the Enter the certificate identifiers to assign to the Virtual Service field.

Figure 3‑96: Enter certificate identifier
  1. In the New value text box, enter the certificate identifier (friendly name) of the certificate to be assigned.
  2. Click Insert value.
  3. Click Accept.

Figure 3‑97: Submit
  1. Click Submit.

Modify Virtual Service Name

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

Figure 3‑98: Modify Virtual Service Name parameters
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  1. Click Not set in the Select the Virtual Service to be renamed field.

Figure 3‑99: Select the Virtual Service
  1. Expand the KEMP directory.
  2. Expand the relevant LoadMaster.
  3. Select the relevant Virtual Service.
  4. Click Select.

Figure 3‑100: Service Name
  1. Enter the new name for the Virtual Service.
  2. Click Submit.

Remove Virtual Service

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

Figure 3‑101: Remove Virtual Service parameters
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  1. Click Not set in the Select the Virtual Service to be removed field.

Figure 3‑102: Select Virtual Service
  1. Expand the KEMP directory.
  2. Expand the relevant LoadMaster.
  3. Select the relevant Virtual Service.
  4. Click Select.

Figure 3‑103: Submit
  1. Click Submit.

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.


Add SubVS

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

Figure 3‑104: Add a SubVS
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  2. Click Not set in the Select the Virtual Service to add a SubVS to field.

Figure 3‑105: Select Virtual Service
  1. Expand the KEMP directory.
  2. Expand the relevant LoadMaster.
  3. Select the relevant Virtual Service.
  4. Click Select.

Figure 3‑106: Add SubVS
  1. Click Submit.


Modify SubVS Name

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

Figure 3‑107: Modify SubVS Name parameters
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  2. Click Not set in the Select the SubVS to be renamed field.

Figure 3‑108: Select the SubVS
  1. Expand the KEMP directory.
  2. Expand the relevant LoadMaster.
  3. Select the relevant SubVS.
  4. Click Select.

Figure 3‑109: Enter name
  1. Enter the new name for the SubVS.
  2. Click Submit.

RemoveSubVS

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

Figure 3‑110: Remove SubVS parameters
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  2. Click Not set in the Select the SubVS to be removed field.

Figure 3‑111: Select the SubVS
  1. Expand the KEMP directory.
  2. Expand the relevant LoadMaster.
  3. Expand the relevant Virtual Service.
  4. Select the relevant SubVS.
  5. Click Select.

Figure 3‑112: Remove SubVS parameters
  1. Click Submit.

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.


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.

Figure 3‑113: Add Real Server to SubVS parameters
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  2. Click Real Server Configuration.

Figure 3‑114: Not set
  1. Click Not set.

Figure 3‑115: Select the SubVS
  1. Expand the KEMP directory.
  2. Expand the relevant LoadMaster.
  3. Expand the relevant Virtual Service.
  4. Select the relevant SubVS.
  5. Click Select.

Figure 3‑116: Add Real Server to SubVS
  1. Enter the IP address of the Real Server to be added.
  2. Enter the port of the Real Server.
  3. Click Submit.


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.

Figure 3‑117: Authentication
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  2. Click Real Server Configuration.

Figure 3‑118: Not set
  1. Click Not set.

Figure 3‑119: Select the Virtual Service
  1. Expand the KEMP directory.
  2. Expand the relevant LoadMaster.
  3. Select the relevant Virtual Service.
  4. Click Select.

Figure 3‑120: Real Server Configuration
  1. Enter the IP address of the Real Server.
  2. Enter the port of the Real Server.
  3. Click Submit.

Remove Real Server

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

Figure 3‑121: Remove Real Server
  1. Enter the usernameand passwordto access the LoadMaster.
  1. Specifying the SSL certificate is optional - this is the certificate file used to authenticate to the LoadMaster (the root LoadMaster certificate).
  2. Click Not set in the Select the Real Server to be removed field.

Figure 3‑122: Select the Real Server
  1. Expand the KEMP directory.
  2. Expand the relevant LoadMaster.
  3. Expand the Virtual Service and/or SubVS.
  4. Select the relevant Real Server.
  5. Click Select.

Figure 3‑123: Submit
  1. Click Submit.


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.


Uninstall the Workflows

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

Figure 4‑1: Design
  1. Select Design from the drop-down menu in the top-left of the screen.

Figure 4‑2: Packages
  1. Select the packages tab (orange icon).

Figure 4‑3: Delete element with content
  1. Right-click com.kemptechnologies and select Delete element with content.

Figure 4‑4: Delete All
  1. Click DELETE ALL.

Figure 4‑5: Deleting
  1. 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.


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
  1. 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.


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.

Figure 4‑6: Orchestrator Configuration
  1. Click the Orchestrator Configuration link.

Figure 4‑7: Log in
  1. Enter the Orchestrator credentials and click Login.

Figure 4‑8: Startup Options
  1. Click Startup Options on the left.

Figure 4‑9: Restart service
  1. Click Restart service.

Figure 4‑10: Restarting service
  1. Wait for the service to restart.

Figure 4‑11: Server restart complete

A message will appear when the service has been restarted.



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
  • L7LimitInput
  • sdnstatsmode

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
Table 0‑1: Orchestrator server specifications

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
Table 0‑2: Memory Usage

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%
Table 0‑3: CPU Usage

Post a Comment

 
TECH SUPPORT © 2012 - Designed by INFOSBIRD