Manual Pages for UNIX Operating System command usage for man v12n_domain_roles

Extended Library Functions                             v12n(3EXT)



NAME
     v12n,         v12n_capabilities,          v12n_domain_roles,
     v12n_domain_name,     v12n_domain_uuid,    v12n_ctrl_domain,
     v12n_chassis_serialno -  return  virtualization  environment
     domain parameters

SYNOPSIS
     cc [ flag... ] file... -lv12n [ library... ]
     #include 

     int v12n_capabilities();


     int v12n_domain_roles();


     int v12n_domain_uuid(uuid_t uuid);


     size_t v12n_domain_name(char *buf, size_t buflen);


     size_t v12n_ctrl_domain(char *buf, size_t buflen);


     size_t v12n_chassis_serialno(char *buf, size_t buflen);


DESCRIPTION
     The v12n_capabilities() function returns the  virtualization
     capabilities  mask of the current domain. The virtualization
     capabilities bit mask consists of the following values:

     V12N_CAP_SUPPORTED     Virtualization is supported  on  this
                            domain.


     V12N_CAP_ENABLED       Virtualization  is  enabled  on  this
                            domain.


     V12N_CAP_IMPL_LDOMS    Logical Domains is the supported vir-
                            tualization implementation.



     The v12n_domain_roles() function returns the  virtualization
     domain  role  mask. The virtualization domain role mask con-
     sists of the following values:

     V12N_ROLE_CONTROL    If the virtualization implementation is
                          Logical  Domains,  and this bit is one,



SunOS 5.11          Last change: 14 Jul 2010                    1






Extended Library Functions                             v12n(3EXT)



                          the current domain is a control domain.
                          If this bit is zero, the current domain
                          is a guest domain.


     V12N_ROLE_IO         Current domain is an I/O domain.


     V12N_ROLE_SERVICE    Current domain is a service domain.


     V12N_ROLE_ROOT       Current domain is an root I/O domain.



     The  v12n_domain_uuid()  function  stores  the   universally
     unique  identifier  (UUID)  for  the  current virtualization
     domain in the uuid argument. See  the  libuuid(3LIB)  manual
     page.


     The v12n_domain_name()  function  stores  the  name  of  the
     current  virtualization  domain in the location specified by
     buf. buflen specifies the size in bytes of  the  buffer.  If
     the buffer is too small to hold the complete null-terminated
     name, the first buflen bytes of the name are stored  in  the
     buffer. A buffer of size V12N_NAME_MAX is sufficient to hold
     any domain name. If buf is NULL or buflen is 0, the name  is
     not copied into the buffer.


     The v12n_ctrl_domain() function stores the control domain or
     dom0 network node name of the current domain in the location
     specified by buf. Note that a  domain's  control  domain  is
     volatile during a domain migration. The information returned
     by this function might be stale if the  domain  was  in  the
     process  of migrating. buflen specifies the size in bytes of
     the buffer. If the buffer is too small to hold the  complete
     null-terminated name, the first buflen bytes of the name are
     stored in the buffer. A buffer of size V12N_NAME_MAX is suf-
     ficient  to hold the control domain node name string. If buf
     is NULL or buflen is 0, the name  is  not  copied  into  the
     buffer.


     The  v12n_chassis_serialno()  function  stores  the  chassis
     serial number of the platform on which the current domain is
     running in the location specified  by  buf.  Note  that  the
     chassis serial number is volatile during a domain migration.
     The information returned by this function might be stale  if
     the domain was in the process of migrating. buflen specifies
     the size in bytes of the buffer. If the buffer is too  small



SunOS 5.11          Last change: 14 Jul 2010                    2






Extended Library Functions                             v12n(3EXT)



     to  hold the complete null-terminated name, the first buflen
     bytes of the name are stored in the buffer. A buffer of size
     V12N_NAME_MAX  is  sufficient  to  hold  any  chassis serial
     number string. If buf is NULL or buflen is 0,  the  name  is
     not copied into the buffer.

RETURN VALUES
     On  successful  completion,   the   v12n_capabilties()   and
     v12n_domain_roles()  functions  return  a  non-negative  bit
     mask. Otherwise, the v12n_domain_roles() function returns -1
     and sets errno to indicate the error.


     On successful completion,  the  v12n_domain_uuid()  function
     returns   0.   Otherwise,  the  v12n_domain_uuid()  function
     returns -1 and sets errno to indicate the error.


     On   successful    completion,    the    v12n_domain_name(),
     v12n_ctrl_domain(),  and  v12n_chassis_serialno()  functions
     return the buffer  size  required  to  hold  the  full  non-
     terminated  string. Otherwise, these functions return -1 and
     set errno to indicate the error.

ERRORS
     The v12n_domain_roles() function fails with EPERM  when  the
     calling process has an ID other than the privileged user.


     The v12n_domain_name() function will fail if:

     EPERM      The calling process has  an  ID  other  than  the
                privileged user.


     ENOTSUP    Virtualization is not  supported  or  enabled  on
                this domain.


     EFAULT     buf points to an illegal address.


     ENOENT     The sun4v machine description is inaccessible  or
                has no uuid node.



     The v12n_domain_uuid() function will fail if:

     EPERM      The calling process has  an  ID  other  than  the
                privileged user.




SunOS 5.11          Last change: 14 Jul 2010                    3






Extended Library Functions                             v12n(3EXT)



     ENOTSUP    Virtualization is not  supported  or  enabled  on
                this domain.


     EFAULT     buf points to an illegal address.


     ENOENT     The sun4v machine description is inaccessible  or
                has no uuid node.



     The v12n_ctrl_domain() function will fail if:

     EPERM      The calling process has  an  ID  other  than  the
                privileged user.


     ENOTSUP    Virtualization is not  supported  or  enabled  on
                this domain.


     EFAULT     buf points to an illegal address.


     ETIME      The domain service on the control domain did  not
                respond within the timeout value.



     The v12n_chassis_serialno() function will fail if:

     EPERM      The calling process has  an  ID  other  than  the
                privileged user.


     ENOTSUP    Virtualization is not  supported  or  enabled  on
                this domain.


     EFAULT     buf points to an illegal address.


     ETIME      The domain service on the control domain did  not
                respond within the timeout value.


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





SunOS 5.11          Last change: 14 Jul 2010                    4






Extended Library Functions                             v12n(3EXT)



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | MT-Safe                     |
    |_____________________________|_____________________________|


SEE ALSO
     virtinfo(1M), libuuid(3LIB), libv12n(3LIB), attributes(5)












































SunOS 5.11          Last change: 14 Jul 2010                    5