Skip to content

CMDB

Introduction

Configuration Management Database (CMDB) is a centralized repository used to store information about all the significant entities in your IT environment. The CMDB acts as a data storehouse and could be considered the heart of the IT Service Management (ITSM). The CMDB includes Configuration Items (CIs), which are critical resources to your organization. It is by analyzing the CIs you may decide on the need for implementing a Change. The CIs could be Assets, IT Services, Users, Support Groups, Hardware, installed Software Applications, Documents, Business Services, etc, that are part of your IT system.

In SDP Cloud, CMDB is completely customizable. You can even delete all the default CI Types provided by us and you can model your required CI Types & Fields from scratch.


Guidelines

  • Identify your requirements and decide the CI Types and Fields you require.
  • Use our CI Type builder to create CI Types. You can Drag and Drop Fields to create different types of fields for the CI Types.
  • Identify the relationships and you can create relationships between CI Types.
  • Relationships can be created between CI Types or between CIs.
  • Populate the CMDB with CIs and relationship.

Important

  1. For modelling the CI Types and Fields, you can use our CI Type builder as it will be easier to design the CI Types and Fields.
  2. The Fields and CI Types provided in the SDP Cloud are just samples for better understanding. It can be customised for specific organisation needs.

Prerequisites

There are some things which need to be noted down before using the CMDB API. The steps are given as follows :

  • Locate the CI Type where you want to add CIs. (Setup -> CMDB -> Configuration Items -> Required CI Type).
  • You will find the field “API Name”. This api name is necessary to make the API calls. Once the API Names are defined, it cannot be edited (Setup -> CMDB -> Required CI Type -> Details Tab -> API Name)
  • The API for the required operations such as GET, ADD, EDIT, DELETE and GET LIST can be performed using the api URL mentioned below. Example : API Name for “Workstation” CI Type is “ci_workstation”. The API URL will be “/api/v3/cmdb/ci_workstation”
  • Similarly, each field has a Field Key that will be used in the api payload JSON. For example, the Field Key of IP Address field is “txt_ip_address”

Screenshot of API Name
Screenshot of API Name

Screenshot of Field Key
Screenshot of Field Key

FORMAT
EXAMPLE
/api/v3/cmdb/<API Name of CI Type>
/api/v3/cmdb/ci_workstation
{
  "<API Name of CI Type>": {
    "name": "...",
    "description": "...",
    "ci_attributes": {
      "Field Key": "Field value"
    }
  }
}
{
  "ci_workstation": {
    "name": "...",
    "description": "...",
    "ci_attributes": {
      "txt_ip_address": "127.0.0.1"
    }
  }
}

Important

  • “name” field is mandatory for CI addition (POST)