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.

InboundFirewallRule class

The InboundFirewallRule class represents an inbound firewall rule.

InboundFirewallRule class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/InboundFirewallRule/guid

Retrieves a InboundFirewallRule object.

search

POST

csm/InboundFirewallRule/search

Searches for InboundFirewallRule objects.

Operation APIs

The InboundFirewallRule class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/InboundFirewallRule/guid/firewallNetworkInterface

Retrieves the firewallNetworkInterface relationship.

relation

GET

csm/InboundFirewallRule/guid/firewall

Retrieves the firewall relationship.

relation

GET

csm/InboundFirewallRule/guid/logicalSimpleFirewallRule

Retrieves the logicalSimpleFirewallRule relationship.

relation

GET

csm/InboundFirewallRule/guid/provider

Retrieves the provider relationship.

relation

GET

csm/InboundFirewallRule/guid/tags

Retrieves the tags relationship.

InboundFirewallRule class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

firewallNetworkInterface

FirewallNetworkInterface

0..1

Firewall that owns the inbound rule

firewall

Firewall

1

logicalSimpleFirewallRule

LogicalSimpleFirewallRule

0..1

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

accept

Boolean

1

Indicates whether the rule permits traffic

creationSource

SecurityRuleSourceType

1

destinationAddress

String

0..1

If the rule applies to a destination host, specifies its address

destinationMask

String

0..1

If the rule applies to a destination network, specifies its mask

destinationNetworkAddress

String

0..1

If the rule applies to a destination network, specifies its address

destinationPort

Integer

0..1

Destination port number

destinationPortRange

String

0..1

Destination port range

enabled

Boolean

0..1

Indicates whether the firewall rule is enabled

isHidden

Boolean

1

Indicates whether the rule permits traffic

isLocked

Boolean

1

isLogged

Boolean

1

Indicates whether the rule permits traffic

protocol

Integer

0..1

Identifier of the protocol subject to the firewall rule. For example, the identifier for TCP is 6. To find other protocol numbers, see registry of assigned Internet protocol numbers

sequence

Integer

0..1

Sequence number

sourceAddress

String

0..1

If the rule applies to a source host, specifies its address

sourceMask

String

0..1

If the rule applies to a source network, specifies its mask.

sourceNetworkAddress

String

0..1

If the rule applies to a source network, specifies its address.

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

name

String

1

Human-readable name of the object

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.

Comments