Template Management-Network Interface
Network Interface is a template type that fetches the primary information and details about the network for a specified location.
API Calls
/V5/templates/NETWORK_INTERFACE
/V5/templates/{templateId}/NETWORK_INTERFACE
/V5/templates
/V5/templates/copy/{templateid}/NETWORK_INTERFACE
/V5/templates
/V5/templates/{templateId}/NETWORK_INTERFACE
JSON Table
Attribute | Data Type | Description | |
---|---|---|---|
type | String | The template type. | |
templateId | int | Template ID | |
templateName | String | Template name. | |
createdAtLocationId | application/json | ID of location at which the template is created. The value is of the type Location ID JSON. | |
description | String | For internal use only. | |
templateType | String | Template type. Applicable value is NETWORK_INTERFACE | |
mncTemplateId | int | System-generated ID of the template provided via the parent server to the child server. |
|
secondaryNetworkEnabled | boolean | Whether a secondary network interface is enabled or not. | |
primaryPriorityEnabled | boolean | Whether the primary interface must be preferred over the secondary. | |
primaryEthernetOverGreSettings | application/json | EoGRE settings for the primary interface. | |
primaryEthernetOverGreSettings/greKey | String | GRE key for the tunnel creation | |
primaryEthernetOverGreSettings/remoteIpAddress | String | IP address of the remote end point | |
primaryEthernetOverGreSettings/localVlan | int | The local VLAN on which the tunnel will be created. | |
secondaryEthernetOverGreSettings | application/json | EoGRE settings for the secondary interface. | |
secondaryEthernetOverGreSettings/greKey | String | GRE key | |
secondaryEthernetOverGreSettings/remoteIpAddress | String | IP of remore end point | |
secondaryEthernetOverGreSettings/localVlan | int | Local VLAn for tunnel creation | |
secondaryEthernetOverGreSettings/networkProbeInterval | int | The interval, in seconds, after which the AP checks connectivity with remote endpoint by sending a ping request packet. This can have a value between 10 and 3600. The interval must be a multiple of 10. | |
secondaryEthernetOverGreSettings/networkPingRetryCount | int | Count of ping request packets that the AP sends to the remote endpoint. The default value is 3. | |
secondaryEthernetOverGreSettings/networkPingTimeout | int | Time, in seconds, till which the AP waits for a ping reply. The default value is 60 seconds. | |
mnctemplate | boolean | True indicates this has been pushed by the parent server. |
Sample JSON
{ "type": "networkinterfaceprofile", "templateId": 1, "templateName": "Test Network", "createdAtLocationId": { "type": "locallocationid", "id": 0 }, "description": "", "templateType": "NETWORK_INTERFACE", "mncTemplateId": 0, "secondaryNetworkEnabled": true, "primaryPriorityEnabled": true, "primaryEthernetOverGreSettings": { "greKey": 1234, "remoteIpAddress": "192.168.55.111", "localVlan": 3 }, "secondaryEthernetOverGreSettings": { "greKey": 1234, "remoteIpAddress": "192.168.55.110", "localVlan": 3, "networkProbeInterval": 300, "networkPingRetryCount": 3, "networkPingTimeout": 60 }, "mnctemplate": false }