REST API - get
  1. Operations
  2. appliance
  3. networking
  4. firewall
  5. inbound

appliance networking firewall inbound: get

Get the ordered list of firewall rules. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. When a connection matches a firewall rule, further processing for the connection stops, and the appliance ignores any additional firewall rules you have set. This operation was added in vSphere API 6.7.1.

Request:

HTTP request

GET https://{server}/rest/appliance/networking/firewall/inbound
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : [
        {
            "address" : "string",
            "prefix" : 1,
            "interface_name" : "string",
            "policy" : "IGNORE"
        },
        {
            "address" : "string",
            "prefix" : 1,
            "interface_name" : "string",
            "policy" : "IGNORE"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value rule[] List of address-based firewall rules.
value[].address string IPv4 or IPv6 address. This attribute was added in vSphere API 6.7.1.
value[].prefix long CIDR prefix used to mask address. For example, an IPv4 prefix of 24 ignores the low-order 8 bits of address. This attribute was added in vSphere API 6.7.1.
value[].policy string The allow or deny policy of this rule. This attribute was added in vSphere API 6.7.1.

Defines firewall rule policies. This enumeration was added in vSphere API 6.7.1. Value is one of:
IGNORE: Drop packet with correpsonding address. This constant was added in vSphere API 6.7.1.
ACCEPT: Allow packet with corresponding address. This constant was added in vSphere API 6.7.1.
REJECT: Drop packet with corresponding address sending destination is not reachable. This constant was added in vSphere API 6.7.1.
RETURN: Apply default or port-specific rules to packet with corresponding address. This constant was added in vSphere API 6.7.1.
value[].interface_name string The interface to which this rule applies. An empty string indicates that the rule applies to all interfaces. This attribute was added in vSphere API 6.7.1.

Optional.

Errors:

HTTP Status Code Type Description
500 error Generic error