File Formats                                    servicebundle(4)



NAME
     servicebundle - service manifest file format

SYNOPSIS
     /usr/share/lib/xml/dtd/servicebundle.dtd.1


DESCRIPTION
     The service management facility, described in smf(5),  util-
     izes  an XML-based file format to marshal the description of
     a set of services or service instances between systems. This
     file  is  known  as  a service bundle. The primary form of a
     service bundle is the inventory of services  that  are  pro-
     vided by a package, which is called a service manifest.


     The  DTD  describing  the  servicebundle  is  provided   at
     /usr/share/lib/xml/dtd/servicebundle.dtd.1.  The attributes
     and tags are fully described in the commented DTD. The  ser-
     vices  supplied  with  the  operating  system,  stored under
     /var/svc/manifest, provide examples of correctly formed ser-
     vice descriptions.


     servicebundle documents can also  use  the  XML  Inclusions
     (XInclude)  facility to merge multiple documents into one. A
     servicebundle document manipulator must  therefore  support
     the functionality defined by the XInclude specification.


     A complete service description consists of the following:

         o    A set of properties that identify the  service  and
              identify its restarter

         o    A set of properties that identify each instance

         o    A set of framework property  groups  that  describe
              the framework's understanding of each instance

         o    A set of method  property  groups  as  required  by
              svc.startd(1M), or by a delegated restarter

         o    Additional optional method property groups

         o    A set of dependency property groups

         o    An optional group of properties that indicate  ser-
              vices  to  which dependencies on the described ser-
              vice were added

         o    A   set   of   application   property   groups   or



SunOS 5.11           Last change: 6 Mar 2009                    1






File Formats                                    servicebundle(4)



              application-specific typed property groups contain-
              ing application configuration data

         o    A template that  describes  supporting  information
              about this service, such as a description, links to
              documentation, and metadata about  property  groups
              and properties.


     The document type definition for the service bundle provides
     markup to define each of these aspects of a service descrip-
     tion, as well as a number of entities that identify  regular
     features    in   describing   a   service,   such   as   the
      tag.

  Manifest Handling During Packaging Operations
     Service manifests within packages should be identified  with
     the  class  manifest.  Class action scripts that install and
     remove service manifests are included in the packaging  sub-
     system.  When pkgadd(1M) is invoked, the service manifest is
     imported.


     When pkgrm(1M) is invoked, instances in  the  manifest  that
     are  disabled are deleted. Any services in the manifest with
     no remaining instances are also deleted.


     If the -R option is supplied to pkgadd(1M) or pkgrm(1M), the
     actions  described  in this section are done when the system
     is next rebooted with that alternate root path.

ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Availability                 SUNWcsu                     
    
     Stability                    Committed                   
    


SEE ALSO
     pkgadd(1M),     pkgrm(1M),      svcadm(1M),      svccfg(1M),
     svc.startd(1M),   libscf(3LIB),   attributes(5),  locale(5),
     smf(5), smfmethod(5), smftemplate(5)




SunOS 5.11           Last change: 6 Mar 2009                    2






File Formats                                    servicebundle(4)



NOTES
     Nested servicebundle elements must be of the same type.





















































SunOS 5.11           Last change: 6 Mar 2009                    3