IKEGatewayConnection

Set the attributes like NSG role, authentication method etc for establishing IKE security association with remote gateway.

Overview

allowAnySubnet boolean
associatedIKEAuthenticationID string
associatedIKEAuthenticationType enum (IKE_CERTIFICATE | IKE_PSK)
associatedIKEEncryptionProfileID string
associatedIKEGatewayProfileID string
associatedVLANID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
mark integer
name string filterable   orderable  
NSGIdentifier string filterable   orderable  
NSGIdentifierType enum (ID_DER_ASN1_DN | ID_FQDN | ID_IPV4_ADDR | ID_KEY_ID | ID_RFC822_ADDR) filterable   orderable  
NSGRole enum (INITIATOR | RESPONDER) filterable   orderable  
portVLANName string
priority integer filterable   orderable  
sequence integer
unencryptedPSK string

API Resource

/ikegatewayconnections/id
delete get put

Parents

/subnets/id/ikegatewayconnections
get put
/vlans/id/ikegatewayconnections
get post

Children

/ikegatewayconnections/id/metadatas
get post
/ikegatewayconnections/id/alarms
get
/ikegatewayconnections/id/globalmetadatas
get post put

Members

/ikegatewayconnections/id/performancemonitors
get put
/ikegatewayconnections/id/subnets
get put

Attributes documentation

allowAnySubnet boolean
Discussion

Allow any local subnets to be used

Charateristics

SDK attribute: allowAnySubnet

associatedIKEAuthenticationID string
Discussion

Associated Authentication ID

Charateristics

Format: free
SDK attribute: associatedIKEAuthenticationID

associatedIKEAuthenticationType enum
Discussion

Associated Authentication Type

Charateristics

Allowed values: IKE_CERTIFICATE, IKE_PSK
SDK attribute: associatedIKEAuthenticationType

associatedIKEEncryptionProfileID string
Discussion

The ID of the associated IKEEncryptionProfile

Charateristics

Format: free
SDK attribute: associatedIKEEncryptionProfileID

associatedIKEGatewayProfileID string
Discussion

The ID of the associated IKEGatewayProfile

Charateristics

Format: free
SDK attribute: associatedIKEGatewayProfileID

associatedVLANID string
Discussion

The ID of the associated Vlan

Charateristics

Format: free
SDK attribute: associatedVLANID

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

mark integer
Discussion

skbMark, used by vrs for the ike monitor feature

Charateristics

Default value: 1
Min value: 1
Max value: 16000
SDK attribute: mark

name string filterable   orderable  
Discussion

Optional Name of the connection

Charateristics

Format: free
SDK attribute: name

NSGIdentifier string filterable   orderable  
Discussion

NSG Identifier. Null to take on the default 'uuid'

Charateristics

Format: free
SDK attribute: NSGIdentifier

NSGIdentifierType enum filterable   orderable  
Discussion

NSG Identifier Type.

Charateristics

Allowed values: ID_DER_ASN1_DN, ID_FQDN, ID_IPV4_ADDR, ID_KEY_ID, ID_RFC822_ADDR
Default value: ID_KEY_ID
SDK attribute: NSGIdentifierType

NSGRole enum filterable   orderable  
Discussion

NSG role

Charateristics

Allowed values: INITIATOR, RESPONDER
SDK attribute: NSGRole

portVLANName string
Discussion

The Name of the Port and Vlan the IKEv2 Connection is on

Charateristics

Format: free
SDK attribute: portVLANName

priority integer filterable   orderable  
Discussion

Priority of the IKEv2 Gateway Connection

Charateristics

Min value: 1
Max value: 16000
SDK attribute: priority

sequence integer
Discussion

The sequence of the IKE Gateway Connection

Charateristics

SDK attribute: sequence

unencryptedPSK string
Discussion

Unencrypted PSK

Charateristics

Format: free
SDK attribute: unencryptedPSK