This is the multi-page printable view of this section. Click here to print.
Create Security Group Rule
1 - 1.1
scp-cli security-group security-group-rule create
--security_group_id <value>
--direction <value>
[--description <value>]
[--ethertype <value>]
[--port_range_max <value>]
[--port_range_min <value>]
[--protocol <value>]
[--remote_address_group_id <value>]
[--remote_group_id <value>]
[--remote_ip_prefix <value>]
Description
Create Security Group rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_id required | string | Security Group ID | 06e5d676-f330-485a-94e9-47ac91cce09a |
| direction required | string | Security Group Rule Direction (Ingress, Egress) | Ingress |
| description optional | string | Security Group Rule Description | Example Description for Security Group Rule |
| ethertype optional | string | Security Group Rule Ethertype (IPV4) | IPv4 |
| port_range_max optional | integer | Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None | 22 |
| port_range_min optional | integer | Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None | 22 |
| protocol optional | string | Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254) | TCP |
| remote_address_group_id optional | string | Security Group Rule Address Group ID | 4b18494930bf4c5dbb97a9eb2ef68fe1 |
| remote_group_id optional | string | Security Group Rule Remote Group ID | 06e5d676-f330-485a-94e9-47ac91cce09a |
| remote_ip_prefix optional | string | Security Group Rule Remote IP Address | 1.1.1.1/32 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group Rule ID | 10d8250e-f4eb-453a-96af-b50b5b514a1a |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group Rule Description | Example Description for Security Group Rule |
| direction | Security Group Rule Direction (Ingress, Egress) | Ingress |
| ethertype | Security Group Rule Ethertype (IPV4) | IPv4 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| port_range_max | Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None | 22 |
| port_range_min | Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None | 22 |
| protocol | Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254) | TCP |
| remote_address_group_id | Address Group ID | 4b18494930bf4c5dbb97a9eb2ef68fe1 |
| remote_address_group_name | Address Group Name | ExampleAG1 |
| remote_group_id | Security Group Rule Remote Group ID | 06e5d676-f330-485a-94e9-47ac91cce09a |
| remote_group_name | Security Group Rule Remote Group Name | ExampleSG2 |
| remote_ip_prefix | Security Group Rule Remote IP Address | 1.1.1.1/32 |
| security_group_id | Security Group ID | 06e5d676-f330-485a-94e9-47ac91cce09a |
2 - 1.0
scp-cli security-group security-group-rule create
--security_group_id <value>
--direction <value>
[--description <value>]
[--ethertype <value>]
[--port_range_max <value>]
[--port_range_min <value>]
[--protocol <value>]
[--remote_group_id <value>]
[--remote_ip_prefix <value>]
Description
Create Security Group rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_id required | string | Security Group ID | 06e5d676-f330-485a-94e9-47ac91cce09a |
| direction required | string | Security Group Rule Direction (Ingress, Egress) | Ingress |
| description optional | string | Security Group Rule Description | Example Description for Security Group Rule |
| ethertype optional | string | Security Group Rule Ethertype (IPV4) | IPv4 |
| port_range_max optional | integer | Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None | 22 |
| port_range_min optional | integer | Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None | 22 |
| protocol optional | string | Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254) | TCP |
| remote_group_id optional | string | Security Group Rule Remote Group ID | 06e5d676-f330-485a-94e9-47ac91cce09a |
| remote_ip_prefix optional | string | Security Group Rule Remote IP Address | 1.1.1.1/32 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group Rule ID | 10d8250e-f4eb-453a-96af-b50b5b514a1a |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group Rule Description | Example Description for Security Group Rule |
| direction | Security Group Rule Direction (Ingress, Egress) | Ingress |
| ethertype | Security Group Rule Ethertype (IPV4) | IPv4 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| port_range_max | Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None | 22 |
| port_range_min | Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None | 22 |
| protocol | Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254) | TCP |
| remote_group_id | Security Group Rule Remote Group ID | 06e5d676-f330-485a-94e9-47ac91cce09a |
| remote_group_name | Security Group Rule Remote Group Name | ExampleSG2 |
| remote_ip_prefix | Security Group Rule Remote IP Address | 1.1.1.1/32 |
| security_group_id | Security Group ID | 06e5d676-f330-485a-94e9-47ac91cce09a |