perfstat_virtual_fcadapter Subroutine
Purpose
Retrieves the Virtual Fiber Channel adapter (NPIV) usage statistics.
Library
Perfstat Library (libperfstat.a)
Syntax
#include <libperfstat.h>
int perfstat_virtual_fcadapter (name, userbuff, sizeof_struct, desired_number)
perfstat_id_t * name;
perfstat_fcstat_t * userbuff;
size_t sizeof_struct;int desired_number;Description
The perfstat_virtual_fcadapter subroutine retrieves one or more Virtual Fiber Channel adapter (NPIV) usage statistics.
The same function can also be used to retrieve the number of available sets of Virtual Fiber Channel adapter (NPIV) usage statistics.
To get one or more sets of Virtual FC adapter (NPIV) usage metrics, set the name parameter to the name of the first Virtual FC adapter for which the statistics are to be collected, and set the desired_number parameter. To start from the first Virtual FC adapter, set the name parameter to the quotation marks (" ") or FIRST_VFCHOST. The userbuff parameter must always point to the memory area that is big enough to contain the number of perfstat_fcstat_t structures that this subroutine is to copy. Upon return, the name parameter is set to either the name of the next FC adapter, or to the quotation marks (" ") after all of the structures are copied.
To retrieve the number of available sets of Virtual FC adapter usage metrics, set the name parameter and the userbuff parameter to the value of null, and the desired_number parameter to the value of zero. The returned value is the number of available sets.
Parameters
| Item | Description |
|---|---|
| name | Contains the quotation marks (" "), FIRST_VFCHOST, or the name indicating the first FC adapter for which the statistics is to be retrieved. For example: vfchost0, vfchost1. |
| userbuff | Points to the memory that is to be filled with one or more perfstat_fcstat_t structures. |
| sizeof_struct | Specifies the size of the perfstat_fcstat_t structure. |
| desired_number | Specifies the number of perfstat_fcstat_t structures to copy to the userbuff parameter. |
Return Values
Upon successful completion, the number of structures filled is returned.
If unsuccessful, a value of -1 is returned and the errno global variable is set.
Error Codes
The perfstat_virtual_fcadapter subroutine is unsuccessful if one of the following is true:
| Item | Description |
|---|---|
| EINVAL | One of the parameters is not valid |
| EFAULT | The memory is not sufficient |
| ENOMEM | The default length of the string is too short. |
| ENOMSG | The dictionary is not accessible. |
Files
The libperfstat.h file defines standard macros, data types, and subroutines.