Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

LogicalPerimeterFirewallInterface class


The LogicalPerimeterFirewallInterface class represents a logical perimeter firewall interface. Inbound and outbound firewall rules may be configured on it.

LogicalPerimeterFirewallInterface class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the LogicalPerimeterFirewallInterface class.

Basic APIs

Name

HTTP
method

URI

Description

get

GET

Retrieves a LogicalPerimeterFirewallInterface object.

search

POST

Searches for LogicalPerimeterFirewallInterface objects.

Operation APIs

Name

HTTP
method

URI

Description

replaceInboundRules

POST

This API replaces the existing set of inbound firewall rules on the interface with the newly provided set of LogicalFirewallRule objects.
The replaceInboundRules API may only be used within the context of a LogicalHostingEnvironment lock. Locking the LogicalHostingEnvironment object prevents concurrent updates to the same firewalls or rules. The API usage pattern should be as follows :
 Acquire a lock ID using the LogicalHostingEnvironment acquireLock API.
 Use the lock ID to make the replaceInboundRules API call.
 Release the LogicalHostingEnvironment lock.


replaceOutboundRules

POST

This API replaces the existing set of outbound firewall rules on the interface with the newly provided set of LogicalFirewallRule objects.
The replaceOutboundRules API may only be used within the context of a LogicalHostingEnvironment lock. Locking the LogicalHostingEnvironment object prevents concurrent updates to the same firewalls or rules. The API usage pattern should be as follows :
 Acquire a lock ID using the LogicalHostingEnvironment acquireLock API.
 Use the lock ID to make the replaceOutboundRules API call.
 Release the LogicalHostingEnvironment lock.


replaceRules

POST

This API replaces the existing set of firewall rules on the interface with the newly provided set of LogicalFirewallRule objects.
 The replaceRules API may only be used within the context of a LogicalHostingEnvironment lock. Locking the LogicalHostingEnvironment object prevents concurrent updates to the same firewalls or rules. The API usage pattern should be as follows :
 Acquire a lock ID using the LogicalHostingEnvironment acquireLock API.
 Use the lock ID to make the replaceRules API call.
 Release the LogicalHostingEnvironment lock.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

Retrieves the logicalFirewall relationship.

relation

GET

Retrieves the logicalFirewallRule relationship.

relation

GET

Retrieves the logicalNetwork relationship.

relation

GET

Retrieves the resourceNetworkInterface relationship.

relation

GET

Retrieves the tickets relationship.

relation

GET

Retrieves the provider relationship.

relation

GET

Retrieves the tags relationship.

LogicalPerimeterFirewallInterface class relationships and attributes

The following tables list the relationships and attributes of the LogicalPerimeterFirewallInterface class.

Relationships

Name

Type

Multi-
plicity

Description

logicalFirewall

0..1

 

logicalFirewallRule

0..*

 

logicalNetwork

0..*

 

resourceNetworkInterface

1..*

 

tickets

0..*

 

cloudClass

1

Fully-qualified name of the class to which the object belongs

provider

1

Provider that created the object

tags

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

Description

lastUpdatedInbound
String

0..1

lastUpdatedInbound is used to store the latest token used to update/read the inbound firewall rules

lastUpdatedOutbound
String

0..1

lastUpdatedOutbound is used to store the latest token used to update/read the outbound firewall rules

isEnabled
Boolean

0..1

 

isTemplate
Boolean

0..1

 

supportedRuleDirection

0..1

 

externalID
String

0..1

Identifier used for the object by an external provider

owner
String

0..1

Name of the owner of the object

reconciliationID
String

0..1

Reconciliation identity value for the object from the BMC Atrium CMDB

tokenID
String

0..1

Token identifier

description
String

0..1

Text that describes the object

guid
String

1

Globally unique identifier for the object

labels
String

0..*

 

modifiedDate

0..1

Date the Cloudobject was modified

name
String

1

Human-readable name of the object

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*