Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
Add one or more rules to a security group.

USAGE:
scw instance security-group add-rules <security-group-id ...> [arg=value ...]

ARGS:
security-group-id ID of the security group to add rules to
[rules.{index}.protocol] Protocol for the rule (unknown_protocol | tcp | udp | icmp | any)
[rules.{index}.direction] Direction of traffic for the rule (unknown_direction | inbound | outbound | both)
[rules.{index}.action] Action to take when the rule matches (unknown_action | accept | drop)
[rules.{index}.source-ip-range] Source IP range for the rule
[rules.{index}.destination-ip-range] Destination IP range for the rule
[rules.{index}.source-ports.start] Start of the port range
[rules.{index}.source-ports.end] End of the port range
[rules.{index}.destination-ports.start] Start of the port range
[rules.{index}.destination-ports.end] End of the port range
[rules.{index}.position] Position of this rule in the rule list, starting at 1
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1 | it-mil-2 | it-mil-3)

FLAGS:
-h, --help help for add-rules
--list-sub-commands List all subcommands

GLOBAL FLAGS:
-B, --beta Enable beta mode
-c, --config string The path to the config file
-D, --debug Enable debug mode
-H, --no-headers Skip headers in human output
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use
--web open console page for the current resource
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
Remove all rules of a security group

USAGE:
scw instance security-group clear [arg=value ...]
scw instance security-group clear <security-group-id ...> [arg=value ...]

EXAMPLES:
Remove all rules of the given security group
scw instance security-group clear security-group-id=11111111-1111-1111-1111-111111111111
scw instance security-group clear 11111111-1111-1111-1111-111111111111

ARGS:
security-group-id ID of the security group to reset.
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1)
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1 | it-mil-2 | it-mil-3)

FLAGS:
-h, --help help for clear
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
Command "create-rule" is deprecated, it is not available in v2 of the API and will be removed when v1 reaches end of support. Rules can be created using "scw instance security-group add-rules <security-group-id ...> [arg=value ...]".
Create a rule in the specified security group ID.

USAGE:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,31 @@ USAGE:

EXAMPLES:
Create a security group with a specified name and description
scw instance security-group create name=foobar description=foobar foobar
scw instance security-group create name=foobar description="foobar foobar"

Create a security group that will be applied as default on all Instances of this Project
scw instance security-group create project-default=true

Create a security group that will have a default drop inbound policy (traffic your Instance receives)
scw instance security-group create inbound-default-policy=drop
scw instance security-group create inbound-default-action=drop

Create a security group that will have a default drop outbound policy (traffic your Instance transmits)
scw instance security-group create outbound-default-policy=drop
scw instance security-group create outbound-default-action=drop

Create a stateless security group
scw instance security-group create
scw instance security-group create stateless=true

ARGS:
name=<generated> Name of the security group
[description] Description of the security group
[disable-default-rules=false] Whether to disable default rules
[project-id] Project ID to use. If none is passed the default project ID will be used
[tags.{index}] Tags of the security group
[project-default] Whether this security group becomes the default security group for new Instances
[stateful=true] Whether the security group is stateful or not
[inbound-default-policy=accept] Default policy for inbound rules (unknown_policy | accept | drop)
[outbound-default-policy=accept] Default policy for outbound rules (unknown_policy | accept | drop)
[enable-default-security] True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable
[organization-id] Organization ID to use. If none is passed the default organization ID will be used
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1)

DEPRECATED ARGS:
[organization-default] Defines whether this security group becomes the default security group for new Instances
[tags.{index}] Tags for the security group
[project-default] Whether this should be the default security group for the project
[inbound-default-action=accept] Default action for inbound rules (unknown_action | accept | drop)
[outbound-default-action=accept] Default action for outbound rules (unknown_action | accept | drop)
[stateless=false] Whether the security group should be stateless
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1 | it-mil-2 | it-mil-3)

FLAGS:
-h, --help help for create
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
Command "delete-rule" is deprecated, it is not available in v2 of the API and will be removed when v1 reaches end of support. Rules can be deleted using "scw instance security-group delete-rules security-group-rule-ids.0=<security-group-rule-id>".
Delete a security group rule with the specified ID.

USAGE:
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
Delete specified security groups.

USAGE:
scw instance security-group delete-rules [arg=value ...]

ARGS:
[security-group-rule-ids.{index}] List of rule IDs to delete
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1 | it-mil-2 | it-mil-3)

FLAGS:
-h, --help help for delete-rules
--list-sub-commands List all subcommands

GLOBAL FLAGS:
-B, --beta Enable beta mode
-c, --config string The path to the config file
-D, --debug Enable debug mode
-H, --no-headers Skip headers in human output
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use
--web open console page for the current resource
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
Delete a security group with the specified ID.
Delete a specified security group.

USAGE:
scw instance security-group delete <security-group-id ...> [arg=value ...]
Expand All @@ -10,8 +10,8 @@ EXAMPLES:
scw instance security-group delete 11111111-1111-1111-1111-111111111111

ARGS:
security-group-id UUID of the security group you want to delete
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1)
security-group-id ID of the security group to delete
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1 | it-mil-2 | it-mil-3)

FLAGS:
-h, --help help for delete
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ USAGE:
ARGS:
security-group-id ID of the security group to reset.
[mode=yaml] marshaling used when editing data (yaml | json)
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1)
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1 | it-mil-2 | it-mil-3)

