Configuring a Product with the Ops Manager API

Overview

This topic describes how to configure product tiles for Ops Manager using the Ops Manager API. This procedure is not intended for beginner users of Ops Manager, PCF, or API-based procedures.

For information about setting up Ops Manager with the UI, see Using Ops Manager.

Prerequisites

Before you configure a product tile with the Ops Manager API, you must have completed the following prerequisites:

Configuring a Product with the API

  1. Upload or import the product into Ops Manager.
    1. Enter the following HTTP request to upload the product: POST api/v0/available_products
    2. Enter the following HTTP request to list the names of available products: GET api/v0/available_products
    3. Find the product you uploaded by referencing its name and version from the list that displays.
    4. Enter the following HTTP request to add the uploaded product to Ops Manager: POST /api/v0/staged/products.
  2. Confirm that the product is staged for deployment. Enter the following HTTP request to confirm the product exists in Ops Manager and display the product GUID: GET api/v0/staged_products.
  3. Enter the following HTTP request to assign availability zones (AZs) and networks to the product: PUT /api/v0/staged/products/:PRODUCT-GUID/networks_and_azs.
  4. Enter the following HTTP request to update the product’s properties: PUT /api/v0/staged/products/:PRODUCT-GUID/properties.
  5. Enter the following HTTP request to configure syslog for the product: PUT /api/v0/staged/products/:PRODUCT-GUID/syslog_configuration.
  6. Update the product’s resource configuration:
    1. Enter the following HTTP request to list all jobs on a product and display the GUID for each job: GET api/v0/staged/products/:PRODUCT-GUID/jobs.
    2. Enter the following HTTP request to update the resource config for a partiular job: PUT api/v0/staged/products/:PRODUCT-GUID/jobs/:JOB-GUID/resource_config.
Create a pull request or raise an issue on the source for this page in GitHub