15f7be9a52
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
26 lines
1.3 KiB
ReStructuredText
26 lines
1.3 KiB
ReStructuredText
.. _bool: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _vSphere API 4.0: ../../../vim/version.rst#vimversionversion5
|
|
|
|
.. _vmodl.DynamicData: ../../../vmodl/DynamicData.rst
|
|
|
|
.. _vim.ManagedEntity.Status: ../../../vim/ManagedEntity/Status.rst
|
|
|
|
|
|
vim.alarm.AlarmTriggeringAction.TransitionSpec
|
|
==============================================
|
|
Specification indicating which on transitions this action fires. The existence of a Spec indicates that this action fires on transitions from that Spec's startState to finalState.There are only four acceptable {startState, finalState} pairs: {green, yellow}, {yellow, red}, {red, yellow} and {yellow, green}. At least one of these pairs must be specified. Any deviation from the above will render the enclosing AlarmSpec invalid.
|
|
:extends: vmodl.DynamicData_
|
|
:since: `vSphere API 4.0`_
|
|
|
|
Attributes:
|
|
startState (`vim.ManagedEntity.Status`_):
|
|
|
|
The state from which the alarm must transition for the action to fire. Valid choices are red, yellow and green.
|
|
finalState (`vim.ManagedEntity.Status`_):
|
|
|
|
The state to which the alarm must transition for the action to fire. Valid choices are red, yellow, and green.
|
|
repeats (`bool`_):
|
|
|
|
Whether or not the action repeats, as per the actionFrequency defined in the enclosing Alarm.
|