CPM APIs

Sample API Usage

curl 'https://<CMS_IP_Address>/rms/probes' -H 'Authorization: Basic <base64_encode_of_userid:password>' --insecure

Header:

Procure List of Probes

The below API URL provides information related to the Probes. Only a Super Admin user can utilize this API.

Request Type: GET

URL: https://<CMS_IP_Address>/rms/probes

Response Code:

200 - Success

Sample Response:

Procure Logs

The below API procures logs from the Probe instances:

Response Code:

200 - Success

Sample Responses:

Response containing link to the status URL:

Response containing status of all the probes along with the download path:

In a successful response, the download URL link is provided for each Probe. The log files can be downloaded once the status changes to “SUCCESS”. If not, access/refresh the URL after some time to ensure that the log collection is complete and the status changes to “SUCCESS”.

Procure Statistics

The below API procures statistics from the Probe instances:

Response Code:

200 - Success

Sample Response:

Response containing a link to the status URL:

In a successful response, the download URL link is provided for each Probe. The statistics files can be downloaded once the status changes to “SUCCESS”. If not, access/refresh the URL after some time to ensure that the statistics collection is complete and the status changes to “SUCCESS”.

Procure Data

The below API procures data from the Probe instances:

Response Code:

200 - Success

Sample Response:

Response containing a link to the status URL:

In a successful response, the download URL link is provided for each Probe. The data files can be downloaded once the status changes to “SUCCESS”. If not, access/refresh the URL after some time to ensure that the data collection is complete and the status changes to “SUCCESS”.

Modify Log Levels

Modify the log levels using the below information. Log level modifications are supported on individual probes only. Allowed log levels are - debug, info, trace.

Sample Response:

Modify the log level for a specific module:

Download Files

The API lists all the files available on the probe.

Response Code:

200 - Success

Download file list from the required probe:

Download file list from all probes:

View Commands

This API lists all the requests submitted to this API with the status of completion.  

Accepted Parameters:

1. from - Integer “n” can be provided as the optional parameter in “from” to view all the API requests submitted for the past “n” hours. If the parameter “from” is not provided or is invalid, all the API requests submitted are provided

2. cmdpage – Integer “i” can be provided as the optional parameter in “cmdpage” to specify the number of commands to be displayed per page

3. probepage - Integer “j” can be provided as the optional parameter in “probepage” to specify the number of probes to be displayed per page

Request Type: GET

URL: https://<CMS_IP_Address>/rms/view/api?from={n}&cmdpage={i}&probepage={j}

Sample Response:

Install Probe

This API is available only for Version 2.11 and Above.

Probe installation can be performed using the below information:

1. cmsdns – DNS name for CMS

2. kafkadns - DNS name for Kafka

3. remoteae – true (for Remote vRule Engine) OR false (for Embedded vRule Engine)

4. hostentry – Entries are not added in the file /etc/hosts to resolve the LFR and CMS DNS names. Allowed values are: true OR false

5. password – Base64 encoded password

6. sku – (Linux only) Required SKU. Allowed values are: web, host OR mem. Default value is web (if not specified)

7. hostname – Hostname of the Probe

8. hostProfileTag - Host Profile Tag allows for an application instance to be auto-associated with a process profile on CMS

9. appServiceTags - List of app service tags separated by a comma; App service tags enable an Application Instance to be auto-associated with an application on CMS

10. hostonly - (Windows only) To install HOST-ONLY features. Allowed Values are 0 (complete installation) or 1 (Host only installation)

11. The below parameters are available for Version 3.0.0 and above:

    1. lfrport - VSP LFR Port

    2. cmsip - IP Address of CMS

    3. kafkaip - IP Address of Kafka. This parameter is required if CMS IP and Kafka IP are different

    4. lfrip - IP Address of LFR

Response Code:

200 - Success

Sample Response: Single Probe Installation (GET)

Upgrade Probe

This API is available only for Version 2.11 and Above.

Probe upgrade can be performed using the below information:

Accepted Parameters: All the parameters are optional. If they are not provided, the default values are utilized by the Probe installable

1. version – VSP version to which the Probe must be upgraded. This version must be available on LFR. Currently, only the value “latest” is allowed as LFR contains only one VSP version

2. cmsdns – Custom DNS name for CMS. Ensure that the value provided during upgrade is the same as the value provided during installation

