FirewallNetworkInterface class

The FirewallNetworkInterface class represents a firewall network interface.

FirewallNetworkInterface class APIs

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

Basic APIs

Name	HTTP method	URI	Description
get	`GET`	`csm/FirewallNetworkInterface/guid`	Retrieves a `FirewallNetworkInterface` object.
search	`POST`	`csm/FirewallNetworkInterface/search`	Searches for `FirewallNetworkInterface` objects.

Operation APIs

Name	HTTP method	URI	Description
replaceInboundRules	`POST`	`csm/FirewallNetworkInterface/guid/replaceInboundRules`	Replaces inbound rules for a firewall network interface.
replaceOutboundRules	`POST`	`csm/FirewallNetworkInterface/guid/replaceOutboundRules`	Replaces outbound rules for a firewall network interface.

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/FirewallNetworkInterface/guid/firewall`	Retrieves the `firewall` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/inboundFirewallRule`	Retrieves the `inboundFirewallRule` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/outboundFirewallRule`	Retrieves the `outboundFirewallRule` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/computeContainer`	Retrieves the `computeContainer` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/destinationNetworkPath`	Retrieves the `destinationNetworkPath` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/host`	Retrieves the `host` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/ipAddresses`	Retrieves the `ipAddresses` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/network`	Retrieves the `network` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/sourceNetworkPath`	Retrieves the `sourceNetworkPath` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/zone`	Retrieves the `zone` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/computeContainerNetworkInterface`	Retrieves the `computeContainerNetworkInterface` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/loadBalancingServiceNetworkInterface`	Retrieves the `loadBalancingServiceNetworkInterface` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/logicalFirewallInterface`	Retrieves the `logicalFirewallInterface` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/logicalLoadBalancerInterface`	Retrieves the `logicalLoadBalancerInterface` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/resourceNetwork`	Retrieves the `resourceNetwork` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/tickets`	Retrieves the `tickets` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/FirewallNetworkInterface/guid/tags`	Retrieves the `tags` relationship.

FirewallNetworkInterface class relationships and attributes

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

Relationships

Name	Type	Multi- plicity	Description
`firewall`	`Firewall`	0..1	Firewall via which the firewall network interface is accessed
`inboundFirewallRule`	`InboundFirewallRule`	0..*	Inbound rules associated with the firewall
`outboundFirewallRule`	`OutboundFirewallRule`	0..*	Outbound rules associated with the firewall
`computeContainer`	`ComputeContainer`	0..1	Associated compute container
`destinationNetworkPath`	`NetworkPath`	0..*	Associated destination network path
`host`	`Server`	1	Server access via the NIC
`ipAddresses`	`IPAddress`	1..*	IP addresses assigned to the NIC
`network`	`Network`	1..*	Associated network
`sourceNetworkPath`	`NetworkPath`	0..*	Associated source network path
`zone`	`Zone`	1	Associated zone
`computeContainerNetworkInterface`	`ComputeContainerNetworkInterface`	0..*	Realized compute container network interfaces
`loadBalancingServiceNetworkInterface`	`LoadBalancingServiceNetworkInterface`	0..*	Realized load balancing service network interfaces
`logicalFirewallInterface`	`LogicalFirewallInterface`	0..1
`logicalLoadBalancerInterface`	`LogicalLoadBalancerInterface`	1
`resourceNetwork`	`ResourceNetwork`	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 network interface is enabled
`isTemplate`	`Boolean`	1	Indicates whether the firewall network interface is a template
`isDHCP`	`Boolean`	1	Indicates whether the interface uses DHCP
`isPublicIP`	`Boolean`	0..1
`lanID`	`String`	1	Local area network identifier
`macAddress`	`String`	0..1	MAC Address
`networkLabel`	`String`	1	Network label
`nicNumber`	`Integer`	1	Network interface card number
`switch`	`String`	0..1	Switch
`switchPort`	`String`	0..1	Switch port
`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