Skip to content

Commit 03ae836

Browse files
author
Robin Engström
committed
README.md: Added Datacenter support table
Part of MON-10311 Signed-off-by: Robin Engström <robin.engstrom@op5.com>
1 parent ea79f99 commit 03ae836

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,22 @@ The supported featureset will differ a bit between VMWare 5 and VMWare 6; please
2020
| IO | Yes | Yes |
2121
| Memory | Yes | Yes |
2222
| Network | Yes | Yes |
23-
| Runtime | Yes | Partially: -Overview -Connection state -Health -Maintenance -Status -Storage Health |
23+
| Runtime | Yes | Partially: Overview*, Connection state, Health, Maintenance, Status, Storage Health |
2424
| Service | Yes | Yes |
2525
| Uptime | No | Yes |
2626
| Storage | Yes | No |
27+
* Specified in the plugin help text as "^all", meaning that the sub command are omitted
28+
29+
### Checks supported for Datacenters
30+
| Check | Vmware 5 | Vmware 6 |
31+
|---------|--------------------------------------------------------------------------|------------------------------------------------|
32+
| CPU | Yes | Yes |
33+
| IO | Yes | Yes |
34+
| Memory | Yes | Yes |
35+
| Network | Partially: Overview*, Receive, Send, Usage | Partially: Receive, Send, Usage, Overview* |
36+
| Runtime | Partially: Overview*, Issues, List, Listcluster, Listhost, Status, Tools | Partially: Overview*, List, Listcluster, Tools |
37+
| VMFS | Partially: Overview* | Partially: Free space, Used space |
38+
* Specified in the plugin help text as "^all", meaning that the sub command are omitted
2739

2840
## Prerequisites
2941
'VMware vSphere SDK for Perl', available at
@@ -112,10 +124,17 @@ $ /opt/plugins/check_vmware_api --help
112124
## Get involved - Contribute to the Check VMware API project
113125
It is easy to get involved in the project and to contribute!
114126
* Start using the plugin and if you like what you see, help by spreading the word on blogs and forums.
115-
* Post your comments and feedback at the bottom of this page
116-
Sign up at the [op5-users](http://lists.op5.com/mailman/listinfo/op5-users) mailing list to join the conversation and help other users by answering questions. It is here that you can follow the project and contribute your code and bugfixes. (The mailing list is not project specific)
117-
* If you find a bug you can [report the bug here](https://bugs.op5.com/) or on the mailing list
118-
* If you miss any documentation or know how to solve an undocumented problem you can contribute with documentation here in the op5 Knowledge Base.
127+
* If you find a bug you can create a bug report in the issue tracker here on GitHub.
128+
### Testing
129+
* Unit tests: This plugin is huge and hard to unit test but if pull requests with unit tests are greatly appreciated.
130+
* Integration tests: This plugin is equipped with an option of generating tests (--generate_test). Simply run the plugin with this flag appended at the end of your command followed by a filename with the following format:
131+
132+
> <target>_<command>_<subcommand>_<option>.dat
133+
For example:
134+
> host_runtime_maintenance_maintwarn.dat
135+
So running the plugin from command line with the following will generate the integration test:
136+
> $ ./check_vmware_api -u <user> -p <password> -H <host_name> -l runtime -s maintenance -o maintwarn --generate_test host_runtime_maintenance_maintwarn.dat
137+
You can omit subcommand and/or option from the command and reflect that in the file name. To run all the tests simply run 'make'.
119138
120139
## License
121140
See LICENSE.

0 commit comments

Comments
 (0)