FLAGS:
-h, --help help for edit
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
Command "get-rule" is deprecated, it is not available in v2 of the API and will be removed when v1 reaches end of support. Rules can be listed using "scw instance security-group get <security-group-id>".
Get details of a security group rule with the specified ID.

USAGE:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
Get the details of a security group with the specified ID.
Get the details of a specified security group.

USAGE:
scw instance security-group get <security-group-id ...> [arg=value ...]
Expand All @@ -10,8 +10,8 @@ EXAMPLES:
scw instance security-group get 11111111-1111-1111-1111-111111111111

ARGS:
security-group-id UUID of the security group you want to get
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1)
security-group-id ID of the security group to retrieve
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1 | it-mil-2 | it-mil-3)

FLAGS:
-h, --help help for get
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
Command "list-default-rules" is deprecated, it is not available in v2 of the API and will be removed when v1 reaches end of support. Default rules can be listed using "scw instance security-group get <security-group-id>".
Lists the default rules applied to all the security groups.

USAGE:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
Command "list-rules" is deprecated, it is not available in v2 of the API and will be removed when v1 reaches end of support. Rules can be listed using "scw instance security-group get <security-group-id>".
List the rules of the a specified security group ID.

USAGE:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
List all existing security groups.
List all security groups.

USAGE:
scw instance security-group list [arg=value ...]
Expand All @@ -10,12 +10,14 @@ EXAMPLES:
scw instance security-group list name=foobar

ARGS:
[name] Name of the security group
[project-id] Security group Project ID
[tags] List security groups with these exact tags (to filter with several tags, use commas to separate them)
[project-default] Filter security groups with this value for project_default
[organization-id] Security group Organization ID
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1 | all)
[page-token] Token for pagination
[page-size] Number of items to return per page
[order-by] Field and direction to sort by (created_at_desc | created_at_asc | updated_at_desc | updated_at_asc)
[project-id] Project ID to use. If none is passed the default project ID will be used
[name] Filter by name
[tags.{index}] Filter by tags
[security-group-ids.{index}] Filter by specific security group IDs
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1 | it-mil-2 | it-mil-3)

FLAGS:
-h, --help help for list
Expand Down
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
Replaces the existing rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request.
Replace all rules of a specified security group with the provided rules.

USAGE:
scw instance security-group set-rules [arg=value ...]
scw instance security-group set-rules <security-group-id ...> [arg=value ...]

ARGS:
security-group-id UUID of the security group to update the rules on
[rules.{index}.id] UUID of the security rule to update. If no value is provided, a new rule will be created
[rules.{index}.action] Action to apply when the rule matches a packet (unknown_action | accept | drop)
[rules.{index}.protocol] Protocol family this rule applies to (unknown_protocol | TCP | UDP | ICMP | ANY)
[rules.{index}.direction] Direction the rule applies to (unknown_direction | inbound | outbound)
[rules.{index}.ip-range] Range of IP addresses these rules apply to
[rules.{index}.dest-port-from] Beginning of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY
[rules.{index}.dest-port-to] End of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY, or if it is equal to dest_port_from
[rules.{index}.position] Position of this rule in the security group rules list. If several rules are passed with the same position, the resulting order is undefined
[rules.{index}.editable] Indicates if this rule is editable. Rules with the value false will be ignored
[rules.{index}.zone] Zone of the rule. This field is ignored
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1)
security-group-id ID of the security group to set rules for
[rules.{index}.protocol] Protocol for the rule (unknown_protocol | tcp | udp | icmp | any)
[rules.{index}.direction] Direction of traffic for the rule (unknown_direction | inbound | outbound | both)
[rules.{index}.action] Action to take when the rule matches (unknown_action | accept | drop)
[rules.{index}.source-ip-range] Source IP range for the rule
[rules.{index}.destination-ip-range] Destination IP range for the rule
[rules.{index}.source-ports.start] Start of the port range
[rules.{index}.source-ports.end] End of the port range
[rules.{index}.destination-ports.start] Start of the port range
[rules.{index}.destination-ports.end] End of the port range
[rules.{index}.position] Position of this rule in the rule list, starting at 1
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1 | it-mil-2 | it-mil-3)

FLAGS:
-h, --help help for set-rules
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@ USAGE:
scw instance security-group update-rule [arg=value ...]

ARGS:
security-group-id UUID of the security group
security-group-rule-id UUID of the rule
[protocol] Protocol family this rule applies to (unknown_protocol | TCP | UDP | ICMP | ANY)
[direction] Direction the rule applies to (unknown_direction | inbound | outbound)
[action] Action to apply when the rule matches a packet (unknown_action | accept | drop)
[ip-range] Range of IP addresses these rules apply to
[dest-port-from] Beginning of the range of ports this rule applies to (inclusive). If 0 is provided, unset the parameter.
[dest-port-to] End of the range of ports this rule applies to (inclusive). If 0 is provided, unset the parameter.
[position] Position of this rule in the security group rules list
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1)
security-group-rule-id ID of the rule to update
[protocol] New protocol for the rule (unknown_protocol | tcp | udp | icmp | any)
[direction] New direction for the rule (unknown_direction | inbound | outbound | both)
[action] New action for the rule (unknown_action | accept | drop)
[source-ip-range] New source IP range for the rule
[destination-ip-range] New destination IP range for the rule
[source-ports.start] Start of the port range
[source-ports.end] End of the port range
[destination-ports.start] Start of the port range
[destination-ports.end] End of the port range
[position] New position for the rule
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | it-mil-1 | it-mil-2 | it-mil-3)

FLAGS:
-h, --help help for update-rule
Expand Down
Loading