DocsKnowledge BaseAPI Explorer
Documentation›ZCF›ZStack Cloud›Explore more›CLI Command ManualZCF
Document navigation

IPsec

CreateIPsecConnection

Creates an IPsec connection. For example,
CreateIPsecConnection name=ipsec1 vipUuid=c023e287a3fa4503b259f893aaf2d33d \
l3NetworkUuid=9082f45fce9c46f19b2ab5ff117511d6 peerAddress=10.128.19.5 peerCidrs=172.20.222.1/24 \
authKey=123456

Parameters

Name Description Optional Valid Value Starting Version
name The IPsec connection name. 0.6
description The detailed description of the IPsec connection. Yes 0.6
l3NetworkUuid The L3 network UUID. Yes 4.5.0
peerAddress The remote network Address. 4.5.0
authMode The authentication mode. Yes
  • psk
  • certs
 0.6
authKey The authentication key. 0.6
idType The ID configuration method. Yes 4.5.0
vipUuid The VIP UUID. 0.6
localId The local ID. Yes 4.5.0
remoteId The remote ID. Yes 4.5.0
peerCidrs The destination network CIDR. Yes 4.5.0
ikeVersion The IKE version. Yes
  • ike
  • ikev1
  • ikev2
 4.5.0
ikeAuthAlgorithm The IKE authentication algorithm. Yes
  • md5
  • sha1
  • sha256
  • sha384
  • sha512
 0.6
ikeEncryptionAlgorithm The IKE encryption algorithm. Yes
  • 3des
  • aes-128
  • aes-192
  • aes-256
 0.6
ikeDhGroup The IKE DH group. Yes 4.5.0
ikeLifeTime The IKE life time. Yes 4.5.0
policyAuthAlgorithm The ESP authentication algorithm. Yes
  • md5
  • sha1
  • sha256
  • sha384
  • sha512
 0.6
policyEncryptionAlgorithm The ESP encryption algorithm. Yes
  • 3des
  • aes-128
  • aes-192
  • aes-256
 0.6
pfs The PFS DH group. Yes
  • none
  • dh-group0
  • dh-group2
  • dh-group5
  • dh-group14
  • dh-group15
  • dh-group16
  • dh-group17
  • dh-group18
  • dh-group19
  • dh-group20
  • dh-group21
  • dh-group22
  • dh-group23
  • dh-group24
  • dh-group25
  • dh-group26
 4.5.0
policyMode The encapsulation mode. Yes
  • tunnel
  • transport
 4.5.0
transformProtocol The security protocol. Yes
  • esp
  • ahah-esp
 4.5.0
lifeTime The IPsec life time. Yes 4.5.0
resourceUuid The resource UUID. Yes 0.6
tagUuids The tag UUID list. 4.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. Yes 0.6
timeout Yes

DeleteIPsecConnection

Deletes an IPsec connection. For example,
DeleteIPsecConnection uuid=05caec6ebc234b2a899f7eb362ada51b

Parameters

Name Description Optional Valid Value Starting Version
uuid The IPsec connection UUID. 0.6
deleteMode The delete mode. For more information, see Delete Resources. Yes
  • Permissive
  • Enforcing
 0.6
systemTags The system tags. For more information, see CreateSystemTag. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. Yes 0.6
timeout Yes

QueryIPSecConnection

Queries an IPsec connection. For example,
QueryIPSecConnection uuid=5a56262681154dbdab1ded93613d7666
QueryIPSecConnection l3Network.uuid=cef5d1b507204c78b285d7074679818e

Primitive Fields of Query

See IPsec Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
peerCidrs peerCidrs Inventory 4.5.0
l3NetworkRefs l3NetworkRefs Inventory 4.5.0

UpdateIPsecConnection

Updates an IPsec connection. For example,
UpdateIPsecConnection uuid=5a56262681154dbdab1ded93613d7666

Parameters

Name Description Optional Valid Value Starting Version
uuid The IPsec connection UUID. 0.6
name The IPsec connection name. Yes 0.6
description The detailed description of the IPsec connection. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. Yes 0.6
timeout Yes

ChangeIPSecConnectionState

Changes the state of an IPsec connection. For example,
ChangeIPSecConnectionState uuid=5a56262681154dbdab1ded93613d7666 stateEvent=disable

Parameters

Name Description Optional Valid Value Starting Version
uuid The IPsec connection UUID. 2.3
stateEvent The state event. Yes
  • enable
  • disable
 2.3
systemTags The system. For more information, see CreateSystemTag. Yes 2.3
userTags The user tags. For more information, see CreateUserTag. Yes 2.3
timeout Yes

ReconnectIPsecConnection

Reconnects an IPsec connection. For example, 
ReconnectIPsecConnection uuid=13d92544a79845fd9c857954b77762d8

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 4.5.0
systemTags The system. For more information, see CreateSystemTag. 是 4.5.0
userTags The user tags. For more information, see CreateUserTag. 是 4.5.0
timeout 是

