This is the multi-page printable view of this section. Click here to print.
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of VPN service and how to call CLI. The output is formatted as a JSON string
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20251231 |
scpcli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]
Create VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| name required | string | VPN Gateway Name | ExampleVpnGW1 |
| ip_type required | string | VPN Gateway IP Type | PUBLIC |
| ip_id required | string | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_address required | string | VPN Gateway IP Address | 123.0.0.1 |
| description optional | string | Description | Example Description for VPN Gateway |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
scpcli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]
Create VPN gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| name required | string | VPN Gateway Name | ExampleVpnGW1 |
| ip_type required | string | VPN Gateway IP Type | PUBLIC |
| ip_id required | string | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_address required | string | VPN Gateway IP Address | 123.0.0.1 |
| description optional | string | Description | Example Description for VPN Gateway |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
scpcli vpn vpn-tunnel create
--remote_subnets <value>
--phase2_life_time <value>
--phase2_encryptions <value>
--phase2_diffie_hellman_groups <value>
--perfect_forward_secrecy <value>
--pre_shared_key <value>
--phase1_life_time <value>
--phase1_encryptions <value>
--phase1_diffie_hellman_groups <value>
--peer_gateway_ip <value>
--ike_version <value>
--dpd_retry_interval <value>
--vpn_gateway_id <value>
--name <value>
[--description <value>]
[--tags <value>]
Create VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| remote_subnets required | array | VPN Tunnel IPSec Remote Subnet | 10.1.1.0/24 |
| phase2_life_time required | integer | VPN Tunnel IPSec Lifetime (sec) | 43200 |
| phase2_encryptions required | array | VPN Tunnel ISAKMP Proposal List | null-md5 |
| phase2_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| perfect_forward_secrecy required | string | VPN Tunnel IPSec Perfect Forward Secrecy(PFS) | ENABLE |
| pre_shared_key required | string | VPN Tunnel ISAKMP Authentication : Pre-shared Key | PreSharedKey1 |
| phase1_life_time required | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| phase1_encryptions required | array | VPN Tunnel ISAKMP Proposal List | des-md5 |
| phase1_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| peer_gateway_ip required | string | VPN Tunnel Peer Gateway IP Address | 123.0.0.2 |
| ike_version required | integer | VPN Tunnel IKE Version | 2 |
| dpd_retry_interval required | integer | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) | 60 |
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| name required | string | VPN Tunnel Name | ExampleVpnTunnel1 |
| description optional | string | Description | Example Description for VPN Tunnel |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
scpcli vpn vpn-tunnel create
--remote_subnet <value>
--phase2_life_time <value>
--phase2_encryptions <value>
--phase2_diffie_hellman_groups <value>
--perfect_forward_secrecy <value>
--pre_shared_key <value>
--phase1_life_time <value>
--phase1_encryptions <value>
--phase1_diffie_hellman_groups <value>
--peer_gateway_ip <value>
--ike_version <value>
--dpd_retry_interval <value>
--vpn_gateway_id <value>
--name <value>
[--description <value>]
[--tags <value>]
Create VPN tunnel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
| Name | Type | Description | Example |
|---|---|---|---|
| remote_subnet required | string | VPN Tunnel IPSec Remote Subnet | 10.1.0.0/16 |
| phase2_life_time required | integer | VPN Tunnel IPSec Lifetime (sec) | 43200 |
| phase2_encryptions required | array | VPN Tunnel ISAKMP Proposal List | null-md5 |
| phase2_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| perfect_forward_secrecy required | string | VPN Tunnel IPSec Perfect Forward Secrecy(PFS) | ENABLE |
| pre_shared_key required | string | VPN Tunnel ISAKMP Authentication : Pre-shared Key | PreSharedKey1 |
| phase1_life_time required | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| phase1_encryptions required | array | VPN Tunnel ISAKMP Proposal List | des-md5 |
| phase1_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| peer_gateway_ip required | string | VPN Tunnel Peer Gateway IP Address | 123.0.0.2 |
| ike_version required | integer | VPN Tunnel IKE Version | 2 |
| dpd_retry_interval required | integer | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) | 60 |
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| name required | string | VPN Tunnel Name | ExampleVpnTunnel1 |
| description optional | string | Description | Example Description for VPN Tunnel |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
scpcli vpn vpn-gateway delete
--vpn_gateway_id <value>
Delete VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
scpcli vpn vpn-gateway delete
--vpn_gateway_id <value>
Delete VPN gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
scpcli vpn vpn-tunnel delete
--vpn_tunnel_id <value>
Delete VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
scpcli vpn vpn-tunnel delete
--vpn_tunnel_id <value>
Delete VPN tunnel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
scpcli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Get VPN gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | VPN Gateway Name | ExampleVpnGW1 |
| ip_address optional | string | VPN Gateway IP Address | 123.0.0.1 |
| vpc_id optional | string | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name optional | string | VPC Name | ExampleVPC1 |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
scpcli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Get VPN gateway list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | VPN Gateway Name | ExampleVpnGW1 |
| ip_address optional | string | VPN Gateway IP Address | 123.0.0.1 |
| vpc_id optional | string | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name optional | string | VPC Name | ExampleVPC1 |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
scpcli vpn vpn-tunnel list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpn_gateway_id <value>]
[--vpn_gateway_name <value>]
Get VPN tunnel list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | VPN Tunnel Name | ExampleVpnTunnel1 |
| vpn_gateway_id optional | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_name optional | string | VPN Gateway Name | ExampleVpnGW1 |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
scpcli vpn vpn-tunnel list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpn_gateway_id <value>]
[--vpn_gateway_name <value>]
[--peer_gateway_ip <value>]
[--remote_subnet <value>]
Get VPN tunnel list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | VPN Tunnel Name | ExampleVpnTunnel1 |
| vpn_gateway_id optional | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_name optional | string | VPN Gateway Name | ExampleVpnGW1 |
| peer_gateway_ip optional | string | VPN Tunnel Peer Gateway IP Address | 123.0.0.2 |
| remote_subnet optional | string | VPN Tunnel IPSec Remote Subnet | 10.1.0.0/16 |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
scpcli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]
Set VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| description optional | string | Description | Example Description for VPN Gateway |
scpcli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]
Set VPN gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| description optional | string | Description | Example Description for VPN Gateway |
scpcli vpn vpn-tunnel set
--vpn_tunnel_id <value>
[--description <value>]
[--dpd_retry_interval <value>]
[--ike_version <value>]
[--peer_gateway_ip <value>]
[--phase1_diffie_hellman_groups <value>]
[--phase1_encryptions <value>]
[--phase1_life_time <value>]
[--pre_shared_key <value>]
[--perfect_forward_secrecy <value>]
[--phase2_diffie_hellman_groups <value>]
[--phase2_encryptions <value>]
[--phase2_life_time <value>]
[--remote_subnets <value>]
Set VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
| description optional | string | Description | Example Description for VPN Tunnel |
| dpd_retry_interval optional | integer | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) | 60 |
| ike_version optional | integer | VPN Tunnel IKE Version | 2 |
| peer_gateway_ip optional | string | VPN Tunnel Peer Gateway IP Address | 123.0.0.2 |
| phase1_diffie_hellman_groups optional | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| phase1_encryptions optional | array | VPN Tunnel ISAKMP Proposal List | des-md5 |
| phase1_life_time optional | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| pre_shared_key optional | string | VPN Tunnel ISAKMP Authentication : Pre-shared Key | PreSharedKey1 |
| perfect_forward_secrecy optional | **** | VPN Tunnel IPSec Perfect Forward Secrecy(PFS) | ENABLE |
| phase2_diffie_hellman_groups optional | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| phase2_encryptions optional | array | VPN Tunnel ISAKMP Proposal List | null-md5 |
| phase2_life_time optional | integer | VPN Tunnel IPSec Lifetime (sec) | 43200 |
| remote_subnets optional | array | VPN Tunnel IPSec Remote Subnet | 10.1.1.0/24 |
scpcli vpn vpn-tunnel set
--vpn_tunnel_id <value>
[--description <value>]
[--dpd_retry_interval <value>]
[--ike_version <value>]
[--peer_gateway_ip <value>]
[--phase1_diffie_hellman_groups <value>]
[--phase1_encryptions <value>]
[--phase1_life_time <value>]
[--pre_shared_key <value>]
[--perfect_forward_secrecy <value>]
[--phase2_diffie_hellman_groups <value>]
[--phase2_encryptions <value>]
[--phase2_life_time <value>]
[--remote_subnet <value>]
Set VPN tunnel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
| description optional | string | Description | Example Description for VPN Tunnel |
| dpd_retry_interval optional | integer | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) | 60 |
| ike_version optional | integer | VPN Tunnel IKE Version | 2 |
| peer_gateway_ip optional | string | VPN Tunnel Peer Gateway IP Address | 123.0.0.2 |
| phase1_diffie_hellman_groups optional | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| phase1_encryptions optional | array | VPN Tunnel ISAKMP Proposal List | des-md5 |
| phase1_life_time optional | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| pre_shared_key optional | string | VPN Tunnel ISAKMP Authentication : Pre-shared Key | PreSharedKey1 |
| perfect_forward_secrecy optional | **** | VPN Tunnel IPSec Perfect Forward Secrecy(PFS) | ENABLE |
| phase2_diffie_hellman_groups optional | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| phase2_encryptions optional | array | VPN Tunnel ISAKMP Proposal List | null-md5 |
| phase2_life_time optional | integer | VPN Tunnel IPSec Lifetime (sec) | 43200 |
| remote_subnet optional | string | VPN Tunnel IPSec Remote Subnet | 10.1.0.0/16 |
scpcli vpn vpn-gateway show
--vpn_gateway_id <value>
Show VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
scpcli vpn vpn-gateway show
--vpn_gateway_id <value>
Show VPN gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
scpcli vpn vpn-tunnel show
--vpn_tunnel_id <value>
Show VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| status | VPN Tunnel Status | UP |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
scpcli vpn vpn-tunnel show
--vpn_tunnel_id <value>
Show VPN tunnel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| status | VPN Tunnel Status | UP |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |