fcstat – Collects Fibre Channel adapter statistics using the fcstat command on AIX
Synopsis
This module allows you to gather statistics from Fibre Channel (FC) adapters using the AIX fcstat command.
Supports device-generic and device-specific reporting, diagnostic mode, reset, and time-series reporting.
Parameters
- device_name (True, str, None)
Name of the Fibre Channel device (for example, fcs0).
- remove_delay (optional, bool, False)
Removes delay in generating output when the device is opened in nondiagnostic mode and the link is down.
- all_statistics (optional, bool, False)
Displays all statistics, including device-specific statistics (-e).
- reset_stats (optional, bool, False)
Resets some statistics back to initial values (-z).
Only privileged users can issue this flag.
- interval (optional, int, None)
Displays a time-series report of the traffic statistics continuously with a time interval between two consecutive reports,.
If set to 0, only a single report is generated.
- count (optional, int, None)
Number of reports to generate at the specified interval.
Must be used together with the interval option.
- protocol (optional, str, None)
Displays a time-series report of traffic statistics for a specific transport protocol (TP) that is specified with the Protocol parameter.
- recorded_output (optional, str, None)
Path to file where command output should be written.
- concatenated_output (True, bool, None)
Controls whether the output is appended to the file or overwrites it.
Notes
Note
You can refer to the IBM documentation for additional information on the fcstat command at https://www.ibm.com/docs/en/aix/7.3.0?topic=f-fcstat-command.
Examples
- name: Run fcstat on fcs0 with generic stats
ibm.power_aix.fcstat:
device_name: fcs0
- name: Run fcstat with extended stats on fcs1
ibm.power_aix.fcstat:
device_name: fcs1
extended_stats: true
- name: Run fcstat in diagnostic mode and reset stats
ibm.power_aix.fcstat:
device_name: fcs0
diagnostic_mode: true
reset_stats: true
- name: Run fcstat time-series with 5 second interval, 3 reports
ibm.power_aix.fcstat:
device_name: fcs0
interval: 5
protocol: scsi
Return Values
- msg (always, str, fcstat executed successfully with given options.)
Execution message indicating success or failure.
- cmd (always, str, fcstat -e fcs0)
Full fcstat command executed.
- rc (always, int, )
Return code from fcstat command.
- stdout (always, str, )
Standard output from fcstat command.
- stderr (on failure, str, )
Error output from fcstat command (if any).
Status
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by community.