Function: | BcAdminProxyCluster.perform() |
|
| Starts a given action for the proxy cluster. |
Parameters: |
bc_object (BcObject of type BcObjectType.PROXY_CLUSTER ).
|
| Proxy cluster for which the action is to be started. |
action (String) |
| Action that is to be started for the specified proxy. Possible values are (see BcDef.ACTION_xxx in the MC-CLI-JavaDoc) |
| check-adm | Checks the proxy cluster's administration status. |
| check-avail | Checks the proxy cluster's execution status. |
| restart | Terminates and restarts the proxy cluster. |
| save | Saves the changes that have been made for this proxy cluster in the current session. |
| start | Starts the proxy cluster. |
| stop | Terminates the proxy cluster. |
| update-config | Enters the saved changes in the configuration of the proxy cluster. |
params (kw)
|
| Dictionary with the key-value pairs for the parameters that are to be passed to the specified action. If action=start , stop , restart or update-config , then the following key-value pair can be specified in the dictionary params: |
| | 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 (only possible for action=restart )
|
| lu62gateway
| BcDef.BOOL_TRUE / BcDef.BOOL_FALSE /
BcDef.COLDSTART (only possible for action=start)
|
| The following meanings apply: key="all-components“ Specifies whether the action should be performed for all components.
key=container Specifies whether the action should be performed for the container of the proxy cluster.
key=communication-service Specifies whether the action should be performed for the communication service of the proxy cluster.
key=force-start Specifies whether the components of the proxy cluster that are not currently running should also be started.
key=lu62gateway Specifies whether the action should be performed for the openUTM-LU62 Gateway of the proxy cluster.
value=BcDef.BOOL_TRUE The specified action should be performed for this component of the proxy cluster.
value=BcDef.BOOL_FALSE The specified action should not be performed for this component of the proxy cluster (default).
value=BcDef.COLDSTART The specified action should be performed as a cold start for this component of the proxy cluster (only permitted for action=start and key=lu62gateway ).
|
Return: | (BcObject of type BcObjectType.ACTION ). Contains all information about the started action and all its subactions. To obtain more detailed information, you can call a function of the BcAdminAction module with this object as parameter. None if the action was not started (e.g. if there is nothing to save on a save action).
|
Exceptions: | BcParameterException , BcObjectException , BcToolException
|
Note: | In the case of action=start , stop , restart , it may first be necessary to perform an authentication for all proxies as otherwise the action cannot be started for the proxies. If the key-value pair all-components , BcDef.BOOL_TRUE is specified in params for the actions start/stop/restart/update-config then other keyvalue pairs are ignored.
|
Example: |
...
import BcAdminProxyCluster
...
clstr_obj=BcAdminProxyCluster.getObject("BCCluster")
bcaction=BcAdminProxyCluster.perform(clstr_obj,"stop")
...
|