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 | URI | Description |
|---|---|---|---|
get | GET | Retrieves a Firewall object. | |
search | POST | Searches for Firewall objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
replaceRulesForIP | POST | Replaces the firewall rules for an IP address. |
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the networkContainer relationship. | |
relation | GET | Retrieves the networkInterface relationship. | |
relation | GET | Retrieves the rules relationship. | |
relation | GET | Retrieves the zone relationship. | |
relation | GET | Retrieves the logicalPerimeterFirewall relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | 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- | Description |
|---|---|---|---|
networkContainer | 1 | Network container bounded by the firewall | |
networkInterface | 0..* | Network interfaces via which the firewall can be accessed | |
rules | 0..* |
| |
zone | 1 |
| |
logicalPerimeterFirewall | 0..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- | 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 | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |