entstat – Collects Ethernet device statistics using the entstat command on AIX
Synopsis
This module allows you to gather statistics from Ethernet devices using the AIX entstat command.
Supports device-generic statistics, device-specific reporting, reset, and debug trace toggle.
Parameters
- device_name (True, str, None)
Name of the Ethernet device (for example, ent0).
- device_statistics (optional, bool, False)
Displays all statistics, including device-specific statistics (-d).
- reset_stats (optional, bool, False)
Resets all statistics back to initial values (-r).
Only privileged users can issue this flag.
- debug_trace (optional, bool, False)
Toggles debug trace in some device drivers (-t).
- 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 entstat command at https://www.ibm.com/docs/en/aix/7.3.0?topic=e-entstat-command.
Examples
- name: Run entstat on ent0 with generic stats
ibm.power_aix.entstat:
device_name: ent0
- name: Run entstat with device-specific stats on ent1
ibm.power_aix.entstat:
device_name: ent1
device_statistics: true
- name: Run entstat with reset stats
ibm.power_aix.entstat:
device_name: ent0
reset_stats: true
- name: Run entstat with debug trace enabled
ibm.power_aix.entstat:
device_name: ent0
debug_trace: true
Return Values
- msg (always, str, entstat executed successfully with given options.)
Execution message indicating success or failure.
- cmd (always, str, entstat -d ent0)
Full entstat command executed.
- rc (always, int, )
Return code from entstat command.
- stdout (always, str, )
Standard output from entstat command.
- stderr (on failure, str, )
Error output from entstat command (if any).
Status
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by community.