LogicalDistributedFirewallInterface class

The LogicalDistributedFirewallInterface class represents a logical distributed firewall.

LogicalDistributedFirewallInterface class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/LogicalDistributedFirewallInterface/guid

Retrieves a LogicalDistributedFirewallInterface object.

search

POST

csm/LogicalDistributedFirewallInterface/search

Searches for LogicalDistributedFirewallInterface objects.

Operation APIs

Name

HTTP
method

URI

Description

replaceInboundRules

POST

csm/LogicalDistributedFirewallInterface/guid/replaceInboundRules

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

csm/LogicalDistributedFirewallInterface/guid/replaceOutboundRules

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

csm/LogicalDistributedFirewallInterface/guid/replaceRules

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

csm/LogicalDistributedFirewallInterface/guid/logicalFirewall

Retrieves the logicalFirewall relationship.

relation

GET

csm/LogicalDistributedFirewallInterface/guid/logicalFirewallRule

Retrieves the logicalFirewallRule relationship.

relation

GET

csm/LogicalDistributedFirewallInterface/guid/logicalNetwork

Retrieves the logicalNetwork relationship.

relation

GET

csm/LogicalDistributedFirewallInterface/guid/resourceNetworkInterface

Retrieves the resourceNetworkInterface relationship.

relation

GET

csm/LogicalDistributedFirewallInterface/guid/tickets

Retrieves the tickets relationship.

relation

GET

csm/LogicalDistributedFirewallInterface/guid/provider

Retrieves the provider relationship.

relation

GET

csm/LogicalDistributedFirewallInterface/guid/tags

Retrieves the tags relationship.

LogicalDistributedFirewallInterface class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

logicalFirewall

LogicalFirewall

0..1

logicalFirewallRule

LogicalFirewallRule

0..*

logicalNetwork

LogicalNetwork

0..*

resourceNetworkInterface

ResourceNetworkInterface

1..*

tickets

Ticket

0..*

cloudClass

CloudClass

1

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

provider

Provider

1

Provider that created the object

tags

Tag

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

Description

lastUpdated

String

0..1

securedEntityId

String

0..*

isEnabled

Boolean

0..1

isTemplate

Boolean

0..1

supportedRuleDirection

RuleDirection

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

Date

0..1

Date the Cloudobject was modified

name

String

1

Human-readable name of the object

Was this page helpful? Yes No Submitting... Thank you

Comments