HostFirewallRuleset

HostFirewallRuleset
HostFirewallRuleset

Data object that describes a single network ruleset that can be allowed or blocked by the firewall using the HostFirewallSystem object.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "key": "string",
    "label": "string",
    "required": false,
    "rule": [
        {
            "_typeName": "string",
            "port": 0,
            "endPort": 0,
            "direction": "string",
            "portType": "string",
            "protocol": "string"
        }
    ],
    "service": "string",
    "enabled": false,
    "allowedHosts": {
        "_typeName": "string",
        "ipAddress": [
            "string"
        ],
        "ipNetwork": [
            {
                "_typeName": "string",
                "network": "string",
                "prefixLength": 0
            }
        ],
        "allIp": false
    },
    "userControllable": false,
    "ipListUserConfigurable": false
}
string
key
Required

Brief identifier for the ruleset.

string
label
Required

Display label for the ruleset.

boolean
required
Required

Flag indicating whether the ruleset is required and cannot be disabled.

array of HostFirewallRule
rule
Required

List of rules within the ruleset.

string
service
Optional

Managed service (if any) that uses this ruleset.

Must be one of the services listed in service.

boolean
enabled
Required

Flag indicating whether the ruleset is enabled.

If the ruleset is enabled, all ports specified in the ruleset are opened by the firewall.

HostFirewallRulesetIpList
allowedHosts
Optional

List of ipaddress to allow access to the service

boolean
userControllable
Optional

Flag indicating whether user can enable/disable the firewall ruleset.

Since: vSphere API Release 8.0.2.0

boolean
ipListUserConfigurable
Optional

Flag indicating whether user can modify the allowed IP list of the firewall ruleset.

Since: vSphere API Release 8.0.2.0

Property Of