IKEGateway

Represents an IKE Gateway

Overview

associatedCloudID string read only   autogenerated   filterable   orderable  
associatedCloudType enum (AZURECLOUD) read only   filterable   orderable  
associatedEnterpriseID string
configurationStatus enum (CANCELING | CANCELLED | CLOUD_CONFIGURATION_REMOVED | FAILED | IN_PROGRESS | NOT_APPLICABLE | PAUSING | SUCCESS | SYNCED_FROM_CLOUD | UNKNOWN | WAITING | WAITING_FOR_RESOURCES) read only   filterable   orderable  
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
IKEv1Mode enum (AGGRESSIVE | MAIN | NONE) filterable   orderable  
IKEVersion enum (V1 | V2) filterable   orderable  
IPAddress string required   filterable   orderable  
lastUpdatedBy string autogenerated  
name string filterable   orderable  

API Resource

/ikegateways/id
delete get put

Parents

/enterprises/id/ikegateways
get post

Children

/ikegateways/id/metadatas
get post
/ikegateways/id/ikesubnets
get post
/ikegateways/id/globalmetadatas
get post put

Members

/ikegateways/id/ikegatewayconfig
get put

Attributes documentation

associatedCloudID string read only   autogenerated   filterable   orderable  
Discussion

ID of the associated third-party cloud instance


Charateristics

Format: free
SDK attribute: associatedCloudID

associatedCloudType enum read only   filterable   orderable  
Discussion

Type of associated third-party cloud instance, ex. AZURECLOUD


Charateristics

Allowed values: AZURECLOUD
SDK attribute: associatedCloudType

associatedEnterpriseID string
Discussion

The ID of the associated Enterprise


Charateristics

Format: free
SDK attribute: associatedEnterpriseID

configurationStatus enum read only   filterable   orderable  
Discussion

Status of configuration on third-party cloud instance


Charateristics

Allowed values: CANCELING, CANCELLED, CLOUD_CONFIGURATION_REMOVED, FAILED, IN_PROGRESS, NOT_APPLICABLE, PAUSING, SUCCESS, SYNCED_FROM_CLOUD, UNKNOWN, WAITING, WAITING_FOR_RESOURCES
SDK attribute: configurationStatus

description string filterable   orderable  
Discussion

Description of the IKEv2 Gateway


Charateristics

Format: free
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.


Charateristics

SDK attribute: embeddedMetadata

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

IKEv1Mode enum filterable   orderable  
Discussion

Mode for IKEv1


Charateristics

Allowed values: AGGRESSIVE, MAIN, NONE
Default value: NONE
SDK attribute: IKEv1Mode

IKEVersion enum filterable   orderable  
Discussion

The IKE Version


Charateristics

Allowed values: V1, V2
Default value: V2
SDK attribute: IKEVersion

IPAddress string required   filterable   orderable  
Discussion

IP Address of the IKEv2 Gateway


Charateristics

Format: free
SDK attribute: IPAddress

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string filterable   orderable  
Discussion

Name of the IKEv2 Gateway


Charateristics

Format: free
SDK attribute: name