3. kafkadns – Custom DNS name for Kafka. Ensure that the value provided during upgrade is the same as the value provided during installation

4. remoteae – true (for Remote vRule Engine) OR false (for Embedded vRule Engine; Default Value)

5. hostentry – Entries are not added in the file /etc/hosts to resolve the LFR and CMS DNS names. Allowed values are: true (Default Value) OR false

6. password – Base64 encoded password

7. The below parameters are available for Version 3.0.0 and above:

   1. hostname - Hostname of the Probe. This is utilized during probe registration with CMS

   2. hostprofiletag - Appropriate Host Profile Tag. A Host Profile Tag allows for an application instance to be auto-associated with a process profile on CMS

   3. sku – (Linux only) Required SKU. Allowed values are: web, host OR mem. Default value is web (if not specified)

   4. appservicetags - List of comma-separated Application Service tags to enable a Probe to auto-associate with a CMS Application

   5. hostonly - To install HOST-ONLY features. Allowed Values are: true (HOST-ONLY features) or false

   6. lfrport - VSP LFR Port

   7. cmsip - IP Address of CMS

   8. kafkaip - IP Address of Kafka. This parameter is required if CMS IP and Kafka IP are different

   9. lfrip - IP Address of LFR

Response Code:

200 - Success

Sample Response: Single Probe Upgrade (GET)

Uninstall Probe

This API is available only for Version 2.11 and Above.

Probe installation can be performed using the below information:

Accepted Parameters:

1. password – Base64 encoded password

Response Code:

200 - Success

Sample Response: Single Probe Uninstallation (GET)

Install Script

This API is available only for Version 2.11 and Above. It enables installation of a script from LFR to a Probe machine.

Accepted Parameters:

1. sourcePath – (Required) Specify the relative source path of the script on LFR. It must specify a file. Example: If the LFR path is: https://<LFR_IPAddress>:8443/vsp/pas1/pa1.sh then source path must be /vsp/pas1/pa1.sh

2. destPath – (Required) Specify the directory path on the Probe where the script must be copied. This directory must be present on the Probe, else the API fails

3. user – (Optional) Specify the owner of the copied script. If not specified, it Is deployed with the same user running the CPM client

4. userGroup – (Optional) Specify the user group of the copied script

Request Type: POST

URL: https://<CMS_IP_Address>/rms/install/script

Request JSON:

Sample Response:

Error Scenarios

1. sourcePath

   1. If it is not provided, the API execution fails

   2. It must specify a file inside the LFR. It should not be a directory

2. destPath – All the parent directories of the destPath must be present on the Probe. If it is not present, the API execution fails

3. user - Should be an existing user on the Probe. In cases where the user does not exist, the script is copied on the Probe using user running the cpm-client. The change in owner to the specified user fails

4. userGroup - Should be an existing user group on the Probes. In cases where the user group does not exist, the script is copied on the Probe using user running the cpm-client. The change in owner to the specified user group fails

Migrate Probe

This API is available only for Version 3.0.0 and Above.

Probe migration from On-prem to SaaS CMS can be performed using the below information:

Accepted Parameters: All the parameters are optional. If they are not provided, the default values are utilized by the Probe installable

1. version – VSP version to which the Probe must be upgraded. This version must be available on LFR. Currently, only the value “latest” is allowed as LFR contains only one VSP version

2. cmsdns – Custom DNS name for CMS. Ensure that the value provided during upgrade is the same as the value provided during installation

3. kafkadns – Custom DNS name for Kafka. Ensure that the value provided during upgrade is the same as the value provided during installation

4. remoteae – true (for Remote vRule Engine) OR false (for Embedded vRule Engine; Default Value)

5. hostentry – Entries are not added in the file /etc/hosts to resolve the LFR and CMS DNS names. Allowed values are: true (Default Value) OR false

6. password – Base64 encoded password

7. hostname - Hostname of the Probe. This is utilized during probe registration with CMS

8. hostprofiletag - Appropriate Host Profile Tag. A Host Profile Tag allows for an application instance to be auto-associated with a process profile on CMS

9. sku – (Linux only) Required SKU. Allowed values are: web, host OR mem. Default value is web (if not specified)

10. appservicetags - List of comma-separated Application Service tags to enable a Probe to auto-associate with a CMS Application

