WANService

Represents a WAN Service Object.

Overview

associatedDomainID string
associatedVPNConnectID string
configType enum (DYNAMIC | STATIC) filterable   orderable  
description string filterable   orderable  
domainName string
enterpriseName string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
externalRouteTarget string filterable   orderable  
IRBEnabled boolean filterable   orderable  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
orphan boolean
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
servicePolicy string filterable   orderable  
serviceType enum (L2 | L3) required   filterable   orderable  
tunnelType enum (DC_DEFAULT | GRE | VXLAN)
userMnemonic string filterable   orderable  
useUserMnemonic boolean filterable   orderable  
vnId integer
WANServiceIdentifier string filterable   orderable  

API Resource

/services/id
delete get put

Parents

/redundancygroups/id/services
get post
/autodiscoveredgateways/id/services
get
/gateways/id/services
get post

Children

/services/id/permissions
get post
/services/id/metadatas
get post
/services/id/alarms
get
/services/id/globalmetadatas
get post put
/services/id/enterprisepermissions
get post
/services/id/eventlogs
get

Members

This object has no members.

Attributes documentation

associatedDomainID string
Discussion

ID of the entity to which the WAN Service is attached to. This could be ID DOMAIN/L2DOMAIN


Charateristics

Format: free
SDK attribute: associatedDomainID

associatedVPNConnectID string
Discussion

The associated vpn connect ID.


Charateristics

Format: free
SDK attribute: associatedVPNConnectID

configType enum filterable   orderable  
Discussion

Type of the CONFIG.


Charateristics

Allowed values: DYNAMIC, STATIC
SDK attribute: configType

description string filterable   orderable  
Discussion

A description of the WAN Service


Charateristics

Format: free
Max length: 255
SDK attribute: description

domainName string
Discussion

The associated domain name.


Charateristics

Format: free
SDK attribute: domainName

enterpriseName string
Discussion

The associated enterprise name.


Charateristics

Format: free
SDK attribute: enterpriseName

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

externalRouteTarget string filterable   orderable  
Discussion

Route target associated with the WAN. It is an optional parameterthat can be provided by the user


Charateristics

Format: free
Max length: 255
SDK attribute: externalRouteTarget

IRBEnabled boolean filterable   orderable  
Discussion

Determines whether Integrated Routing and Bridging is enabled on the WAN Service


Charateristics

SDK attribute: IRBEnabled

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 WAN Service


Charateristics

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

orphan boolean
Discussion

Indicates if this WAN Service is orphan or not.


Charateristics

SDK attribute: orphan

permittedAction enum
Discussion

The permitted action to USE/EXTEND this Gateway.


Charateristics

Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction

servicePolicy string filterable   orderable  
Discussion

Name of 7X50 Policy associated with the service


Charateristics

Format: free
Max length: 32
SDK attribute: servicePolicy

serviceType enum required   filterable   orderable  
Discussion

Type of the service.


Charateristics

Allowed values: L2, L3
SDK attribute: serviceType

tunnelType enum
Discussion

Type of the tunnel.


Charateristics

Allowed values: DC_DEFAULT, GRE, VXLAN
SDK attribute: tunnelType

userMnemonic string filterable   orderable  
Discussion

user mnemonic of the WAN Service


Charateristics

Format: free
Max length: 255
SDK attribute: userMnemonic

useUserMnemonic boolean filterable   orderable  
Discussion

Determines whether to use user mnemonic of the WAN Service


Charateristics

SDK attribute: useUserMnemonic

vnId integer
Discussion

VNID of the BackHaul Subnet of L3Domain /L2Domain to which this WANService is associated


Charateristics

SDK attribute: vnId

WANServiceIdentifier string filterable   orderable  
Discussion

Identifier of the WAN Service


Charateristics

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