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
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a connection.

USAGE:
scw s2s-vpn connection create [arg=value ...]

ARGS:
[project-id] Project ID to use. If none is passed the default project ID will be used
name Name of the connection
[tags.{index}] List of tags to apply to the connection
[is-ipv6] Defines IP version of the IPSec Tunnel
initiation-policy Who initiates the IPsec tunnel (unknown_initiation_policy | vpn_gateway | customer_gateway)
[ikev2-ciphers.{index}.encryption] (unknown_encryption | aes128 | aes192 | aes256 | aes128gcm | aes192gcm | aes256gcm | aes128ccm | aes256ccm | chacha20poly1305)
[ikev2-ciphers.{index}.integrity] (unknown_integrity | sha256 | sha384 | sha512)
[ikev2-ciphers.{index}.dh-group] (unknown_dhgroup | modp2048 | modp3072 | modp4096 | ecp256 | ecp384 | ecp521 | curve25519)
[esp-ciphers.{index}.encryption] (unknown_encryption | aes128 | aes192 | aes256 | aes128gcm | aes192gcm | aes256gcm | aes128ccm | aes256ccm | chacha20poly1305)
[esp-ciphers.{index}.integrity] (unknown_integrity | sha256 | sha384 | sha512)
[esp-ciphers.{index}.dh-group] (unknown_dhgroup | modp2048 | modp3072 | modp4096 | ecp256 | ecp384 | ecp521 | curve25519)
[enable-route-propagation] Defines whether route propagation is enabled or not.
vpn-gateway-id ID of the VPN gateway to attach to the connection
customer-gateway-id ID of the customer gateway to attach to the connection
[bgp-config-ipv4.routing-policy-id]
[bgp-config-ipv4.private-ip]
[bgp-config-ipv4.peer-private-ip]
[bgp-config-ipv6.routing-policy-id]
[bgp-config-ipv6.private-ip]
[bgp-config-ipv6.peer-private-ip]
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for create

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete an existing connection, specified by its connection ID.

USAGE:
scw s2s-vpn connection delete <connection-id ...> [arg=value ...]

ARGS:
connection-id ID of the connection to delete
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for delete

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Detach an existing routing policy from a connection, specified by its connection ID.

USAGE:
scw s2s-vpn connection detach-routing-policy <connection-id ...> [arg=value ...]

ARGS:
connection-id ID of the connection from which routing policy is being detached
[routing-policy-v4] ID of the routing policy to detach from the BGP IPv4 session
[routing-policy-v6] ID of the routing policy to detach from the BGP IPv6 session
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for detach-routing-policy

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the VPN Gateway until route propagation is re-enabled.

USAGE:
scw s2s-vpn connection disable-route-propagation <connection-id ...> [arg=value ...]

ARGS:
connection-id ID of the connection on which to disable route propagation
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for disable-route-propagation

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce.

USAGE:
scw s2s-vpn connection enable-route-propagation <connection-id ...> [arg=value ...]

ARGS:
connection-id ID of the connection on which to enable route propagation
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for enable-route-propagation

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Get a connection for the given connection ID. The response object includes information about the connection's various configuration details.

USAGE:
scw s2s-vpn connection get <connection-id ...> [arg=value ...]

ARGS:
connection-id ID of the requested connection
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for get

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List all your connections. A number of filters are available, including Project ID, name, tags and status.

USAGE:
scw s2s-vpn connection list [arg=value ...]

ARGS:
[order-by] Order in which to return results (created_at_asc | created_at_desc | name_asc | name_desc | status_asc | status_desc)
[project-id] Project ID to filter for
[name] Connection name to filter for
[tags.{index}] Tags to filter for
[statuses.{index}] Connection statuses to filter for (unknown_status | active | limited_connectivity | down | locked)
[is-ipv6] Filter connections with IP version of IPSec tunnel
[routing-policy-ids.{index}] Filter for connections using these routing policies
[route-propagation-enabled] Filter for connections with route propagation enabled
[vpn-gateway-ids.{index}] Filter for connections attached to these VPN gateways
[customer-gateway-ids.{index}] Filter for connections attached to these customer gateways
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)

FLAGS:
-h, --help help for list

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Renew pre-shared key for a given connection.

USAGE:
scw s2s-vpn connection renew-psk <connection-id ...> [arg=value ...]

ARGS:
connection-id ID of the connection to renew the PSK
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for renew-psk

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Set a new routing policy on a connection, overriding the existing one if present, specified by its connection ID.

