1VPOLLER-CLIENT(1)                User Commands               VPOLLER-CLIENT(1)
2
3
4

NAME

6       vpoller-client - manual page for vpoller-client 0.7.3
7

DESCRIPTION

9   Usage:
10              vpoller-client [options] -m <method> -V <host>
11

OPTIONS

13       -h, --help
14              Display this usage info
15
16       -v, --version
17              Display version and exit
18
19       -d, --debug
20              Debug mode, be more verbose
21
22       -m <method>, --method <method>
23              The method to be processed during the client request
24
25       -V <host>, --vsphere-host <host>
26              The vSphere host to send the request to
27
28       -n <name>, --name <name>
29              Name of the object, e.g. ESXi hostname, datastore URL, etc.
30
31       -p <properties>, --properties <properties>
32              Name of the property as defined by the vSphere Web SDK
33
34       -r <retries>, --retries <retries>
35              Number of times to retry if a request times out [default: 3]
36
37       -t <timeout>, --timeout <timeout>
38              Timeout after that period of milliseconds [default: 10000]
39
40       -e <endpoint>, --endpoint <endpoint>
41              Endpoint  of  vPoller  Proxy/Worker  the client connects to [de‐
42              fault: tcp://localhost:10123]
43
44       -k <key>, --key <key>
45              Provide additional key for data filtering
46
47       -c <counter>, --counter <counter>
48              Retrieve performance metrics with this counter name
49
50       -s <max-sample>, --max-sample <max-sample>
51              Max number of performance samples to retrieve
52
53       -i <instance>, --instance <instance>
54              Performance metric instance name
55
56       -T <interval> --perf-interval <interval>
57              Historical performance interval name
58
59       -U <username>, --guest-username <username>
60              Username to use for authentication in guest system
61
62       -P <password>, --guest-password <password>
63              Password to use for authentication in guest system
64
65       -H <helper>, --helper <helper>
66              Specify a helper module to use for processing of the result mes‐
67              sage, e.g. 'vpoller.helpers.zabbix'
68

EXAMPLES

70              vpoller-client -m vm.discover -V vc01.example.org vpoller-client
71              -m  vm.discover  -V   vc01.example.org   -p   runtime.powerState
72              vpoller-client -m vm.get -V vc01.example.org -n vm01.example.org
73              -p  summary.overallStatus  vpoller-client  -m   vm.disk.get   -V
74              vc01.example.org  -n  vm01.example.org -k /var vpoller-client -m
75              vm.process.get -V vc01.example.org -n vm01.example.org  -U  user
76              -P pass
77

SEE ALSO

79       The  full  documentation  for vpoller-client is maintained as a Texinfo
80       manual.  If the info and vpoller-client programs are properly installed
81       at your site, the command
82
83              info vpoller-client
84
85       should give you access to the complete manual.
86
87
88
89vpoller-client 0.7.3             January 2023                VPOLLER-CLIENT(1)
Impressum