VRealize Operations Manager APl Programming Guide 11ocT2018 vRealize Operations Manager 7.0 VmWare
vRealize Operations Manager API Programming Guide 11 OCT 2018 vRealize Operations Manager 7.0
vRealize Operations Manager API Programming Guide ou can find the most up-to-date technical documentation on the VMware website at https://docs.vmware.com If you have comments about this docu submit your feedback to docfeedh VMware Inc 3401 Hillview Palo Alto, CA 94304 ww. vmware. com Copyright. 2018 VMware, Inc. All rights reserved. Copyright and trademark information re. Inc
vRealize Operations Manager API Programming Guide VMware, Inc. 2 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments about this documentation, submit your feedback to docfeedback@vmware.com Copyright © 2018 VMware, Inc. All rights reserved. Copyright and trademark information. VMware, Inc. 3401 Hillview Ave. Palo Alto, CA 94304 www.vmware.com
Contents About This Programming Guide 4 2 Understanding the vRealize Operations Manager API 5 How the vRealize Operations Manager API Works 5 Client Workflow Overview 6 Using the API with VMware vRealize Operations Manager 1 3 Getting Started with the API 12 Acquire an Authentication Token 12 Find the Adapter Type and Object Type 14 Generate a List of All Metrics for the object 15 4 Configuring an Adapter Instance 18 Summary of Configuring an Adapter Instance Requests 18 Identify the Solution and Its Adapters 19 Identify the Object Types Required for the Adapter 2 Create the Adapter Instance 22 Provide Proof of Certificate Validity 26 Start Monitoring the New Adapter Instance 30
Contents 1 About This Programming Guide 4 2 Understanding the vRealize Operations Manager API 5 How the vRealize Operations Manager API Works 5 Client Workflow Overview 6 Using the API with VMware vRealize Operations Manager 10 3 Getting Started with the API 12 Acquire an Authentication Token 12 Find the Adapter Type and Object Type 14 Generate a List of All Metrics for the Object 15 4 Configuring an Adapter Instance 18 Summary of Configuring an Adapter Instance Requests 18 Identify the Solution and Its Adapters 19 Identify the Object Types Required for the Adapter 21 Create the Adapter Instance 22 Provide Proof of Certificate Validity 26 Start Monitoring the New Adapter Instance 30 VMware, Inc. 3
About This Programming Guide The vRealize Operations Manager TM AP/ Programming Guide provides information about the VMware vRealize Operations Manager REST APIs, including how to use the REST API resources, authenticate. and construct rEst APi calls Intended audience This information is intended for administrators and programmers who want to configure and manage vRealize Operations Manager programmatically using the vRealize Operations Manager REST APL.The guide focuses on common use cases
About This Programming Guide 1 The vRealize® Operations Manager™ API Programming Guide provides information about the VMware vRealize Operations Manager REST APIs, including how to use the REST API resources, authenticate, and construct REST API calls. Intended Audience This information is intended for administrators and programmers who want to configure and manage vRealize Operations Manager programmatically using the vRealize Operations Manager REST API. The guide focuses on common use cases. VMware, Inc. 4
Understanding the vRealize Operations Manager API 2 Developers can use the API to build interactive clients of vRealize Operations Manager. The API follows the RESt style and is available to all licensed users vreaLize Operations Manager clients communicate with the server over Http, exchanging epresentations of vRealize Operations Manager objects. These representations take the form of JSON or Xml elements You use Http Get requests to retrieve the current representation of an object Http Post and Put requests to create or modify an object and Http deLete requests to delete an object This chapter includes the following topics How the vRealize Operations Manager API Works Client Workflow Overview Using the API with VMware vRealize Operations Manager How the vRealize Operations Manager API Works You use a Web browser to communicate with the vRealize Operations Manager analytics engine, either through the product user interface or through API calls Figure 2-1. vRealize Operations Manager Simplified Architecture Inventory Product User Interface REST AP rEalize Operations Manager Analytics Engine
Understanding the vRealize Operations Manager API 2 Developers can use the API to build interactive clients of vRealize Operations Manager. The API follows the REST style and is available to all licensed users. vRealize Operations Manager clients communicate with the server over HTTP, exchanging representations of vRealize Operations Manager objects. These representations take the form of JSON or XML elements. You use HTTP GET requests to retrieve the current representation of an object, HTTP POST and PUT requests to create or modify an object, and HTTP DELETE requests to delete an object. This chapter includes the following topics: n How the vRealize Operations Manager API Works n Client Workflow Overview n Using the API with VMware vRealize Operations Manager How the vRealize Operations Manager API Works You use a Web browser to communicate with the vRealize Operations Manager analytics engine, either through the product user interface or through API calls. Figure 2‑1. vRealize Operations Manager Simplified Architecture VMware, Inc. 5