Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다. 본 가이드는 Firewall 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
Firewall
- 1: CLIs
- 1.1: Create Firewall Rule
- 1.1.1: 1.0
- 1.2: Delete Firewall Rule
- 1.2.1: 1.0
- 1.3: List Firewall Rules
- 1.3.1: 1.0
- 1.4: List Firewalls
- 1.4.1: 1.0
- 1.5: Set Firewall
- 1.5.1: 1.0
- 1.6: Set Firewall Rule
- 1.6.1: 1.0
- 1.7: Show Firewall
- 1.7.1: 1.0
- 1.8: Show Firewall Rule
- 1.8.1: 1.0
1 - CLIs
1.1 - Create Firewall Rule
1.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
firewall rule 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| status required | string | Firewall rule 사용 여부 | - |
| source_address required | array | 출발지 주소 | 192.168.1.1 |
| service required | array | 서비스 포트 | '{"service_type": "TCP", "service_value": "443"}' |
| direction required | string | Firewall rule 방향 | - |
| destination_address required | array | 목적지 주소 | 10.0.0.1 |
| action required | string | Firewall rule 동작 | - |
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| description optional | string | Firewall rule 설명 | Firewall rule description example |
| order_direction optional | string | 순서 방향 | - |
| order_rule_id optional | string | 순서 규칙 ID | 043aa63459da466faad71fe4fe587031 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall rule ID | b156740b6335468d8354eb9ef8eddf5a |
| action | Firewall rule 동작 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall rule 설명 | Firewall rule description example |
| destination_address | 목적지 주소 | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | 목적지 인터페이스 이름 | IFW1-v1001dn |
| direction | Firewall rule 방향 | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall rule 이름 | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall rule 순서 | 100 |
| service | 서비스 포트 | |
| source_address | 출발지 주소 | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | 출발지 인터페이스 이름 | IFW1-v2501up |
| state | Firewall rule 상태 | |
| status | Firewall rule 사용 여부 | |
| vendor_rule_id | 벤더 규칙 ID | 72 |
1.2 - Delete Firewall Rule
1.2.1 - 1.0
scpcli firewall firewall-rule delete
--firewall_rule_id <value>
Description
firewall rule 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_rule_id required | string | Firewall rule ID | b156740b6335468d8354eb9ef8eddf5a |
1.3 - List Firewall Rules
1.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
firewall rule 목록 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 출발지 IP | 192.168.1.1 |
| dst_ip optional | string | 목적지 IP | 192.168.1.1 |
| description optional | string | Firewall rule 설명 | Firewall rule description example |
| state optional | array | Firewall rule 상태 | - |
| status optional | **** | Firewall rule 사용 여부 | - |
| fetch_all optional | boolean | Firewall rule 전체 조회 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall rule ID | b156740b6335468d8354eb9ef8eddf5a |
| action | Firewall rule 동작 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall rule 설명 | Firewall rule description example |
| destination_address | 목적지 주소 | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | 목적지 인터페이스 이름 | IFW1-v1001dn |
| direction | Firewall rule 방향 | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall rule 이름 | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall rule 순서 | 100 |
| service | 서비스 포트 | |
| source_address | 출발지 주소 | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | 출발지 인터페이스 이름 | IFW1-v2501up |
| state | Firewall rule 상태 | |
| status | Firewall rule 사용 여부 | |
| vendor_rule_id | 벤더 규칙 ID | 72 |
1.4 - List Firewalls
1.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
firewall 목록 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 이름 | FW_IGW_secuVPC |
| vpc_name optional | string | VPC 명 | secuVPC |
| product_type optional | array | Firewall 상품 유형 | - |
| state optional | array | Firewall 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| flavor_name | Firewall 사이즈 이름 | SMALL |
| flavor_rule_quota | Firewall 규칙 수 제한 | 100 |
| fw_resource_id | FW 리소스 ID | 005fd1d30dea11f08a2c56773bef875b |
| loggable | 로그 사용 여부 | False |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall 이름 | FW_IGW_secuVPC |
| pre_product_id | 선행 상품 ID | 76479b7ffee1431198d9beb4502cda08 |
| product_type | Firewall 상품 유형 | |
| state | Firewall 상태 | |
| status | Firewall 활성 여부 | |
| total_rule_count | 전체 규칙 개수 | 8 |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | secuVPC |
1.5 - Set Firewall
1.5.1 - 1.0
scpcli firewall firewall set
--firewall_id <value>
[--flavor_name <value>]
[--loggable <value>]
Description
firewall 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| flavor_name optional | string | Firewall 사이즈 이름 | - |
| loggable optional | boolean | 로그 사용 여부 | False |
1.6 - Set Firewall Rule
1.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
firewall rule 수정한다,
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_rule_id required | string | Firewall rule ID | b156740b6335468d8354eb9ef8eddf5a |
| source_address required | array | 출발지 주소 | 192.168.1.1 |
| service required | array | 서비스 포트 | '{"service_type": "TCP", "service_value": "443"}' |
| direction required | string | Firewall rule 방향 | - |
| destination_address required | array | 목적지 주소 | 10.0.0.1 |
| action required | string | Firewall rule 동작 | - |
| description optional | string | Firewall rule 설명 | Firewall rule description example |
1.7 - Show Firewall
1.7.1 - 1.0
scpcli firewall firewall show
--firewall_id <value>
Description
firewall 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| flavor_name | Firewall 사이즈 이름 | SMALL |
| flavor_rule_quota | Firewall 규칙 수 제한 | 100 |
| fw_resource_id | FW 리소스 ID | 005fd1d30dea11f08a2c56773bef875b |
| loggable | 로그 사용 여부 | False |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall 이름 | FW_IGW_secuVPC |
| pre_product_id | 선행 상품 ID | 76479b7ffee1431198d9beb4502cda08 |
| product_type | Firewall 상품 유형 | |
| state | Firewall 상태 | |
| status | Firewall 활성 여부 | |
| total_rule_count | 전체 규칙 개수 | 8 |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | secuVPC |
1.8 - Show Firewall Rule
1.8.1 - 1.0
scpcli firewall firewall-rule show
--firewall_rule_id <value>
Description
firewall rule 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 동작 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall rule 설명 | Firewall rule description example |
| destination_address | 목적지 주소 | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | 목적지 인터페이스 이름 | IFW1-v1001dn |
| direction | Firewall rule 방향 | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall rule 이름 | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall rule 순서 | 100 |
| service | 서비스 포트 | |
| source_address | 출발지 주소 | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | 출발지 인터페이스 이름 | IFW1-v2501up |
| state | Firewall rule 상태 | |
| status | Firewall rule 사용 여부 | |
| vendor_rule_id | 벤더 규칙 ID | 72 |