This documentation supports the 9.1 to 9.1 Service Pack 3 version and its patches of BMC Atrium Core. The documentation for version 9.1.04 and its patches is available here.

To view the latest version, select the version from the Product version menu.

CMDBActivateFederatedInContext function

The CMDBActivateFederatedInContext function expands the BMC_FederatedInterface instance for a specific CI. Depending on a flag that you specify when you call this function, your federated instance might be either only expanded or expanded and launched.


#include "ar.h"
#include "arextern.h"
#include "cmdb.h"

int CMDBActivateFederatedInContext(
      ARControlStruct *control,
      CMDBClassNameId *classNameId,
      ARNameType datasetId,
      ARNameType instanceId,
      ARNameType federatedInstanceId,
      unsigned int activateOption,
      CMDBFederatedActivateInfo *federatedInfo,
      ARStatusList *status)

Input arguments

Input argument



The control record for the operation, which contains information about the user requesting the operation and the server on which the operation is to be performed.


The class name for which to expand or launch the federated instance. The classNameID argument contains the namespace name and the unique class name.


The unique identifier for the dataset. The data in the return values are based on the dataset ID specified.


The instance ID of the specified instance for which the federated instance is to be expanded or launched.


The instance ID of the federated instance that is to be expanded or launched.


The mask number that indicates whether the federated instance is to be launched and expanded. Specify a value of 1 for this parameter to return information in federatedInfo.

  • 0: Activate None--No BMC_FederatedInterface instance to be activated (CMDB_FEDERATION_ACTIVATION_NONE ).
  • 1 << 0: Activation Expand--Only activate the specified BMC_FederatedInterface instance (CMDB_FEDERATION_ACTIVATION_EXPAND ). No launch required.
  • 1 << 1: Activation Launch--Activate and launch the specified BMC_FederatedInterface instance

Return values

Return value



The expanded federated instance information.


A list of zero or more notes, warnings, or errors generated from a call of this function.

Was this page helpful? Yes No Submitting... Thank you