org.openstack4j.model.network.ext

Interface FirewallRule

All Superinterfaces:

Buildable<FirewallRuleBuilder>, ModelEntity, Serializable

All Known Implementing Classes:

NeutronFirewallRule

public interface FirewallRule
extends ModelEntity, Buildable<FirewallRuleBuilder>

Networking (Neutron) FwaaS Firewall Rule Extension API

Represents a collection of attributes like ports, ip addresses which define match criteria and action (allow, or deny) that needs to be taken on the matched data traffic.

Author:

Vishvesh Deshmukh

Nested Class Summary

Nested classes/interfaces inherited from interface org.openstack4j.common.Buildable

Buildable.Builder<T extends Buildable.Builder<T,M>,M extends Buildable<?>>

Method Summary

Modifier and Type	Method and Description
NeutronFirewallRule.FirewallRuleAction	getAction()
String	getDescription()
String	getDestinationIpAddress()
String	getDestinationPort()
String	getId()
IPVersionType	getIpVersion()
String	getName()
String	getPolicy()
Integer	getPosition()
NeutronFirewallRule.IPProtocol	getProtocol()
String	getSourceIpAddress()
String	getSourcePort()
String	getTenantId()
Boolean	isEnabled()
Boolean	isShared()

Methods inherited from interface org.openstack4j.common.Buildable

toBuilder

Method Detail

getId

String getId()

Returns:

id : Unique identifier for the firewall rule object.

getName

String getName()

Returns:

name : Human readable name for the firewall rule (255 characters limit). Does not have to be unique.

getTenantId

String getTenantId()

Returns:

tenantId : Owner of the Firewall Rule. Only an administrative user can specify a tenant ID other than its own.

getDescription

String getDescription()

Returns:

description : Human readable description for the firewall rule (1024 characters limit).

getPolicy

String getPolicy()

Returns:

policyid : This is a read-only attribute which gets populated with the uuid of the firewall policy when this firewall rule is associated with a firewall policy. A firewall rule can be associated with one firewall policy at a time. The association can however be updated to a different firewall policy. This attribute can be null if the rule is not associated with any firewall policy.

isShared

Boolean isShared()

Returns:

shared : When set to True makes this firewall rule visible to tenants other than its owner, and can be used in firewall policies not owned by its tenant.

getProtocol

NeutronFirewallRule.IPProtocol getProtocol()

Returns:

protocol : IP Protocol : Possible values are ICMP/TCP/UDP/NONE(ANY).

See Also:

NeutronFirewallRule.IPProtocol

getIpVersion

IPVersionType getIpVersion()

Returns:

ipVersion : IP Protocol Version : Possible values are 4/6.

See Also:

IPVersionType

getSourceIpAddress

String getSourceIpAddress()

Returns:

sourceIpAddress or CIDR : Valid IP address (v4 or v6), or CIDR.

getDestinationIpAddress

String getDestinationIpAddress()

Returns:

destinationIpAddress or CIDR : Valid IP address (v4 or v6), or CIDR.

getSourcePort

String getSourcePort()

Returns:

sourcePort : Valid port number (integer or string), or port range in the format of a ':' separated range). In the case of port range, both ends of the range are included.

getDestinationPort

String getDestinationPort()

Returns:

destinationPort : Valid port number (integer or string), or port range in the format of a ':' separated range). In the case of port range, both ends of the range are included.

getPosition

Integer getPosition()

Returns:

position : This is a read-only attribute that gets assigned to this rule when the rule is associated with a firewall policy. It indicates the position of this rule in that firewall policy. This position number starts at 1. The position can be null if the firewall rule is not associated with any policy.

getAction

NeutronFirewallRule.FirewallRuleAction getAction()

Returns:

action : Action to be performed on the traffic matching the rule (allow, deny).

See Also:

NeutronFirewallRule.FirewallRuleAction

isEnabled

Boolean isEnabled()

Returns:

enabled : When set to False will disable this rule in the firewall policy. Facilitates selectively turning off rules without having to disassociate the rule from the firewall policy.