Files
deb-python-pyvmomi/docs/vim/action/RunScriptAction.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

17 lines
617 B
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _ActionParameter: ../../vim/action/Action/ActionParameter.rst
.. _vim.action.Action: ../../vim/action/Action.rst
vim.action.RunScriptAction
==========================
This data object type specifies a script that is triggered by an alarm. You can use any elements of the `ActionParameter`_ enumerated list as part of your script to provide information available at runtime.
:extends: vim.action.Action_
Attributes:
script (`str`_):
The fully-qualified path to a shell script that runs on the VirtualCenter server as a result of an alarm.