Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly
Loading...

{{viewport.spaceProperty.prod}}

perform() - Administrative Aktionen starten

Funktion:

BcAdminProxyCluster.perform()

startet für den Proxy Cluster eine bestimmte Aktion.

Parameter:

bc_object
(BcObject vom Typ BcObjectType.PROXY_CLUSTER).

Proxy Cluster, für den die Aktion gestartet werden soll.

action (String)

Aktion, die für den angegebenen Proxy gestartet werden soll. Mögliche Werte sind (siehe BcDef.ACTION_xxx in der MC-CLI-JavaDoc)

check-adm

überprüft den Administrationsstatus des Proxy Clusters.

check-avail

überprüft den Lauf-Status des Proxy Clusters.

restart

beendet und startet den Proxy Cluster neu.

save

sichert die Änderungen, die für diesen Proxy Cluster in der aktuellen Sitzung gemacht worden sind.

start

startet den Proxy Cluster.

stop

beendet den Proxy Cluster.

update-config

bringt die gesicherten Änderungen in die Konfiguration des Proxy Clusters ein.

params (kw)

Dictionary mit den key-value-Paaren der Parameter, die der angegebenen Aktion mitgegeben werden sollen.

Falls action=start, stop, restart oder update-config, können im Dictionary params folgende key-value-Paare angegeben werden:

key =

value =

all-components

BcDef.BOOL_TRUE / BcDef.BOOL_FALSE

container

BcDef.BOOL_TRUE / BcDef.BOOL_FALSE

communication-service

BcDef.BOOL_TRUE / BcDef.BOOL_FALSE

force-start

BcDef.BOOL_TRUE / BcDef.BOOL_FALSE (nur bei action=restart möglich)

lu62gateway

BcDef.BOOL_TRUE / BcDef.BOOL_FALSE / BcDef.COLDSTART (nur bei action=start möglich)

Dabei bedeuten:

key=all-components
Gibt an, ob die Aktion für alle Komponenten durchgeführt werden soll.

key=container
Gibt an, ob die Aktion für den Container des Proxy Clusters durchgeführt werden soll.

key=communication-service
Gibt an, ob die Aktion für den Communication Service des Proxy Clusters durchgeführt werden soll.

key=force-start
gibt an, ob die Komponenten des Proxy Clusters, die aktuell nicht laufen, auch gestartet werden sollen.

key=lu62gateway
Gibt an, ob die Aktion für das openUTM-LU62 Gateway des Proxy Clusters durch geführt werden soll.

value=BcDef.BOOL_TRUE
Die angegebene Aktion soll für diese Komponente des Proxy Clusters durchgeführt werden.

value=BcDef.BOOL_FALSE
Die angegebene Aktion soll für diese Komponente des Proxy Clusters nicht durchgeführt werden (Standard).

value=BcDef.COLDSTART
Die angegebene Aktion soll für diese Komponente des Proxy Clusters als Kaltstart durchgeführt werden (nur bei action=start und key=lu62gateway zulässig).

Rückgabe:

(BcObject mit Typ BcObjectType.ACTION).

  • Enthält alle Informationen über die gestartete Aktion und sämtliche Teilaktionen. Um genauere Informationen zu erhalten, kann eine Funktion des Moduls BcAdminAction mit diesem Objekt als Parameter aufgerufen werden.

  • None, wenn die Aktion nicht gestartet wurde (z.B. wenn bei save nichts zu sichern ist).

Exceptions:

BcParameterException, BcObjectException, BcToolException

Anmerkung:

  • Bei action=start, stop, restart muss ggf. vorher eine Authentifikation für alle Proxys durchgeführt werden, da sonst die Aktion für die Proxys nicht gestartet werden kann.

  • Wenn bei den Aktionen start/stop/restart/update-config in params das key- value-Paar all-components, BcDef.BOOL_TRUE angegeben wird, werden andere key-value-Paare ignoriert.

Beispiel:

...
import BcAdminProxyCluster
...
clstr_obj=BcAdminProxyCluster.getObject("BCCluster")
bcaction=BcAdminProxyCluster.perform(clstr_obj,"stop")
...