Files
deb-python-pyvmomi/docs/vim/host/Ruleset.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

43 lines
1.3 KiB
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _bool: https://docs.python.org/2/library/stdtypes.html
.. _service: ../../vim/host/ServiceInfo.rst#service
.. _vmodl.DynamicData: ../../vmodl/DynamicData.rst
.. _HostFirewallSystem: ../../vim/host/FirewallSystem.rst
.. _vim.host.Ruleset.Rule: ../../vim/host/Ruleset/Rule.rst
.. _vim.host.Ruleset.IpList: ../../vim/host/Ruleset/IpList.rst
vim.host.Ruleset
================
Data object that describes a single network ruleset that can be allowed or blocked by the firewall using the `HostFirewallSystem`_ object.
:extends: vmodl.DynamicData_
Attributes:
key (`str`_):
Brief identifier for the ruleset.
label (`str`_):
Display label for the ruleset.
required (`bool`_):
Flag indicating whether the ruleset is required and cannot be disabled.
rule (`vim.host.Ruleset.Rule`_):
List of rules within the ruleset.
service (`str`_, optional):
Managed service (if any) that uses this ruleset. Must be one of the services listed in `service`_ .
enabled (`bool`_):
Flag indicating whether the ruleset is enabled. If the ruleset is enabled, all ports specified in the ruleset are opened by the firewall.
allowedHosts (`vim.host.Ruleset.IpList`_, optional):
List of ipaddress to allow access to the service