Skip to content

Commit 0344a0a

Browse files
committed
Update README.md
1 parent c4af3f4 commit 0344a0a

1 file changed

Lines changed: 32 additions & 16 deletions

File tree

README.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,8 @@ To call the script to run infinitely, waiting 5 minutes between each iteration,
106106
Accept wildcard characters? false
107107
108108
-Cluster <String[]>
109-
Specifies the VMWare Clusters you want to receive data from. Default is to read all Clusters managed by VCenter server or, if -Datacenter is specified, all Clusters in this Datacenter.
109+
Specifies the VMWare Clusters you want to receive data from. Default is to read all Clusters managed
110+
by VCenter server or, if -Datacenter is specified, all Clusters in this Datacenter.
110111
111112
Required? false
112113
Position? 6
@@ -115,7 +116,8 @@ To call the script to run infinitely, waiting 5 minutes between each iteration,
115116
Accept wildcard characters? false
116117
117118
-Graphiteserver <String[]>
118-
Specifies one or more (separated by comma) IP addresses or the DNS names of the Graphite servers which you want to connect to.
119+
Specifies one or more (separated by comma) IP addresses or the DNS names of the Graphite servers
120+
which you want to connect to.
119121
You can also add the Portnumber to each Server like "grafana.acme.com:2003"
120122
121123
Required? false
@@ -125,7 +127,8 @@ To call the script to run infinitely, waiting 5 minutes between each iteration,
125127
Accept wildcard characters? false
126128
127129
-Graphiteserverport <Int32>
128-
Specifies the port on the Graphite server you want to use for the connection. Defaults to 2003. You can also add the portnumber to the servers hostname or IP address in the -Graphiteserver parameter.
130+
Specifies the port on the Graphite server you want to use for the connection. Defaults to 2003.
131+
You can also add the portnumber to the servers hostname or IP address in the -Graphiteserver parameter.
129132
130133
Required? false
131134
Position? 8
@@ -134,7 +137,8 @@ To call the script to run infinitely, waiting 5 minutes between each iteration,
134137
Accept wildcard characters? false
135138
136139
-Group <String>
137-
Specifies the Group, an additional prefix for the metrics path in Graphite. The metrics path will be "vmperf.<Group>."
140+
Specifies the Group, an additional prefix for the metrics path in Graphite.
141+
The metrics path will be "vmperf.<Group>."
138142
139143
Required? false
140144
Position? 9
@@ -152,9 +156,12 @@ To call the script to run infinitely, waiting 5 minutes between each iteration,
152156
Accept wildcard characters? false
153157
154158
-FromLastPoll <String>
155-
Optional path and name of an .xml file where the date and time of the last poll will be saved. If the file does not exist, it will be created and overwritten after each poll.
156-
If this parameter is set, the script will try to receive all metrics from the VCenter Server starting at the date and time of the last poll up to the most recent data (Real-Time).
157-
This is useful if you want to schedule the script externally (with Task Scheduler, for instance) and you want to use the "-Iterations 1" parameter.
159+
Optional path and name of an .xml file where the date and time of the last poll will be saved. If the
160+
file does not exist, it will be created and overwritten after each poll.
161+
If this parameter is set, the script will try to receive all metrics from the VCenter Server starting
162+
at the date and time of the last poll up to the most recent data (Real-Time).
163+
This is useful if you want to schedule the script externally (with Task Scheduler, for instance) and you
164+
want to use the "-Iterations 1" parameter.
158165
But be careful, VCenter stores the Real-Time statistics just for a limited number of time (1 day per default).
159166
160167
Required? false
@@ -164,10 +171,14 @@ To call the script to run infinitely, waiting 5 minutes between each iteration,
164171
Accept wildcard characters? false
165172
166173
-Sleepseconds <Int32>
167-
Specifies the number of seconds to wait between iterations. The counter starts after the last statistics have been sent to Graphite.
168-
Note that VCenter is collecting its performance statistics every 20 seconds and saves an average of the collected counters. It makes no sense to specify a value below 20 seconds here. The script reads the so called
169-
"Realtime" counters from VCenter which will be kept there for one hour. So do not use anything above 3600 seconds.
170-
The script requests all statistics data from VCenter server since the last time they were requested, regardless of how long the Sleepseconds parameter was set. You wont miss any data.
174+
Specifies the number of seconds to wait between iterations. The counter starts after the last statistics
175+
have been sent to Graphite.
176+
Note that VCenter is collecting its performance statistics every 20 seconds and saves an average of the
177+
collected counters. It makes no sense to specify a value below 20 seconds here. The script reads the so
178+
called "Realtime" counters from VCenter which will be kept there for one hour. So do not use anything
179+
above 3600 seconds.
180+
The script requests all statistics data from VCenter server since the last time they were requested,
181+
regardless of how long the Sleepseconds parameter was set. You wont miss any data.
171182
172183
Required? false
173184
Position? 12
@@ -176,7 +187,8 @@ To call the script to run infinitely, waiting 5 minutes between each iteration,
176187
Accept wildcard characters? false
177188
178189
-Whatif [<SwitchParameter>]
179-
Indicate that the cmdlet will process but will NOT send any metrics to Graphite, instead display a list of metrics that would be sent to Graphite.
190+
Indicate that the cmdlet will process but will NOT send any metrics to Graphite, instead display a list
191+
of metrics that would be sent to Graphite.
180192
181193
Required? false
182194
Position? named
@@ -185,8 +197,10 @@ To call the script to run infinitely, waiting 5 minutes between each iteration,
185197
Accept wildcard characters? false
186198
187199
-EventLogLevel <String>
188-
Set the Log-Level for writing events to the Windows Aplication log. Valid values are Error, Warning, Information, and None. The default value is Warning.
189-
Note that if you like to use logging to the Windows Event Log, you have to run this script at least once with administrative privileges on this computer!
200+
Set the Log-Level for writing events to the Windows Aplication log. Valid values are Error, Warning,
201+
Information, and None. The default value is Warning.
202+
Note that if you like to use logging to the Windows Event Log, you have to run this script at least once
203+
with administrative privileges on this computer!
190204
191205
Required? false
192206
Position? 13
@@ -195,8 +209,10 @@ To call the script to run infinitely, waiting 5 minutes between each iteration,
195209
Accept wildcard characters? false
196210
197211
<CommonParameters>
198-
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
199-
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
212+
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable,
213+
WarningAction, WarningVariable,
214+
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters
215+
(http://go.microsoft.com/fwlink/?LinkID=113216).
200216
```
201217

202218
## Examples

0 commit comments

Comments
 (0)