Aufrufparameter angeben

Die Aufrufparameter der MC-CLI-Funktionen sind in der Regel Stellungsparameter. Einige Parameter, die optional sind, sind als Schlüsselwortparameter definiert (im Folgenden mit (kw) gekennzeichnet). Wenn beim Aufruf einer Funktion das Schlüsselwort nicht mit angegeben wird, ist die Stellung des Parameters maßgeblich.

Für die Übergabe der Parameter beim Aufruf der MC-CLI-Funktionen müssen Sie abhängig vom Parametertyp (Objekte, Eigenschaften der Objekte) zusätzlich folgende Regeln beachten:

Objekte

Am MC-CLI gelten für die Angabe der Objekte folgende Regeln:

• Bei den Funktionen create() und getObject() muss ggf. das übergeordnete BcObject vom Typ BcObjectType.PROXY oder BcObjectType.PROXY_CLUSTER angegeben werden. 

• Die Funktionen create() und getObject() liefern als Ergebnis ein erzeugtes bzw. gelesenes Objekt BcObject vom Typ BcObjectType zurück.

  Mit diesem Objekt können dann alle weiteren Funktionen für dieses Objekt aufgerufen werden (Parameter bc_object). 

• Die Funktion getList() gibt ein (Jython-) Dictionary zurück mit
key

  Name des Objekts (Eigenschaft name)
  value

  Objekt vom Typ BcObject

  Mit jedem dieser Objekte können dann alle weiteren Funktionen für dieses Objekt aufgerufen werden (Parameter bc_object).

Eigenschaften (Properties)

Am MC-CLI gelten für die Eigenschaften (Parameter props bei create() oder modifyProperties(), Rückgabe bei getProperties()) folgende Regeln:

• Alle Eigenschaften werden in Jython-Dictionaries übergeben.

• Die Eigenschaftsnamen bestehen immer aus Kleinbuchstaben, Ziffern, Bindestrich ('-') und Punkt ('.').

• Wenn für ein Objekt an der grafischen Oberfläche der Management Console mehrere Registerkarten mit Eigenschaften existieren, wird den Namen der Eigenschaften die Bezeichnung der jeweiligen Registerkarte als Präfix vorangestellt, z.B. "utm.", "timer.". Ausnahme: Die Eigenschaften der Registerkarte General. Sie erhalten keinen Präfix.

• Eigenschaftsnamen für Zeitwerte enthalten als Postfix die Einheit (".sec" bzw. ".min").

• Die Werte der Eigenschaften werden immer als Zeichenfolgen angegeben, auch bei Integer-Werten (z.B. bei Zeitwerten oder Portnummern)

• Kann eine Eigenschaft nur bestimmte Werte annehmen, sind sie in der Java-Klasse BcDef definiert. Genaueres ist in den einzelnen Funktionen beschrieben.

• Wird einem Objekt (Proxy, Resource Adapter, ...) bei der Konfiguration über die grafische Oberfläche ein MC-CmdHandler zugordnet, werden am CLI nur die entsprechenden Eigenschaften admin-port und ggf. admin-pw angegeben.