Specifying call parameters

The call parameters of the MC-CLI functions are usually positional parameters. Some optional parameters are defined as keyword parameters (identified with (kw) below). If the corresponding keyword is not specified when a function is called then the position of the parameter is the determining factor.

When passing the parameters on MC-CLI function calls, you must observe some additional rules depending on the parameter type (objects, properties of the objects):

Objects

At the MC-CLI, the following rules apply when specifying objects:

• In the case of the functions create() and getObject(), it may be necessary to specify the higher-level BcObject of type BcObjectType.PROXY or BcObjectType.PROXY_CLUSTER.

• The functions create() and getObject() return a created or read BcObject object of type BcObjectType as the result.

  This object can then be used to call all the other functions for this object (parameter: bc_object).

• The function getList() returns a (Jython) dictionary with
  key

  Name of the object (property name)
  value

  Object of type BcObject

  Each of these objects can then be used to call all the other functions for this object (parameter: bc_object).

Properties

In the MC-CLI, the following rules apply to properties (parameter props in create() or modifyProperties(), return in getProperties()):

• All properties are passed in Jython dictionaries.

• The property names always consist of lowercase letters, numbers, hyphens ('-') and periods ('.').

• If multiple tabs with properties exist in the Management Console graphical user interface, then the property name is prefixed by the name of the relevant tab, e.g. "utm.", "timer.". Exception: The properties of the General tab. These have no prefix.

• Properties for time values have the unit as postfix (".sec" or ".min").

• The values of the properties are always specified as strings, including in the case of integer values (e.g. for time values or port numbers).

• If a property is only able to assume certain values then these are defined in the Java class BcDef. This is described in greater detail in the sections relating to the individual functions.

• If an MC-CmdHandler is assigned to an object (proxy, resource adapter, etc.) via the graphical user interface during configuration, then only the corresponding properties admin-port and possibly also admin-pw are specified in the CLI.