| BcAdminProxy.perform()
startet für den Proxy die in action angegebene Aktion. |
Parameter: | bc_object
(BcObject vom Typ BcObjectType.PROXY)
Proxy, der administriert 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
check-avail
| überprüft den Administrationsstatus des Proxys. überprüft Verfügbarkeit des Proxys. Es wird zunächst der Proxy-Container geprüft.Ist er verfügbar und danach die Komponenten und Kommunikationspartner des Proxys geprüft. |
restart
| beendet und startet den Proxy neu (Restart).sichert die Änderungen, die für diesen Proxy in der aktuellen Sitzung gemacht worden sind. |
save
| sichert die Änderungen, die für diesen Proxy in der aktuellen Sitzung gemacht worden sind. |
start
| startet den Proxy. |
stop
| beendet den Proxy. |
update-config
| bringt die gesicherten Änderungen in die Konfiguration des
Proxys ein. |
params (kw)
Dictionary mit den key-value-Paaren der Parameter, die der angegebenen Aktion mitgegeben werden sollen.
Falls action=check-avail, kann im Dictionary params folgendes key-valuePaar angegeben werden: key="all-components“
value=BcDef.BOOL_TRUE
wenn für alle Komponenten des Proxys die Verfügbarkeit überprüft werden soll.
value=BcDef.BOOL_FALSE
wenn nur für den Proxy-Container die Verfügbarkeit überprüft werden soll (Standard).
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
|
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 Proxys durchgeführt werden soll.
key=communication-service
Gibt an, ob die Aktion für den Communication Service des Proxys durchgeführt werden soll.
key=lu62gateway
Gibt an, ob die Aktion für das openUTM-LU62 Gateway des Proxys durchgeführt werden soll.
value=BcDef.BOOL_TRUE
Die angegebene Aktion soll für diese Komponente des Proxys durchgeführt werden.
value=BcDef.BOOL_FALSE
Die angegebene Aktion soll für diese Komponente des Proxys nicht durchgeführt werden (Standard).
value=BcDef.COLDSTART
Die angegebene Aktion soll für diese Komponente des Proxys 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 |
Exceptions: | BcParameterException, BcObjectException, BcToolException
|
Anmerkung: | Wenn das Proxy Objekt zu einem Proxy Cluster gehört, kann die Aktion "save" nicht mit BcAdminProxy.perform() angestoßen werden. Das Sichern der geänderten Eigenschaften erfolgt direkt im Aufruf von modifyProperties() bzw. über BcAdminProxyCluster.perform(). Wenn das Proxy Objekt zu einem Proxy Cluster gehört, kann die Aktion "updateconfig" nicht mit BcAdminProxy.perform() angestoßen werden. Sie muss über BcAdminProxyCluster.perform() angestoßen werden. Wenn bei den Aktionen start/stop/restart in params das key-value-Paar "all-components", BcDef.BOOL_TRUE angegeben wird, werden andere keyvalue-Paare ignoriert.
|
Beispiel: |
...
import BcAdminProxy
...
proxy_obj=BcAdminProxy.getObject("proxy")
bcaction=BcAdminProxy.perform(proxy_obj,"check-avail")
...
|
