Starts, stops, and restarts ColdFusion servers. This CFC only works when running ColdFusion in the Enterprise or Developer installs.
| hierarchy: |
WEB-INF.cftags.component CFIDE.adminapi.base CFIDE.adminapi.serverinstance |
| path: | /opt/coldfusion/cfusion/wwwroot/CFIDE/adminapi/serverinstance.cfc |
| serializable: | Yes |
| properties: | |
| final: | false |
| abstract: | false |
| methods: | addCluster, addServersToCluster, createServerInstance, deleteServerInstance, removeCluster, removeServersFromCluster, restartInstance, startInstance, stopInstance |
| inherited methods: | dump, getEdition, getInstallType, isAdminUser, logaudit |
| addCluster |
|---|
public
void
addCluster
(
required
cluster
)
Name of the cluster to be created Output: suppressed Parameters: cluster: any, required, cluster - Name of the cluster to be created |
| addServersToCluster |
public
void
addServersToCluster
(
required
cluster,
required
servernames
)
Creates cluster Output: suppressed Parameters: cluster: any, required, cluster - Name of the cluster to be created servernames: any, required, servernames - Name of the ColdFusion instance to be added to cluster |
| createServerInstance |
public
void
createServerInstance
(
required
name
)
Creates instance of a ColdFusion server. Output: suppressed Parameters: name: any, required, name - Name of the ColdFusion instance to be created |
| deleteServerInstance |
public
void
deleteServerInstance
(
required
name
)
Deletes instance of a ColdFusion server. Output: suppressed Parameters: name: any, required, name - Name of the ColdFusion instance to be deleted |
| removeCluster |
public
void
removeCluster
(
required
cluster
)
Remove cluster Output: suppressed Parameters: cluster: any, required, cluster - Name of the cluster to be removed |
| removeServersFromCluster |
public
void
removeServersFromCluster
(
required
cluster,
required
servernames
)
Remove servers from cluster Output: suppressed Parameters: cluster: any, required, cluster - Name of the cluster from which servers are to be removed servernames: any, required, servernames - Name of the ColdFusion instance to be removed to cluster |
| restartInstance |
public
void
restartInstance
(
required
name
)
Restarts an instance of a ColdFusion server. Output: suppressed Parameters: name: any, required, name - Name of the ColdFusion instance to restart. |
| startInstance |
public
void
startInstance
(
required
name
)
Starts an instance of a ColdFusion server. Output: suppressed Parameters: name: any, required, name - Name of the ColdFusion instance to start. |
| stopInstance |
public
void
stopInstance
(
required
name
)
Stops an instance of a ColdFusion server. Output: suppressed Parameters: name: any, required, name - Name of the ColdFusion instance to stop. |