This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

CLIs

1: Create Security Group

1.1: 1.0

2: Create Security Group Rule

2.1: 1.0

3: Delete Security Group

3.1: 1.0

4: Delete Security Group Rule

4.1: 1.0

5: List Security Group Rules

5.1: 1.0

6: List Security Groups

6.1: 1.0

7: Set Security Group

7.1: 1.0

8: Show Security Group

8.1: 1.0

9: Show Security Group Rule

9.1: 1.0

1 - Create Security Group

1.1 - 1.0

scpcli security-group security-group create
--name <value>
[--description <value>]
[--loggable <value>]
[--tags <value>]

Description

Create Security Group.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
name required	string	Security Group Name	-
description optional	string	Security Group Description	-
loggable optional	boolean	Security Group Loggable	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Security Group ID
account_id	Security Group Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Description
loggable	Security Group Loggable
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Security Group Name
rule_count	Security Group Rule Count
state	Security Group State

2 - Create Security Group Rule

2.1 - 1.0

scpcli 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 (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	-
direction required	string	Security Group Rule Direction (Ingress, Egress)	-
description optional	string	Security Group Rule Description	-
ethertype optional	string	Security Group Rule Ethertype (IPV4, IPV6)	-
port_range_max optional	integer	Security Group Rule Port Range Max	-
port_range_min optional	integer	Security Group Rule Port Range Min	-
protocol optional	string	Security Group Rule Protocol	-
remote_group_id optional	string	Security Group Rule Remote Group ID	-
remote_ip_prefix optional	string	Security Group Rule Remote IP Address	-

Responses

Name	Description	Example
id	Security Group Rule ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Rule Description
direction	Security Group Rule Direction (Ingress, Egress)
ethertype	Security Group Rule Ethertype (IPV4, IPV6)
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
port_range_max	Security Group Rule Port Range Max
port_range_min	Security Group Rule Port Range Min
protocol	Security Group Rule Protocol
remote_group_id	Security Group Rule Remote Group ID
remote_group_name	Security Group Rule Remote Group Name
remote_ip_prefix	Security Group Rule Remote IP Address
security_group_id	Security Group ID

3 - Delete Security Group

3.1 - 1.0

scpcli security-group security-group delete
--security_group_id <value>

Description

Delete Security Group.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	-

4 - Delete Security Group Rule

4.1 - 1.0

scpcli security-group security-group-rule delete
--security_group_rule_id <value>

Description

Delete Security Group rule.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
security_group_rule_id required	string	Security Group Rule ID	-

5 - List Security Group Rules

5.1 - 1.0

scpcli security-group security-group-rule list
--security_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--remote_ip_prefix <value>]
[--remote_group_id <value>]
[--description <value>]
[--direction <value>]
[--service <value>]

Description

Get Security Group rule list.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Security Group Rule ID	-
remote_ip_prefix optional	string	Security Group Rule Remote IP Address	-
remote_group_id optional	string	Security Group Rule Remote Group ID	-
description optional	string	Security Group Rule Description	-
direction optional	string	Security Group Rule Direction (Ingress, Egress)	-
service optional	string	Security Group Rule Service	-

Responses

Name	Description	Example
id	Security Group Rule ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Rule Description
direction	Security Group Rule Direction (Ingress, Egress)
ethertype	Security Group Rule Ethertype (IPV4, IPV6)
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
port_range_max	Security Group Rule Port Range Max
port_range_min	Security Group Rule Port Range Min
protocol	Security Group Rule Protocol
remote_group_id	Security Group Rule Remote Group ID
remote_group_name	Security Group Rule Remote Group Name
remote_ip_prefix	Security Group Rule Remote IP Address
security_group_id	Security Group ID

6 - List Security Groups

6.1 - 1.0

scpcli security-group security-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]

Description

Get Security Group 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`
id optional	string	Security Group ID	-
name optional	string	Security Group Name	-

Responses

Name	Description	Example
id	Security Group ID
account_id	Security Group Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Description
loggable	Security Group Loggable
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Security Group Name
rule_count	Security Group Rule Count
state	Security Group State

7 - Set Security Group

7.1 - 1.0

scpcli security-group security-group set
--security_group_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Security Group.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	-
description optional	string	Security Group Description	-
loggable optional	boolean	Security Group Loggable	-

8 - Show Security Group

8.1 - 1.0

scpcli security-group security-group show
--security_group_id <value>

Description

Show Security Group.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	-

Responses

Name	Description	Example
id	Security Group ID
account_id	Security Group Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Description
loggable	Security Group Loggable
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Security Group Name
rule_count	Security Group Rule Count
state	Security Group State

9 - Show Security Group Rule

9.1 - 1.0

scpcli security-group security-group-rule show
--security_group_rule_id <value>
[--fields <value>]

Description

Show Security Group rule.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
security_group_rule_id required	string	Security Group Rule ID	-
fields optional	array	Field Name	-

Responses

Name	Description	Example
id	Security Group Rule ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Rule Description
direction	Security Group Rule Direction (Ingress, Egress)
ethertype	Security Group Rule Ethertype (IPV4, IPV6)
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
port_range_max	Security Group Rule Port Range Max
port_range_min	Security Group Rule Port Range Min
protocol	Security Group Rule Protocol
remote_group_id	Security Group Rule Remote Group ID
remote_group_name	Security Group Rule Remote Group Name
remote_ip_prefix	Security Group Rule Remote IP Address
security_group_id	Security Group ID