ntpinfo.cpp

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

//%2006////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation, The Open Group.
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; Symantec Corporation; The Open Group.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//==============================================================================
//
// Author: Mike Brasher ([e-mail])
//
// Modified By:
//
//%/////////////////////////////////////////////////////////////////////////////

#include <cstring>


// Using the general CIMOM TestClient as an example, developed an
// ntpinfo client that does an enumerateInstances of the
// PG_NTPService class and displays properties of interest.

// At this time, there is only one instance of PG_NTPService. 

#include "NTPInfo.h" 

PEGASUS_USING_PEGASUS;
PEGASUS_USING_STD;

#define NAMESPACE CIMNamespaceName ("root/cimv2")
#define CLASSNAME CIMName ("PG_NTPService")

/**  Constructor for NTPInfo Client
  */

NTPInfo::NTPInfo(void)
{
   ntpSystemName = String::EMPTY;
   ntpSystemCreationClassName = String::EMPTY;
   ntpName = String::EMPTY;
   ntpCreationClassName = String::EMPTY;
   ntpCaption = String::EMPTY;
   ntpDescription = String::EMPTY;
   ntpServerAddress = NULL;
}

NTPInfo::~NTPInfo(void)
{
}         

/** ErrorExit - Print out the error message as an
    and get out.
    @param - Text for error message
    @return - None, Terminates the program
    @exception - This function terminates the program
*/
void NTPInfo::errorExit(const String& message)
{
    cerr << "ntpinfo error: " << message << endl;
    exit(1);
}

/** _usage method for osinfo - only accept one option
    -c for raw CIM formatting
*/
void NTPInfo::_usage()
{
  cerr << "Usage: osinfo [-c]" << endl;
  cerr << "Example:" << endl;
  cerr << "  ntpinfo " << endl;
  cerr << "  ntpinfo -c " << endl;
}

/**
   displayProperties method of the osinfo Test Client
  */
void NTPInfo::displayProperties()
{
   // interesting properties are stored off in class variables

   cout << "Network Time Protocol (NTP) Service Information" << endl;
   cout << endl;

   // expect to have values for the keys (even if Unknown)
   cout << "  System Name                : " << ntpSystemName << endl;
   cout << "  System Creation Class Name : " << ntpSystemCreationClassName << endl;
   cout << "  Name                       : " << ntpName << endl;
   cout << "  Creation Class Name        : " << ntpCreationClassName << endl;
   cout << "  Caption                    : " << ntpCaption << endl;
   cout << "  Description                : " << ntpDescription << endl;
   if (ntpServerAddress.size() == 0)
   {
      cout << "  No NTP Servers Configured" << endl;
   }
   else
   {
      for (int i = 0; i <ntpServerAddress.size(); i++)
      {
          cout << "  Server Address[" << i << "]          : " <<
               ntpServerAddress[i] << endl;
      }
   }

}

/**
   gatherProperties method of the osinfo Test Client
  */
void NTPInfo::gatherProperties(CIMInstance &inst, Boolean cimFormat) 
{
   // don't have a try here - want it to be caught by caller

   // loop through the properties
   for (Uint32 j=0; j < inst.getPropertyCount(); j++)
   {
      CIMName propertyName = inst.getProperty(j).getName();

      // only pull out those properties of interest
      if (propertyName.equal (CIMName ("SystemName")))
      {
         inst.getProperty(j).getValue().get(ntpSystemName);
      }  // end if SystemName

      if (propertyName.equal (CIMName ("SystemCreationClassName")))
      {
         inst.getProperty(j).getValue().get(ntpSystemCreationClassName);
      }  // end if SystemCreationClassName
      
      if (propertyName.equal (CIMName ("Name")))
      {
         inst.getProperty(j).getValue().get(ntpName); 
      }  // end if Name

      if (propertyName.equal (CIMName ("CreationClassName")))
      {
         inst.getProperty(j).getValue().get(ntpCreationClassName);
      }  // end if CreationClassName

      if (propertyName.equal (CIMName ("Caption")))
      {
         inst.getProperty(j).getValue().get(ntpCaption); 
      }  // end if Caption

      if (propertyName.equal (CIMName ("Description")))
      {
         inst.getProperty(j).getValue().get(ntpDescription); 
      }  // end if Description 

      if (propertyName.equal (CIMName ("ServerAddress")))
      {
         inst.getProperty(j).getValue().get(ntpServerAddress); 
      }  // end if ServerAddress 
   }  // end of for looping through properties
}

/* 
   getNTPInfo of the NTP provider. 
*/
void NTPInfo::getNTPInfo(const int argc, const char** argv)
{

// ATTN-SLC-16-May-02-P1  enhance to take host & user info
//  Decided to keep local only for first release 

    Boolean cimFormat = false;

    // before we even connect to CIMOM, make sure we're
    // syntactically valid

    if (argc > 2)
    {
       _usage();
       exit(1);
    }

    if (argc == 2)
    {
       // only support one option, -c for CIM formatting
       const char *opt = argv[1];

       if (strcmp(opt,"-c") == 0)
       {
          cimFormat = true;
       }
       else
       {
          _usage();
          exit(1);
       }
    }

    // need to first connect to the CIMOM

    try
    {
        // specify the timeout value for the connection (if inactive)
        // in milliseconds, thus setting to one minute
        CIMClient client;
        client.setTimeout(60 * 1000);
	client.connectLocal();
        
        Boolean deepInheritance = true;
        Boolean localOnly = true;
        Boolean includeQualifiers = false;
        Boolean includeClassOrigin = false;
        Uint32 numberInstances;

        Array<CIMInstance> cimNInstances = 
	       client.enumerateInstances(NAMESPACE, CLASSNAME, 
                                         deepInheritance,
				         localOnly,  includeQualifiers,
				         includeClassOrigin );
	  
        numberInstances = cimNInstances.size();

        // while we only have one instance (the running OS), we can take the
        // first instance.  When the OSProvider supports installed OSs as well,
        // will need to select the runningOS instance

        for (Uint32 i = 0; i < cimNInstances.size(); i++)
        {
           CIMObjectPath instanceRef = cimNInstances[i].getPath ();
           if ( !(instanceRef.getClassName().equal (CIMName (CLASSNAME))))
           {
              errorExit("EnumerateInstances failed");
           }

           // first gather the interesting properties
           gatherProperties(cimNInstances[i], cimFormat);
         
           // then display them
           displayProperties();

      }   // end for looping through instances
    
    }  // end try 
   
    catch(Exception& e)
    {
      errorExit(e.getMessage());
    }

}

///////////////////////////////////////////////////////////////
//    MAIN
///////////////////////////////////////////////////////////////

int main(const int argc, const char** argv)
{
   NTPInfo ntpInfo;
   ntpInfo.getNTPInfo(argc, argv);
   return 0;
}