USAGE:
scw s2s-vpn connection set-routing-policy <connection-id ...> [arg=value ...]

ARGS:
connection-id ID of the connection whose routing policy is being updated
[routing-policy-v4] ID of the routing policy to set for the BGP IPv4 session
[routing-policy-v6] ID of the routing policy to set for the BGP IPv6 session
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for set-routing-policy

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update an existing connection, specified by its connection ID.

USAGE:
scw s2s-vpn connection update <connection-id ...> [arg=value ...]

ARGS:
connection-id ID of the connection to update
[name] Name of the connection
[tags.{index}] List of tags to apply to the connection
[initiation-policy] Who initiates the IPsec tunnel (unknown_initiation_policy | vpn_gateway | customer_gateway)
[ikev2-ciphers.{index}.encryption] (unknown_encryption | aes128 | aes192 | aes256 | aes128gcm | aes192gcm | aes256gcm | aes128ccm | aes256ccm | chacha20poly1305)
[ikev2-ciphers.{index}.integrity] (unknown_integrity | sha256 | sha384 | sha512)
[ikev2-ciphers.{index}.dh-group] (unknown_dhgroup | modp2048 | modp3072 | modp4096 | ecp256 | ecp384 | ecp521 | curve25519)
[esp-ciphers.{index}.encryption] (unknown_encryption | aes128 | aes192 | aes256 | aes128gcm | aes192gcm | aes256gcm | aes128ccm | aes256ccm | chacha20poly1305)
[esp-ciphers.{index}.integrity] (unknown_integrity | sha256 | sha384 | sha512)
[esp-ciphers.{index}.dh-group] (unknown_dhgroup | modp2048 | modp3072 | modp4096 | ecp256 | ecp384 | ecp521 | curve25519)
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for update

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
29 changes: 29 additions & 0 deletions cmd/scw/testdata/test-all-usage-s2s-vpn-connection-usage.golden
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
A connection represents the IPsec tunnel between VPN gateway and customer gateway.

USAGE:
scw s2s-vpn connection <command>

AVAILABLE COMMANDS:
create Create a connection
delete Delete a connection
detach-routing-policy Detach a routing policy
disable-route-propagation Disable route propagation
enable-route-propagation Enable route propagation
get Get a connection
list List connections
renew-psk Renew pre-shared key
set-routing-policy Set a new routing policy
update Update a connection

FLAGS:
-h, --help help for connection

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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

Use "scw s2s-vpn connection [command] --help" for more information about a command.
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a customer gateway.

USAGE:
scw s2s-vpn customer-gateway create [arg=value ...]

ARGS:
[project-id] Project ID to use. If none is passed the default project ID will be used
name Name of the customer gateway
[tags.{index}] List of tags to apply to the customer gateway
[ipv4-public] Public IPv4 address of the customer gateway
[ipv6-public] Public IPv6 address of the customer gateway
asn AS Number of the customer gateway
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for create

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete an existing customer gateway, specified by its customer gateway ID.

USAGE:
scw s2s-vpn customer-gateway delete <gateway-id ...> [arg=value ...]

ARGS:
gateway-id ID of the customer gateway to delete
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for delete

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Get a customer gateway for the given customer gateway ID.

USAGE:
scw s2s-vpn customer-gateway get <gateway-id ...> [arg=value ...]

ARGS:
gateway-id ID of the requested customer gateway
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for get

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List all your customer gateways. A number of filters are available, including Project ID, name, and tags.

USAGE:
scw s2s-vpn customer-gateway list [arg=value ...]

ARGS:
[order-by] Order in which to return results (created_at_asc | created_at_desc | name_asc | name_desc)
[project-id] Project ID to filter for
[name] Customer gateway name to filter for
[tags.{index}] Tags to filter for
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)

FLAGS:
-h, --help help for list

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update an existing customer gateway, specified by its customer gateway ID. You can update its name, tags, public IPv4 & IPv6 address and AS Number.

USAGE:
scw s2s-vpn customer-gateway update <gateway-id ...> [arg=value ...]

ARGS:
gateway-id ID of the customer gateway to update
[name] Name of the customer gateway
[tags.{index}] List of tags to apply to the customer gateway
[ipv4-public] Public IPv4 address of the customer gateway
[ipv6-public] Public IPv6 address of the customer gateway
[asn] AS Number of the customer gateway
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for update

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-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
Loading
Loading