Managed Object - HostFirewallSystem(vim.host.FirewallSystem)

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


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

NameTypeDescription
_thisManagedObjectReference A reference to the HostFirewallSystem used to make the method call.
idxsd:string



Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown if an internal error happend when reconfigure the ruleset.
NotFoundThrown if the ruleset ID is unknown.
RuntimeFaultThrown 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



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

NameTypeDescription
_thisManagedObjectReference A reference to the HostFirewallSystem used to make the method call.
idxsd:string



Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown if an internal error happend when reconfigure the ruleset.
NotFoundThrown if the ruleset ID is unknown.
RuntimeFaultThrown 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



RefreshFirewall(refresh)

Refresh the firewall information and settings to pick up any changes made directly on the host.
Required Privileges
Host.Config.NetService

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostFirewallSystem used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown 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



UpdateDefaultPolicy(updateDefaultPolicy)

Updates the default firewall policy; unset fields are left unchanged.
Required Privileges
Host.Config.NetService

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostFirewallSystem used to make the method call.
defaultPolicyHostFirewallDefaultPolicy



Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown 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



UpdateRuleset(updateRuleset)

Update the firewall ruleset specification.
Required Privileges
Host.Config.NetService
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostFirewallSystem used to make the method call.
idxsd:string


specHostFirewallRulesetRulesetSpec



Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown if the update of the ruleset failed.
NotFoundThrown if the ruleset ID is unknown
RuntimeFaultThrown 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