com.vmware.appliance.networking.firewall

Class InboundStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.networking.firewall.InboundStub

All Implemented Interfaces:

Inbound, InboundTypes, Service

public class InboundStub
extends com.vmware.vapi.internal.bindings.Stub
implements Inbound

Remote stub implementation of the Inbound API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

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

InboundTypes.Policy, InboundTypes.Rule

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

Constructor and Description
InboundStub(ApiProvider apiProvider, StubConfigurationBase config)
InboundStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

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.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InboundStub

public InboundStub(ApiProvider apiProvider,
           com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
           StubConfigurationBase config)

InboundStub

public InboundStub(ApiProvider apiProvider,
           StubConfigurationBase config)

Method Detail

set

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

Description copied from interface: Inbound

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.

Specified by:

set in interface Inbound

Parameters:

rules - List of address-based firewall rules.

set

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

Description copied from interface: Inbound

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.

Specified by:

set in interface Inbound

Parameters:

rules - List of address-based firewall rules.

invocationConfig - Configuration for the method invocation.

set

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

Description copied from interface: Inbound

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

Specified by:

set in interface Inbound

Parameters:

rules - List of address-based firewall rules.

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

set

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

Description copied from interface: Inbound

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

Specified by:

set in interface Inbound

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

public java.util.List<InboundTypes.Rule> get()

Description copied from interface: Inbound

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.

Specified by:

get in interface Inbound

Returns:

List of address-based firewall rules.

get

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

Description copied from interface: Inbound

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.

Specified by:

get in interface Inbound

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

List of address-based firewall rules.

get

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

Description copied from interface: Inbound

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

Specified by:

get in interface Inbound

Parameters:

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

get

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

Description copied from interface: Inbound

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

Specified by:

get in interface Inbound

Parameters:

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

invocationConfig - Configuration for the method invocation.