11. hostonly - To install HOST-ONLY features. Allowed Values are: true (HOST-ONLY features) or false

12. lfrport - VSP LFR Port

13. cmsip - IP Address of CMS

14. kafkaip - IP Address of Kafka. This parameter is required if CMS IP and Kafka IP are different

15. lfrip - IP Address of LFR

Response Code:

200 - Success

Sample Response: Single Probe Migration (GET)

Self Upgrade

This API is available only for Version 3.0.0 and Above.

It upgrades CPM installed on the probe to the latest version that is available in LFR.

Pre-requisite: Ensure that the client certificates are downloaded and placed in LFR by following the below steps:

1. Download the certificates on LFR directory: /var/www/html/vsp using the API below:

   1. Request Type: GET

   2. URL:https://<CMS_IP_OR_DOMAIN>/rms/download/tenantcerts?type=<zip|tar>

      1. type - Provide the value "tar" for Linux and "zip" for Windows

2. The file name must be certificates.tar for Linux and certificates.zip for Windows

3. Provide the file with appropriate read permissions

   ShellShell

   ## Linux
   chmod 644  certificates.tar
   ## Windows
   chmod 644  certificates.zip

   Shell

   Copy

Accepted Parameters: All the parameters are optional. If they are not provided, the default values are utilized by the Probe installable

1. version – VSP version to which the Probe must be upgraded. This version must be available on LFR. Currently, only the value “latest” is allowed as LFR contains only one VSP version

2. cmsdns – Custom DNS name for CMS. Ensure that the value provided during upgrade is the same as the value provided during installation

3. kafkadns – Custom DNS name for Kafka. Ensure that the value provided during upgrade is the same as the value provided during installation

4. hostentry – Entries are not added in the file /etc/hosts to resolve the LFR and CMS DNS names. Allowed values are: true (Default Value) OR false

5. lfrport - VSP LFR Port

6. cmsip - IP Address of CMS

7. kafkaip - IP Address of Kafka. This parameter is required if CMS IP and Kafka IP are different

8. lfrip - IP Address of LFR

Response Code:

200 - Success

Sample Response: Single Probe Self Upgrade (GET)

VSP-CLI Command

This API is available only for Version 2.11 and Above. It API can be used to execute vsp-cli commands on a Probe machine.

Accepted Parameters:

1. arguments– (Required) Accepts all the arguments that are required by vsp-cli command

   1. Example: To execute the command “vsp-cli start ae”, the value for arguments is: [“start”, “ae”]

Request Type: POST

URL: https://<CMS_IP_Address>/rms/vspcli

Request JSON:

Sample Response:

Service Command

Version 3.0.0 and Above:

This API is used to start or stop VSP services using VSP-Cli command.  

Accepted Parameters:

1. action - stop or start

2. serviceid – vsp

3. probSet - Set of probe IDs where the vsp-cli command must be executed

Request Type: POST

URL: https://<CMS_IP_Address>/rms/service

Sample Request:

Sample Response:

Error Reponses

Error responses with sample responses applicable for all the APIs mentioned in the previous sections are provided here:

1. Error Code 400 – Probe ID is invalid or Module ID is invalid

   1. Sample Response 1 – Invalid Probe ID

      {

         "status": "INVALID_PROBEID",

         "errorMessage": "Invalid probeid",

         "apiCommand": "change loglevel to info , for module ae"

      }

   2. Sample Response 2 – Invalid Module ID

      {

         "status": "INVALID_MODULE",

         "errorMessage": "Invalid module, allowed - (ae|fde|fsm|hmm|rmp|vipcs|vma|weba|vmgr|aep)",

         "apiCommand": "change loglevel to info , for module aem"

      }

   3. Sample Response 3 – Invalid SKU value

      {

       "status": "INVALID_PARAMETER",

       "error": "Given sku is invalid. possible values are - (web|host|mem)",

       "api": "install probe"

      }

2. Error Code 404 – Probe is not found

   {

      "status": "PROBE_NOT_FOUND",

      "errorMessage": "Probe not found - 3c0fae9a-0075-4e8d-8d90-59ad94d0fb13",

      "apiCommand": "change loglevel to info , for module ae"

   }

3. Error Code 401 – User is unauthorized and user authentication failed