cluster

Description

Provides methods to access and modify clusters.

Namespace:

cluster

Method: addCluster

Description:

Add a cluster

Parameters:

  • string sessionKey

  • string name

  • string description

  • integer management node id

  • string cluster provider

  • struct containing the values for each field in the form

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteCluster

Description:

Delete a cluster given the ID

Parameters:

  • string sessionKey

  • int clusterId

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: listClusterNodes

Description:

Lists the nodes of a cluster.

Parameters:

  • string sessionKey

  • int clusterId

Returns:

  • array :

    • string - hostname

Method: listClusters

Description:

List all clusters for the user’s org

Parameters:

  • string sessionKey

Returns:

  • array :

    • struct - cluster_id

      • string "cluster_name"

Method: scheduleJoinNodeToCluster

Description:

Schedule the execution of a node join the cluster

Parameters:

  • string sessionKey

  • int clusterId

  • array :

    • integer - systemIds

  • struct containing the values for each field in the form

  • dateTime.iso8601 earliestOccurrence - earliest the action can run

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: scheduleRemoveNodeFromCluster

Description:

Schedule the execution of a node join the cluster

Parameters:

  • string sessionKey

  • int clusterId

  • array :

    • integer - systemIds

  • struct containing the values for each field in the form

  • dateTime.iso8601 earliestOccurrence - earliest the action can run

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: scheduleUpgradeCluster

Description:

Schedule the execution of a cluster upgrade

Parameters:

  • string sessionKey

  • int clusterId

  • struct containing the values for each field in the form

  • dateTime.iso8601 earliestOccurrence - earliest the action can run

Returns:

  • int - 1 on success, exception thrown otherwise.