Cims

The Cims class is the top-level class in the IBM Security Windows API.

Syntax

public interface ICims

Discussion

This class is used to establish the connection with Active Directory and set up the environment so that other operations can be performed. Before you can retrieve any information from Active Directory, you must create a Cims object. For example:

'Create a CIMS object to interact with Active Directory

set cims = CreateObject("Centrify.DirectControl.Cims")

If you are writing programs using IBM Security, version 5.0 or later, the top-level Cims object is named Cims3. For example:

set cdc = CreateObject("Centrify.DirectControl.Cims3")

If you have scripts created for a previous version of IBM Security software, you should modify the object created to be a Cims3 object to work with version 5.0 or later.

If you are writing programs using a .NET language, the namespace for the top-level Cims object is Centrify.DirectControl.API.Cims, regardless of the version of IBM Security you are using. For example, to create the top-level Cims object in a .NET program, type:

Centrify.DirectControl.API.Cims cdc = new Centrify.DirectControl.API.Cims();

Methods

The Cims class provides the following methods:

Method	Description
AddComputer	Adds a computer object to a specific zone.
AddComputerZone	Adds a computer zone to a computer object.
AddWindowsComputer	Adds a Windows computer object to a hierarchical zone.
ConfigureForest	Configures the Active Directory forest to work with IBM Security software.
Connect	Connects to an Active Directory domain controller.
CreateZone	Creates an individual zone object in a parent container object.
CreateZoneWithSchema	Creates an individual zone object with a specified schema type in a parent container object.
GetComputer	Returns a computer object with its related data by its directory object.
GetComputerByComputerZone	Returns a computer object given the LDAP path to the computer zone.
GetComputerByPath	Returns a computer object given the LDAP path to the computer.
GetGroup	Returns a group object with its related data by its directory object.
GetGroupByPath	Returns a group object with its related data by its LDAP path.
GetUser	Returns a user object with its related data by its directory object.
[GetUserByPath](	Returns a user object with its related data by its LDAP path.
GetWindowsUser	Returns a Windows user object.
GetWindowsUserByPath	Returns a Windows user object given the path to the object.
GetZone	Returns a zone object with its related data by object name.
GetZoneByPath	Returns a zone object with its related data by its LDAP path.
IsForestConfigured	Checks whether the forest is properly configured with valid IBM Security licenses.
LoadLicenses	Returns all of the IBM Security licenses for the connected domain.

Properties

The Cims class provides the following properties:

Property	Description
Password	Gets the password used to establish the connection to the Active Directory domain.
Server	Gets the domain controller computer name used to establish the connection to the Active Directory domain.
UserName	Gets the user name used to establish the connection to the Active Directory domain.