ChangeIPsecConnection

Changes configurations of an IPsec connection. For example, 
ChangeIPsecConnection uuid=13d92544a79845fd9c857954b77762d8 peerAddress=172.26.30.114 authKey=123

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 4.5.0
peerAddress The remote network address. 4.5.0
authMode The authentication mode. Yes
  • psk
  • certs
 4.5.0
authKey The authentication key. Yes 4.5.0
idType The ID configuration method. Yes
  • ip
  • name
  • fqdn
 4.5.0
localId The local ID. Yes 4.5.0
remoteId The remote ID. Yes 4.5.0
ikeVersion The IKE version. Yes
  • ike
  • ikev1
  • ikev2
 4.5.0
ikeAuthAlgorithm The IKE authentication algorithm. Yes
  • md5
  • sha1
  • sha256
  • sha384
  • sha512
 4.5.0
ikeEncryptionAlgorithm The IKE encryption algorithm. Yes
  • 3des
  • aes-128
  • aes192
  • aes256
 4.5.0
ikeDhGroup The IKE DH group. Yes 4.5.0
ikeLifeTime The IKE life time. Yes 4.5.0
policyAuthAlgorithm The ESP authentication algorithm. Yes
  • md5
  • sha1
  • sha256
  • sha384
  • sha512
 4.5.0
policyEncryptionAlgorithm The ESP encryption algorithm. Yes
  • 3des
  • aes-128
  • aes-192
  • aes-256
 4.5.0
pfs The PFS DH group. Yes
  • none
  • dh-group2
  • dh-group5
  • dh-group14
  • dh-group15
  • dh-group16
  • dh-group17
  • dh-group18
  • dh-group19
  • dh-group20
  • dh-group21
  • dh-group22
  • dh-group23
  • dh-group24
  • dh-group25
  • dh-group26
 4.5.0
policyMode The encapsulation mode. Yes
  • tunnel
  • transport
 4.5.0
transformProtocol The security protocol. Yes
  • esp
  • ah
  • ah-esp
 4.5.0
lifeTime The IPsec life time. Yes 4.5.0
systemTags The system. For more information, see CreateSystemTag. Yes 4.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.5.0
timeout 是

AttachL3NetworksToIPsecConnection

Attaches an L3 network to an IPsec connection. For example, 
AttachL3NetworksToIPsecConnection uuid=8430a82e1293406fb10de06567af6f1d \
l3NetworkUuids=3533e0dcd01d4e2aa8697048e152c5d8

Parameters

Name Description Optional Valid Value Starting Version
uuid The IPsec connection UUID. 2.3
l3NetworkUuids The local subnet. Make sure that network type is VPC. 2.3
resourceUuid Yes 2.3
systemTags The system tags. For more information, see CreateSystemTag. Yes 2.3
userTags The user tags. For more information, see CreateUserTag. Yes 2.3
timeout Yes

DetachL3NetworksFromIPsecConnection

Detaches an L3 network from an IPsec connection. For example,
DetachL3NetworksFromIPsecConnection uuid=8430a82e1293406fb10de06567af6f1d \
l3NetworkUuids=3533e0dcd01d4e2aa8697048e152c5d8

Parameters

Name Description Optional Valid Value Starting Version
uuid The IPsec connection UUID. 2.3
l3NetworkUuids The local subnet. Make sure that network type is VPC. 2.3
systemTags The system tags. For more information, see CreateSystemTag. Yes 2.3
userTags The user tags. For more information, see CreateUserTag. Yes 2.3
timeout Yes

AddRemoteCidrsToIPsecConnection

Adds a remote CIDR to an IPsec connection. For example,
AddRemoteCidrsToIPsecConnection uuid=8430a82e1293406fb10de06567af6f1d \
peerCidrs=192.168.127.1/24

Parameters

Name Description Optional Valid Value Starting Version
uuid The IPsec connection UUID. 2.3
peerCidrs The remote network CIDR UUID. 2.3
resourceUuid Yes 2.3
systemTags The system tags. For more information, see CreateSystemTag. Yes 2.3
userTags The user tags. For more information, see CreateUserTag. Yes 2.3
timeout Yes

RemoveRemoteCidrsFromIPsecConnection

Removes a remote CIDR from an IPsec connection. For example,
RemoveRemoteCidrsFromIPsecConnection uuid=8430a82e1293406fb10de06567af6f1d \
peerCidrs=192.168.127.1/24

Parameters

Name Description Optional Valid Value Starting Version
uuid The IPsec connection UUID. 2.3
peerCidrs The remote network CIDR. 2.3
resourceUuid Yes 2.3
systemTags The system tags. For more information, see CreateSystemTag. Yes 2.3
userTags The user tags. For more information, see CreateUserTag. Yes 2.3
timeout Yes
PreviousAddAccessControlListRedirectRuleNextNetflow
CLI Command Manual | 5.5.30 | ZStack Cloud · ZCF | ZStack Resource Center