getClusterReport

Request

 <ncsRequest>
   <clusterReport>
     <getClusterReport/>
   </clusterReport>
 </ncsRequest> 
 

Reply

 <ncsReply>
   <clusterReport>
     <getClusterReport>
       <clusterState>
         <epoch/>
         <masterNode/>
         <nodeInfo>
           <name>
           <state>
         </nodeInfo>
         <resourceInfo>
           <name>
           <resourceType>
           <state>
           <location>
           <incarnation>
           <upSince>
       </clusterState>
       <clusterConfig>
         <basicInfo>
           <ipAddress>
           <port>
           <quorum>
             <timeout>
             <membership>
           <quorum>
         </basicInfo>
         <notificationInfo state=" ">
           <emailAddresses>
             <email>
           </emailAddresses>
           <notificationType>
             <onlyCritical/>
             <verbose/>
           </notificationType>
           <xmlMsg/>
         </notificationInfo>
         <priorityInfo>
           <resourceList>
             <name>
           </resourceList>
         </priorityInfo>
         <protocolInfo>
           <heartbeat>
           <tolerance>
           <masterWatchdog>
           <slaveWatchdog>
           <maxRetransmits>
           <summary>
         </protocolInfo>
         <nodeInfo>
           <name>
           <distinguishedName>
           <ipAddress>
           <nodeNumber>
         </nodeInfo>
         <resourceInfo>
           <name>
           <ipAddress>
           <distinguishedName>
           <poolName>
           <resourceType>
             <pool/>
             <resource/>
             <template/>
             <masterIP/>
           <resourceType>
           <scriptInfo>
             <unloadScript>
               <script>
               <timeout>
             </unloadScript>
             <loadScript>
               <script>
               <timeout>
             </loadScript>
           </scriptInfo>
           <policyInfo>
             <followMaster/>
             <ignoreQuorum/>
             <startMode>
               <manual/>
               <auto/>
             </startMode>
             <failoverMode>
               <manual/>
               <auto/>
             </failoverMode>
             <failbackMode>
               <manual/>
               <auto/>
               <disable/> 
             </failbackMode>
           </policyInfo>
           <preferredNodeInfo>
             <unassignedNodes>
               <node>
             </unassignedNodes>
           <preferredNodes>
               <node>
             </preferredNodes>
           </preferredNodeInfo>
           <protocolInfo>
             <virtualServerName>
             <cifsServerName>
             <ipAddress>
             <afp/>
             <ncp/>
             <cifs/>
           </protocolInfo>
         </resourceInfo>
       </clusterConfig>
       <result value=>
         <description> 
       </result>
     </getClusterReport>
   </clusterReport>
 </ncsReply>
 

Elements

getClusterReport

Get a cluster report.

clusterState

Provides the values for the state of the cluster:

Values	Description
epoch	The current epoch.
masterNode	Specifies the name of the master node.
nodeInfo name state	Repeats the node name and state for each node.
resourceInfo name resourceType state location incarnation upSince	Repeats the resource information for each resource: The resource name. The resource type. Resource state: Valid states are: Offline, Loading, Running, Unassigned, NDS Sync, Upgrade, Failback Alert, Failover Alert, and Start Alert. Location of the resource. The number of lives. Generalized time format (YYYMMDDHHSS).

clusterConfig, basicInfo

Optional basic cluster configuration information:

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

clusterConfig, notificationInfo state

(Optional) The value of state can be either enabled or disabled:

Values	Description
emailAddresses email	Repeat list of email addresses to send notifcation emails.
notificationType onlyCritical verbose	Returns only critical or all notification information.
xmlMsg state	(Optional) The value of the state can be either enabled or disabled. If enabled, notification emails will be encoded in XML.

clusterConfig, priorityInfo

Cluster protocol information:

Values	Description
heartbeat	Number of seconds.
tolerance	Number of seconds.
masterWatchdog	Number of seconds.
slaveWatchdog	Number of seconds.
maxRetransmits	Number of seconds.

clusterConfig, nodeInfo

Repeats the cluster node information for each of the following values:

Values	Description
name	Name of the node.
distinguishedName	DN of the node’s NCP server.
ipAddress	IP address of the node.
nodeNumber	The node number.

clusterConfig, resourceInfo

(Required) Repeats the resource information for each of the following values:

Values	Description
name	(Required) The name of the resource.
ipAddress	(Optional) The IP address for a cluster pool resource.
distinguishedName	(Optional) The DN of the virtual NCP server for a cluster pool resource.
poolName	(Required) The name of the pool.
resourceType pool resource template masterIP	(Required) Cluster resource type values.
scriptInfo unloadScript loadScript	(Optional) Resource unload and load script information values.
policyInfo followMaster ignoreQuorum startMode failoverMode failbackMode	(Optional) Policy information values: If present, resource always runs on cluster master node. If present, resource ignores quorum on cluster startup. Resource starts manually or automatically on cluster startup. Resource failover is manual or automatic. Resource failback is manual, automatic, or disabled.
preferredNodeInfo unassignedNodes	(Optional) Lists unassigned nodes and node name.
preferredNodes	(Optional) List of assigned node names, from most preferred to least preferred.
protocolInfo virtualServerName cifsServerName ipAddress afp ncp cifs	(Required) Repeat protocol information for each resource: Name of virtual NCP server. If cifs is present, NetBios name of virtual CIFS server. IP address of virtual server. (Optional) If present, AFP advertising is enabled. (Optional) If present, NCP advertising is enabled. (Optional) If present, CIFS advertising is enabled.
result value description	An error value and text description, or zero for no error.

clusterState

Repeats the resource information for each of the following values:

Values	Description
name	(Required) The name of the resource.
resourceType	(Required) This will include a type for the master IP resource.
state	(Required) State will also contain alerts. Valid states are: Offline; Loading; Running; Unassigned; NDS Sync; Upgrade; Failback Alert; Failover Alert; and Start Alert.
location	(Required) The name of the node where the resource is located.

clusterState

Repeats the resource information for each of the following values:

Values	Description
name	(Required) The name of the resource.
resourceType	(Required) This will include a type for the master IP resource.
state	(Required) State will also contain alerts. Valid states are: Offline; Loading; Running; Unassigned; NDS Sync; Upgrade; Failback Alert; Failover Alert; and Start Alert.
location	(Required) The name of the node where the resource is located.

clusterState

Repeats the resource information for each of the following values:

Values	Description
name	(Required) The name of the resource.
resourceType	(Required) This will include a type for the master IP resource.
state	(Required) State will also contain alerts. Valid states are: Offline; Loading; Running; Unassigned; NDS Sync; Upgrade; Failback Alert; Failover Alert; and Start Alert.
location	(Required) The name of the node where the resource is located.

clusterState

Repeats the resource information for each of the following values:

Values	Description
name	(Required) The name of the resource.
resourceType	(Required) This will include a type for the master IP resource.
state	(Required) State will also contain alerts. Valid states are: Offline; Loading; Running; Unassigned; NDS Sync; Upgrade; Failback Alert; Failover Alert; and Start Alert.
location	(Required) The name of the node where the resource is located.