Debian Codegraph @

ansible_collections/vmware/vmware_rest/manual/source/vmware_rest_scenarios/appliance/health.rst

raw
1 .. _ansible_collections.vmware.vmware_rest.docsite.vmware_rest_appliance_health:
2
3 *******************************************
4 Get the health state of the VCSA components
5 *******************************************
6
7 Introduction
8 ============
9
10 The collection provides several modules that you can use to know the state of the different components of the VCSA.
11
12 Scenario requirements
13 =====================
14
15 You've got an up and running vCenter Server Appliance.
16
17
18 Health state per component
19 --------------------------
20
21 The database storage:
22
23 .. ansible-task::
24
25 - name: Get the database storage heath status
26 vmware.vmware_rest.appliance_health_databasestorage_info:
27
28 The system load:
29
30 .. ansible-task::
31
32 - name: Get the system load status
33 vmware.vmware_rest.appliance_health_load_info:
34
35 The memory usage:
36
37 .. ansible-task::
38
39 - name: Get the system mem status
40 vmware.vmware_rest.appliance_health_mem_info:
41
42
43 The system status:
44
45 .. ansible-task::
46
47 - name: Get the system health status
48 vmware.vmware_rest.appliance_health_system_info:
49
50 The package manager:
51
52 .. ansible-task::
53
54 - name: Get the health of the software package manager
55 vmware.vmware_rest.appliance_health_softwarepackages_info:
56
57 The storage system:
58
59 .. ansible-task::
60
61 - name: Get the health of the storage system
62 vmware.vmware_rest.appliance_health_storage_info:
63
64 The swap usage:
65
66 .. ansible-task::
67
68 - name: Get the health of the swap
69 vmware.vmware_rest.appliance_health_swap_info:
70
71
72 Monitoring
73 ----------
74
75 You can also retrieve information from the VCSA monitoring backend. First you need the name of the item. To get a full list of these items, run:
76
77 .. ansible-task::
78
79 - name: Get the list of the monitored items
80 vmware.vmware_rest.appliance_monitoring_info:
81 register: result
82
83
84 With this information, you can access the information for a given time frame:
85
86 .. ansible-task::
87
88 - name: Query the monitoring backend
89 vmware.vmware_rest.appliance_monitoring_query:
90 end_time: 2021-04-14T09:34:56.000Z
91 start_time: 2021-04-14T08:34:56.000Z
92 names:
93 - mem.total
94 interval: MINUTES5
95 function: AVG
96 register: result