This is the multi-page printable view of this section. Click here to print.
CLIs
- 1: Create Firewall Rule
- 1.1: 1.0
- 2: Delete Firewall Rule
- 2.1: 1.0
- 3: List Firewall Rules
- 3.1: 1.0
- 4: List Firewalls
- 4.1: 1.0
- 5: Set Firewall
- 5.1: 1.0
- 6: Set Firewall Rule
- 6.1: 1.0
- 7: Show Firewall
- 7.1: 1.0
- 8: Show Firewall Rule
- 8.1: 1.0
1 - Create Firewall Rule
1.1 - 1.0
scpcli firewall firewall-rule create
--status <value>
--source_address <value>
--service <value>
--direction <value>
--destination_address <value>
--action <value>
--firewall_id <value>
[--description <value>]
[--order_direction <value>]
[--order_rule_id <value>]
Description
Create firewall rule.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| status required | string | Firewall Rule Status | - |
| source_address required | array | Source Address | 192.168.1.1 |
| service required | array | Service Port | '{"service_type": "TCP", "service_value": "443"}' |
| direction required | string | Firewall Rule Direction | - |
| destination_address required | array | Destination Address | 10.0.0.1 |
| action required | string | Firewall Rule Action | - |
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| description optional | string | Firewall Rule Description | Firewall rule description example |
| order_direction optional | string | Order Direction | - |
| order_rule_id optional | string | Order Rule ID | 043aa63459da466faad71fe4fe587031 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
| action | Firewall Rule Action | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall Rule Description | Firewall rule description example |
| destination_address | Destination Address | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | Destination Interface Name | IFW1-v1001dn |
| direction | Firewall Rule Direction | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall Rule Name | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall Rule Sequence | 100 |
| service | Service Port | |
| source_address | Source Address | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | Source Interface Name | IFW1-v2501up |
| state | Firewall Rule State | |
| status | Firewall Rule Status | |
| vendor_rule_id | Vendor Rule ID | 72 |
2 - Delete Firewall Rule
2.1 - 1.0
scpcli firewall firewall-rule delete
--firewall_rule_id <value>
Description
Delete firewall rule.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_rule_id required | string | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
3 - List Firewall Rules
3.1 - 1.0
scpcli firewall firewall-rule list
--firewall_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--src_ip <value>]
[--dst_ip <value>]
[--description <value>]
[--state <value>]
[--status <value>]
[--fetch_all <value>]
Description
Get firewall rule list.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| src_ip optional | string | Source IP | 192.168.1.1 |
| dst_ip optional | string | Destination IP | 192.168.1.1 |
| description optional | string | Firewall Rule Description | Firewall rule description example |
| state optional | array | Firewall Rule State | - |
| status optional | **** | Firewall Rule Status | - |
| fetch_all optional | boolean | Firewall Rule Fetch ALL | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
| action | Firewall Rule Action | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall Rule Description | Firewall rule description example |
| destination_address | Destination Address | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | Destination Interface Name | IFW1-v1001dn |
| direction | Firewall Rule Direction | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall Rule Name | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall Rule Sequence | 100 |
| service | Service Port | |
| source_address | Source Address | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | Source Interface Name | IFW1-v2501up |
| state | Firewall Rule State | |
| status | Firewall Rule Status | |
| vendor_rule_id | Vendor Rule ID | 72 |
4 - List Firewalls
4.1 - 1.0
scpcli firewall firewall list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpc_name <value>]
[--product_type <value>]
[--state <value>]
Description
Get firewall list.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Firewall Name | FW_IGW_secuVPC |
| vpc_name optional | string | VPC Name | secuVPC |
| product_type optional | array | Firewall Product Type | - |
| state optional | array | Firewall State | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| flavor_name | Firewall Size Name | SMALL |
| flavor_rule_quota | Firewall Rule Quota | 100 |
| fw_resource_id | Fw Resource ID | 005fd1d30dea11f08a2c56773bef875b |
| loggable | Logging Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall Name | FW_IGW_secuVPC |
| pre_product_id | Pre Product ID | 76479b7ffee1431198d9beb4502cda08 |
| product_type | Firewall Product Type | |
| state | Firewall State | |
| status | Firewall Status | |
| total_rule_count | Total Rule Count | 8 |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | secuVPC |
5 - Set Firewall
5.1 - 1.0
scpcli firewall firewall set
--firewall_id <value>
[--flavor_name <value>]
[--loggable <value>]
Description
Set firewall.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| flavor_name optional | string | Firewall Size Name | - |
| loggable optional | boolean | Logging Use | False |
6 - Set Firewall Rule
6.1 - 1.0
scpcli firewall firewall-rule set
--firewall_rule_id <value>
--source_address <value>
--service <value>
--direction <value>
--destination_address <value>
--action <value>
[--description <value>]
Description
Set firewall rule.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_rule_id required | string | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
| source_address required | array | Source Address | 192.168.1.1 |
| service required | array | Service Port | '{"service_type": "TCP", "service_value": "443"}' |
| direction required | string | Firewall Rule Direction | - |
| destination_address required | array | Destination Address | 10.0.0.1 |
| action required | string | Firewall Rule Action | - |
| description optional | string | Firewall Rule Description | Firewall rule description example |
7 - Show Firewall
7.1 - 1.0
scpcli firewall firewall show
--firewall_id <value>
Description
Show firewall.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| flavor_name | Firewall Size Name | SMALL |
| flavor_rule_quota | Firewall Rule Quota | 100 |
| fw_resource_id | Fw Resource ID | 005fd1d30dea11f08a2c56773bef875b |
| loggable | Logging Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall Name | FW_IGW_secuVPC |
| pre_product_id | Pre Product ID | 76479b7ffee1431198d9beb4502cda08 |
| product_type | Firewall Product Type | |
| state | Firewall State | |
| status | Firewall Status | |
| total_rule_count | Total Rule Count | 8 |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | secuVPC |
8 - Show Firewall Rule
8.1 - 1.0
scpcli firewall firewall-rule show
--firewall_rule_id <value>
Description
Show firewall rule.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_rule_id required | string | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
| action | Firewall Rule Action | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall Rule Description | Firewall rule description example |
| destination_address | Destination Address | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | Destination Interface Name | IFW1-v1001dn |
| direction | Firewall Rule Direction | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall Rule Name | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall Rule Sequence | 100 |
| service | Service Port | |
| source_address | Source Address | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | Source Interface Name | IFW1-v2501up |
| state | Firewall Rule State | |
| status | Firewall Rule Status | |
| vendor_rule_id | Vendor Rule ID | 72 |