Scripting Object - VcHostFirewallSystem

Scripting-object corresponding to
HostFirewallSystem
Attribute of
VcHostConfigManager

Scripting 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.

Attributes

Name Type Description
availableFieldVcCustomFieldDef []

@since VI API 2.5
firewallInfoVcHostFirewallInfo

@since VI API 2.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
valueVcCustomFieldValue []

@since VI API 2.5
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, disableRuleset, enableRuleset, refreshFirewall, setCustomValue, updateDefaultPolicy, updateRuleset

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

setCustomValue

Assigns a value to a custom field. The setCustomValue method requires whichever updatePrivilege is defined as one of the {@link CustomFieldsManager.FieldDef#fieldInstancePrivileges} for the CustomFieldDef whose value is being changed. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

updateRuleset

Update the firewall ruleset specification. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String

arg1VcHostFirewallRulesetRulesetSpec


Return Value

Type Description
None

updateDefaultPolicy

Updates the default firewall policy; unset fields are left unchanged. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostFirewallDefaultPolicy


Return Value

Type Description
None

refreshFirewall

Refresh the firewall information and settings to pick up any changes made directly on the host. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None