Adding CIs to UCMDB

This example demonstrates how to add new Configuration Items (CIs) and relationships to your UCMDB server using the data_model module.

Environment Awareness

The library automatically detects the UCMDB server version upon connection. You can access this via client.server_version, which returns a tuple (e.g., (11, 6, 0)). This is useful for conditional logic if certain API features require a specific UCMDB version.

Python Example

import logging
import os

import urllib3
from ucmdb_rest import UCMDBAuthError, UCMDBServer

urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)

"""
Use case:  How can I add some CIs to UCMDB?  This example sets up some logging, creates the ucmdb
client, creates a unix CI with an attached running software and then sends it.
"""

# 1. SETUP LOGGING
# We configure the root logger to show both our messages and the library's messages
logging.basicConfig(
    level=logging.INFO,
    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
)
logger = logging.getLogger("add_cis_example")

def main():
    # 2. INITIALIZE CLIENT
    try:
        script_dir = os.path.dirname(__file__)
        cred_path = os.path.join(script_dir,'credentials.json')
        client = UCMDBServer.from_json(cred_path)

        logger.info(f"Connected to UCMDB Version: {client.server_version}")

        # 3. PREPARE DATA
        ci_to_add = {"cis": [
                        {
                            "ucmdbId": "temporary_id_1",
                            "type": "unix",
                            "properties": {
                                "display_label": "MyLinuxServer",
                                "name": "MyLinuxServer"
                            }
                        },
                        {
                            "ucmdbId": "temporary_id_2",
                            "type": "running_software",
                            "properties": {
                                "discovered_product_name": "My Custom Software"
                            }
                        }
                    ],
            "relations": [
                        {
                            "ucmdbId": "temp_rel_1",
                            "type": "composition",
                            "end1Id": "temporary_id_1",
                            "end2Id": "temporary_id_2",
                            "properties": {}
                        }
                    ]
            }
        # 4. EXECUTE AND LOG RESULTS
        logger.info("Attempting to add new Node CI...")
        result = client.data_model.addCIs(ci_to_add)

        # We log the resulting ID returned by the library
        logger.info(f"Successfully added CI. UCMDB IDs: {result.text}")

    except UCMDBAuthError as e:
        logger.error(f"Authentication failed: {e}")
    except Exception as e:
        logger.critical(f"An unexpected error occurred: {e}", exc_info=True)

if __name__ == "__main__":
    main()

Key Parameters

When using add_cis, you can specify optional flags:

• global_ids:
  • Type: Boolean
  • Description: Returns the global ID instead of the local UCMDB ID.
• force_temp:
  • Type: Boolean
  • Description: Use this if you want to bypass standard identification and force a temporary CI.
• ignore_existing:
  • Type: Boolean
  • Description: If the CI is already there, don't throw an error, just skip it.