Overview of MC-CLI

All proxy objects and proxy cluster objects, i.e. proxies, proxy clusters, resource adapters, EIS partners, inbound users, inbound services, outbound services, inbound message endpoints and outbound communication endpoints, as well as the Communication Service and openUTM-LU62 Gateway proxy components, can be configured and administered via CLI user scripts.

You can create the above-mentioned objects (except for the proxies), read and modify the properties of the objects, and remove objects from the configuration. You can read the properties of the todo topics and delete todo topics.

You can also run administration functions for the objects. You can, for example, check availability and administrability or start and stop proxies or proxy clusters.

MC-CLI modules and functions

The MC-CLI interface consists of a number of modules each of which contains a group of functions:

• The module BcAdminMain contains functions that are used to start and exit a Management Console session at the MC-CLI.

  The parameter console_home is used to access the central file console.properties.xml which contains the configuration data.

• The module BcAdminAction contains functions which analyze the results of an administration call and return information about the event and all the subactions.

• A module for each object type that can be administered and configured via the MC-CLI. Each of these modules contains the functions required to administer and configure the corresponding object type. The available modules are listed in the following table.

  BcAdminProxy	Functions for configuring and administering a proxy
  BcAdminProxyCluster	Functions for configuring and administering a proxy cluster
  BcAdminCommService	Functions for configuring and administering a communication service (proxy components for communication with CICS partners)
  BcAdminLu62Gateway	Functions for configuring and administering an openUTM-LU62 Gateway (proxy components for communication with CICS partners)
  BcAdminRa	Functions for configuring and administering a resource adapter
  BcAdminEisPartner	Functions for configuring and administering an EIS partner
  BcAdminInboundService	Functions for configuring an inbound service
  BcAdminInboundMsgEndpoint	Functions for configuring an inbound message endpoint
  BcAdminInboundUser	Functions for configuring an inbound user
  BcAdminOutboundService	Functions for configuring an outbound service
  BcAdminOutboundCommEndpoint	Functions for configuring an outbound message endpoint
  BcAdminTodo	Information functions and functions for handling a todo topic

  The modules contain various functions depending on the object type. You will find a list of all the functions present in these modules in the following table.

  Functions indicates which functions are available for the corresponding object types and which object properties can be read and/or modified.

  create()	Add a new object to the configuration
  getObject()	Read an existing object from the configuration
  authenticate()	Authenticate caller
  remove()	Remove an object from the configuration
  getProperties()	Read the properties of the object
  modifyProperties()	Modify the properties of the object
  getList()	Read a list of objects of a given type that are linked to this object
  perform()	Start administrative actions, e.g. checkAvailability, start, stop
  addProxy()	Add a proxy to the proxy cluster
  removeProxy()	Remove a proxy from the proxy cluster
  getMasterProxy()	Read master proxy of a proxy cluster
  setMasterProxy()	Change the master proxy of a proxy cluster
  getAssignment()	Read assignment of a proxy component to a proxy
  setAssignment()	Change assignment of a proxy component to a proxy
  getProxies()	Read all proxies to which this proxy component is assigned
  getGatewayPorts()	Read Lu62Gateway listener ports of a proxy or of all proxies in the cluster
  setGatewayPorts()	Change Lu62Gateway listener ports of a proxy or of multiple proxies in the cluster
  getLuNames()	Read logical unit name of a proxy or of all proxies in the cluster
  setLuNames()	Change logical unit name of a proxy or of multiple proxies in the cluster

The exact meanings of the functions and object properties are described in the Management Console's online help system. For more information on the online help system, see Starting the Management Console online Help system .

The names of the object properties are mostly identical to those used in the graphical user interface and even when they differ, they are nevertheless unambiguous.