File: FirewallSystem.rst

package info (click to toggle)
python-pyvmomi 6.7.1-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 14,984 kB
  • sloc: python: 9,206; xml: 77; makefile: 11
file content (162 lines) | stat: -rw-r--r-- 2,910 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
.. _str: https://docs.python.org/2/library/stdtypes.html

.. _vim.Task: ../../vim/Task.rst

.. _vSphere API 5.0: ../../vim/version.rst#vimversionversion7

.. _vim.fault.NotFound: ../../vim/fault/NotFound.rst

.. _vim.host.FirewallInfo: ../../vim/host/FirewallInfo.rst

.. _vim.fault.HostConfigFault: ../../vim/fault/HostConfigFault.rst

.. _vim.ExtensibleManagedObject: ../../vim/ExtensibleManagedObject.rst

.. _vim.host.Ruleset.RulesetSpec: ../../vim/host/Ruleset/RulesetSpec.rst

.. _vim.host.FirewallInfo.DefaultPolicy: ../../vim/host/FirewallInfo/DefaultPolicy.rst


vim.host.FirewallSystem
=======================
  The FirewallSystem managed object describes the firewall configuration of the host.The firewall should be configured first by setting the default policy and then by making exceptions to the policy to get the desired openness.


:extends: vim.ExtensibleManagedObject_


Attributes
----------
    firewallInfo (`vim.host.FirewallInfo`_):
       Firewall configuration.


Methods
-------


UpdateDefaultPolicy(defaultPolicy):
   Updates the default firewall policy; unset fields are left unchanged.


  Privilege:
               Host.Config.NetService



  Args:
    defaultPolicy (`vim.host.FirewallInfo.DefaultPolicy`_):




  Returns:
    None
         


EnableRuleset(id):
   Opens the firewall ports belonging to the specified ruleset. If the ruleset has a managed service with a policy of 'auto' that is not running, starts the service.


  Privilege:
               Host.Config.NetService



  Args:
    id (`str`_):




  Returns:
    None
         

  Raises:

    `vim.fault.NotFound`_: 
       if the ruleset ID is unknown.

    `vim.fault.HostConfigFault`_: 
       if an internal error happend when reconfigure the ruleset.


DisableRuleset(id):
   Blocks the firewall ports belonging to the specified ruleset. If the ruleset has a managed service with a policy of 'auto' and all other rulesets used by the service are blocked, stops the service.


  Privilege:
               Host.Config.NetService



  Args:
    id (`str`_):




  Returns:
    None
         

  Raises:

    `vim.fault.NotFound`_: 
       if the ruleset ID is unknown.

    `vim.fault.HostConfigFault`_: 
       if an internal error happend when reconfigure the ruleset.


UpdateRuleset(id, spec):
   Update the firewall ruleset specification.
  since: `vSphere API 5.0`_


  Privilege:
               Host.Config.NetService



  Args:
    id (`str`_):


    spec (`vim.host.Ruleset.RulesetSpec`_):




  Returns:
    None
         

  Raises:

    `vim.fault.NotFound`_: 
       if the ruleset ID is unknown

    `vim.fault.HostConfigFault`_: 
       if the update of the ruleset failed.


RefreshFirewall():
   Refresh the firewall information and settings to pick up any changes made directly on the host.


  Privilege:
               Host.Config.NetService



  Args:


  Returns:
    None