VAppNetworkDescriptor_FirewallRule

VAppNetworkDescriptor_FirewallRule
VAppNetworkDescriptor_FirewallRule

Represents a firewall rule.

JSON Example
{
    "description": "Some description.",
    "destinationIp": "any",
    "destinationPortRange": "any",
    "destinationVm": {
        "ipType": "assigned",
        "vmName": "myvm",
        "vmNicId": 1
    },
    "direction": "in",
    "enableLogging": false,
    "icmpSubType": "address-mask-request",
    "id": "3b09cb36-1736-4bbf-a693-1a4947bdfeee",
    "isEnabled": true,
    "matchOnTranslate": true,
    "policy": "allow",
    "port": -1,
    "position": 1,
    "protocol": {
        "any": true,
        "icmp": true,
        "other": "string",
        "tcp": true,
        "udp": true
    },
    "sourceIp": "10.71.80.255",
    "sourcePort": -1,
    "sourcePortRange": "any",
    "sourceVm": {
        "ipType": "assigned",
        "vmName": "myvm",
        "vmNicId": 1
    }
}
string
description
Optional

A description of the rule.

string
destinationIp
Optional

Destination IP address to which the rule applies. A value of Any matches any IP address.

string
destinationPortRange
Optional

Destination port range to which this rule applies.

destinationVm
Optional

destinationVm

string
direction
Optional

Direction of traffic to which rule applies. One of: in (rule applies to incoming traffic. This is the default value), out (rule applies to outgoing traffic).

boolean
enableLogging
Optional

Used to enable or disable firewall rule logging. Default value is false

string
icmpSubType
Optional

ICMP subtype. One of: address-mask-request, address-mask-reply, destination-unreachable, echo-request, echo-reply, parameter-problem, redirect, router-advertisement, router-solicitation, source-quench, time-exceeded, timestamp-request, timestamp-reply, any.

string
id
Optional

Firewall rule identifier.

boolean
isEnabled
Optional

Used to enable or disable the firewall rule. Default value is true.

boolean
matchOnTranslate
Optional

For DNATed traffic, match the firewall rules only after the destination IP is translated.

string
policy
Optional

One of: drop (drop packets that match the rule), allow (allow packets that match the rule to pass through the firewall)

integer As int32 As int32
port
Optional

The port to which this rule applies. A value of -1 matches any port.

integer As int32 As int32
position
Optional

The position of the firewall rule.

string
sourceIp
Optional

Source IP address to which the rule applies. A value of Any matches any IP address.

integer As int32 As int32
sourcePort
Optional

Source port to which this rule applies. A value of -1 matches any port.

string
sourcePortRange
Optional

Source port range to which this rule applies.

sourceVm
Optional

sourceVm