Cluster Commands#

Note

From release 21.1 onwards, a standalone topology is considered a single node cluster (cluster-of-one). This means that commands such as cluster provision, cluster list, cluster status and cluster maintenance-mode should be run on a standalone topology.

The following Command Line Interface console display shows the available commands for clustering.

cluster add <ip>                  - add a new node to join the existing cluster
cluster check <verbose>           - Display pre-upgrade readiness.
                                    For each node, test if ports
                                    are available, the time taken to connect, drive space
                                    percentage and lastly checks if NTP is running
cluster del <ip>                  - remove a node from the existing cluster
cluster job kill <pid>            - Kill a detached job <pid>
cluster job list                  - List detached jobs in the cluster
cluster job reconnect <pid>       - Reconnect to a detached job <pid>
cluster list                      - display the list of nodes associated with the cluster
cluster maintenance-mode          - Display the status, start or stop maintenance
         <start|stop|status>        mode across the cluster
cluster prepnode                  - Prepares the system so that it can be joined to a cluster
cluster primary                   - Check if the system is considered the primary by patch
                                    or delta install scripts
cluster primary role              - Check if the system is considered the
         <application|database>     'primary' in the given role
cluster provision                 - perform cluster-wide provisioning
         [datacentre <location>]
         [role <role>]
cluster run <where> <command>     - run the command on a particular host.
                                    <where> can either be a name prefix, ip, role, or 'all'
cluster status                    - display the status of the cluster
cluster upgrade <iso/url>         - upgrade all applications from iso image <iso-name>.
         [datacentre <location>]    <iso-name> can be a URL for upgrading
         [backup <location>]        from a remote server.
cluster where <application>       - determine on which nodes the application is installed