Supported Target Versions
vRealize Orchestrator 8.11.2

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
1.0.0Initial Deployment

Introduction

VMware vRealize Orchestrator is a powerful automation tool designed for system administrators and IT operations staff who must streamline tasks and remediation actions and integrate these functions with third-party IT operations software.

Prerequisites

  • OpsRamp Classic Gateway 14.0.0 and above.
  • OpsRamp Nextgen Gateway 14.0.0 and above.
    Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc..
  • Should be able to connect to vRealize portal via SSH with the provided IpAddress/Hostname and the credentials.

Roles and Permissions

Users with read permissions are required to fetch service status related data.

Supported Metrics

Click here to view the supported metrics
Native TypeMetric NameDisplay NameUnitsApplication VersionDescription
VMWare vRealize OrchestratorVMware vRealize Orchestrator Port StatusVMware vRealize Orchestrator Port StatusNone1.0.0VMware vRealize orchestrator port open/close status
vmware_vrealize_orchestrator_service_StatusVMware vRealize Orchestrator Service StatusNone1.0.0VMware vRealize Orchestrator system services running status
vmware_vrealize_orchestrator_url_StatusVMware vRealize Orchestrator URL StatusNone1.0.0VMware vRealize Orchestrator URL reachability Status
vmware_vrealize_orchestrator_webpage_url_HealthStatusVMware vRealize Orchestrator Webpage URL Health StatusNone1.0.0VMWare vRealize orchestrator web page health status. Possible statuses are: ERROR, OK, UNKNOWN, WARN

Default Monitoring Configurations

VMware vRealize Orchestrator has default Global Device Management Policies, Global Templates, Global Monitors and Global metrics in OpsRamp. You can customize these default monitoring configurations as per your business use cases by cloning respective Global Templates and Global Device Management Policies. OpsRamp recommends doing this activity before installing the application to avoid noise alerts and data.

  1. Default Global Device Management Policies

    OpsRamp has a Global Device Management Policy for the Native Type of VMware vRealize Orchestrator. You can find those Device Management Policies at Setup > Resources > Device Management Policies, search with suggested names in global scope. Each Device Management Policy follows below naming convention:

    {appName nativeType - version}

    Ex: vmware-vrealize-orchestrator VMware vRealize Orchestrator - 1(i.e, appName = vmware-vrealize-orchestrator, nativeType = VMware vRealize Orchestrator , version = 1)

  2. Default Global Templates

    OpsRamp has a Global Template for the Native Type of VMware vRealize Orchestrator. You can find those templates at Setup > Monitoring > Templates, search with suggested names in global scope. Each template follows below naming convention:

    {appName nativeType 'Template' - version}

    Ex: vmware-vrealize-orchestrator VMware vRealize Orchestrator Template - 1(i.e, appName = vmware-vrealize-orchestrator, nativeType = VMware vRealize Orchestrator, version = 1)

  3. Default Global Monitors

    OpsRamp has a Global Monitors for the Native Type which has monitoring support. You can find those monitors at Setup > Monitoring > Monitors, search with suggested names in global scope. Each Monitors follows below naming convention:

    {monitorKey appName nativeType - version}

    Ex: VMware vRealize Orchestrator Monitor vmware-vrealize-orchestrator VMware vRealize Orchestrator 1 (i.e, monitorKey =VMware vRealize Orchestrator Monitor, appName = vmware-vrealize-orchestrator, nativeType = VMware vRealize Orchestrator , version = 1)

Configure and Install the VMWare vRealize Orchestrator Integration

  1. From All Clients, select a client.
  2. Navigate to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed. If there are no installed applications, it will navigate to the Available Integrations and Apps page.
  5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
  6. Search for the application using the search option available. Alternatively, use the All Categories option to search.
  1. Click ADD on the VMware vRealize Orchestrator tile and select the version.
  2. From the Configurations page, click + ADD.
  3. Enter the below mentioned BASIC INFORMATION:
