NSGatewayTemplate

Represents a Network Service Gateway Template.

Overview

description string filterable   orderable  
enterpriseID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
infrastructureAccessProfileID string
infrastructureProfileID string required  
instanceSSHOverride enum (ALLOWED | DISALLOWED) filterable   orderable  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
personality enum (NSG | NSGBR | NSGDUC) creation only   filterable   orderable  
SSHService enum (DISABLED | ENABLED) filterable   orderable  

API Resource

/nsgatewaytemplates/id
delete get put

Parents

/enterprises/id/nsgatewaytemplates
get
/nsgatewaytemplates
get post

Children

/nsgatewaytemplates/id/metadatas
get post
/nsgatewaytemplates/id/globalmetadatas
get post put
/nsgatewaytemplates/id/nsporttemplates
get post

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

A description of the Gateway template.


Charateristics

Format: free
Max length: 255
SDK attribute: description

enterpriseID string
Discussion

The enterprise associated with this Gateway template. This is a read only attribute


Charateristics

Format: free
SDK attribute: enterpriseID

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

infrastructureAccessProfileID string
Discussion

The ID of the infrastructure access profile associated to this Gateway Template.


Charateristics

Format: free
SDK attribute: infrastructureAccessProfileID

infrastructureProfileID string required  
Discussion

The ID of the infrastructure gateway profile this instance of a Gateway template is associated with.


Charateristics

Format: free
SDK attribute: infrastructureProfileID

instanceSSHOverride enum filterable   orderable  
Discussion

Indicates if this template instance allows the gateway instance(s) which inherit from it to independently enable/disable SSH service.


Charateristics

Allowed values: ALLOWED, DISALLOWED
Default value: DISALLOWED
SDK attribute: instanceSSHOverride

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of the Gateway template.


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

personality enum creation only   filterable   orderable  
Discussion

Personality of the Gateway template - NSG, NSGBR, cannot be changed after creation.


Charateristics

Allowed values: NSG, NSGBR, NSGDUC
SDK attribute: personality

SSHService enum filterable   orderable  
Discussion

Enable/Disable SSH Service on all the Gateway instances which inherit from this template.


Charateristics

Allowed values: DISABLED, ENABLED
Default value: ENABLED
SDK attribute: SSHService