Firewall Profiles

Contents

Firewall Profiles

A firewall is a device or set of devices designed to allow or deny network transmissions based upon a set of rules and is frequently used to protect networks from unauthorized access while permitting legitimate communications to pass. Firewall profiles represent these sets of rules and allow their application to a set of servers.

List firewall profiles

GET /v3/network/firewall_profiles

This action provides information about the existing firewall profiles.

Inputs

None

Returns

An array of firewall profiles with the following fields:

Field Type Description
id String Identifier of the firewall profile.
name String Logical name of the firewall profile.
description String Description of the firewall profile.
default Boolean Flag indicating whether the firewall profile is the default firewall profile for the user account.
rules Array of Objects Set of rules of the firewall profile, each rule having the following fields:A string name, specifying a logical name for the rule.A string protocol, specifying the protocol whose traffic is opened by the rule (TCP or UDP).An integer min_port, specifying where the port interval opened by the rule starts.An integer max_port, specifying where the port interval opened by the rule ends.A string source, specifying with the CIDR format to which network the rule opens to traffic.
resource_type String An identifier for the type of resource, specifically "firewall_profile".
label_ids Array of Strings List of ids corresponding to the labels the firewall profile has assigned.

Back to top

Show firewall profile

GET /v3/network/firewall_profiles/:id

This action provides information about the firewall profile identified by the given id.

Inputs

None

Returns

Field Type Description
id String Identifier of the firewall profile.
name String Logical name of the firewall profile.
description String Description of the firewall profile.
default Boolean Flag indicating whether the firewall profile is the default firewall profile for the user account.
rules Array of Objects Set of rules of the firewall profile, each rule having the following fields:A string name, specifying a logical name for the rule.A string protocol, specifying the protocol whose traffic is opened by the rule (TCP or UDP).An integer min_port, specifying where the port interval opened by the rule starts.An integer max_port, specifying where the port interval opened by the rule ends.A string source, specifying with the CIDR format to which network the rule opens to traffic.
resource_type String An identifier for the type of resource, specifically "firewall_profile".
label_ids Array of Strings List of ids corresponding to the labels the firewall profile has assigned.

Back to top

Create a firewall profile

POST /v3/network/firewall_profiles

This action creates a firewall profile with the given parameters.

Inputs

Field Type Description Required
name String Logical name of the firewall profile. Yes
description String Description of the firewall profile. No
rules Array of Objects Set of rules of the firewall profile, each rule having the following fields:A string name, specifying a logical name for the rule.A string protocol, specifying the protocol whose traffic is opened by the rule (TCP or UDP).An integer min_port, specifying where the port interval opened by the rule starts.An integer max_port, specifying where the port interval opened by the rule ends.A string source, specifying with the CIDR format to which network the rule opens to traffic. No, but if any rule is specified, all its fields are required except for the name.
label_ids Array of Strings List of ids corresponding to the labels to assign to the firewall profile.  

Returns

Field Type Description
id String Identifier of the firewall profile.
name String Logical name of the firewall profile.
description String Description of the firewall profile.
default Boolean Flag indicating whether the firewall profile is the default firewall profile for the user account.
rules Array of Objects Set of rules of the firewall profile, each rule having the following fields:A string name, specifying a logical name for the rule.A string protocol, specifying the protocol whose traffic is opened by the rule (TCP or UDP).An integer min_port, specifying where the port interval opened by the rule starts.An integer max_port, specifying where the port interval opened by the rule ends.A string source, specifying with the CIDR format to which network the rule opens to traffic.
resource_type String An identifier for the type of resource, specifically "firewall_profile".
label_ids Array of Strings List of ids corresponding to the labels the firewall profile has assigned.

Back to top

Update firewall profile

PUT /v3/network/firewall_profiles/:id

This action updates the firewall profile identified by the given id with the given parameters.

Inputs

Field Type Description Required
name String Logical name of the firewall profile. No
description String Description of the firewall profile. No
rules Array of Objects Set of rules of the firewall profile, each rule having the following fields:A string name, specifying a logical name for the rule.A string protocol, specifying the protocol whose traffic is opened by the rule (TCP or UDP).An integer min_port, specifying where the port interval opened by the rule starts.An integer max_port, specifying where the port interval opened by the rule ends.A string source, specifying with the CIDR format to which network the rule opens to traffic. No, but if any rule is specified, all its fields are required except for the name.

Returns

Field Type Description
id String Identifier of the firewall profile.
name String Logical name of the firewall profile.
description String Description of the firewall profile.
default Boolean Flag indicating whether the firewall profile is the default firewall profile for the user account.
rules Array of Objects Set of rules of the firewall profile, each rule having the following fields:A string name, specifying a logical name for the rule.A string protocol, specifying the protocol whose traffic is opened by the rule (TCP or UDP).An integer min_port, specifying where the port interval opened by the rule starts.An integer max_port, specifying where the port interval opened by the rule ends.A string source, specifying with the CIDR format to which network the rule opens to traffic.
resource_type String An identifier for the type of resource, specifically "firewall_profile".
label_ids Array of Strings List of ids corresponding to the labels the firewall profile has assigned.

Back to top

Destroy firewall profile

DELETE /v3/network/firewall_profiles/:id

This action destroys the firewall profile identified by the given id.

Inputs

None

Returns

None

Back to top

Syncronize firewall profile

PUT /v3/network/firewall_profiles/:id/synchronize

This action synchronizes the firewall profile identified by the given id in the cloud provider. The firewall profile must be in an inconsistent state.

Inputs

None

Returns

None

Back to top

Discard firewall profile

DELETE /v3/network/firewall_profiles/:id/discard

This action discards the firewall profile identified by the given id from IMCO. The firewall profile must be in an inconsistent decommission state.

Inputs

None

Returns

None

Back to top