vSphere Web Services API
|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
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 | ||
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 | xsd:string |
Since 2.0 |
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
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 | xsd:string |
Since 2.0 |
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
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
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 | HostFirewallDefaultPolicy |
Since 2.0 |
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
UpdateRuleset(updateRuleset)
Update the firewall ruleset specification.- Required Privileges
- Host.Config.NetService
- Since
- vSphere API Release 5.0
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostFirewallSystem used to make the method call. |
| id | xsd:string |
Since vSphere API Release 5.0 |
| spec | HostFirewallRulesetRulesetSpec |
Since vSphere API Release 5.0 |
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
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |