Manual Pages for UNIX Operating System command usage for man HBA_GetAdapterPortAttributes

Common Fibre Channel HBA Information Library Functions
                            HBA_GetAdapterPortAttributes(3HBAAPI)



NAME
     HBA_GetAdapterPortAttributes,
     HBA_GetDiscoveredPortAttributes,  HBA_GetPortAttributesByWWN
     - retrieve Fibre Channel port attributes for a specific dev-
     ice

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

     HBA_STATUS HBA_GetAdapterPortAttributes(HBA_HANDLE handle,
          HBA_UINT32 portindex, HBA_PORTATTRIBUTES *portattributes);


     HBA_STATUS HBA_GetDiscoveredPortAttributes(HBA_HANDLE handle,
          HBA_UINT32 portindex, HBA_UINT32 discoveredportindex,
          HBA_PORTATTRIBUTES *portattributes);


     HBA_STATUS HBA_GetPortAttributesByWWN(HBA_HANDLE handle,
          HBA_WWN PortWWN, HBA_PORTATTRIBUTES *portattributes);


PARAMETERS
     handle                 an   open   handle   returned    from
                            HBA_OpenAdapter(3HBAAPI)


     portindex              the index of a specific port  on  the
                            HBA   as   returned   by  a  call  to
                            HBA_GetAdapterAttributes(3HBAAPI).
                            The maximum value specified should be
                            (HBA_ADAPTERATTRIBUTES.NumberOfPorts
                            - 1).


     portattributes         a pointer  to  an  HBA_PORTATTRIBUTES
                            structure.   Upon  successful comple-
                            tion,  this  structure  contains  the
                            specified port attributes.


     discoveredportindex    the index of  a  specific  discovered
                            port   on  the  HBA  as  returned  by
                            HBA_GetAdapterPortAttributes(3HBAAPI).
                            The maximum value specified should be
                            (HBA_PORTATTRIBUTES.NumberOfDiscoveredPorts
                            - 1).






SunOS 5.11           Last change: 1 Sep 2003                    1






Common Fibre Channel HBA Information Library Functions
                            HBA_GetAdapterPortAttributes(3HBAAPI)



     PortWWN                the port WWN of the device for  which
                            port attributes are retrieved.


DESCRIPTION
     The HBA_GetAdapterPortAttributes() function  retrieves  Port
     Attributes for a specific port on the HBA.


     The  HBA_GetDiscoveredPortAttributes()  function   retrieves
     Port  Attributes  for a specific discovered device connected
     to the HBA.


     The  HBA_GetPortAttributesByWWN()  function  retrieves  Port
     Attributes  for a specific device based on the PortWWN argu-
     ment.

RETURN VALUES
     Upon successful completion, HBA_STATUS_OK is returned.  Oth-
     erwise,  an  error value is returned from the underlying VSL
     and the values in hbaattributes are undefined.

ERRORS
     See libhbaapi(3LIB) for general error status values.

EXAMPLES
     Example 1 Retrieve the port attributes for each port on  the
     HBA.


     The following example retrieves the port attributes for each
     port on the HBA.


       for (hbaPort = 0; hbaPort < hbaAttrs.NumberOfPorts; hbaPort++) {
           if ((status = HBA_GetAdapterPortAttributes(handle,
                   hbaPort, &hbaPortAttrs)) != HBA_STATUS_OK) {
               fprintf(stderr, "Unable to get adapter port %d "
                   "attributes for HBA %d with name \"%s\".\n",
                   hbaPort, hbaCount, adaptername);
               HBA_CloseAdapter(handle);
               continue;
           }
           memcpy(&wwn, hbaPortAttrs.PortWWN.wwn, sizeof (wwn));
           printf(" Port %d: WWN=%016llx\n", hbaPort, wwn);

           /* ... */
       }





SunOS 5.11           Last change: 1 Sep 2003                    2






Common Fibre Channel HBA Information Library Functions
                            HBA_GetAdapterPortAttributes(3HBAAPI)



     Example 2 Retrieve the discovered port target attributes for
     each discovered target port on the HBA.


     The following example retrieves the discovered  port  target
     attributes for each discovered target port on the HBA.


       for (discPort = 0;
               discPort < hbaPortAttrs.NumberofDiscoveredPorts;
               discPort++) {
           if ((status = HBA_GetDiscoveredPortAttributes(
                   handle, hbaPort, discPort,
                   &discPortAttrs)) != HBA_STATUS_OK) {
               fprintf(stderr, "Unable to get "
                   "discovered port %d attributes for "
                   "HBA %d with name \"%s\".\n",
                   discPort, hbaCount, adaptername);
               continue;
           }
           memcpy(&wwn, discPortAttrs.PortWWN.wwn,
               sizeof (wwn));
           printf("  Discovered Port %d: WWN=%016llx\n",
               discPort, wwn);

           /* ... */
       }


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






















SunOS 5.11           Last change: 1 Sep 2003                    3






Common Fibre Channel HBA Information Library Functions
                            HBA_GetAdapterPortAttributes(3HBAAPI)



______________________________________________________________________
   |        ATTRIBUTE TYPE       |        ATTRIBUTE VALUE      |
   | ____________________________|_____________________________|_
   |  Interface Stability        |  Committed                  |
   | ____________________________|_____________________________|_
   |                             |  Standard: FC-HBA Version  4|
   |                             |  (API version 2)            |
   |_____________________________|_____________________________|
   | MT-Level                    | Safe                        |
   |_____________________________|_____________________________|
   | Standard                    | FC-MI 1.92 (API version 1)  |
   |_____________________________|_____________________________|


SEE ALSO
     HBA_GetAdapterPortAttributes(3HBAAPI),
     HBA_OpenAdapter(3HBAAPI), libhbaapi(3LIB), attributes(5)


     T11 FC-MI Specification


































SunOS 5.11           Last change: 1 Sep 2003                    4






Common Fibre Channel HBA Information Library Functions
                            HBA_GetAdapterPortAttributes(3HBAAPI)






















































SunOS 5.11           Last change: 1 Sep 2003                    5