com.vmware.appliance.networking.firewall

Interface Inbound

All Superinterfaces:

InboundTypes, Service

All Known Implementing Classes:

InboundStub

public interface Inbound
extends Service, InboundTypes

The Inbound interface provides methods to manage inbound firewall rules. This interface was added in vSphere API 6.7 U1.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.networking.firewall.InboundTypes

InboundTypes.Policy, InboundTypes.Rule

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<InboundTypes.Rule>	get() Get the ordered list of firewall rules.
void	get(AsyncCallback<java.util.List<InboundTypes.Rule>> asyncCallback) Get the ordered list of firewall rules.
void	get(AsyncCallback<java.util.List<InboundTypes.Rule>> asyncCallback, InvocationConfig invocationConfig) Get the ordered list of firewall rules.
java.util.List<InboundTypes.Rule>	get(InvocationConfig invocationConfig) Get the ordered list of firewall rules.
void	set(java.util.List<InboundTypes.Rule> rules) Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses.
void	set(java.util.List<InboundTypes.Rule> rules, AsyncCallback<java.lang.Void> asyncCallback) Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses.
void	set(java.util.List<InboundTypes.Rule> rules, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses.
void	set(java.util.List<InboundTypes.Rule> rules, InvocationConfig invocationConfig) Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses.

Method Detail

set

void set(java.util.List<InboundTypes.Rule> rules)

Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses. This overwrites the existing firewall rules and creates a new rule list. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. For example, the list of rules can be as follows:

1. "address": "10.112.0.1", "prefix": 0, "interface_name": "*","policy": "REJECT"
   "address": "10.112.0.1", "prefix": 0, "interface_name": "nic0","policy": "ACCEPT"
   

In the above example, the first rule drops all packets originating from 10.112.0.1 and
the second rule accepts all packets originating from 10.112.0.1 only on nic0. In effect, the second rule is always ignored which is not desired, hence the order has to be swapped. 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 method was added in vSphere API 6.7 U1.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

rules - List of address-based firewall rules.

Throws:

Error - Generic error

set

void set(java.util.List<InboundTypes.Rule> rules,
       InvocationConfig invocationConfig)

Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses. This overwrites the existing firewall rules and creates a new rule list. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. For example, the list of rules can be as follows:

1. "address": "10.112.0.1", "prefix": 0, "interface_name": "*","policy": "REJECT"
   "address": "10.112.0.1", "prefix": 0, "interface_name": "nic0","policy": "ACCEPT"
   

In the above example, the first rule drops all packets originating from 10.112.0.1 and
the second rule accepts all packets originating from 10.112.0.1 only on nic0. In effect, the second rule is always ignored which is not desired, hence the order has to be swapped. 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 method was added in vSphere API 6.7 U1.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

rules - List of address-based firewall rules.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

set

void set(java.util.List<InboundTypes.Rule> rules,
       AsyncCallback<java.lang.Void> asyncCallback)

Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses. This overwrites the existing firewall rules and creates a new rule list. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. For example, the list of rules can be as follows:

1. "address": "10.112.0.1", "prefix": 0, "interface_name": "*","policy": "REJECT"
   "address": "10.112.0.1", "prefix": 0, "interface_name": "nic0","policy": "ACCEPT"
   

In the above example, the first rule drops all packets originating from 10.112.0.1 and
the second rule accepts all packets originating from 10.112.0.1 only on nic0. In effect, the second rule is always ignored which is not desired, hence the order has to be swapped. 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 method was added in vSphere API 6.7 U1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - Generic error

Parameters:

rules - List of address-based firewall rules.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

set

void set(java.util.List<InboundTypes.Rule> rules,
       AsyncCallback<java.lang.Void> asyncCallback,
       InvocationConfig invocationConfig)

Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses. This overwrites the existing firewall rules and creates a new rule list. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. For example, the list of rules can be as follows:

1. "address": "10.112.0.1", "prefix": 0, "interface_name": "*","policy": "REJECT"
   "address": "10.112.0.1", "prefix": 0, "interface_name": "nic0","policy": "ACCEPT"
   

In the above example, the first rule drops all packets originating from 10.112.0.1 and
the second rule accepts all packets originating from 10.112.0.1 only on nic0. In effect, the second rule is always ignored which is not desired, hence the order has to be swapped. 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 method was added in vSphere API 6.7 U1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - Generic error

Parameters:

rules - List of address-based firewall rules.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

java.util.List<InboundTypes.Rule> 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 method was added in vSphere API 6.7 U1.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

List of address-based firewall rules.

Throws:

Error - Generic error

get

java.util.List<InboundTypes.Rule> get(InvocationConfig invocationConfig)

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 method was added in vSphere API 6.7 U1.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

List of address-based firewall rules.

Throws:

Error - Generic error

get

void get(AsyncCallback<java.util.List<InboundTypes.Rule>> asyncCallback)

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 method was added in vSphere API 6.7 U1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
List of address-based firewall rules.

Operation Errors:
Error - Generic error

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(AsyncCallback<java.util.List<InboundTypes.Rule>> asyncCallback,
       InvocationConfig invocationConfig)

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 method was added in vSphere API 6.7 U1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
List of address-based firewall rules.

Operation Errors:
Error - Generic error

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.