# Managed Object - HostFirewallSystem(vim.host.FirewallSystem)

Property of
  HostConfigManager
Extends
  ExtensibleManagedObject
See also
  HostFirewallDefaultPolicy, HostFirewallInfo, HostFirewallRulesetRulesetSpec
Since
  2.0

## Managed Object Description

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.

Properties

Name | Type | Description
--- | --- | ---
firewallInfo* | HostFirewallInfo | Firewall configuration.
Properties inherited from ExtensibleManagedObject
availableField, value

*May not be present

Methods

Methods defined in this Managed Object
DisableRuleset, EnableRuleset, RefreshFirewall, UpdateDefaultPolicy, UpdateRuleset
Methods inherited from ExtensibleManagedObject
setCustomValue

# DisableRuleset(disableRuleset)

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.

Required Privileges
  Host.Config.NetService

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostFirewallSystem used to make the method call.
id P | xsd:string | Since 2.0

P Required privilege: id

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if an internal error happened when reconfigure the ruleset.
NotFound | Thrown if the ruleset ID is unknown.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="DisableRuleset" type="vsan:DisableRulesetRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="DisableRulesetResponse"> <complexType/> </element>

# EnableRuleset(enableRuleset)

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.

Required Privileges
  Host.Config.NetService

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostFirewallSystem used to make the method call.
id P | xsd:string | Since 2.0

P Required privilege: id

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if an internal error happened when reconfigure the ruleset.
NotFound | Thrown if the ruleset ID is unknown.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="EnableRuleset" type="vsan:EnableRulesetRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="EnableRulesetResponse"> <complexType/> </element>

# RefreshFirewall(refresh)

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

Required Privileges
  Host.Config.NetService

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostFirewallSystem used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RefreshFirewall" type="vsan:RefreshFirewallRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RefreshFirewallResponse"> <complexType/> </element>

# UpdateDefaultPolicy(updateDefaultPolicy)

Updates the default firewall policy; unset fields are left unchanged.

Required Privileges
  Host.Config.NetService

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostFirewallSystem used to make the method call.
defaultPolicy P | HostFirewallDefaultPolicy | Since 2.0

P Required privilege: defaultPolicy

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="UpdateDefaultPolicy" type="vsan:UpdateDefaultPolicyRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="UpdateDefaultPolicyResponse"> <complexType/> </element>

# UpdateRuleset(updateRuleset)

Update the firewall ruleset specification.

Required Privileges
  Host.Config.NetService
Since
  vSphere API 5.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostFirewallSystem used to make the method call.
id P | xsd:string | Since vSphere API 5.0
spec P | HostFirewallRulesetRulesetSpec | Since vSphere API 5.0

PRequired privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if the update of the ruleset failed.
NotFound | Thrown if the ruleset ID is unknown
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="UpdateRuleset" type="vsan:UpdateRulesetRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="UpdateRulesetResponse"> <complexType/> </element>