getClusterInfo

Request

 <ncsRequest>
   <clusterConfig>
     <getClusterInfo>
       <typeOfInfo>
         <basicInfo/>
         <notificationInfo/>
         <priorityInfo/>
         <protocolInfo/>
       </typeOfInfo>
     </getClusterInfo>
   </clusterConfig>
 </ncsRequest>
 

Reply

 <ncsReply>
   <clusterConfig>
     <getClusterInfo>
       <basicInfo>
         <ipAddress>
         <port>
         <quorum>
           <timeout>
           <membership>
         <quorum>
       </basicInfo>
       <notificationInfo state=" ">
         <emailAddresses>
           <email>
         </emailAddresses>
         <notificationType>
           <onlyCritical/>
           <verbose/>
         </notificationType>
         <xmlMsg state= " "/> 
       </notificationInfo>
       <priorityInfo>
         <resourceList>
           <name>
         </resourceList>
       </priorityInfo>
       <protocolInfo>
         <heartbeat>
         <tolerance>
         <masterWatchdog>
         <slaveWatchdog>
         <maxRetransmits>
         <summary>
       </protocolInfo>
       <result value=>
         <description>
       </result>
     </getClusterInfo>
   </clusterConfig>
 </ncsReply>
 

Elements

typeOfInfo

(Optional) If omitted, all information is returned. Otherwise, the information is divided in categories of information and identifies which categories you want to get as specified below:

Information Types	Description
basicInfo	If present, get basic info.
notificationInfo	If present, get email notification info.
priorityInfo	If present, get resource priority info.
protocolInfo	If present, get cluster protocol info.

basicInfo

(Optional) Specifies basic cluster information:

Information Value	Description
ipAddress	The IP address of the cluster.
port	The TCP port number for cluster management if using ConsoleOne.
quorum timeout membership	Specifies the cluster startup quorum configuration (the number of seconds to wait for the quorum and the number of nodes to establish the quorum at startup.

notificationInfo state

(Optional) The state can be either enabled or disabled according to the following values:

Notification Values	Description
emailAddresses email	List of email addresses to send notification emails.
notificationType onlyCritical verbose	Notification content returned is critical or all information.
xmlMsg state	The value of state can be either enabled or disabled. If enabled, notification emails will be encoded in XML.