Firewall class

The Firewall class represents a virtual firewall.

Firewall class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/Firewall/guid

Retrieves a Firewall object.

search

POST

csm/Firewall/search

Searches for Firewall objects.

Operation APIs

Name

HTTP
method

URI

Description

replaceRulesForIP

POST

csm/Firewall/guid/replaceRulesForIP

Replaces the firewall rules for an IP address.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/Firewall/guid/networkContainer

Retrieves the networkContainer relationship.

relation

GET

csm/Firewall/guid/networkInterface

Retrieves the networkInterface relationship.

relation

GET

csm/Firewall/guid/rules

Retrieves the rules relationship.

relation

GET

csm/Firewall/guid/zone

Retrieves the zone relationship.

relation

GET

csm/Firewall/guid/logicalPerimeterFirewall

Retrieves the logicalPerimeterFirewall relationship.

relation

GET

csm/Firewall/guid/tickets

Retrieves the tickets relationship.

relation

GET

csm/Firewall/guid/provider

Retrieves the provider relationship.

relation

GET

csm/Firewall/guid/tags

Retrieves the tags relationship.

Firewall class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

networkContainer

NetworkContainer

1

Network container bounded by the firewall

networkInterface

FirewallNetworkInterface

0..*

Network interfaces via which the firewall can be accessed

rules

FirewallRule

0..*

zone

Zone

1

logicalPerimeterFirewall

LogicalPerimeterFirewall

0..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

isEnabled

Boolean

1

Indicates whether the firewall is enabled

isLocked

Boolean

0..1

isManuallyEnableable

Boolean

0..1

Indicates whether the firewall is enabled

isTemplate

Boolean

1

Indicates whether the firewall is a template

lastUpdatedToken

String

0..1

Last token updated. It is used to determine whether the copy of the object held by the client is the same as the current persisted copy.

isOnboarded

Boolean

1

Indicates whether the object is onboarded

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