FunctionalityDescription
NameEnter the name for the configuration.
VMware vRealize Orchestrator IP Address/Host NameIP address/host name of the VMware vRealize Orchestrator.
Note: If IP Address is provided, It should be having resolvable hostname to make the API’s work.
API PortAPI Port details
Note: By default 443 is added
SSH PortSSH Port
Note: Default port value is 22
SSH CredentialSelect the Credential from the drop-down list.

Notes:
  • Click + Add to create a credential. The ADD CREDENTIAL window is displayed. Enter the following information.
    • Name: Credential name.
    • Description: Brief description of the credential.
    • User Name: User name.
    • Password: Password.
    • Confirm Password: Confirm password
Ports to be monitoredPort to be monitored.
Note: Default value is 22, 443, 5480, 80, 8281, 8283

Notes:

  • By default the Is Secure checkbox is selected.
  • VMware vRealize Orchestrator IP Address/Host Name and Port should be accessible from Gateway.
  • Select the following:
    • App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
    • API Timeouts: These are the maximum API Timeouts that the application can use to connect and get responses from the end device.
      • Connection Timeout in Secs: a time period in which a client should establish a connection with a server.
        Note: By default, 60 is selected.
      • Connection Request Timeout in Secs: a time period required to process an HTTP call: from sending a request to receiving a response.
        Note: By default, 10 is selected.
      • Socket Timeout in Secs: a maximum time of inactivity between two data packets when exchanging data with a server.
        Note: By default, 10 is selected.
  1. Select the below mentioned Custom Attribute:
FunctionalityDescription
Custom AttributeSelect the custom attribute from the drop down list box.
ValueSelect the value from the drop down list box.

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  1. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.

  1. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.

    Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

  2. Click NEXT.

  3. (Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.

Veeam
  1. Select an existing registered profile.
Veeam
  1. Click FINISH.

The application is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify the Configuration

View the VMware vRealize Orchestrator Details

The VMware vRealize Orchestrator integration is displayed in the Infrastructure > Resources > Server. You can navigate to the Attributes tab to view the discovery details, and Metrics tab to view the metric details for VMware vRealize Orchestrator.

View Resource Metrics

To confirm VMWare vRealize Orchestrator monitoring, review the following:

  • Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
  • Alerts: Alerts are generated for metrics that are configured as defined for integration.

Resource Filter Input Keys

VMware vRealize Orchestrator application Resources are filtered and discovered based on below keys.

Click here to view the Supported Input Keys
Resource TypeSupported Input Keys
All TypesresourceName
hostName
ipAddress

Supported Alert Custom Macros

Customize the alert subject and description with below macros then it will generate alerts based on customisation.
Supported macros keys:

Click here to view the alert subject and description with macros

                                ${resource.name}

                                ${resource.ip}

                                ${resource.type}

Risks, Limitations & Assumptions

  • Application can handle Critical/Recovery failure alert notifications for below two cases when user enables Notification Alert in configuration
    • Connectivity Exception
    • Authentication Exception
  • Application will send any duplicate/repeat failure alert notification for every 6 hours.
  • Application cannot control monitoring pause/resume actions based on above alerts. Metrics can be used to monitor PowerMax resources and can generate alerts based on the threshold values.
  • OpsRamp has provided 22 as default SSH Port value for connecting to VRO end device via SSH. Users can modify this value from the application configuration page at any point of time if required.
  • Mention the ports that need to be monitored in Ports to be monitored. By default we are providing 22, 443, 5480, 80,8281, 8283 ports in this field.
  • Component level thresholds can be configured on each resource level.
  • No support of showing activity log and applied time.
  • Latest snapshot metric support from gateway 14.0.0.
  • For metrics vmware_vrealize_orchestrator_port_Status and vmware_vrealize_orchestrator_url_Status, we are sending status as CLOSE and CRITICAL respectively in case of any failures like connection issues etc.,