. The response of this operation is a client key which can be polled to get progress of the requested operation. To poll for status, perform GET /backgroundTask/status/
operationId: applianceRestore
parameters:
- name: nePk
in: path
description: Appliance primary key
required: true
style: simple
schema:
type: string
requestBody:
description: Backup file
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/BackupFile'
- description: Backup file
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BackupAndRestoreResponse'
deprecated: false
/appliance/saveChanges:
post:
summary: saveChanges
description: the data to post contains ids, ids is an array of neIds.
operationId: saveChanges
parameters: []
requestBody:
description: JSON object containing an array of neIds
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SaveChangesPostBody'
- description: JSON object containing an array of neIds
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/appliance/saveChanges/{nePk}:
post:
summary: PostsaveChanges
description: The nePk is the id of the appliance in Orchestrator.
operationId: PostsaveChanges
parameters:
- name: nePk
in: path
description: The neId.
required: true
style: simple
schema:
type: string
requestBody:
description: This JSON object should contain nothing.
content:
text/plain:
schema:
type: object
description: This JSON object should contain nothing.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/appliance/statsConfig:
get:
summary: statsConfigGet
description: To get stats config which will be synchronized to appliances.
operationId: statsConfigGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/StatsConfig'
deprecated: false
post:
summary: statsConfigPost
description: To modify stats config which will be synchronized to appliances.
operationId: statsConfigPost
parameters: []
requestBody:
description: The config data to set for this API.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/StatsConfig'
- description: The config data to set for this API.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/appliance/statsConfig/default:
get:
summary: statsConfigDefaultGet
description: To get default stats config which will be synchronized to appliances.
operationId: statsConfigDefaultGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/StatsConfig'
deprecated: false
/appliance/wanNextHopHealth/{neId}:
get:
summary: WanNextHopHealthGet
description: Get wan next hop health config on the appliance
operationId: WanNextHopHealthGet
parameters:
- name: neId
in: path
description: Internal Id of the appliance from which you want to retrieve config information
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WanNextHopHealthGet'
deprecated: false
/appliance/{nePk}:
delete:
summary: ApplianceDel
description: Only use this if you truly want to delete the appliance from the network. This will remove the portal account name/key from the Orchestrator. The primary key must exist in Orchestrator.
operationId: ApplianceDel
parameters:
- name: nePk
in: path
description: nePk.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: ApplianceGetOne
description: Get appliance information
operationId: ApplianceGetOne
parameters:
- name: nePk
in: path
description: the primary key of appliance
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplianceItem'
deprecated: false
post:
summary: ApplianceChg
description: Modify an appliance's IP address, username, password, networkRole, and webProtocol.
operationId: ApplianceChg
parameters:
- name: nePk
in: path
description: Appliance primary key
required: true
style: simple
schema:
type: string
requestBody:
description: Appliance information
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AppliancePostData'
- description: Appliance information
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applianceResync:
post:
summary: ResyncAppliance
description: Synchronize operation will return a string key. Use /action/status?key=key to get the status of the operation.
operationId: ResyncAppliance
parameters: []
requestBody:
description: JSON object containing list of appliance keys
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResyncAppliancePost'
- description: JSON object containing list of appliance keys
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
'*/*':
schema:
type: string
description: No response was specified
deprecated: false
/appliancesSoftwareVersions/{nePK}:
get:
summary: AppliancesSoftwareVersions
description: Returns VXOA software versions information
operationId: AppliancesSoftwareVersions
parameters:
- name: nePK
in: path
description: nePK is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PartitionSoftwareVersionInfo'
description: No response was specified
deprecated: false
/application:
get:
summary: applicationGet
description: The schema shows a single application group object
operationId: applicationGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/applicationGet'
description: No response was specified
deprecated: false
/application/builtin:
get:
summary: builtin
description: Get all built-in applications from all appliance
operationId: builtin
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/applicationGet'
description: No response was specified
deprecated: false
/application/userDefined:
get:
summary: userDefined
description: Get all userDefined applications from all appliance
operationId: userDefined
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/applicationGet'
description: No response was specified
deprecated: false
/application/userDefinedConfig/{neId}:
get:
summary: userDefinedConfig
description: Get all user-defined application group on appliance
operationId: userDefinedConfig
parameters:
- name: neId
in: path
description: Internal Id of the appliance from which you want to retrieve status information
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/userDefinedConfig'
deprecated: false
/applicationDefinition/applicationTags:
get:
summary: appTagsGet
description: Use this api to find user defined application groups
operationId: appTagsGet
parameters:
- name: resourceKey
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: userDefined
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
post:
summary: appTagsPost
description: 'Warning: this api is not used for editing a single application group. Please use the same GET api to find all user defined application groups information first. Use this api to create application groups.'
operationId: appTagsPost
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/appTagsBody'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/applicationTags/wildcard:
post:
summary: appGroupSearchPost
description: Use this api to search application groups
operationId: appGroupSearchPost
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/searchWildcard'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/applicationTags/{mode}:
post:
summary: appTagsModePost
description: You are not allowed to change back to legacy mode if you are currently using our cloud based application definition
operationId: appTagsModePost
parameters:
- name: mode
in: path
description: either 'old' or 'new'
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/applications/wildcard:
post:
summary: appSearchPost
description: Use this api to search application
operationId: appSearchPost
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/searchWildcard'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/compoundClassification:
get:
summary: compoundGet
description: Use this api to view user defined application for Compound classification. Records with id greater 50000 are records from portal modified by user.
operationId: compoundGet
parameters:
- name: resourceKey
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: userDefined
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/compoundClassification/reorder:
post:
summary: compoundReorderPost
description: Use this api to change the order for all user defined application for Compound data. Please use the GET api to find all the ids. You need to include all the ids which are less or equal to 50000. You are not allowed to change the order for rules from portal.
operationId: compoundReorderPost
parameters: []
requestBody:
description: an array of comma separated ids. Please excludes ids greater than 50000. Please check the get api to find those ids.
content:
application/json:
schema:
type: array
items:
type: number
description: an array of comma separated ids. Please excludes ids greater than 50000. Please check the get api to find those ids.
format: double
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/compoundClassification/{id}:
delete:
summary: compoundDelete
description: Use this api to delete a user defined application for Compound data
operationId: compoundDelete
parameters:
- name: id
in: path
description: id
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
post:
summary: compoundPost
description: Use this api to create or modify a user defined application for Compound data
operationId: compoundPost
parameters:
- name: id
in: path
description: id
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/compound'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/dnsClassification:
get:
summary: dnsGet
description: Use this api to view user defined application for Domain Name classification
operationId: dnsGet
parameters:
- name: resourceKey
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: userDefined
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/dnsClassification/{domain}:
delete:
summary: dnsDelete
description: Use this api to delete a user defined application for Domain Name
operationId: dnsDelete
parameters:
- name: domain
in: path
description: domain
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
post:
summary: dnsPost
description: Use this api to create or modify a user defined application for domain name
operationId: dnsPost
parameters:
- name: domain
in: path
description: domain
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/dnsConfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/ipIntelligenceClassification:
get:
summary: ipIntelligenceGet
description: Use this api to view user defined application for Address Map classification
operationId: ipIntelligenceGet
parameters:
- name: resourceKey
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: userDefined
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/ipIntelligenceClassification/{ipStart}/{ipEnd}:
delete:
summary: ipIntelligenceDelete
description: Use this api to delete a user defined application for Address Map
operationId: ipIntelligenceDelete
parameters:
- name: ipStart
in: path
description: starting ip, IPv4 address in 32-bit integer format
required: true
style: simple
schema:
type: integer
format: int64
- name: ipEnd
in: path
description: ending ip, IPv4 address in 32-bit integer format
required: true
style: simple
schema:
type: integer
format: int64
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
post:
summary: ipIntelligencePost
description: Use this api to create or modify a user defined application for Address Map
operationId: ipIntelligencePost
parameters:
- name: ipStart
in: path
description: starting ip, IPv4 address in 32-bit integer format
required: true
style: simple
schema:
type: integer
format: int64
- name: ipEnd
in: path
description: ending ip, IPv4 address in 32-bit integer format
required: true
style: simple
schema:
type: integer
format: int64
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ipIntelligence'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/legacyAppliancesUdas:
get:
summary: legacyUdaGet
description: Use this api to view the legacy UDAs on each appliance. If you do not see anything, this means you do not have any UDAs available on appliance at migration time.
operationId: legacyUdaGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/meterFlowClassification:
get:
summary: meterFlowGet
description: Use this api to view user defined application for Meter Flow classification
operationId: meterFlowGet
parameters:
- name: resourceKey
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: userDefined
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/meterFlowClassification/{flowType}/{mid}:
delete:
summary: meterFlowDelete
description: Use this api to delete a user defined application for Meter Flow
operationId: meterFlowDelete
parameters:
- name: flowType
in: path
description: flow type, e.g. MF
required: true
style: simple
schema:
type: string
- name: mid
in: path
description: id
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
post:
summary: meterFlowPost
description: Use this api to create or modify a user defined application for Meter Flow
operationId: meterFlowPost
parameters:
- name: flowType
in: path
description: flow type, e.g. MF
required: true
style: simple
schema:
type: string
- name: mid
in: path
description: id
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/meterFlow'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/portProtocolClassification:
get:
summary: portProtocolGet
description: Use this api to view user defined application for IP/TCP/UDP classification
operationId: portProtocolGet
parameters:
- name: resourceKey
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: userDefined
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/portProtocolClassification/{port}/{protocol}:
delete:
summary: portProtocolDelete
description: Use this api to delete a user defined application for IP Protocol(port=0), TCP Protocol(protocol=6), UDP Protocol(protocol=17)
operationId: portProtocolDelete
parameters:
- name: port
in: path
description: port number
required: true
style: simple
schema:
type: integer
format: int32
- name: protocol
in: path
description: protocol number
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
post:
summary: portProtocolPost
description: Use this api to create or modify a user defined application for IP Protocol(port=0), TCP Protocol(protocol=6), UDP Protocol(protocol=17)
operationId: portProtocolPost
parameters:
- name: port
in: path
description: port number
required: true
style: simple
schema:
type: integer
format: int32
- name: protocol
in: path
description: protocol number
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/portProtocol'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/saasClassification:
get:
summary: saasGet
description: Use this api to view user defined application for SaaS classification.
operationId: saasGet
parameters:
- name: resourceKey
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: userDefined
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationDefinition/saasClassification/{id}:
delete:
summary: saasDelete
description: Use this api to delete a user defined application for SaaS data
operationId: saasDelete
parameters:
- name: id
in: path
description: id
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
post:
summary: PostcompoundPost
description: Use this api to create or modify a user defined application for SaaS data. Set the saasId to -1 if you need to create a new SaaS application.
operationId: PostcompoundPost
parameters:
- name: id
in: path
description: id
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/saas'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/applicationGroups/{neId}:
get:
summary: applicationGroups
description: Get all applicationGroups on a appliance
operationId: applicationGroups
parameters:
- name: neId
in: path
description: Internal Id of the appliance from which you want to retrieve status information
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/applicationGroups'
deprecated: false
/applicationTrends:
get:
summary: applicationTrends
description: '"appliance-name" key corresponds to a specific appliance name and "appName" corresponds to a specific application name'
operationId: applicationTrends
parameters:
- name: startDate
in: query
description: Beginning date for stats in milliseconds
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endDate
in: query
description: End date for stats in milliseconds
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: traffic
in: query
description: Traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/traffic'
- description: Traffic type
- name: bound
in: query
description: Traffic direction
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/bound'
- description: Traffic direction
- name: nePKList
in: query
description: 'List of appliances IDs like so: 0.NE,1.NE'
required: true
style: form
explode: true
schema:
type: string
- name: customRangeUsed
in: query
description: Indicates if custom date rage is used
style: form
explode: true
schema:
type: boolean
default: false
example: false
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationTrendsGet'
deprecated: false
/authRadiusTacacs/{neId}:
get:
summary: auth
description: the returned data contains aaa, radius and tacacs objects. aaa object includes auth_method and author objects. auth_method represents Authentication Order for the appliance, You can have upto 3 levels of Authentication Order (local, radius and tacacs).
author represents Authorization Information for the appliance and it consists of default user and map order.
radius and tacacs contains server object, The return value is a hash map of RADIUS/TACACS settings keyed by their Order.
operationId: auth
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Auth'
deprecated: false
/authentication/login:
post:
summary: authentication
description: Use this api to login to Orchestrator using FORM post. Commonly used to embed orchestrator UI or proxy orchestrator login via a web proxy.
operationId: authentication
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
enum:
- application/x-www-form-urlencoded
type: string
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- user
- password
type: object
properties:
user:
type: string
description: User id. Sent as a query param when login form is submitted
password:
type: string
description: Password. Sent as a query param when login form is submitted
required: false
responses:
'200':
description: No response was specified
headers: {}
content:
text/html:
schema:
type: string
description: No response was specified
deprecated: false
/authentication/loginStatus:
get:
summary: Getauthentication
description: Get the current authentication status of the HTTP session
operationId: Getauthentication
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/LoginStatus'
deprecated: false
/authentication/loginToken:
post:
summary: Postauthentication
description: Send a 2-factor code to user's mailbox for 2-factor authentication
operationId: Postauthentication
parameters: []
requestBody:
description: Json object containing user id and password, sent as user authentication information when user want to receive 2-factor code
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestLoginToken'
- description: Json object containing user id and password, sent as user authentication information when user want to receive 2-factor code
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: string
description: No response was specified
deprecated: false
/authentication/logout:
get:
summary: authentication1
description: Logout of current HTTP session
operationId: authentication1
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
text/html:
schema:
type: string
description: No response was specified
deprecated: false
/authentication/password/validation:
post:
summary: Postauthentication1
description: "Authenticate user's password only, but doesn't mark user's status as login "
operationId: Postauthentication1
parameters: []
requestBody:
description: Json object containing user id and password, sent as query param when user want to validate user's password
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LoginToken'
- description: Json object containing user id and password, sent as query param when user want to validate user's password
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: string
description: No response was specified
deprecated: false
/authentication/userAuthType:
post:
summary: userAuthType
description: Possible authentication types include PASSWORDONLY, MAIL, APP, MAIL_AND_APP
operationId: userAuthType
parameters: []
requestBody:
description: Json object containing user id and password
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LoginToken'
- description: Json object containing user id and password
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/userAuthType'
deprecated: false
/authentication/userAuthTypeToken:
post:
summary: userAuthTypeToken
description: Possible authentication types include PASSWORDONLY, MAIL, APP, MAIL_AND_APP
operationId: userAuthTypeToken
parameters: []
requestBody:
description: Json object containing the reset password token
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ResetPasswordToken'
- description: Json object containing the reset password token
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/avcMode:
get:
summary: avcMode
description: Returns Orchestrator avc Mode
operationId: avcMode
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/avcMode'
deprecated: false
/banners/{neId}:
get:
summary: bannerInfo
description: ' Lists the banner messages on each appliance'
operationId: bannerInfo
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BannerInfo'
deprecated: false
/bgp/config/neighbor/{neId}:
get:
summary: GetNeighbor
description: Get specific neighbor configuration data.
operationId: GetNeighbor
parameters:
- name: neId
in: path
description: neId of the appliance
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Neighbors'
deprecated: false
/bgp/config/system/{neId}:
get:
summary: GetBGPSystemConfig
description: Get BGP system configuration data.
operationId: GetBGPSystemConfig
parameters:
- name: neId
in: path
description: neId of the appliance
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BgpSystemConfig'
deprecated: false
/bgp/state/{neId}:
get:
summary: BGPState
description: Get specific appliance bgp state details.
operationId: BGPState
parameters:
- name: neId
in: path
description: neId of the appliance
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/StateObj'
deprecated: false
/brandCustomization:
delete:
summary: TextCustomizationConfigDelete
description: Delete all text brand customization configurations
operationId: TextCustomizationConfigDelete
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
get:
summary: TextCustomizationConfigGet
description: Get text brand customization configurations
operationId: TextCustomizationConfigGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/textCustomizationItems'
deprecated: false
post:
summary: TextCustomizationConfigPost
description: Create new text brand customization configurations
operationId: TextCustomizationConfigPost
parameters: []
requestBody:
description: POST body is an object of text customization configuration object
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/textCustomizationItems'
- description: POST body is an object of text customization configuration object
required: true
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
put:
summary: TextCustomizationConfigPut
description: Update text brand customization configurations
operationId: TextCustomizationConfigPut
parameters: []
requestBody:
description: PUT body is an object of text customization configuration object
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/textCustomizationItems'
- description: PUT body is an object of text customization configuration object
required: true
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/brandCustomization/image/:
get:
summary: fileNameGet
description: Return file names for all the uploaded images
operationId: fileNameGet
parameters:
- name: metaData
in: query
description: Sub-resource type
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/fileNames'
deprecated: false
/brandCustomization/image/{type}:
delete:
summary: imageDelete
description: Delete image for given type of brand customization and restore default
operationId: imageDelete
parameters:
- name: type
in: path
description: The type of customization. e.g. 'backgroundImage'.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
summary: imagePost
description: Upload image for given type of brand customization
operationId: imagePost
parameters:
- name: type
in: path
description: The type of customization. e.g. 'backgroundImage'.
required: true
style: simple
schema:
type: string
- name: qqfile
in: query
description: File name
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
put:
summary: PutimagePost
description: Update image for given type of brand customization
operationId: PutimagePost
parameters:
- name: type
in: path
description: The type of customization. e.g. 'backgroundImage'.
required: true
style: simple
schema:
type: string
- name: qqfile
in: query
description: File name
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/broadcastCli:
post:
summary: broadcastCliPost
description: Broadcasts CLI commands to all the selected appliances
operationId: broadcastCliPost
parameters: []
requestBody:
description: The data to post to this API
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/broadcastCliBody'
- description: The data to post to this API
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/bypass:
post:
summary: bypassPost
description: Toggles bypass mode - only effective on NX appliances
operationId: bypassPost
parameters: []
requestBody:
description: The data to post to this API
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/bypassBody'
- description: The data to post to this API
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/bypass/{nePk}:
get:
summary: bypassGet
description: Get bypass mode settings of one appliance in Orchestrator.
operationId: bypassGet
parameters:
- name: nePk
in: path
description: The neId of the appliance in Orchestrator.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Whether to get the info from Orchestrator database.
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/bypassGetBody'
deprecated: false
/cache/builtinApps:
get:
summary: builtinAppGet
description: Get all built in applications
operationId: builtinAppGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BuiltinApps'
deprecated: false
/cache/interfaceEndpoints:
get:
summary: interfaceGet
description: Get all appliances' interface endpoints' information including IP addresses.
operationId: interfaceGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Interfaces'
deprecated: false
/cache/userApps:
get:
summary: userAppGet
description: Gets the user applications
operationId: userAppGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/UserApps'
deprecated: false
/cloudApplications/config/{neId}:
get:
summary: cloudAppsConfig
description: 'This api provides the following information: SaaS Optimization flag (enabled/disabled), RTT Calculation Interval, RTT Ping Interface, and a list of Cloud Applications downloaded from portal'
operationId: cloudAppsConfig
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/cloudAppsConfig'
deprecated: false
/cloudApplications/monitor/{neId}:
get:
summary: cloudAppsMonitor
description: Get reachability/RTT values for SaaS App subnets enabled for advertisement
operationId: cloudAppsMonitor
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/cloudAppsMonitor'
deprecated: false
/configReportDisk/{neId}:
get:
summary: disks
description: the return data contains disks, controller objects and diskImage. disks object is a map of disk partitions keyed by their disk ids. controller object is a map of hard disk drive keyed by their disk ids.
operationId: disks
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DisksGet'
deprecated: false
/dbPartition/info:
get:
summary: dbPartition
description: Gets Orchestrator database partition details
operationId: dbPartition
parameters:
- name: table
in: query
description: Name of the table
style: form
explode: true
schema:
type: string
- name: partition
in: query
description: Name of the partition
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DbPartitionInfo'
description: No response was specified
deprecated: false
/dbPartition/{table}/{partition}:
delete:
summary: deletePartition
description: Delete default & current partition cannot be deleted
operationId: deletePartition
parameters:
- name: table
in: path
description: Name of the table
required: true
style: simple
schema:
type: string
- name: partition
in: path
description: Name of the partition
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/debugFiles/cancel:
post:
summary: cancel
description: Cancel download the file
operationId: cancel
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/debugFiles/delete:
post:
summary: deleteGMSDebugFile
description: Delete the Orchestrator debug file
operationId: deleteGMSDebugFile
parameters: []
requestBody:
description: The name of the orchestrator debug file
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DeleteGMSDebugFile'
- description: The name of the orchestrator debug file
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/debugFiles/delete/{nePk}:
post:
summary: deleteNeFile
description: Delete the debug file on the appliance
operationId: deleteNeFile
parameters:
- name: nePk
in: path
description: nePk is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
requestBody:
description: The info of the deleted file
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DeleteInfoClass'
- description: The info of the deleted file
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
'/debugFiles/proxyConfig ':
get:
summary: getProxyConfig
description: Return data is an object, the keys contains 'proxyHost', 'proxyPassword', 'proxyPort', 'proxyUser' and 'useProxy'
operationId: getProxyConfig
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyConfig'
deprecated: false
post:
summary: setProxyConfig
description: Set the proxy config settings
operationId: setProxyConfig
parameters: []
requestBody:
description: The proxy config settings
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ProxyConfig'
- description: The proxy config settings
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
'/debugFiles/{nePk} ':
get:
summary: debugFiles
description: Returned data is an object, The key is 'debugDump', 'techDump', 'snapshots', 'tcpDump', 'debugFile' and 'log', each value is an object of the debug file info. Each the debug file info contains 'name' and 'stats'. The value of the stats is an object of the stats.
operationId: debugFiles
parameters:
- name: nePk
in: path
description: nePk is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DebugFiles'
deprecated: false
/deployment/validate/{nePk}:
post:
summary: validateDeployment
description: Validate a deployment configuration, and see whether or not the deployment will require a reboot after apply.
operationId: validateDeployment
parameters:
- name: nePk
in: path
description: The appliance ne pk.
required: true
style: simple
schema:
type: string
requestBody:
description: The deployment configuration to validate on the appliance
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DeploymentPost'
- description: The deployment configuration to validate on the appliance
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentValidateResult'
deprecated: false
/deployment/validateDiscovered/{discoveredApplianceId}:
post:
summary: validateDiscoveredDeployment
description: Validate the deployment of an appliance that is discovered but not yet managed.
operationId: validateDiscoveredDeployment
parameters:
- name: discoveredApplianceId
in: path
description: The ID of the discovered appliance
required: true
style: simple
schema:
type: string
requestBody:
description: The deployment configuration to validate on the appliance
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DeploymentPost'
- description: The deployment configuration to validate on the appliance
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentValidateResult'
deprecated: false
/deployment/{nePk}:
get:
summary: getApplianceDeployment
description: Get the deployment configuration of the appliance, does a direct call to the appliance.
operationId: getApplianceDeployment
parameters:
- name: nePk
in: path
description: The appliance ne pk.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentGet'
deprecated: false
/dhcpConfig:
get:
summary: dhcpConfigGet
description: These setting are used to manage a global DHCP pool on the orchestrator. Also they serve as defaults for the DHCP settings in the Deployment Profiles
operationId: dhcpConfigGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dhcpConfig'
deprecated: false
post:
summary: dhcpConfigPost
description: Save orchestrator DHCP settings
operationId: dhcpConfigPost
parameters: []
requestBody:
description: JSON object containing DHCP settings
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dhcpConfig'
- description: JSON object containing DHCP settings
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/dhcpConfig/leases/{neId}:
get:
summary: dhcpdLeases
description: 'There may be dynamic fields in the actual data. For details regarding schema for leases file checkout: http://linux.die.net/man/5/dhcpd.leases'
operationId: dhcpdLeases
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dhcpdLeases'
- description: DHCP server lease records
deprecated: false
/dhcpConfig/reservations:
get:
summary: dhcpReservationsGet
description: Get list of reserved subnets from the DHCP pool
operationId: dhcpReservationsGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dhcpReservation'
description: No response was specified
deprecated: false
post:
summary: dhcpReservationsPost
description: Reserve a subnet in the DHCP pool
operationId: dhcpReservationsPost
parameters: []
requestBody:
description: JSON object containing DHCP pool reservation data
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dhcpReservation'
- description: JSON object containing DHCP pool reservation data
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/dhcpConfig/reservations/gms:
post:
summary: dhcpReservationsGmsPost
description: Update DHCP pool reservations list. This api can be used to clear up local reservations (that have not been configured on appliance yet)
operationId: dhcpReservationsGmsPost
parameters: []
requestBody:
description: JSON object containing DHCP pool reservation data
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dhcpReservationGms'
description: JSON object containing DHCP pool reservation data
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/dhcpConfig/reset:
post:
summary: dhcpConfigResetPost
description: Remove all DHCP pool reservations
operationId: dhcpConfigResetPost
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/dhcpConfig/state/failover/{neId}:
get:
summary: dhcpdFailoverStates
description: 'There may be dynamic fields in the actual data. For details regarding schema for leases file checkout: http://linux.die.net/man/5/dhcpd.leases'
operationId: dhcpdFailoverStates
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dhcpdFailoverStates'
- description: DHCP server lease report of failover state records
deprecated: false
/dnsProxy/config/{neId}:
get:
summary: dnsProxyConfigGet
description: The returned data is an object. It includes all of the DNS proxy configurations; notably the profiles, domain groups and maps.
operationId: dnsProxyConfigGet
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DnsProxyConfig'
deprecated: false
/exception/tunnel:
delete:
summary: tunnelExceptionDelete
description: Use this API to delete all current tunnel exceptions
operationId: tunnelExceptionDelete
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: tunnelExceptionGet
description: Get all tunnel exceptions
operationId: tunnelExceptionGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelExceptionEntry'
deprecated: false
post:
summary: tunnelExceptionPost
description: POST body is an array of tunnel exception entries.
operationId: tunnelExceptionPost
parameters: []
requestBody:
description: Array of tunnel Exception entry, 'id' of the exception must be 0 or not present
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TunnelExceptionEntry'
description: Array of tunnel Exception entry, 'id' of the exception must be 0 or not present
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelExceptionEntry'
deprecated: false
put:
summary: tunnelExceptionPut
description: Use this API to update multiple tunnel exceptions in one REST call.
operationId: tunnelExceptionPut
parameters: []
requestBody:
description: Array of tunnel exception entries, 'id's of entries must be valid existing
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TunnelExceptionEntry'
description: Array of tunnel exception entries, 'id's of entries must be valid existing
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/exception/tunnel/{id}:
delete:
summary: tunnelExceptionSingleDelete
description: Use this API to delete a specific tunnel exception.
operationId: tunnelExceptionSingleDelete
parameters:
- name: id
in: path
description: The valid id of the an existing tunnel exception.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
put:
summary: tunnelExceptionSingleUpdate
description: Use this API to update a specific tunnel exception.
operationId: tunnelExceptionSingleUpdate
parameters:
- name: id
in: path
description: The valid id of the an existing tunnel exception.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: Tunnel exception entry
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TunnelExceptionEntry'
- description: Tunnel exception entry
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/flow/flowBandwidthStats/{neId}/q:
get:
summary: flowBandwidthStats
description: Returns the so far accumulated bandwidth stats about the flow
operationId: flowBandwidthStats
parameters:
- name: neId
in: path
description: Appliance ID
required: true
style: simple
schema:
type: string
- name: id
in: query
description: Flow ID
required: true
style: form
explode: true
schema:
minimum: 1
type: integer
format: int64
- name: seq
in: query
description: Flow sequence number
required: true
style: form
explode: true
schema:
minimum: 1
type: integer
format: int64
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: object
description: No response was specified
deprecated: false
/flow/flowDetails/{neId}/q:
get:
summary: flowDetails
description: Returns flow details
operationId: flowDetails
parameters:
- name: neId
in: path
description: Appliance ID
required: true
style: simple
schema:
type: string
- name: id
in: query
description: Flow ID
required: true
style: form
explode: true
schema:
minimum: 1
type: integer
format: int64
- name: seq
in: query
description: Flow sequence number
required: true
style: form
explode: true
schema:
minimum: 1
type: integer
format: int64
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FlowDetails'
description: No response was specified
deprecated: false
/flow/flowDetails2/{neId}/q:
get:
summary: flowDetails2
description: Returns more detailed info about the flow
operationId: flowDetails2
parameters:
- name: neId
in: path
description: Appliance ID
required: true
style: simple
schema:
type: string
- name: id
in: query
description: Flow ID
required: true
style: form
explode: true
schema:
minimum: 1
type: integer
format: int64
- name: seq
in: query
description: Flow sequence number
required: true
style: form
explode: true
schema:
minimum: 1
type: integer
format: int64
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FlowDetails2'
description: No response was specified
deprecated: false
/flow/flowReClassification/{neId}:
post:
summary: flowsReclassification
description: Reclassifies the flow(s)
operationId: flowsReclassification
parameters:
- name: neId
in: path
description: Appliance ID
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FlowsResetBody'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FlowsResetResponse'
deprecated: false
/flow/flowReset/{neId}:
post:
summary: flowsReset
description: Resets the flow(s)
operationId: flowsReset
parameters:
- name: neId
in: path
description: Appliance ID
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FlowsResetBody'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FlowsResetResponse'
deprecated: false
/flow/{neId}/q:
get:
summary: flows
description: Flows can be more specifically filtered by the available query parameters.
operationId: flows
parameters:
- name: neId
in: path
description: Appliance ID
required: true
style: simple
schema:
type: string
- name: ip1
in: query
description: First IP endpoint
style: form
explode: true
schema:
type: string
- name: mask1
in: query
description: Mask for ip1
style: form
explode: true
schema:
type: integer
format: int32
- name: port1
in: query
description: Port of first IP endpoint
style: form
explode: true
schema:
minimum: 0
type: integer
format: int32
- name: ip2
in: query
description: Second IP endpoint
style: form
explode: true
schema:
type: string
- name: mask2
in: query
description: Mask for ip2
style: form
explode: true
schema:
type: integer
format: int32
- name: port2
in: query
description: Port of second IP endpoint
style: form
explode: true
schema:
minimum: 0
type: integer
format: int32
- name: ipEitherFlag
in: query
description: Enable directionality for IP. If true, ip1 will be treated as the source IP, and ip2 will be treated as the destination IP
style: form
explode: true
schema:
type: boolean
default: true
example: true
- name: portEitherFlag
in: query
description: Enable directionality for port. If true, port1 will be treated as the source port, and port2 will be treated as the destination port
style: form
explode: true
schema:
type: boolean
default: true
example: true
- name: application
in: query
description: Application specific flows. Drop-down only shows built-in apps and not user-defined apps
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/application'
- description: Application specific flows. Drop-down only shows built-in apps and not user-defined apps
- name: applicationGroup
in: query
description: Application groups. Drop-down only shows a small subset of application groups
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/applicationGroup'
- description: Application groups. Drop-down only shows a small subset of application groups
- name: protocol
in: query
description: Application protocol
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/protocol1'
- description: Application protocol
- name: vlan
in: query
description: Virtual LAN ID
style: form
explode: true
schema:
minimum: 0
type: integer
format: int32
- name: dscp
in: query
description: DSCP marking
style: form
explode: true
schema:
type: string
default: any
example: any
- name: overlays
in: query
description: Overlay ID. Multiple values must be separated with "|". E.g. "1|2"
style: form
explode: true
schema:
type: string
- name: transport
in: query
description: 'Transport type. Accepted values: "fabric", "underlay", "breakout". Multiple values must be separated with "|". E.g. "fabric|underlay". Note: Fabric refers to SD-WAN.'
style: form
explode: true
schema:
type: string
- name: services
in: query
description: Service name. Third party services should be formatted with an asterisk symbol at the end in order to filter by prefix instead of finding a complete match. Multiple services must be separated with "|". E.g. "Zscaler_*|PaloAlto"
style: form
explode: true
schema:
type: array
items:
type: string
- name: zone1
in: query
description: 'Flows to zone1. Values: "any", "0" (default), "zone_id"'
style: form
explode: true
schema:
type: string
- name: zone2
in: query
description: 'Flows from zone2. Values: "any", "0" (default), "zone_id"'
style: form
explode: true
schema:
type: string
- name: zoneEither
in: query
description: 'Flows either to zoneEither or from zoneEither. Values: "any", "0" (default), "zone_id"'
style: form
explode: true
schema:
type: string
- name: filter
in: query
description: Flow categories
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/filter1'
- description: Flow categories
- name: edgeHA
in: query
description: Edge HA flows. "True" to include, "False" to exclude
style: form
explode: true
schema:
type: boolean
default: false
example: false
- name: builtIn
in: query
description: Built-in policy flows. "True" to include, "False" to exclude
style: form
explode: true
schema:
type: boolean
default: false
example: false
- name: uptime
in: query
description: Active and ended flow timing. If not specified, it defaults to "anytime" plus "term"
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/uptime'
- description: Active and ended flow timing. If not specified, it defaults to "anytime" plus "term"
- name: bytes
in: query
description: Bytes transferred
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/bytes'
- description: Bytes transferred
- name: duration
in: query
description: Flows that have lasted less than ("<") or greater than (">") the specified duration (in minutes). Value should be "any" or a number formatted with a "<" or ">" in front of a value between 0 and 18446744073709551615. E.g. ">5000"
style: form
explode: true
schema:
type: string
default: any
example: any
- name: anytimeSlowFlows
in: query
description: Slow Flows flag. If this flag is present, it will show slow flows only
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FlowsGet'
deprecated: false
/gms/advancedProperties:
get:
summary: GetAdvProp
description: Get Orchestrator advanced properties
operationId: GetAdvProp
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedProperties'
deprecated: false
put:
summary: PostAdvProp
description: Update Orchestrator advanced properties
operationId: PostAdvProp
parameters: []
requestBody:
description: JSON object for Orchestrator Advanced Properties.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AdvancedProperties'
- description: JSON object for Orchestrator Advanced Properties.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/advancedProperties/metadata:
get:
summary: GetAdvProp1
description: Get Orchestrator metadata of the advanced properties
operationId: GetAdvProp1
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedPropertiesMetaData'
deprecated: false
/gms/appliance/preconfiguration:
get:
summary: getPreconfigurations
description: Get all preconfigurations
operationId: getPreconfigurations
parameters:
- name: filter
in: query
description: Any additional filters to be applied
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/filter2'
- description: Any additional filters to be applied
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/onePreconfig'
description: No response was specified
deprecated: false
post:
summary: createPreconfiguration
description: Create a preconfiguration
operationId: createPreconfiguration
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/createPreconfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/createPreconfigResponse'
deprecated: false
/gms/appliance/preconfiguration/default:
get:
summary: getDefaultPreconfigurations
description: Get the default preconfiguration, this contains the template YAML which has all possible configuration items. You will have to base64 decode configData to see the YAML in plain text
operationId: getDefaultPreconfigurations
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/onePreconfig'
description: No response was specified
deprecated: false
/gms/appliance/preconfiguration/findMatch:
post:
summary: getMatchingPreconfiguration
description: Get the first matching preconfiguration, matching by serial then tag
operationId: getMatchingPreconfiguration
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/matchPreconfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/onePreconfig'
deprecated: false
/gms/appliance/preconfiguration/validate:
post:
summary: PostgetMatchingPreconfiguration
description: Get the first matching preconfiguration, matching by serial then tag
operationId: PostgetMatchingPreconfiguration
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/createPreconfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
'400':
description: Preconfiguration isn't valid, response body will give the reason
headers: {}
content: {}
deprecated: false
/gms/appliance/preconfiguration/{preconfigId}:
delete:
summary: deletePreconfiguration
description: Delete one preconfiguration
operationId: deletePreconfiguration
parameters:
- name: preconfigId
in: path
description: The ID of the preconfiguration
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: getPreconfiguration
description: Get one preconfiguration
operationId: getPreconfiguration
parameters:
- name: preconfigId
in: path
description: The ID of the preconfiguration
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/onePreconfig'
deprecated: false
post:
summary: modifyPreconfiguration
description: Modify one preconfiguration
operationId: modifyPreconfiguration
parameters:
- name: preconfigId
in: path
description: The ID of the preconfiguration
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/createPreconfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/appliance/preconfiguration/{preconfigId}/apply:
get:
summary: getPreconfigurationApplyStatus
description: Get the apply status of a preconfiguration
operationId: getPreconfigurationApplyStatus
parameters:
- name: preconfigId
in: path
description: The ID of the preconfiguration
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/preconfigApplyStatus'
deprecated: false
/gms/appliance/preconfiguration/{preconfigId}/apply/discovered/{discoveredId}:
post:
summary: applyDiscoveredPreconfiguration
description: Use this API when you want to apply preconfiguration to a discovered appliance (this is an appliance that is in the discovered tab in the UI). Applying will happen in the asynchronously, so poll using GET /gms/appliance/preconfiguration/{preconfigId}/apply.
operationId: applyDiscoveredPreconfiguration
parameters:
- name: preconfigId
in: path
description: The ID of the preconfiguration
required: true
style: simple
schema:
type: string
- name: discoveredId
in: path
description: The ID of the target discovered appliance
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/appliance/preconfiguration/{preconfigId}/apply/{nePk}:
post:
summary: applyManagedPreconfiguration
description: Use this API when you want to apply preconfiguration to a managed appliance (this is an appliance that is in the tree in the UI). Applying will happen in the asynchronously, so poll using GET /gms/appliance/preconfiguration/{preconfigId}/apply.
operationId: applyManagedPreconfiguration
parameters:
- name: preconfigId
in: path
description: The ID of the preconfiguration
required: true
style: simple
schema:
type: string
- name: nePk
in: path
description: The ID of the target managed appliance
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/applianceCrashHistory:
get:
summary: CrashHistory
description: Depending on action parameter if the value is empty it returns all the appliance history otherwise it will send all the crash reports to portal
operationId: CrashHistory
parameters:
- name: action
in: query
description: if the value is empty it returns all the appliance history otherwise it will send all the crash reports to portal
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CrashHistory'
description: No response was specified
deprecated: false
/gms/applianceRebootHistory:
get:
summary: RebootHistory
description: Depending on action parameter if the value is empty it returns all the appliance history otherwise it will send all the reboot reports to portal
operationId: RebootHistory
parameters:
- name: action
in: query
description: if the value is empty it returns all the appliance history otherwise it will send all the reboot reports to portal
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RebootHistory'
description: No response was specified
deprecated: false
/gms/applianceWizard/apply/{nePk}:
get:
summary: getApplyApplianceWizard
description: Returns a handle to poll. Poll handle with /action/status?key={actionGroupId}
operationId: getApplyApplianceWizard
parameters:
- name: nePk
in: path
description: The nePk of the appliance
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplyWizardGet'
deprecated: false
post:
summary: applyApplianceWizard
description: >-
Applies the wizard to an appliance in the background. The wizard is broken into steps and each step is represented by an object in 'wizardData'. Every step is optional, if you don't want a step to be applied then delete it from the JSON when you POST. Subnets is special in that it will post to /subnets for <8.1.7 appliances and /subnets2 for >=8.1.7 appliances. If you are using an older appliance you will need to adjust the subnets.data section to match the appliance API format.
The actionGroupId is used to poll the status of applying the wizard with POST /action/status.
operationId: applyApplianceWizard
parameters:
- name: nePk
in: path
description: The nePk of the appliance
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ApplyWizardPost'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplyWizardGet'
deprecated: false
/gms/backup:
get:
summary: gmsBackupGet
description: There is only one orchestrator backup schedule job. Include the orchestrator configuration and orchestrator schedule information. Both the configuration and schedule information can be empty.
operationId: gmsBackupGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GmsBackupConfigObject'
deprecated: false
/gms/backup/config:
post:
summary: gmsBackupConfig
description: add or update orchestrator backup config data
operationId: gmsBackupConfig
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GmsBackupConfigObject'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/gms/backup/exportTemplate:
get:
summary: goldenOrchestratorExport
description: Create blueprint template
operationId: goldenOrchestratorExport
parameters:
- name: mode
in: query
description: "'template' or 'migration'"
required: true
style: form
explode: true
schema:
type: string
- name: download
in: query
description: any value would be considered true
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/backup/testConnection:
post:
summary: gmsBackupTestConnection
description: Test the orchestrator backup remote server whether can connect.
operationId: gmsBackupTestConnection
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GmsBackupConfigObject'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GmsBackupResponseObject'
deprecated: false
/gms/discovery:
get:
summary: getDiscoveryConfig
description: Returns the configuration for Discovery
operationId: getDiscoveryConfig
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DiscoveryConfiguration'
deprecated: false
post:
summary: updateDiscoveryConfig
description: 'Updates the discovery configuration with the object passed. Note: Replaces the whole configuration with the configuration passed'
operationId: updateDiscoveryConfig
parameters: []
requestBody:
description: An array of email addresses to send the discovery (discovered, approved and denied EdgeConnects) email to.
content:
application/json:
schema:
type: array
items:
type: string
description: An array of email addresses to send the discovery (discovered, approved and denied EdgeConnects) email to.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/dynamicTopologyConfig:
get:
summary: getDynamicTopologyConfig
description: Returns the configuration for the dynamic topology tab.
operationId: getDynamicTopologyConfig
parameters:
- name: userName
in: query
description: The username you want to retrieve the topology config for
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DynamicTopologyConfiguration'
deprecated: false
post:
summary: updateDynamicTopologyConfig
description: Updates the dynamic topology configuration for the given user
operationId: updateDynamicTopologyConfig
parameters:
- name: userName
in: query
description: The username you want to update the topology config for
required: true
style: form
explode: true
schema:
type: string
requestBody:
description: The topology configuration to save, where the user's username is the key.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DynamicPreferencesSaveForUser'
- description: The topology configuration to save, where the user's username is the key.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/dynamicTopologyConfig/{username}:
get:
summary: getUserDynamicTopologyConfig
description: Deprecated. Use the GET /gms/dynamicTopologyConfig with the userName query parameter
operationId: getUserDynamicTopologyConfig
parameters:
- name: username
in: path
description: The username of the user to retrieve the dynamic topology configuration of.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DynamicTopologyConfiguration'
deprecated: true
post:
summary: saveDynamicTopologyConfig
description: Deprecated. Use POST /gms/dynamicTopologyConfig with the username query parameter
operationId: saveDynamicTopologyConfig
parameters:
- name: username
in: path
description: The username to save the configuration under.
required: true
style: simple
schema:
type: string
requestBody:
description: The dynamic topology configuration to save, where the user's username is the key.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DynamicPreferencesSaveForUser'
- description: The dynamic topology configuration to save, where the user's username is the key.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: true
/gms/gmsRegistration:
get:
summary: mgmInterfaceByGet
description: Please use /gms/gmsRegistration2
operationId: mgmInterfaceByGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MgmInterfaceInfoDefault'
deprecated: true
post:
summary: mgmInterfaceByPost
description: Please use /gms/gmsRegistration2
operationId: mgmInterfaceByPost
parameters: []
requestBody:
description: Json object containing primary dns,secondary dns and domain name
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MgmInterfaceInfoDefault'
- description: Json object containing primary dns,secondary dns and domain name
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: true
/gms/gmsRegistration2:
get:
summary: mgmInterfaceByGet1
description: This configuration determines what appliances will use to connect to Orchestrator. If the customDefaultIP is a blank string, Orchestrator will send it's internal management IP (returned as internalManagementIP) as the default.
If any labels are configured, it will push that IP/domain instead.
operationId: mgmInterfaceByGet1
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MgmInterfaceInfoDefault2'
deprecated: false
post:
summary: mgmInterfaceByPost1
description: Configure what IP or domain is sent to appliances (to connect to Orchestrator). If the customDefaultIP is set to blank, Orchestrator will send it's internal management IP to the appliances. Otherwise, the default will be the customDefaultIP.
Under 'label' you can also specify which IP or domain to send if the appliance is using the label in it's deployment configuration.
If Orchestrator is managed by Orchestrator SP, the customDefaultIP cannot be empty
operationId: mgmInterfaceByPost1
parameters: []
requestBody:
description: Json object containing the custom default IP (if you don't want to use the Orchestrator's internal IP), and the specific label configuration (not required)
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MgmInterfaceInfoDefault2Post'
- description: Json object containing the custom default IP (if you don't want to use the Orchestrator's internal IP), and the specific label configuration (not required)
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/gms/grNode:
get:
summary: allGRNodeGet
description: Get appliance positions on a map for topology
operationId: allGRNodeGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GRNode'
description: No response was specified
deprecated: false
/gms/grNode/forNePk/{nePk}:
post:
summary: grNodeUpdateByNePk
description: Updates an appliance position by nePk. Will only update the values (wx, wy, latitude, longitude) if the value is not 0.
operationId: grNodeUpdateByNePk
parameters:
- name: nePk
in: path
description: The appliance's nePk
required: true
style: simple
schema:
type: string
requestBody:
description: Position object
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GRNodeUpdatePostBody'
- description: Position object
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/grNode/{grNodePk}:
get:
summary: grNodeGet
description: Get appliance position by graphical node primary key
operationId: grNodeGet
parameters:
- name: grNodePk
in: path
description: Graphical node primary key
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GRNode'
deprecated: false
post:
summary: grNodeUpdate
description: Update appliance position
operationId: grNodeUpdate
parameters:
- name: grNodePk
in: path
description: Graphical node primary key
required: true
style: simple
schema:
type: string
requestBody:
description: Position object
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GRNodeUpdatePostBody'
- description: Position object
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GRNode'
deprecated: false
/gms/group:
get:
summary: allGroupsGet
description: 'There are system groups and there are user defined groups. System groups are groups with id: 0.Network(Root group), 1.Network(Internal purposes) and 2.Network(Auto discovered group). User defined groups start with id: 3.Network onwards'
operationId: allGroupsGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Group'
description: No response was specified
deprecated: false
/gms/group/new:
post:
summary: groupAdd
description: Only name and parentId are required. Background image URL is optional.
operationId: groupAdd
parameters: []
requestBody:
description: Group information
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GroupNewPostBody'
- description: Group information
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/group/root:
get:
summary: rootGroupGet
description: Get root group
operationId: rootGroupGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
deprecated: false
/gms/group/{id}:
delete:
summary: groupDelete
description: Delete a group
operationId: groupDelete
parameters:
- name: id
in: path
description: group primary key
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: groupGet
description: 'There are system groups and there are user defined groups. System groups are groups with id: 0.Network(Root group), 1.Network(Internal purposes) and 2.Network(Auto discovered group). User defined groups start with id: 3.Network onwards'
operationId: groupGet
parameters:
- name: id
in: path
description: group primary key. Looks like "10.Network"
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
deprecated: false
post:
summary: groupUpdate
description: 'There are system groups and there are user defined groups. System groups are groups with id: 0.Network(Root group), 1.Network(Internal purposes) and 2.Network(Auto discovered group). User defined groups start with id: 3.Network onwards'
operationId: groupUpdate
parameters:
- name: id
in: path
description: group primary key. Looks like "10.Network"
required: true
style: simple
schema:
type: string
requestBody:
description: group information
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GroupUpdatePostBody'
- description: group information
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/httpsCertificate:
post:
summary: httpsCertificateValidation
description: upload the intermediate certs, certificate and key files
operationId: httpsCertificateValidation
parameters: []
requestBody:
description: A JSON object representing intermediate certs, certificate and key files
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/certKeyValidation'
- description: A JSON object representing intermediate certs, certificate and key files
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/httpsCertificate/validation:
post:
summary: httpsCertificateValidation1
description: Validate the certificate and key
operationId: httpsCertificateValidation1
parameters: []
requestBody:
description: A JSON object representing certificate and key files
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/certKeyValidation'
- description: A JSON object representing certificate and key files
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/interfaceLabels:
get:
summary: getInterfaceLabels
description: Returns all the interface labels saved
operationId: getInterfaceLabels
parameters:
- name: active
in: query
description: Boolean flag to return only the active (active = true) or only inactive (acive = false)
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InterfaceLabels'
deprecated: false
post:
summary: postInterfaceLabels
description: Save interface labels, will completely replace the current implementation. You cannot remove labels that are in use in an overlay
operationId: postInterfaceLabels
parameters:
- name: deleteDependencies
in: query
description: Whether or not you want to delete the labels from port profiles and templates using it
style: form
explode: true
schema:
type: boolean
requestBody:
description: Object of labels you wish to save (will overwrite the current lan labels list). To remove a label, set the 'active' to false.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/InterfaceLabels'
- description: Object of labels you wish to save (will overwrite the current lan labels list). To remove a label, set the 'active' to false.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/interfaceLabels/{type}:
get:
summary: getLabelsForType
description: Returns all the labels for the given type
operationId: getLabelsForType
parameters:
- name: type
in: path
description: The type of interface that you want to retrieve the list of labels of [wan, lan].
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/type2'
- description: The type of interface that you want to retrieve the list of labels of [wan, lan].
- name: active
in: query
description: Boolean flag to return only the active (active = true) or only inactive (acive = false)
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/InterfaceLabel'
deprecated: false
/gms/internalSubnets2:
get:
summary: getInternalSubnets
description: This is the list of internal subnets used to classify internet traffic. Any traffic not matching these internal subnets will be classified as internet traffic. This list will be pushed to appliances.
operationId: getInternalSubnets
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InternalSubnetsApiObject'
deprecated: false
post:
summary: saveInternalSubnets
description: Save the list of internal subnets to use to classify internet traffic. Any traffic not matching the internal subnets will be classified as internet traffic. This list will be pushed to all appliances. User can configure up to 512 subnets in each ipv4 and ipv6 entry.
operationId: saveInternalSubnets
parameters: []
requestBody:
description: ''
content:
text/plain:
schema:
type: string
required: false
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/ipwhitelist/drops:
get:
summary: getIPWhitelistDrops
description: The IP addresses of the dropped requests on this server
operationId: getIPWhitelistDrops
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IpWhitelistDrop'
description: No response was specified
deprecated: false
/gms/ipwhitelist/external:
get:
summary: getExternalIPWhitelist
description: This is the list of external subnet addresses allowed to access this server.
operationId: getExternalIPWhitelist
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
post:
summary: setExternalIPWhitelist
description: This is the list of external subnet addresses allowed to access this server.
operationId: setExternalIPWhitelist
parameters: []
requestBody:
description: This is the list of external subnet addresses allowed to access this server.
content:
application/json:
schema:
type: array
items:
type: string
description: This is the list of external subnet addresses allowed to access this server.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/job:
get:
summary: scheduledJobsGet
description: 'Return all the scheduled jobs. "Minute schedule - Every minute starting at effectiveTime(in epoch sec )"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"minutes": 1
}
},
"Hourly Schedule - every seven hours starting from effectiveTime"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"hourly": 7
}
},
"Daily Schedule - every weekday at 2:03 am"
"schedule": {
"effectiveTime": 1431968786,
"endTime": 1494435986,
"recurrence": {
"daily" : {
"everyWeekDay" : true,
"occursAt" : {
"hour": 2,
"minute": 3
}
}
},
"timezoneOffset": "-08:00"
},
"Daily Schedule - every day at 2:03 am"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"daily" : {
"everyDay" : true,
"occursAt" : {
"hour": 2,
"minute": 3
}
}
},
"timezoneOffset": "-08:00"
},
"Weekly Schedule - every sun, mon, tue and sat at 1:03 am. Timezone offset if the client offset"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"weekly": {
"daysOfTheWeek": [1,2,3,7],
"occursAt" : {
"hour": 1,
"minute": 3
}
}
},
"timezoneOffset": "-08:00"
},
"Monthly Schedule - every 2nd day of every 3 months at 12:06 pm. Timezone offset if the client offset"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"monthly": {
"type3": {
"day": 2,
"everyXMonths": 3
},
"occursAt" : {
"hour": 12,
"minute": 6
}
}
},
"timezoneOffset": "-08:00"
},
"Monthly Schedule - First Tue of every 4 months at 12:06 pm. Rank - 1,2,3,4 dayOfTheWeek - 1 (Sun), 2(Mon)...7(Sat)"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"monthly": {
"type4" : {
"rank": 1,
"dayOfTheWeek": 3,
"everyXMonths": 4
},
"occursAt" : {
"hour": 12,
"minute": 6
}
}
},
"timezoneOffset": "-08:00"
},
"Monthly Schedule - First day of every month at 12:00 pm"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"monthly": {
"type1" : {
"firstDayOfEveryMonth": true
},
"occursAt" : {
"hour": 12,
"minute": 0
}
}
},
"timezoneOffset": "-7:00"
},
"Monthly Schedule - Last day of every month at 12:00 pm"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"monthly": {
"type2" : {
"lastDayOfEveryMonth": true
},
"occursAt" : {
"hour": 12,
"minute": 0
}
}
},
"timezoneOffset": "-7:00"
},
"Yearly Schedule - Jan 2nd every year at 12:02 pm. month - 1(Jan), 2(Feb)..."
"schedule": {
{
"effectiveTime": 12234343,
"recurrence" : {
"yearly": {
"type1": {
"month": 1,
"day": 2
}
"occursAt" : {
"hour": 12,
"minute": 2
}
}
}
},
"timezoneOffset": "-7:00"
},
"Yearly Schedule - 1st Monday of Jan every year at 12:02 pm. rank - 1,2,3,4 dayOfTheWeek - 1(Sun), 2(Mon)... 7(Sat) month - 1(Jan), 2(Feb)..."
"schedule": {
{
{
"effectiveTime": 12234343,
"recurrence" : {
"yearly": {
"type2: {
"rank": 1,
"dayOfTheWeek": 2
"month": 1
}
"occursAt" : {
"hour": 12,
"minute": 2
}
}
}
},
"timezoneOffset": "-7:00"
},
"Run now job schedule"
"schedule": {
"runNow": true
}
'
operationId: scheduledJobsGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScheduledJob2Get'
description: No response was specified
deprecated: false
post:
summary: ScheduledJob2Post
description: '"Job category for Orchestrator jobs. "
2 - Orchestrator Report,
3 - Orchestrator Backup,
4 - Appliance Reboot or Shutdown,
5 - Appliance QOS Scheduling,
6 - IPsec Pre-shared Key Rotation;
"Sample POST"
{
"jobCategory": 2,
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"minutes": 1
}
},
"config": {"a": 1},
"description": "minute schedule",
"targetAppliance": {
"groupPks" : ["1.Network", "2.Network"],
"nePks": ["1.NE", "2.NE"]
}
}
'
operationId: ScheduledJob2Post
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledJob2Post'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/html:
schema:
type: string
description: No response was specified
deprecated: false
/gms/job/historical:
get:
summary: HistoricalJobsGet
description: Every job on its completion, will make an entry to historical jobs table. This api will return all the historical jobs
operationId: HistoricalJobsGet
parameters:
- name: lastXDays
in: query
description: Jobs ended in last x days, Can combine use with scheduleId
style: form
explode: true
schema:
type: integer
format: int32
- name: scheduleId
in: query
description: get historical Jobs by scheduleId
style: form
explode: true
schema:
type: integer
format: int32
- name: latest
in: query
description: get latest historical Job, Can combine use with scheduleId
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/HistoricalJobItem'
description: No response was specified
deprecated: false
/gms/job/historical/{jobId}:
get:
summary: HistoricalJobsGetById
description: Every job on its completion, will make an entry to historical jobs table.
operationId: HistoricalJobsGetById
parameters:
- name: jobId
in: path
description: Get historical Job by Id.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/HistoricalJobItem'
- description: The detail historical job information for one item.
deprecated: false
/gms/job/{jobId}:
delete:
summary: scheduledJobDelete
description: Deletes a schedule job
operationId: scheduledJobDelete
parameters:
- name: jobId
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: ScheduledJob2Get
description: Get scheduled jobs list for one specified appliance based on the nePk Id
operationId: ScheduledJob2Get
parameters:
- name: jobId
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
put:
summary: scheduledJobModify
description: '"Job category for Orchestrator jobs. "
2 - Orchestrator Report,
3 - Orchestrator Backup,
4 - Appliance Reboot or Shutdown,
5 - Appliance QOS Scheduling,
6 - IPsec Pre-shared Key Rotation;
"Sample POST"
{
"jobCategory": 2,
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"minutes": 1
}
},
"config": {"a": 1},
"description": "minute schedule",
"targetAppliance": {
"groupPks" : ["1.Network", "2.Network"],
"nePks": ["1.NE", "2.NE"]
}
}
'
operationId: scheduledJobModify
parameters:
- name: jobId
in: path
description: The id of the job.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledJob2Post'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/job/{jobId}/stop:
post:
summary: stopJob
description: Stop a scheduled job
operationId: stopJob
parameters:
- name: jobId
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/menuCustomization:
get:
summary: getAllMenuItems
description: All the checked menu items with different menu type names
operationId: getAllMenuItems
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/menuType'
deprecated: false
post:
summary: addMenuType
description: Store or update the checked menu items for a special menu type name
operationId: addMenuType
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/menuType'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
put:
summary: updateMenuTypeItems
description: Configure users for menu types and set default menu type for monitoring users
operationId: updateMenuTypeItems
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/updateMenuType'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/menuCustomization/{menuTypeName}:
delete:
summary: deleteExistingMenuType
description: Delete the a special menu type, including its checked menu items and configured users
operationId: deleteExistingMenuType
parameters:
- name: menuTypeName
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/overlays/association:
get:
summary: getAllOverlayApplianceAssociations
description: This resource returns an object, where the keys are overlay IDs, and the value is an array of appliances belonging to that overlay.
operationId: getAllOverlayApplianceAssociations
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: object
additionalProperties:
type: string
deprecated: false
post:
summary: addOverlayApplianceAssociations
description: The request body is an object, where the keys are overlay IDs and the values are appliances to add to the respective overlays
operationId: addOverlayApplianceAssociations
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
type: object
additionalProperties:
type: string
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/overlays/association/remove:
post:
summary: removeAppliancesFromOverlays
description: The request body is an object, where the keys are overlay IDs and the values are appliances to remove from the respective overlays
operationId: removeAppliancesFromOverlays
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
type: object
additionalProperties:
type: string
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/overlays/association/{overlayId}:
get:
summary: getAppliancesForOverlay
description: Get appliances in an overlay
operationId: getAppliancesForOverlay
parameters:
- name: overlayId
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: object
additionalProperties:
type: string
deprecated: false
/gms/overlays/association/{overlayId}/{nePk}:
delete:
summary: deleteOverlayApplianceAssociation
description: Removes the appliance from the overlay, given the appliance ID (nePk) and overlay ID (overlayId).
operationId: deleteOverlayApplianceAssociation
parameters:
- name: overlayId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: nePk
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/overlays/config:
get:
summary: getAllOverlays
description: All the overlays stored in the Orchestrator
operationId: getAllOverlays
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OverlayConfig'
description: No response was specified
deprecated: false
post:
summary: addNewOverlay
description: "Use this API to add a new overlay configuration. If successful, the API will return the ID of the overlay added.
Please see the model for more information (click 'Model' under Data Type)
Valid values:
Topology type: - 1 - Mesh
- 2 - Hub and Spoke
Bonding Policy:
- 1 - High availability
- 2 - High quality
- 3 - High throughput
- 4 - High efficiency
Overlay Fallback Option
- 1 - pass-through
- 3 - drop
- label_{labelId} - pass-through an interface with a specific label
Internet Policy - policyList - The policy list is what policies to take, in order, for internet traffic. If the first policy fails, it will try the next one. The items in the list can be one of the options below, or a service name. The service name needs to match the peer name of a passthrough tunnel on the appliance.
- backhaul_via_overlay - Send the internet traffic back through overlay
- local_breakout - Break out locally through specific interfaces (must configure interface label IDs in localBreakout)
- localBreakout - Two lists (primary/backup) of the interface labels to break out of (see model for more details)
"
operationId: addNewOverlay
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NewOverlayConfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/overlays/config/maxNumOfOverlays:
get:
summary: getMaxNumberOfOverlays
description: Get the max number of overlays you are allowed to have on this Orchestrator
operationId: getMaxNumberOfOverlays
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MaxOverlaysResponse'
deprecated: false
/gms/overlays/config/regions:
get:
summary: getAllRegionalOverlays
description: All the overlays stored in the Orchestrator keyed by overlayId and regionId
operationId: getAllRegionalOverlays
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OverlayIdToRegionalOverlay'
deprecated: false
post:
summary: PostAllRegionalOverlays
description: "Use this API to post an exhaustive representation of regionalized overlays. The body of this request should be a map keyed by overlayId whose value is a map of regionId to regional overlay configuration. Please see the model for more information (click 'Model' under Data Type)
Valid values:
Topology type: - 1 - Mesh
- 2 - Hub and Spoke
Bonding Policy:
- 1 - High availability
- 2 - High quality
- 3 - High throughput
- 4 - High efficiency
Overlay Fallback Option
- 1 - pass-through
- 3 - drop
- label_{labelId} - pass-through an interface with a specific label
Internet Policy - policyList - The policy list is what policies to take, in order, for internet traffic. If the first policy fails, it will try the next one. The items in the list can be one of the options below, or a service name. The service name needs to match the peer name of a passthrough tunnel on the appliance.
- backhaul_via_overlay - Send the internet traffic back through overlay
- local_breakout - Break out locally through specific interfaces (must configure interface label IDs in localBreakout)
- localBreakout - Two lists (primary/backup) of the interface labels to break out of (see model for more details)
"
operationId: PostAllRegionalOverlays
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OverlayIdToRegionalOverlay'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/overlays/config/regions/{overlayId}/{regionId}:
get:
summary: GetRegionalOverlay
description: Get regional overlay by overlayId and regionId
operationId: GetRegionalOverlay
parameters:
- name: overlayId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: regionId
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OverlayConfig'
deprecated: false
put:
summary: ModifyRegionalOverlay
description: Modify regional overlay
operationId: ModifyRegionalOverlay
parameters:
- name: overlayId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: regionId
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OverlayConfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/overlays/config/{overlayId}:
delete:
summary: deleteExistingOverlay
description: Deletes the overlay from the Orchestrator. Removes any appliances from the overlay and deletes any reports specifically for this overlay.
operationId: deleteExistingOverlay
parameters:
- name: overlayId
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: getOverlay
description: Returns one overlay that has the id of the passed overlayId parameter
operationId: getOverlay
parameters:
- name: overlayId
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OverlayConfig'
deprecated: false
put:
summary: updateExistingOverlay
description: "Use this API to update an existing overlay configuration. If you are using regions and have customized regional BIO per region, it will be overridden. To avoid this use the other PUT api which takes regionID as an input. Any changes made to the overlay configuration will be pushed to the appliances automatically.
Please see the model for more information (click 'Model' under Data Type)
Valid values:
Topology type: - 1 - Mesh
- 2 - Hub and Spoke
Bonding Policy:
- 1 - High availability
- 2 - High quality
- 3 - High throughput
- 4 - High efficiency
Overlay Fallback Option
- 1 - pass-through
- 3 - drop
- label_{labelId} - pass-through an interface with a specific label
Internet Policy - policyList - The policy list is what policies to take, in order, for internet traffic. If the first policy fails, it will try the next one. The items in the list can be one of the options below, or a service name. The service name needs to match the peer name of a passthrough tunnel on the appliance.
- backhaul_via_overlay - Send the internet traffic back through overlay
- local_breakout - Break out locally through specific interfaces (must configure interface label IDs in localBreakout)
- localBreakout - Two lists (primary/backup) of the interface labels to break out of (see model for more details)
"
operationId: updateExistingOverlay
parameters:
- name: overlayId
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OverlayConfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/overlays/priority:
get:
summary: getOverlayPriorityMap
description: 'This API returns a JSON object where the key is the priority, and the value of the key is the overlay ID with that priority.
Example:
{ 1 : 2, 2 : 3, 3 : 1 }
This would order the overlays with the overlay with ID 2 first, overlay with ID 3 second, etc.'
operationId: getOverlayPriorityMap
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: object
additionalProperties:
type: number
format: double
deprecated: false
post:
summary: saveOverlayPriority
description: "This API sets the overlay priorities, specifically the order of the different overlays' route maps. The priority is a JSON object where the key is the priority, and the value of the key is the overlay ID with that priority.
Example:
{ 1 : 2, 2 : 3, 3 : 1 }
This would order the overlays with the overlay with ID 2 first, overlay with ID 3 second, etc."
operationId: saveOverlayPriority
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
type: object
additionalProperties:
type: number
format: double
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/scheduleTimezone:
get:
summary: getScheduleTimezone
description: Returns the configured timezone for scheduled jobs and reports
operationId: getScheduleTimezone
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleTimezoneConfiguration'
deprecated: false
post:
summary: updateScheduleTimezone
description: Updates the schedule timezone used with for the scheduled jobs and reports.
operationId: updateScheduleTimezone
parameters: []
requestBody:
description: The timezone to set for the scheduled jobs and reports.
content:
text/plain:
schema:
type: string
description: The timezone to set for the scheduled jobs and reports.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/services:
get:
summary: getServices
description: The list of services is used to provide options in the Overlay editor's Internet Policy section. For every service, a 'Send to ' option will be shown in the available options list. The service name will correspond to the peer name of the pass through tunnel the internet traffic will go on. It is the user's responsibility to create these pass through tunnels on appliances.
operationId: getServices
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SampleServiceSet'
deprecated: false
post:
summary: saveServices
description: Saving a new service list will completely replace the current implementation. Any service IDs that were saved previously, but not included in the POST body will be removed. These services will also be removed from the overlay's policy list.
operationId: saveServices
parameters: []
requestBody:
description: Object of services you wish to save.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SampleServiceSet'
- description: Object of services you wish to save.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/sessionTimeout:
get:
summary: sessionTimeout
description: Returns information of auto logout and max login session
operationId: sessionTimeout
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/UserSessionInfo'
deprecated: false
put:
summary: PutsessionTimeout
description: Update auto logout and max login session
operationId: PutsessionTimeout
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/sessionDetail'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/statsCollection:
get:
summary: statsCollection
description: Gets stats collection enable/disable details
operationId: statsCollection
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/statsCollection'
deprecated: false
post:
summary: PoststatsCollection
description: Used to enable/disable stats collection by orchestrator
operationId: PoststatsCollection
parameters: []
requestBody:
description: Json object for enable/disable stats collection by orchestrator
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/statsCollection'
- description: Json object for enable/disable stats collection by orchestrator
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/statsCollection/default:
get:
summary: StatsCollectionDefault
description: To get default values for stats collection
operationId: StatsCollectionDefault
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/statsCollection'
deprecated: false
/gms/thirdPartyServices:
get:
summary: getThirdPartyServices
description: The list of services is used to provide options in the Overlay editor's Internet Policy section. For every service, a dynamically generated options list will be shown in the available options list. The service name will correspond to the peer name of the pass through tunnel the internet traffic will go on. Pass through tunnels will be generated automatically.
operationId: getThirdPartyServices
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SampleThirdPartyServiceSet'
deprecated: false
/gms/topologyConfig:
get:
summary: getDefaultTopologyConfig
description: Returns the configuration for the topology tab. The key in the configuration will be the username.
operationId: getDefaultTopologyConfig
parameters:
- name: userName
in: query
description: The username you want to retrieve the topology config for
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TopologyConfiguration'
deprecated: false
post:
summary: updateTopologyConfig
description: Updates the topology configuration for the given user
operationId: updateTopologyConfig
parameters:
- name: userName
in: query
description: The username you want to update the topology config for
required: true
style: form
explode: true
schema:
type: string
requestBody:
description: The topology configuration to save, where the user's username is the key.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PreferencesSaveForUser'
- description: The topology configuration to save, where the user's username is the key.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/topologyConfig/map:
post:
summary: saveMapImage
description: Update the map image
operationId: saveMapImage
parameters: []
requestBody:
description: The map image to save.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MapSave'
- description: The map image to save.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/topologyConfig/{username}:
get:
summary: getUserTopologyConfig
description: Deprecated. Use GET /gms/topologyConfig with the username query parameter
operationId: getUserTopologyConfig
parameters:
- name: username
in: path
description: The username of the user to retrieve the topology configuration of.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TopologyConfiguration'
deprecated: true
post:
summary: saveTopologyConfig
description: 'Deprecated. Use POST /gms/topologyConfig with the username query parameter '
operationId: saveTopologyConfig
parameters:
- name: username
in: path
description: The username to save the configuration under.
required: true
style: simple
schema:
type: string
requestBody:
description: The topology configuration to save, where the user's username is the key.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PreferencesSaveForUser'
- description: The topology configuration to save, where the user's username is the key.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: true
/gms/tunnelGroups/association:
get:
summary: getAllTunnelGroupApplianceAssociations
description: This resource returns an object, where the keys are tunnel group IDs, and the value is an array of appliances belonging to that tunnel group.
operationId: getAllTunnelGroupApplianceAssociations
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: object
additionalProperties:
type: string
deprecated: false
post:
summary: addTunnelGroupApplianceAssociations
description: The request body is an object, where the keys are tunnel group IDs and the values are appliances to add to the respective tunnel groups
operationId: addTunnelGroupApplianceAssociations
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
type: object
additionalProperties:
type: string
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/tunnelGroups/association/{tunnelGroupId}:
get:
summary: getAppliancesForTunnelGroup
description: Get appliances in a tunnel group
operationId: getAppliancesForTunnelGroup
parameters:
- name: tunnelGroupId
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: object
additionalProperties:
type: string
deprecated: false
/gms/tunnelGroups/association/{tunnelGroupId}/{nePk}:
delete:
summary: deleteTunnelGroupApplianceAssociation
description: Removes the appliance from the tunnel group, given the appliance ID (nePk) and tunnel group ID (tunnelGroupId).
operationId: deleteTunnelGroupApplianceAssociation
parameters:
- name: tunnelGroupId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: nePk
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/tunnelGroups/config:
get:
summary: getAllTunnelGroups
description: Returns all the tunnel group configurations stored in the Orchestrator
operationId: getAllTunnelGroups
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TunnelGroupConfig'
description: No response was specified
deprecated: false
post:
summary: addNewTunnelGroup
description: Saves a new tunnel group configuration to the Orchestrator
operationId: addNewTunnelGroup
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NewTunnelGroupConfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/tunnelGroups/config/{id}:
delete:
summary: deleteExistingTunnelGroup
description: Deletes the tunnel group from the Orchestrator. Removes any appliances from the tunnel group.
operationId: deleteExistingTunnelGroup
parameters:
- name: id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: getTunnelGroup
description: Returns one tunnel group that matches the ID given
operationId: getTunnelGroup
parameters:
- name: id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelGroupConfig'
deprecated: false
put:
summary: updateExistingTunnelGroup
description: Update the properties of an existing tunnel group
operationId: updateExistingTunnelGroup
parameters:
- name: id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelGroupConfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/tunnelGroups/properties:
get:
summary: getTunnelGroupProperties
description: Get the tunnel group management properties
operationId: getTunnelGroupProperties
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelGroupPropertiesGet'
deprecated: false
post:
summary: setTunnelGroupProperties
description: Set the tunnel group management properties
operationId: setTunnelGroupProperties
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelGroupPropertiesSet'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gms/versions:
get:
summary: versionInfo
description: Returns available orchestrator versions
operationId: versionInfo
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VersionInfo'
deprecated: false
/gmsConfig:
get:
summary: gmsConfig
description: Returns all Orchestrator configs
operationId: gmsConfig
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GmsConfigItem'
description: No response was specified
deprecated: false
post:
summary: PostgmsConfig
description: Creates an Orchestrator config
operationId: PostgmsConfig
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GmsConfigCreation'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gmsConfig/{base}:
delete:
summary: DeletegmsConfig
description: Deletes an Orchestrator config
operationId: DeletegmsConfig
parameters:
- name: base
in: path
description: resource name
required: true
style: simple
schema:
type: string
- name: resourceKey
in: query
description: if provided, it will only delete the sub-resource
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: GetgmsConfig
description: Returns specific Orchestrator config. But a specific Orchestrator config could have multiple sub-resources, that's why it returns an array. However, If "resourceKey" is provided, response will be an object(sub-resource) instead of an array
operationId: GetgmsConfig
parameters:
- name: base
in: path
description: name resource
required: true
style: simple
schema:
type: string
- name: resourceKey
in: query
description: if provided, response will be an object instead of an array
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GmsConfigItem'
description: No response was specified
deprecated: false
put:
summary: PutgmsConfig
description: Updates a versioned Orchestrator config. Current resource version number needs to be provided when updating
operationId: PutgmsConfig
parameters:
- name: base
in: path
description: resource name
required: true
style: simple
schema:
type: string
- name: resourceKey
in: query
description: if provided, it will update the sub-resource
style: form
explode: true
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GmsConfigUpdate'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gmsHostname:
get:
summary: hostnameByGet
description: Get the host name of orchestrator.
operationId: hostnameByGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/HostName'
deprecated: false
/gmsLicense:
get:
summary: licenseByGet
description: Get current license key and information
operationId: licenseByGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/LicenseInfoByGet'
deprecated: false
post:
summary: licenseByPut
description: Set Orchestrator license key
operationId: licenseByPut
parameters: []
requestBody:
description: Orchestrator license key
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LicenseKey'
- description: Orchestrator license key
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/LicenseInfoByPost'
deprecated: false
/gmsLicense/validation:
get:
summary: validateKey
description: Validate a new license key
operationId: validateKey
parameters:
- name: licenseKey
in: query
description: License key to validate
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/LicenseInfoByValidate'
deprecated: false
/gmsOperatingSystem:
get:
summary: OsInfo
description: 'Returns Orchestrator Operating system type '
operationId: OsInfo
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/gmsRemoteAuth:
get:
summary: gmsRemoteAuthGet
description: Get current Radius or TACACS+ configuration
operationId: gmsRemoteAuthGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GmsRemoteAuthGet'
deprecated: false
post:
summary: GmsRemoteAuthPost
description: Modify Radius or TACACS+ configuration
operationId: GmsRemoteAuthPost
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GmsRemoteAuthPost'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/gmsSMTP:
delete:
summary: SMTP
description: Delete custom SMTP
operationId: SMTP
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: GetSMTP
description: Gets SMTP details
operationId: GetSMTP
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SMTPInfo'
deprecated: false
post:
summary: SMTPPost
description: used to set SMTP settings
operationId: SMTPPost
parameters: []
requestBody:
description: Json object for setting values of SMPT user name, password, email server address etc...
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SMTP'
- description: Json object for setting values of SMPT user name, password, email server address etc...
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gmsSMTP/delUnverifiedEmails:
post:
summary: delUnverifiedEmails
description: Delete unverified email addresses
operationId: delUnverifiedEmails
parameters: []
requestBody:
description: a list of unverified email addresses to delete
content:
application/json:
schema:
type: array
items:
type: string
description: a list of unverified email addresses to delete
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/html:
schema:
type: string
description: No response was specified
deprecated: false
/gmsSMTP/sendVerificationEmail:
post:
summary: sendVerificationEmail
description: Send a verification email with a unique verification link including a secure random string to an address
operationId: sendVerificationEmail
parameters:
- name: address
in: query
description: the address to whom will the email be sent
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
text/html:
schema:
type: string
description: No response was specified
deprecated: false
/gmsSMTP/testEmail:
post:
summary: SMTPTestMail
description: used to send test mail
operationId: SMTPTestMail
parameters: []
requestBody:
description: Json object for setting values of SMPT user name, password, email server address etc...
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SMTPTest'
- description: Json object for setting values of SMPT user name, password, email server address etc...
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/gmsSMTP/unverifiedEmails:
get:
summary: listUnverifiedEmails
description: Get all unverified email addresses from gms db
operationId: listUnverifiedEmails
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
/gmsSMTP/verifyAddress:
get:
summary: verifyEmailAddress
description: Use a secure random string in the verification email to verify an email address
operationId: verifyEmailAddress
parameters:
- name: id
in: query
description: The secure random string in the verification email to identify an email address
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
text/html:
schema:
type: string
description: No response was specified
deprecated: false
/gmsserver/briefInfo:
get:
summary: gmsBriefInfo
description: Returns orchestrator server information such as used disk hostname, up time, version etc...
operationId: gmsBriefInfo
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GmsBriefInfo'
deprecated: false
/gmsserver/hello:
get:
summary: hello
description: Returns hello message.
operationId: hello
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/gmsserver/info:
get:
summary: gmsServerInfo
description: Returns orchestrator server information such as used disk space, hostname,release etc...
operationId: gmsServerInfo
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GmsServerInfo'
deprecated: false
/gmsserver/ping:
get:
summary: gmsPingInfo
description: Returns orchestrator server information such as used disk hostname, up time, version etc...
operationId: gmsPingInfo
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GmsPingInfo'
deprecated: false
/haGroups:
get:
summary: haGroupsGet
description: Returns a collection of appliances paired in a HA configuration
operationId: haGroupsGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/HaGroups'
deprecated: false
post:
summary: haGroupsPost
description: Modify appliances paired in a HA configuration
operationId: haGroupsPost
parameters: []
requestBody:
description: JSON object containing collection of appliances paired in a HA configuration
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/HaGroups'
- description: JSON object containing collection of appliances paired in a HA configuration
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/health:
post:
summary: HealthSummary
description: '"appliance-id" key corresponds to a specific appliance id'
operationId: HealthSummary
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/HealthSummaryGetPostBody'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/HealthSummaryResp'
deprecated: false
/health/alarmPeriodSummary:
get:
summary: GetapplianceAlarmSummary
description: Returns summary of alarms for a given appliance for that time period
operationId: GetapplianceAlarmSummary
parameters:
- name: from
in: query
description: Long(Signed 64 bits) value of milliseconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: to
in: query
description: Long(Signed 64 bits) value of milliseconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: applianceId
in: query
description: Appliance ID
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AlarmPeriodSummary'
deprecated: false
/health/jitterPeriodSummary:
get:
summary: JitterPeriodSummary
description: Returns summary of jitter for a given appliance for that time period
operationId: JitterPeriodSummary
parameters:
- name: time
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: overlayId
in: query
description: Overlay id. -1 == all overlays
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: applianceId
in: query
description: Appliance ID
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/JitterPeriodSummary'
deprecated: false
/health/latencyPeriodSummary:
get:
summary: LatencyPeriodSummary
description: Returns summary of latency for a given appliance for that time period
operationId: LatencyPeriodSummary
parameters:
- name: time
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: overlayId
in: query
description: Overlay id. -1 == all overlays
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: applianceId
in: query
description: Appliance ID
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/LatencyPeriodSummary'
deprecated: false
/health/lossPeriodSummary:
get:
summary: LossPeriodSummary
description: Returns summary of loss for a given appliance for that time period
operationId: LossPeriodSummary
parameters:
- name: time
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: overlayId
in: query
description: Overlay id. -1 == all overlays
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: applianceId
in: query
description: Appliance ID
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/LossPeriodSummary'
deprecated: false
/health/mosPeriodSummary:
get:
summary: MosPeriodSummary
description: Returns summary of mos for a given appliance for that time period
operationId: MosPeriodSummary
parameters:
- name: time
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: overlayId
in: query
description: Overlay id. -1 == all overlays
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: applianceId
in: query
description: Appliance ID
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MosPeriodSummary'
deprecated: false
/hostname/{nePk}:
post:
summary: applyHostname
description: Change the hostname of a managed appliance
operationId: applyHostname
parameters:
- name: nePk
in: path
description: The appliance's ne pk
required: true
style: simple
schema:
type: string
requestBody:
description: Json object containing the appliance host name
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/VxoaHostname'
- description: Json object containing the appliance host name
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/idle/clear:
get:
summary: IdleTime
description: Clear idle time
operationId: IdleTime
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/idle/increment:
get:
summary: IdleTime1
description: Increment idle time
operationId: IdleTime1
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AutoLog'
deprecated: false
/ikelessSeedStatus:
get:
summary: ikeless
description: "Returns a representation of key status with whether or not the current key is present, its activation status, and an arbitrary seed number. If an appliance has an arbitrary id of 0, it has the same key as orchestrator. If two appliances have 1 and 2 as their arbitrary ids, it means that their keys do not match orchestrator, nor do they match one another's "
operationId: ikeless
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/IkelessSeedStatusGetAll'
deprecated: false
/interfaceLabels/{nePk}:
post:
summary: applyLabelsToAppliance
description: Pushes the active interface labels on Orchestrator to appliance
operationId: applyLabelsToAppliance
parameters:
- name: nePk
in: path
description: The nePk of the appliance you wish to apply the labels to
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/interfaceState/{neId}:
get:
summary: interfaceState
description: Get node configuration data from Orchestrator database or from the specified appliance.
operationId: interfaceState
parameters:
- name: cached
in: query
description: True means to get data from Orchestrator database, and false means to get data from appliance.
required: true
style: form
explode: true
schema:
type: boolean
- name: neId
in: path
description: The node Id of the appliance.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigData'
deprecated: false
/license/nx:
get:
summary: licensing
description: Retrieves NX licensed appliances
operationId: licensing
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NXLicenseItem'
description: No response was specified
deprecated: false
/license/portal/appliance:
get:
summary: licensing1
description: Retrieves portal licensed appliances
operationId: licensing1
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PortalLicenseItem'
description: No response was specified
deprecated: false
/license/portal/appliance/grant/{nePk}:
post:
summary: grant
description: Grant an appliance a base license via Cloud Portal
operationId: grant
parameters:
- name: nePk
in: path
description: Appliance primary key
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/license/portal/appliance/license/token/{nePk}:
delete:
summary: deleteLicenseToken
description: "Used after revoking an appliance. \n Warning: This will stop the appliance from passing traffic immediately."
operationId: deleteLicenseToken
parameters:
- name: nePk
in: path
description: Appliance primary key
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/license/portal/appliance/revoke/{nePk}:
post:
summary: grant1
description: Revoke an appliance a base license via Cloud Portal
operationId: grant1
parameters:
- name: nePk
in: path
description: Appliance primary key
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/license/portal/ec/{nePk}:
post:
summary: Postlicensing
description: Changes appliance boost and plus settings
operationId: Postlicensing
parameters:
- name: nePk
in: path
description: Appliance primary key
required: true
style: simple
schema:
type: string
requestBody:
description: Appliance boost and plus information
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ECPostData'
- description: Appliance boost and plus information
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ECPostData'
deprecated: false
/license/portal/summary:
get:
summary: licensing2
description: Retrieves summary of portal licensed appliances
operationId: licensing2
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PortalLicenseSummary'
deprecated: false
/license/vx:
get:
summary: licensing3
description: Retrieves VX licensed appliances
operationId: licensing3
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VXLicenseItem'
description: No response was specified
deprecated: false
/linkIntegrityTest/run:
post:
summary: linkintegritytestrun
description: This API allows you to start link integrity test between two appliances using desired test program.
operationId: linkintegritytestrun
parameters: []
requestBody:
description: JSON object that contains the setups for link integrity test.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LinkIntegrityTestRun'
- description: JSON object that contains the setups for link integrity test.
required: true
responses:
'200':
description: Internal background task key of the link integrity test that has been started.
headers: {}
content: {}
deprecated: false
/linkIntegrityTest/status/{neId}:
get:
summary: linkIntegrityStatus
description: Operation to retrieve current link integrity test status for desired appliance.
operationId: linkIntegrityStatus
parameters:
- name: neId
in: path
description: Internal ID of the appliance from which you want to retrieve status information.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/LinkIntegrityStatus'
deprecated: false
/location/addressToLocation:
get:
summary: addressLookup
description: Lookup the latitude and longitude of an address. It will return an array of locations that match the object, in the order of the locations that match the address the best. So if you're looking for the best match, you should use the first element in the array.
operationId: addressLookup
parameters:
- name: address
in: query
description: A string that represents the address to query
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LocationObject'
description: No response was specified
deprecated: false
/logging/{neId}:
get:
summary: getLoggingSettings
description: Returned data is an object, contains logging remote and config settings.
operationId: getLoggingSettings
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: If true, get settings from gmsdb, otherwise get from appliance.
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/LoggingSettings'
deprecated: false
/loginSessions:
get:
summary: sessions
description: Returns all the current sessions
operationId: sessions
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SessionGetItem'
description: No response was specified
deprecated: false
/maintenanceMode:
get:
summary: GetMaintenanceMode
description: Includes pause orchestration list and suppress alarm list.
operationId: GetMaintenanceMode
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceModeData'
deprecated: false
post:
summary: SetMaintenanceMode
description: Includes pause orchestration list and suppress alarm list.
operationId: SetMaintenanceMode
parameters: []
requestBody:
description: Maintenance Mode Configuration
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MaintenanceModePostBody'
- description: Maintenance Mode Configuration
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/html:
schema:
type: string
description: No response was specified
deprecated: false
/maps/deleteUploadedMap:
post:
summary: deleteUploadedMap
description: Delete certain uploaded map
operationId: deleteUploadedMap
parameters: []
requestBody:
description: name of file to be deleted
content:
text/plain:
schema:
type: string
description: name of file to be deleted
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/maps/getUploadedMaps:
get:
summary: getUploadedMaps
description: Get list of uploaded maps
operationId: getUploadedMaps
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/multicast/config/{neId}:
get:
summary: multicastConfigGet
description: Get multicast config info on the appliance
operationId: multicastConfigGet
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/multicastConfigModel'
deprecated: false
/multicast/enable/{neId}:
get:
summary: multicastEnableGet
description: Get multicast enabled info on the appliance
operationId: multicastEnableGet
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/multicastEnableModel'
deprecated: false
/multicast/state/interfaces/{neId}:
get:
summary: multicastInterfaceStateGet
description: Get multicast interface state info on the appliance
operationId: multicastInterfaceStateGet
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/multicastInterfaceState'
deprecated: false
/multicast/state/neighbors/{neId}:
get:
summary: multicastNeighborStateGet
description: Get multicast neighbor state info on the appliance
operationId: multicastNeighborStateGet
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/multicastNeighborState'
deprecated: false
/multicast/state/routes/{neId}:
get:
summary: multicastRouteStateGet
description: Get multicast route state info on the appliance
operationId: multicastRouteStateGet
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/multicastRouteState'
deprecated: false
/nat/{neId}:
get:
summary: getAllNat
description: Returns all NAT Config
operationId: getAllNat
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BranchNat'
deprecated: false
/nat/{neId}/maps:
get:
summary: branchNatMapsGet
description: "Sample response: \n {\"map1\":{\"prio\":{\"10\":{\"dir\":\"outbound\",\"enable\":true,\"comment\":\"\",\"gms_marked\":false,\"match\":{\"intf\":\"lan0\",\"src_subnet\":\"10.16.112.0/24\",\"dst_subnet\":\"10.16.55.0/24\"},\"set\":{\"trans_src\":\"1.1.1.0/24\",\"trans_dst\":\"10.16.112.0/24\"}},\"20\":{\"dir\":\"inbound\",\"enable\":true,\"comment\":\"\",\"gms_marked\":false,\"match\":{\"intf\":\"lan1\",\"dst_subnet\":\"100.100.0.0/24\"},\"set\":{\"trans_dst\":\"100.100.100.0/24\"}}}}}"
operationId: branchNatMapsGet
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BranchNatMaps'
deprecated: false
/nat/{neId}/natPools:
get:
summary: getAllNatPools
description: Returns all NAT Pools
operationId: getAllNatPools
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NATPools'
- description: Object containing all the NATPools
deprecated: false
/netFlow/{neId}:
get:
summary: getNetFlowData
description: 'Returned data is an object and contains the following data: active_timeout (NetFlow), ipfix_tmplt_rfrsh_t (IPFIX), port1, if_wan_tx, enable, ipaddr1, if_lan_rx, if_lan_tx, ipaddr2, if_wan_rx and port2, collector_type1, collector_type2'
operationId: getNetFlowData
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: If true, get data from gmsdb, otherwise get from appliance.
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetFlowData'
deprecated: false
/networkMemory:
post:
summary: EraseNmPost
description: Erase Network Memory on one or more appliances.
operationId: EraseNmPost
parameters: []
requestBody:
description: JSON object containing list of appliance keys
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/EraseNmPost'
- description: JSON object containing list of appliance keys
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/notification:
delete:
summary: delNotification
description: Remove the message of notification banner.
operationId: delNotification
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: getNotification
description: Get the message of notification banner.
operationId: getNotification
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationGet'
description: No response was specified
deprecated: false
post:
summary: postNotification
description: Set the message of notification banner.
operationId: postNotification
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationConfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/ospf/config/interfaces/{neId}:
get:
summary: GetInterfaceConfigDta
description: Get OSPF interfaces configuration data.
operationId: GetInterfaceConfigDta
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Interfaces'
deprecated: false
/ospf/config/system/{neId}:
get:
summary: GetOSPFSystemConfig
description: Get appliance's OSPF system level configuration data.
operationId: GetOSPFSystemConfig
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OSPFSystemConfig'
deprecated: false
/ospf/state/interfaces/{neId}:
get:
summary: OSPFInterfaceStateObj
description: Gets the state of the OSPF interfaces.
operationId: OSPFInterfaceStateObj
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OSPFInterfaceStateResp'
deprecated: false
/ospf/state/neighbors/{neId}:
get:
summary: OSPFNeighborsStateObj
description: Gets the state of the OSPF neighbors.
operationId: OSPFNeighborsStateObj
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OSPFNeighborsStateResp'
deprecated: false
/ospf/state/system/{neId}:
get:
summary: OSPFStateObj
description: Gets the state of the OSPF.
operationId: OSPFStateObj
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OSPFStateObj'
deprecated: false
/overlayManagerProperties:
get:
summary: getOverlayMngProps
description: Get the overlay manager properties in the Orchestrator.
operationId: getOverlayMngProps
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OverlayManagerProperties'
deprecated: false
post:
summary: setOverlayMngProps
description: Set the overlay manager properties in the Orchestrator.
operationId: setOverlayMngProps
parameters: []
requestBody:
description: Json object containing overlay manager properties.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/OverlayManagerPropertiesPost'
- description: Json object containing overlay manager properties.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/portForwarding/{neId}:
get:
summary: portForwardingGet
description: Get port forwarding rules on a VXOA.
operationId: portForwardingGet
parameters:
- name: neId
in: path
description: Ne Id of the VXOA to get
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PortForwardingEntry'
description: No response was specified
deprecated: false
/portProfiles/config:
get:
summary: portProfilesGet
description: Get a list of all Deployment Profile templates
operationId: portProfilesGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/portProfilesGet'
description: No response was specified
deprecated: false
post:
summary: portProfilesPost
description: Create a new Deployment Profile template
operationId: portProfilesPost
parameters: []
requestBody:
description: JSON object containing Deployment Profile template configuration data
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/portProfilesPost'
- description: JSON object containing Deployment Profile template configuration data
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/portProfiles/config/{portProfileId}:
delete:
summary: portProfilesDelete
description: Delete a Deployment Profile template matching the id
operationId: portProfilesDelete
parameters:
- name: portProfileId
in: path
description: System generated unique identifier for the Deployment Profile
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: GetportProfilesGet
description: Get a Deployment Profile template matching the id
operationId: GetportProfilesGet
parameters:
- name: portProfileId
in: path
description: System generated unique identifier for the Deployment Profile
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/portProfilesConfig'
deprecated: false
put:
summary: portProfilesPut
description: Update a Deployment Profile template matching the id
operationId: portProfilesPut
parameters:
- name: portProfileId
in: path
description: System generated unique identifier for the Deployment Profile
required: true
style: simple
schema:
type: string
requestBody:
description: JSON object containing Deployment Profile template configuration data
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/portProfilesPost'
- description: JSON object containing Deployment Profile template configuration data
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/portProfiles/isLabelInUse:
get:
summary: portProfilesLabelInUseGet
description: Check if an interface label is in use by any of the existing deployment profiles
operationId: portProfilesLabelInUseGet
parameters:
- name: labelId
in: query
description: Unique id for interface label
required: true
style: form
explode: true
schema:
type: string
- name: labelSide
in: query
description: Enum to donate LAN/WAN side label. Valid values (lan or wan)
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/labelSide'
- description: Enum to donate LAN/WAN side label. Valid values (lan or wan)
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/portProfilesLabelInUseGetResp'
- description: If label is in use in a profile and list of profiles its in use.
deprecated: false
/rbac/asset:
get:
summary: getAllApplianceAccessGroups
description: Get all appliance access groups / assets
operationId: getAllApplianceAccessGroups
parameters:
- name: assigned
in: query
description: To get assigned appliance access group / asset provide assigned = true; Otherwise it will return list of all appliance access groups / assets
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/allApplianceAccessConfigs'
- description: Multiple pairs of applianceAccessGroupName to value
deprecated: false
post:
summary: createOrUpdateApplianceAccessGroup
description: Create or update appliance access group / asset.
operationId: createOrUpdateApplianceAccessGroup
parameters: []
requestBody:
description: Either applianceGroups or applianceRegions should be empty (not null).
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/accessConfigMap'
- description: Either applianceGroups or applianceRegions should be empty (not null).
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/rbac/asset/{applianceAccessGroupName}:
delete:
summary: deleteApplianceAccessGroupByName
description: Delete appliance access group / asset by name
operationId: deleteApplianceAccessGroupByName
parameters:
- name: applianceAccessGroupName
in: path
description: appliance access group/asset name
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: getApplianceAccessGroupByName
description: Get appliance access group / asset by name
operationId: getApplianceAccessGroupByName
parameters:
- name: applianceAccessGroupName
in: path
description: appliance access group/asset name
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/applianceAccess'
- description: One array should be empty
deprecated: false
/rbac/assignment:
get:
summary: getAllRbacAssignments
description: Get all rbac assignments
operationId: getAllRbacAssignments
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/userAccessCustomization'
description: No response was specified
deprecated: false
post:
summary: createOrUpdateRbacAssignment
description: Create or update rbacAssignment.
operationId: createOrUpdateRbacAssignment
parameters: []
requestBody:
description: If you do not want to assign asset or roles to a user, then send 'null' value for the respective property.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/userAccessCustomization'
- description: If you do not want to assign asset or roles to a user, then send 'null' value for the respective property.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/rbac/assignment/{username}:
delete:
summary: deleteRbacAssignment
description: Delete rbacAssignment by username
operationId: deleteRbacAssignment
parameters:
- name: username
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: getRbacAssignmentByUsername
description: Get rbacAssignment by username
operationId: getRbacAssignmentByUsername
parameters:
- name: username
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/userAccessCustomization'
deprecated: false
/rbac/role:
get:
summary: getAllRoles
description: Get all roles.
operationId: getAllRoles
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RoleMap'
- description: roleName to roleDefinition mapping pairs
deprecated: false
post:
summary: saveRole
description: Create role or Update existing role.
operationId: saveRole
parameters: []
requestBody:
description: menuTypeItems can not be null or empty
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RoleMap'
- description: menuTypeItems can not be null or empty
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/rbac/role/menuAssigned:
get:
summary: getAssignedMenus
description: It will return no data if user is not customized
operationId: getAssignedMenus
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MenuMap'
- description: Effective role features.
deprecated: false
/rbac/role/{roleName}:
delete:
summary: deleteRoleByRoleName
description: Delete role By name. If role is assigned to one or more users then API will return HTTP 423
operationId: deleteRoleByRoleName
parameters:
- name: roleName
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: getRoleByRoleName
description: Get role by name if exists
operationId: getRoleByRoleName
parameters:
- name: roleName
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Role'
- description: Role Definition
deprecated: false
/reachability/appliance/{neId}:
get:
summary: reachabilityFromAppliance
description: "Returned data is an object, each key is IP of the appliance, each value is an object of the reachability status. Each the reachability status contains 'rest', 'ssh', 'https' and 'webSocket'. "
operationId: reachabilityFromAppliance
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ReachabiltyAppliance'
deprecated: false
/reachability/gms/{neId}:
get:
summary: reachabilityFromGMS
description: "Returned data is an object. Each the reachability status contains 'id', 'userName', 'state', 'neId', 'hostName', 'actualWebProtocolType' and 'unsavedChanges'. "
operationId: reachabilityFromGMS
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ReachabilityGMS'
deprecated: false
/realtimeStats/{nePk}:
post:
summary: realtimestats
description: "Tunnel stats: Set 'type' to 'tunnel'. Set 'name' to one of the tunnel names or 'pass-through' or 'pass-through-unshaped'. 'filter' is not used for tunnel statistics.
TrafficType stats: Set the 'type' to 'trafficType' to retrieve two aggregate real-time stats: optimized, all-traffic. For optimized, set 'name' to '0' and for all-traffic, set 'name' to '3'. 'filter' is not used.
Application stats: Set 'type' to 'app'. Set 'name' to application name. 'filter' is required.
DSCP stats: Set 'type' to 'dscp', set name to one of DSCP values from '0' to '63'. 'filter' is required.(Possible 'filter' values are '0' for optimized_traffic,'1' for pass_through_shaped,'2' for pass_through_unshaped,'3' for all_traffic)
MOS stats: Set 'name' to tunnel id, set 'type' to tunnel.
Traffic Class Stats: set 'type' to 'trafficClass', set 'name' to one of traffic classes from '0' to '9'. 'filter' is required.
Flow stats: set type to 'flow', name to '0' for TCP accelerated, '1' for TCP unaccelerated and '2' for non-TCP flows. 'filter' is required.(Possible 'filter' values are '0' for optimized_traffic,'1' for pass_through_shaped,'2' for pass_through_unshaped,'3' for all_traffic)
Shaper stats: Set 'type' to 'shaper'. Set 'name' to one of traffic classes from '0' to '9'.'filter' to traffic direction('0' for Outbound and '1' for Inbound).
Drops stats: Set 'type' to 'drops'. Set 'name' to empty string.
Interface stats: Set 'type' to 'interface'. Set 'name' to interface name.Set 'filter' to traffic type.(Possible 'filter' values are '0' for optimized_traffic,'1' for pass_through_shaped,'2' for pass_through_unshaped,'3' for all_traffic)
Important: Appliances store per second statistics for 3 seconds. You must poll at a frequency faster than 3 seconds to make sure to not have gaps in the results. The result format for all statistics looks like: '{'nameofstat': [time, value], [time, value], [time, value]}' where you get statistics for last three seconds."
operationId: realtimestats
parameters:
- name: nePk
in: path
description: Appliance primary key
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RealTimeStats'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/regions:
get:
summary: regionGet
description: Get all regions
operationId: regionGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RegionModel'
deprecated: false
post:
summary: regionPost
description: Create region
operationId: regionPost
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RegionPostModel'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/regions/appliances:
get:
summary: regionAssociationGET
description: Get all region association
operationId: regionAssociationGET
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
post:
summary: regionAssociationPost
description: Create region association
operationId: regionAssociationPost
parameters: []
requestBody:
description: "Map of appliance nePK and regionId, example: {'0.NE':'1', '1.NE':'3'}"
content:
text/plain:
schema:
type: object
description: "Map of appliance nePK and regionId, example: {'0.NE':'1', '1.NE':'3'}"
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/regions/appliances/nePk/{nePK}:
get:
summary: GetregionAssociationGET
description: Get region association by nePK
operationId: GetregionAssociationGET
parameters:
- name: NePK
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RegionAssociationGETModel'
deprecated: false
/regions/appliances/regionId/{regionId}:
get:
summary: GetregionAssociationGET1
description: Get region association by region ID
operationId: GetregionAssociationGET1
parameters:
- name: regionId
in: path
description: ''
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RegionAssociationGETModel'
deprecated: false
/regions/appliances/{nePK}:
put:
summary: regionAssociationPut
description: Use this API to update region association
operationId: regionAssociationPut
parameters:
- name: NePK
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RegionAssociationPutModel'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/regions/{regionId}:
delete:
summary: regionDelete
description: Use this API to delete region
operationId: regionDelete
parameters:
- name: regionId
in: path
description: ''
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: regionSingleGet
description: Get region by regionId
operationId: regionSingleGet
parameters:
- name: regionId
in: path
description: ''
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RegionModel'
deprecated: false
put:
summary: regionPut
description: Use this API to change region name
operationId: regionPut
parameters:
- name: regionId
in: path
description: ''
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RegionPostModel'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/release:
get:
summary: releases
description: Gets all the Releases for orchestrator and vxoa
operationId: releases
parameters:
- name: filter
in: query
description: If filter is true it returns only new releases of orchestrator and vxoa
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ReleaseInfo'
deprecated: false
/release/notifications:
get:
summary: releaseNotifications
description: This API will return all the notifications that are meant to be shown in Orchestrator. This means the notification is new, it's 'remind me' date is past, and it has not been dismissed.
operationId: releaseNotifications
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReleaseNotification'
description: No response was specified
deprecated: false
/release/notifications/delay/{version}:
post:
summary: delayReleaseNotification
description: Delay the notificaiton by a number of hours.
operationId: delayReleaseNotification
parameters:
- name: version
in: path
description: The version of the release the notification is for
required: true
style: simple
schema:
type: string
requestBody:
description: The number of hours to delay the notification by
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DelayNotificationRequest'
- description: The number of hours to delay the notification by
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/release/notifications/dismiss/{version}:
post:
summary: dismissReleaseNotification
description: Dismiss a release, so it's no longer shown to the user.
operationId: dismissReleaseNotification
parameters:
- name: version
in: path
description: The version of the release the notification is for
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/remoteLogReceiver:
get:
summary: RemoteLogReceiverGet
description: "Remote log receiver configurations are returned in an array of objects.\n \n Response body: Array of Config Objects.\n \nHTTP(S)ReceiverConfig:\n {\n\"id\": integer,\n\"receiverType\": integer,\n\"enabled\": boolean,\n\"name\": string,\n\"logType\": integer,\n\"url\": string\n}\n \nKAFKAProducerConfig:\n {\n\"id\": integer,\n\"receiverType\": integer,\n\"enabled\": boolean,\n\"name\": string,\n\"logType\": integer,\n\"topic\": string,\n\"brokers\": string,\n\"acks\": string,\n\"retries\": integer,\n\"batchSize\": integer,\n\"bufferSize\": integer,\n\"lingerTime\": integer\n}\n \nSYSLOGReceiverConfig:\n {\n\"id\": integer,\n\"receiverType\": integer,\n\"enabled\": boolean,\n\"name\": string,\n\"logType\": integer,\n\"hostname\": string,\n\"port\": integer,\n\"protocol\": integer,\n\"customData\": string,\n\"auditFacility\": integer,\n\"alarmFacility\": integer,\n\"auditErrorSeverity\": integer\n \"auditDebugSeverity\": integer,\n\"auditInfoSeverity\": integer,\n\"alarmCriticalSeverity\": integer,\n\"alarmMajorSeverity\": integer,\n\"alarmMinorSeverity\": integer,\n\"alarmWarningSeverity\": integer\n}\n"
operationId: RemoteLogReceiverGet
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
summary: RemoteLogReceiverAdd
description: >-
Post body is an array of objects WITHOUT id field.
[
{
"receiverType": 0,
"enabled": true,
"name": "HTTP_SERVER01",
"logType": 0,
"url": "www.example.com"
}
]
operationId: RemoteLogReceiverAdd
parameters: []
requestBody:
description: Post body is an array of objects WITHOUT id field
content:
text/plain:
schema:
type: object
description: Post body is an array of objects WITHOUT id field
required: true
responses:
'200':
description: OK
headers: {}
content: {}
'500':
description: Invalid data
headers: {}
content: {}
deprecated: false
put:
summary: RemoteLogReceiverPut
description: >-
PUT request body is an array of objects with valid receiver ids.
[
{
"id": 0,
"receiverType": 0,
"enabled": true,
"name": "HTTP_SERVER01",
"logType": 0,
"url": "www.example.com"
}
]
operationId: RemoteLogReceiverPut
parameters: []
requestBody:
description: PUT request body is an array of objects with valid receiver ids
content:
text/plain:
schema:
type: string
description: PUT request body is an array of objects with valid receiver ids
required: true
responses:
'200':
description: OK
headers: {}
content: {}
'500':
description: Invalid data
headers: {}
content: {}
deprecated: false
/remoteLogReceiver/{receiverId}:
delete:
summary: RemoteLogReceiverDelete
description: Delete a remote log receiver
operationId: RemoteLogReceiverDelete
parameters:
- name: receiverId
in: path
description: The valid id of the receiver to be deleted.
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/remoteLogReceiver/{receiverId}/subscribe:
post:
summary: RemoteLogReceiverSubscribe
description: To query specific log(s) with log type and sequence id(s) provided in the request body
operationId: RemoteLogReceiverSubscribe
parameters:
- name: receiverId
in: path
description: The valid id of the receiver.
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: 'Parameter for fetch specific log message. The id field is an array of strings, item in the array can be a single number or a range, for example: id: ["1", "3", "4-6"], messages with id 1, 3, 4, 5, 6 will be sent.'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fetchingParam'
- description: 'Parameter for fetch specific log message. The id field is an array of strings, item in the array can be a single number or a range, for example: id: ["1", "3", "4-6"], messages with id 1, 3, 4, 5, 6 will be sent.'
required: true
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/resolver/{neId}:
get:
summary: dns
description: Get the current DNS IP address and domain names configured for an appliance.
operationId: dns
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DNS1'
deprecated: false
/restApiConfig:
get:
summary: restApiConfigGet
description: Get the REST API config
operationId: restApiConfigGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/restApiConfig'
deprecated: false
post:
summary: restApiConfigPost
description: Set the REST API config
operationId: restApiConfigPost
parameters: []
requestBody:
description: Set the REST API config
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/restApiConfig'
- description: Set the REST API config
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/restRequestTimeStats/summary:
get:
summary: getRestRequestTimeStatsSummary
description: The summary is grouped by nepk, resource and portalWS
operationId: getRestRequestTimeStatsSummary
parameters:
- name: nePk
in: query
description: nePk of the appliance, 'all' means all appliances
required: true
style: form
explode: true
schema:
type: string
- name: resource
in: query
description: Base resource of the appliance to sent to, 'all' means all resources
required: true
style: form
explode: true
schema:
type: string
- name: portalWS
in: query
description: Through what web socket the requests were sent, true -- portal web socket, false -- direct web socket
required: true
style: form
explode: true
schema:
type: boolean
- name: timedout
in: query
description: Whether the requests timedout
required: true
style: form
explode: true
schema:
type: boolean
- name: from
in: query
description: The minimum epoch time when the requests were sent
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: to
in: query
description: The maximum epoch time when the requests were sent, 0 stands for till now
required: true
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RestRequestTimeStatsSummary'
description: No response was specified
deprecated: false
/restRequestTimeStats/{nePk}/%2F{resource}/{portalWS}/{method}:
get:
summary: getRestRequestTimeStatsDetails
description: The time used details of all rest requests sent to an appliance's specific resource through portal web socket or web socket
operationId: getRestRequestTimeStatsDetails
parameters:
- name: nePk
in: path
description: nePk of the appliance
required: true
style: simple
schema:
type: string
- name: resource
in: path
description: Base resource of the appliance to sent to, for example /webconfig should just be typed webconfig here
required: true
style: simple
schema:
type: string
- name: portalWS
in: path
description: Through what web socket this request was sent, true -- portal web socket, false -- direct web socket
required: true
style: simple
schema:
type: boolean
- name: method
in: path
description: The request method
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/method'
- description: The request method
- name: from
in: query
description: The minimum epoch time when the requests were sent
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: to
in: query
description: The maximum epoch time when the requests were sent, 0 stands for till now
required: true
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RestRequestTimeStatsDetails'
description: No response was specified
deprecated: false
/rmaWizard/apply/{nePk}:
post:
summary: applyRmaWizard
description: notes
operationId: applyRmaWizard
parameters:
- name: nePk
in: path
description: The nePk of the appliance to be replaced
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ApplyRmaWizard'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplyRmaWizard'
deprecated: false
/saMap/{nePk}:
get:
summary: Samap
description: Get built-in policies from appliance by given appliance key(nePk)
operationId: Samap
parameters:
- name: nePk
in: path
description: Appliance nePk
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/saMapObject'
deprecated: false
/securityMaps/{neId}:
get:
summary: securityMaps
description: "Sample response: \n { \"map1\": { \"self\": \"map1\", \"20_21\": { \"self\": \"20_21\", \"prio\": { \"1000\": { \"match\": { \"acl\": \"\", \"either_dns\": \"*google.com\" }, \"self\": 1000, \"misc\": { \"rule\": \"enable\", \"logging\": \"disable\", \"logging_priority\": \"0\" }, \"comment\": \"\", \"gms_marked\": false, \"set\": { \"action\": \"allow\" } }, \"65535\": { \"match\": { \"acl\": \"\" }, \"self\": 65535, \"misc\": { \"rule\": \"enable\", \"logging\": \"disable\", \"logging_priority\": \"0\" }, \"comment\": \"\", \"gms_marked\": false, \"set\": { \"action\": \"deny\" } } } } }}"
operationId: securityMaps
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityMaps'
deprecated: false
/session/activeSessions:
get:
summary: sessions1
description: Returns all the current active sessions
operationId: sessions1
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/activeSessionsItems'
description: No response was specified
deprecated: false
/snmp/{nePk}:
get:
summary: snmpGet
description: Get SNMP information.
operationId: snmpGet
parameters:
- name: nePk
in: path
description: the primary key of appliance
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SnmpItem'
deprecated: false
/spPortal/account/key/changeCount:
get:
summary: spPortalAccountKeyChangeCount
description: This API contacts Portal to get the number of times this account key has been changed. Requires Portal connectivity.
operationId: spPortalAccountKeyChangeCount
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/spPortalAccountKeyChangeCountResp'
deprecated: false
/spPortal/account/key/changeStatus:
get:
summary: spPortalAccountKeyChangeStatus
description: Current account key change status
operationId: spPortalAccountKeyChangeStatus
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/spPortalAccountKeyChangeStatusResp'
deprecated: false
/spPortal/account/key/generate:
put:
summary: spPortalAccountKeyGeneratePut
description: Requires Portal connectivity.
operationId: spPortalAccountKeyGeneratePut
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/spPortalAccountKeyGeneratePutResp'
deprecated: false
/spPortal/account/license/appliance/ecsp/assign:
post:
summary: spPortalECSPLicenseAssign
description: Assign EC-SP licenses on Portal
operationId: spPortalECSPLicenseAssign
parameters: []
requestBody:
description: JSON object containing appliance to license id mappings
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SpPortalECSPLicenseAssign'
- description: JSON object containing appliance to license id mappings
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: string
description: No response was specified
deprecated: false
/spPortal/account/license/appliance/ecsp/status:
get:
summary: spPortalECSPLicensesGet
description: Get EC-SP licenses from Portal
operationId: spPortalECSPLicensesGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SpPortalECSPLicense'
description: No response was specified
deprecated: false
/spPortal/account/license/appliance/ecsp/unassign:
post:
summary: spPortalECSPLicenseUnassign
description: Unassign EC-SP licenses on Portal
operationId: spPortalECSPLicenseUnassign
parameters: []
requestBody:
description: JSON object containing license ids to be unassigned
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SpPortalECSPLicenseUnassign'
- description: JSON object containing license ids to be unassigned
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: string
description: No response was specified
deprecated: false
/spPortal/account/license/feature:
get:
summary: spPortalAccountLicenseFeatureGet
description: Get account license feature from Portal
operationId: spPortalAccountLicenseFeatureGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SpPortalAccountLicenseFeature'
description: No response was specified
deprecated: false
/spPortal/account/license/type:
get:
summary: spPortalAccountLicenseTypeGet
description: Get account license type from Portal
operationId: spPortalAccountLicenseTypeGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SpPortalAccountLicenseType'
- description: Portal account type information
deprecated: false
/spPortal/account/oldKey:
delete:
summary: spPortalDeleteOldKey
description: >-
Acts as "commit" for a previous account key change. Make sure all managed appliances have the new account key before calling this.
Successful response code is 204: no content. Requires Portal connectivity.
operationId: spPortalDeleteOldKey
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/spPortal/applianceWSStatus/{neId}:
get:
summary: checkApplianceReachabilityUsingWSGet
description: Returns status of orchestrator > portal > appliance websocket and orchestrator > appliance websocket connections. Must provide valid neId.
operationId: checkApplianceReachabilityUsingWSGet
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: integer
format: int64
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/checkApplianceReachabilityUsingWSResponse'
- description: Appliance reachability information
deprecated: false
/spPortal/applicationTags:
get:
summary: appGroupTmpGet
description: Returns a collection of application groups
operationId: appGroupTmpGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: object
description: No response was specified
deprecated: false
/spPortal/applicationTags/info:
get:
summary: appGroupTmpHashCodeGet
description: Returns a hash code for application groups data. It is used as version number.
operationId: appGroupTmpHashCodeGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/tmpHashCode'
deprecated: false
/spPortal/compoundClassification:
get:
summary: compoundTmpGet
description: Returns a collection of application definition
operationId: compoundTmpGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/compoundTmp'
deprecated: false
/spPortal/compoundClassification/info:
get:
summary: compoundTmpHashCodeGet
description: Returns a hash code for application definition data. It is used as version number.
operationId: compoundTmpHashCodeGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/tmpHashCode'
deprecated: false
/spPortal/config:
get:
summary: spPortalConfigGet
description: Get Silver Peak Cloud Portal registration information
operationId: spPortalConfigGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SpPortalConfig'
- description: Portal registration information
deprecated: false
post:
summary: spPortalConfigPost
description: Post Silver Peak Cloud Portal registration information
operationId: spPortalConfigPost
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SpPortalConfig'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/spPortal/connectivity:
get:
summary: connectivityGet
description: 'This API returns enums for portal connectivity status. 0: Unable to connect 1: Connected 2: Connecting'
operationId: connectivityGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SpPortalConnectivityGet'
deprecated: false
/spPortal/createCaseWithPortal:
post:
summary: spPortalCreateCasePost
description: >-
Create a case for the Orchestrator or an appliance.
caseEmail: If Orchestrator is not registered to Portal, a valid Silver Peak support account email address is required in order to create a case.
orchSerialNum: For Orchestrators, leave this field empty (""). For appliances, enter the nePk (E.g. "0.NE"). The corresponding serial number will then be retrieved based on these inputs.
operationId: spPortalCreateCasePost
parameters: []
requestBody:
description: JSON object containing case information that will be used to create a case.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/spPortalCreateCaseWithPortal'
- description: JSON object containing case information that will be used to create a case.
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/spPortal/dnsClassification:
get:
summary: dnsTmpGet
description: Returns an array of application definition
operationId: dnsTmpGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DnsObj'
description: No response was specified
deprecated: false
/spPortal/dnsClassification/info:
get:
summary: dnsTmpHashCodeGet
description: Returns a hash code for application definition data. It is used as version number.
operationId: dnsTmpHashCodeGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/tmpHashCode'
deprecated: false
/spPortal/internetDb/geoLocateIp:
post:
summary: geoLocationPost
description: Returns a collection of GeoLocationObjects indexed by ip address value. IP addresses should be provided as array of 32-bit integers
operationId: geoLocationPost
parameters: []
requestBody:
description: JSON object containing array of ip's to be geo located
content:
application/json:
schema:
type: array
items:
type: integer
format: int32
description: JSON object containing array of ip's to be geo located
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GeoLocationResponse'
- description: Collection of GeoLocationObject indexed by ip address value
deprecated: false
/spPortal/internetDb/geoLocateIp/{ip}:
get:
summary: geoLocationGet
description: IP address should be provided in 32-bit integer format
operationId: geoLocationGet
parameters:
- name: ip
in: path
description: IP Address to be geo located in 32-bit integer format
required: true
style: simple
schema:
type: integer
format: int64
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GeoLocationResponse'
- description: Collection of GeoLocationObject indexed by ip address value
deprecated: false
/spPortal/internetDb/ipIntelligence:
get:
summary: ipIntelligenceTmpGet
description: Returns an array of IP intelligence data which starts at start id with a total limit. Start id starts from 0. Maximum limit is 10000.
operationId: ipIntelligenceTmpGet
parameters:
- name: start
in: query
description: start id, start from 0
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: limit
in: query
description: limit number, maximum is 10000
required: true
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IpIntelTmpObj'
description: No response was specified
deprecated: false
/spPortal/internetDb/ipIntelligence/info:
get:
summary: ipIntelligenceTmpTimeGet
description: Returns a timestamp for application definition data. It is used as version number.
operationId: ipIntelligenceTmpTimeGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/tmpTimeStamp'
deprecated: false
/spPortal/internetDb/ipIntelligence/search:
get:
summary: GetipIntelligenceTmpGet
description: If provides a valid IPv4 address in 32-bit integer format, it will search through ip. Otherwise it will search by match filter[app name, description, country, organization]. Returns an array of IP intelligence data with top 5000 results only, coz the data may be too large.
operationId: GetipIntelligenceTmpGet
parameters:
- name: ip
in: query
description: IPv4 address in 32-bit integer format
style: form
explode: true
schema:
type: integer
format: int32
- name: filter
in: query
description: String filter
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IpIntelTmpObj'
description: No response was specified
deprecated: false
/spPortal/internetDb/ipIntelligence/total:
get:
summary: ipIntelligenceTmpTotal
description: Get count for application definition data for Address Map from portal
operationId: ipIntelligenceTmpTotal
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: integer
description: No response was specified
format: int32
deprecated: false
/spPortal/internetDb/serviceIdToSaasId:
get:
summary: serviceIdToSaasIdGet
description: This API returns collection of service id to service details [serviceId, saasId, country, countryCode, org, saasAppName, displayName, priority] mapping. If no filters are specified this returns top 100 results only coz the data may be too large. You can specify filters to query the dataset.
operationId: serviceIdToSaasIdGet
parameters:
- name: matchAny
in: query
description: Wildcard match on country, org, saasAppName
style: form
explode: true
schema:
type: string
- name: org
in: query
description: Wildcard match on org
style: form
explode: true
schema:
type: string
- name: serviceIds
in: query
description: Only return these serviceIds. Separate multiple serviceIds with a comma ','
style: form
explode: true
schema:
type: string
- name: top
in: query
description: Return top x matches
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceIdToSaasIdGet'
deprecated: false
/spPortal/internetDb/serviceIdToSaasId/count:
get:
summary: serviceIdToSaasIdCountGet
description: Get count of internet services on this appliance
operationId: serviceIdToSaasIdCountGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceIdToSaasIdCountGet'
deprecated: false
/spPortal/internetDb/serviceIdToSaasId/countries:
get:
summary: serviceIdToSaasIdCountriesGet
description: This API returns collection of service id to country details [serviceId, saasId, country, countryCode, org, saasAppName, displayName, priority] mapping.
operationId: serviceIdToSaasIdCountriesGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceIdToSaasIdCountriesGet'
deprecated: false
/spPortal/internetDb/serviceIdToSaasId/saasApps:
get:
summary: serviceIdToSaasIdSaasAppGet
description: This API returns a list of saas applications
operationId: serviceIdToSaasIdSaasAppGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
/spPortal/ipProtocolNumbers:
get:
summary: ipProtocolNumbersGet
description: This API returns list of IP Protocol Numbers
operationId: ipProtocolNumbersGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: object
description: No response was specified
deprecated: false
/spPortal/meterFlowClassification:
get:
summary: meterFlowTmpGet
description: Returns a collection of application definition
operationId: meterFlowTmpGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/meterFlowTmp'
deprecated: false
/spPortal/meterFlowClassification/info:
get:
summary: meterFlowTmpHashCodeGet
description: Returns a hash code for application definition data. It is used as version number.
operationId: meterFlowTmpHashCodeGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/tmpHashCode'
deprecated: false
/spPortal/portProtocolClassification:
get:
summary: portProtocolTmpGet
description: Returns a collection of application definition
operationId: portProtocolTmpGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PortProtocolTmp'
deprecated: false
/spPortal/portProtocolClassification/info:
get:
summary: portProtocolTmpHashCodeGet
description: Returns a hash code for application definition data. It is used as version number.
operationId: portProtocolTmpHashCodeGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/tmpHashCode'
deprecated: false
/spPortal/registration:
get:
summary: gmsPortalRegistrationGet
description: Get current GMS-Portal registration status
operationId: gmsPortalRegistrationGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PortalRegistrationResponse'
deprecated: false
post:
summary: gmsPortalRegistrationPost
description: Use this API to reset the GMS-Portal registration state and initiate new Registration cycle. There is no post data required for this API, to edit portal credentials (Account Key, Account Name, Group, Site) use /gmsConfig/spPortal. Registration cycle may take up to two minutes to get an update from Portal, use GET /spPortal/registration to poll.
operationId: gmsPortalRegistrationPost
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PortalRegistrationResponse'
deprecated: false
/spPortal/saasClassification:
get:
summary: saasTmpGet
description: Returns a collection of application definition
operationId: saasTmpGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/saasTmp'
deprecated: false
/spPortal/saasClassification/info:
get:
summary: saasTmpHashCodeGet
description: Returns a hash code for application definition data. It is used as version number.
operationId: saasTmpHashCodeGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/tmpHashCode'
deprecated: false
/spPortal/status:
get:
summary: spPortalStatusGet
description: Debug API to view current status of all Portal related services
operationId: spPortalStatusGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SpPortalStatusGetResponse'
- description: Collection of GeoLocationObject indexed by ip address value
deprecated: false
/spPortal/tcpUdpPorts:
get:
summary: tcpUdpPortsGet
description: This API returns list of TCP, UDP ports and their applications
operationId: tcpUdpPortsGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: object
description: No response was specified
deprecated: false
/spPortal/topSites:
get:
summary: topSitesGet
description: This API returns array of top internet sites fetched from Silver Peak Cloud Portal
operationId: topSitesGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
/spPortal/trafficBehavior:
get:
summary: tbTmpGet
description: Returns a collection of traffic behavior configuration and names
operationId: tbTmpGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/trafficBehaviorTmp'
deprecated: false
/spPortal/trafficBehavior/info:
get:
summary: tbTmpHashCodeGet
description: Returns a hash code for traffic behavior data. It is used as version number.
operationId: tbTmpHashCodeGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/tmpHashCode'
deprecated: false
/ssl/{neId}:
get:
summary: sslCertsGet
description: The schema shows a single SSL certificate object. The return value is a list of SSL certificates keyed by unique hash code value
operationId: sslCertsGet
parameters:
- name: neId
in: path
description: Internal Id of the appliance from which you want to retrieve status information
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/sslCertsGet'
deprecated: false
/sslCACertificate/getText:
post:
summary: sslCACertGetTextPost
description: This API will take certificate date and return certificate information in text
operationId: sslCACertGetTextPost
parameters: []
requestBody:
description: A JSON object representing CA SSL certificate data
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/sslCertGetTextPost'
- description: A JSON object representing CA SSL certificate data
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/sslCACertificate/validation:
post:
summary: sslCACertValidation
description: Validate the SSL CA certificate file.
operationId: sslCACertValidation
parameters: []
requestBody:
description: A JSON object representing SSL certificate
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/sslCACertValidation'
- description: A JSON object representing SSL certificate
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/sslCACertificate/{neId}:
get:
summary: sslCACerts
description: Get all CA SSL certificates on the appliance.
operationId: sslCACerts
parameters:
- name: neId
in: path
description: Internal Id of the appliance from which you want to retrieve status information
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/sslCACertsGet'
deprecated: false
/sslCertificate/getInfo:
post:
summary: sslCertGetInfoPost
description: This API will take certificate date and return certificate information
operationId: sslCertGetInfoPost
parameters: []
requestBody:
description: A JSON object representing SSL certificate
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/sslCertGetInfoPost'
- description: A JSON object representing SSL certificate
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/sslCertificate/getText:
post:
summary: sslCertGetTextPost
description: This API will take certificate date and return certificate information in text
operationId: sslCertGetTextPost
parameters: []
requestBody:
description: A JSON object representing SSL certificate
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/sslCertGetTextPost'
- description: A JSON object representing SSL certificate
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/sslSubstituteCertificate/validation:
post:
summary: sslSubstituteCertValidation
description: Validate the SSL Substitute certificate
operationId: sslSubstituteCertValidation
parameters: []
requestBody:
description: A JSON object representing SSL Substitute certificate file
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/sslSubstituteCertValidation'
- description: A JSON object representing SSL Substitute certificate file
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/sslSubstituteCertificate/{neId}:
get:
summary: sslSubstituteCertGet
description: Get all SSL Substitute certificates on the appliance.
operationId: sslSubstituteCertGet
parameters:
- name: id
in: query
description: Internal Id of the appliance from which you want to retrieve status information
required: true
style: form
explode: true
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
- name: neId
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/sslSubstituteCertGet'
deprecated: false
/stats/aggregate/appliance:
get:
summary: statsaggregatetunnel
description: This operation is used to retrieve appliance aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: statsaggregatetunnel
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Filter data for a specific group
style: form
explode: true
schema:
type: string
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplianceAggregateStats'
deprecated: false
post:
summary: Poststatsaggregatetunnel
description: This operation is used to retrieve appliance aggregate stats and it's identical to the GET operation on this URL except that you need to pass a request body containing appliance ids that you want to filter on to it. Depend on what query parameters are provided. The response format may look different.
operationId: Poststatsaggregatetunnel
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplianceAggregateStats'
deprecated: false
/stats/aggregate/appliance/{nePk}:
get:
summary: Getstatsaggregatetunnel
description: This operation is used to retrieve appliance aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: Getstatsaggregatetunnel
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplianceAggregateStats'
deprecated: false
/stats/aggregate/application:
get:
summary: statsaggregateapplication
description: This operation is used to retrieve application aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: statsaggregateapplication
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Filter data for a specific group
style: form
explode: true
schema:
type: string
- name: application
in: query
description: Filter for data which belongs to application with name {application}
style: form
explode: true
schema:
type: string
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationAggregateStats'
deprecated: true
post:
summary: Poststatsaggregateapplication
description: This operation is used to retrieve application aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: Poststatsaggregateapplication
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: application
in: query
description: Filter for data which belongs to application with name {application}
style: form
explode: true
schema:
type: string
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationAggregateStats'
deprecated: true
/stats/aggregate/application/{nePk}:
get:
summary: Getstatsaggregateapplication
description: This operation is used to retrieve application aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: Getstatsaggregateapplication
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: application
in: query
description: Filter for data which belongs to application with name {application}
style: form
explode: true
schema:
type: string
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationAggregateStats'
deprecated: true
/stats/aggregate/application2:
get:
summary: Getstatsaggregateapplication1
description: This operation is used to retrieve application aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: Getstatsaggregateapplication1
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: groupPk
in: query
description: Filter data for a specific group
style: form
explode: true
schema:
type: string
- name: application
in: query
description: Filter for data which belongs to application with name {application}
style: form
explode: true
schema:
type: string
- name: top
in: query
description: Retrieve top 10 applications by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Application2AggregateStats'
description: No response was specified
deprecated: false
post:
summary: Poststatsaggregateapplication1
description: This operation is used to retrieve application aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: Poststatsaggregateapplication1
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: application
in: query
description: Filter for data which belongs to application with name {application}
style: form
explode: true
schema:
type: string
- name: top
in: query
description: Retrieve top 10 applications by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Application2AggregateStats'
description: No response was specified
deprecated: false
/stats/aggregate/application2/{nePk}:
get:
summary: Getstatsaggregateapplication12
description: This operation is used to retrieve application aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: Getstatsaggregateapplication12
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: application
in: query
description: Filter for data which belongs to application with name {application}
style: form
explode: true
schema:
type: string
- name: top
in: query
description: Retrieve top 10 applications by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Application2AggregateStats'
description: No response was specified
deprecated: false
/stats/aggregate/boost:
post:
summary: boostaggregatestats
description: This operation is used to retrieve boost aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: boostaggregatestats
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: top
in: query
description: Indicate top x items
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
/stats/aggregate/boost/{nePk}:
get:
summary: Getboostaggregatestats
description: This operation is used to retrieve boost aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: Getboostaggregatestats
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: tunnelName
in: query
description: Filter for data which belongs to tunnel with name {tunnelName}
style: form
explode: true
schema:
type: string
- name: top
in: query
description: Indicate top x items
style: form
explode: true
schema:
type: integer
format: int32
- name: overlay
in: query
description: When it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
/stats/aggregate/dns:
get:
summary: DNSstatsaggregate
description: This operation is used to retrieve DNS aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: DNSstatsaggregate
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: isSource
in: query
description: Integer value representing whether dns is from source or destination
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/isSource'
- description: Integer value representing whether dns is from source or destination
example: 0
- name: splitType
in: query
description: Filter data for a specific type, where 0 is for 'http', 1 is for 'https', 2 is for 'unassigned' and 3 is for 'others'
style: form
explode: true
schema:
type: integer
format: int32
- name: top
in: query
description: No. of rows to return
style: form
explode: true
schema:
type: integer
format: int32
- name: splitByNe
in: query
description: Boolean value indicating whether you want to split aggregate stats by appliance, if true is provided, there will be an extra level of key inside each stats object indicating what appliance the inner stats object belongs to. Default value is null.
style: form
explode: true
schema:
type: boolean
- name: groupBy
in: query
description: Group the data based on this value. Default value is dns.
style: form
explode: true
schema:
type: string
- name: groupBySubDomains
in: query
description: Group the data based on this value.Integer value represents number of sub-domains. Default value is 2.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DNSAggregateStatsFields'
description: No response was specified
deprecated: false
post:
summary: statsaggregatedns
description: This operation is used to retrieve dns aggregate stats and it's identical to the GET operation on this URL except that you need to pass a request body containing appliance ids that you want to filter on to it. Depend on what query parameters are provided. The response format may look different.
operationId: statsaggregatedns
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: isSource
in: query
description: Integer value representing whether dns is from source or destination
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/isSource'
- description: Integer value representing whether dns is from source or destination
example: 0
- name: splitType
in: query
description: Filter data for a specific type, where 0 is for 'http', 1 is for 'https', 2 is for 'unassigned' and 3 is for 'others'
style: form
explode: true
schema:
type: integer
format: int32
- name: top
in: query
description: No. of rows to return
style: form
explode: true
schema:
type: integer
format: int32
- name: splitByNe
in: query
description: Boolean value indicating whether you want to split aggregate stats by appliance, if true is provided, there will be an extra level of key inside each stats object indicating what appliance the inner stats object belongs to. Default value is null.
style: form
explode: true
schema:
type: boolean
- name: groupBy
in: query
description: Group the data based on this value. Default value is dns.
style: form
explode: true
schema:
type: string
- name: groupBySubDomains
in: query
description: Group the data based on this value.Integer value represents number of sub-domains. Default value is 2.
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DNSAggregateStatsFields'
description: No response was specified
deprecated: false
/stats/aggregate/dns/{nePk}:
get:
summary: Getstatsaggregatetunnel1
description: This operation is used to retrieve dns aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: Getstatsaggregatetunnel1
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: isSource
in: query
description: Integer value representing whether dns is from source or destination
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/isSource'
- description: Integer value representing whether dns is from source or destination
example: 0
- name: splitType
in: query
description: Filter data for a specific type, where 0 is for 'http', 1 is for 'https', 2 is for 'unassigned' and 3 is for 'others'
style: form
explode: true
schema:
type: integer
format: int32
- name: top
in: query
description: No. of rows to return
style: form
explode: true
schema:
type: integer
format: int32
- name: splitByNe
in: query
description: Boolean value indicating whether you want to split aggregate stats by appliance, if true is provided, there will be an extra level of key inside each stats object indicating what appliance the inner stats object belongs to. Default value is null.
style: form
explode: true
schema:
type: boolean
- name: groupBy
in: query
description: Group the data based on this value. Default value is dns.
style: form
explode: true
schema:
type: string
- name: groupBySubDomains
in: query
description: Group the data based on this value.Integer value represents number of sub-domains. Default value is 2.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DNSAggregateStatsFields'
description: No response was specified
deprecated: false
/stats/aggregate/drc:
get:
summary: statsaggregatedrctunnel
description: This operation is used to retrieve tunnel aggregate drc stats. Depend on what query parameters are provided. The response format may look different.
operationId: statsaggregatedrctunnel
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Filter data for a specific group
style: form
explode: true
schema:
type: string
- name: top
in: query
description: Indicate top x items
style: form
explode: true
schema:
type: integer
format: int32
- name: overlay
in: query
description: when it is 'all',return all bonded tunnels;when it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra column inside each tunnel stats record in CSV format indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TunnelAggregateDrcStatsBase'
description: No response was specified
deprecated: false
post:
summary: statsdrcaggregatetunnel
description: This operation is used to retrieve tunnel aggregate stats and it's identical to the GET operation on this URL except that you need to pass a request body containing appliance ids that you want to filter on to it. Depend on what query parameters are provided. The response format may look different.
operationId: statsdrcaggregatetunnel
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: top
in: query
description: Indicate top x items
style: form
explode: true
schema:
type: integer
format: int32
- name: overlay
in: query
description: when it is 'all',return all bonded tunnels;when it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra column inside each tunnel stats record in CSV format indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TunnelAggregateDrcStatsBase'
description: No response was specified
deprecated: false
/stats/aggregate/drc/{nePk}:
get:
summary: Getstatsaggregatedrctunnel
description: This operation is used to retrieve tunnel aggregate drc stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: Getstatsaggregatedrctunnel
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: tunnelName
in: query
description: Filter for data which belongs to tunnel with name {tunnelName}
style: form
explode: true
schema:
type: string
- name: top
in: query
description: Indicate top x items
style: form
explode: true
schema:
type: integer
format: int32
- name: overlay
in: query
description: when it is 'all',return all bonded tunnels;when it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra column inside each tunnel stats record in CSV format indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TunnelAggregateDrcStatsBase'
description: No response was specified
deprecated: false
/stats/aggregate/dscp:
get:
summary: statsaggregatedscp
description: This operation is used to retrieve dscp aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: statsaggregatedscp
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Filter data for a specific group
style: form
explode: true
schema:
type: string
- name: dscp
in: query
description: 'Filter for data which belongs to a certain flow type. Valid DSCP: 0 - 63'
style: form
explode: true
schema:
type: integer
format: int32
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DscpAggregateStats'
deprecated: false
post:
summary: Poststatsaggregatedscp
description: This operation is used to retrieve dscp aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: Poststatsaggregatedscp
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: dscp
in: query
description: 'Filter for data which belongs to a certain flow type. Valid DSCP: 0 - 63'
style: form
explode: true
schema:
type: integer
format: int32
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DscpAggregateStats'
deprecated: false
/stats/aggregate/dscp/{nePk}:
get:
summary: Getstatsaggregatedscp
description: This operation is used to retrieve dscp aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: Getstatsaggregatedscp
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficClass
in: query
description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficClass1'
- description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
example: 1
- name: dscp
in: query
description: 'Filter for data which belongs to a certain flow type. Valid DSCP: 0 - 63'
style: form
explode: true
schema:
type: integer
format: int32
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DscpAggregateStats'
deprecated: false
/stats/aggregate/flow:
get:
summary: statsaggregateflow
description: This operation is used to retrieve flow aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: statsaggregateflow
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Filter data for a specific group
style: form
explode: true
schema:
type: string
- name: flow
in: query
description: Filter for data which belongs to a certain flow type.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/flow'
- description: Filter for data which belongs to a certain flow type.
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FlowAggregateStats'
deprecated: false
post:
summary: Poststatsaggregateflow
description: This operation is used to retrieve flow aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: Poststatsaggregateflow
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: flow
in: query
description: Filter for data which belongs to a certain flow type.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/flow'
- description: Filter for data which belongs to a certain flow type.
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FlowAggregateStats'
deprecated: false
/stats/aggregate/flow/active:
post:
summary: Getactiveflowcounts
description: Get active flow counts by NE id
operationId: Getactiveflowcounts
parameters:
- name: top
in: query
description: No. of rows to return
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ActiveFlowCounts'
deprecated: false
/stats/aggregate/flow/{nePk}:
get:
summary: Getstatsaggregateflow
description: This operation is used to retrieve flow aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: Getstatsaggregateflow
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficClass
in: query
description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficClass1'
- description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
example: 1
- name: flow
in: query
description: Filter for data which belongs to a certain flow type.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/flow'
- description: Filter for data which belongs to a certain flow type.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FlowAggregateStats'
deprecated: false
/stats/aggregate/interface:
get:
summary: interfaceaggregatestats
description: This operation is used to retrieve interface aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: interfaceaggregatestats
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InterfaceAggregateStats'
description: No response was specified
deprecated: false
post:
summary: Postinterfaceaggregatestats
description: This operation is used to retrieve interface aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: Postinterfaceaggregatestats
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InterfaceAggregateStats'
description: No response was specified
deprecated: false
/stats/aggregate/interfaceOverlay:
post:
summary: interfaceoverlaytransportaggregatestats
description: This operation is used to retrieve interface overlay transport aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: interfaceoverlaytransportaggregatestats
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: interfaceName
in: query
description: Interface name you want to filter on.
style: form
explode: true
schema:
type: string
- name: overlay
in: query
description: When it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InterfaceOverlayAggregateStats'
description: No response was specified
deprecated: false
/stats/aggregate/jitter:
get:
summary: Jitterstatsaggregate
description: This operation is used to retrieve jitter aggregate stats. Depend on what query parameters are provided.
operationId: Jitterstatsaggregate
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: overlay
in: query
description: when it is 'all',return all bonded tunnels;when it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
post:
summary: statsaggregatejitter
description: This operation is identical to the GET operation on this URL except that you need to pass a request body containing appliance ids that you want to filter on to it.
operationId: statsaggregatejitter
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: top
in: query
description: No. of rows to return
style: form
explode: true
schema:
type: integer
format: int32
- name: overlay
in: query
description: when it is 'all',return all bonded tunnels;when it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/JitterAggregateStatsBase'
description: No response was specified
deprecated: false
/stats/aggregate/jitter/{nePk}:
get:
summary: GetJitterstatsaggregate
description: This operation is used to retrieve jitter aggregate stats. Depend on what query parameters are provided.
operationId: GetJitterstatsaggregate
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: overlay
in: query
description: when it is 'all',return all bonded tunnels;when it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
- name: tunnelName
in: query
description: Filter for data which belongs to tunnel with name {tunnelName}
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
/stats/aggregate/mos:
post:
summary: mosaggregatestats
description: This operation is used to retrieve mos aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: mosaggregatestats
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: top
in: query
description: Indicate top x items
style: form
explode: true
schema:
type: integer
format: int32
- name: overlay
in: query
description: When it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MosAggregateStats'
description: No response was specified
deprecated: false
/stats/aggregate/mos/{nePk}:
get:
summary: Getmosaggregatestats
description: This operation is used to retrieve mos aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: Getmosaggregatestats
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: tunnelName
in: query
description: Filter for data which belongs to tunnel with name {tunnelName}
style: form
explode: true
schema:
type: string
- name: top
in: query
description: Indicate top x items
style: form
explode: true
schema:
type: integer
format: int32
- name: overlay
in: query
description: When it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MosAggregateStats'
description: No response was specified
deprecated: false
/stats/aggregate/ports:
get:
summary: Portstatsaggregate
description: This operation is used to retrieve ports aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: Portstatsaggregate
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: isSource
in: query
description: Integer value representing whether port is from source or destination
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/isSource'
- description: Integer value representing whether port is from source or destination
example: 0
- name: isKnown
in: query
description: Integer value representing whether port is assigned to a application(1) or not(0)
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/isKnown'
- description: Integer value representing whether port is assigned to a application(1) or not(0)
example: 0
- name: protocol
in: query
description: Integer value representing whether protocol used by port
style: form
explode: true
schema:
type: integer
format: int32
- name: port
in: query
description: Integer value representing whether port number
style: form
explode: true
schema:
type: integer
format: int32
- name: top
in: query
description: No. of rows to return
style: form
explode: true
schema:
type: integer
format: int32
- name: splitByNe
in: query
description: Boolean value indicating whether you want to split aggregate stats by appliance, if true is provided, there will be an extra level of key inside each stats object indicating what appliance the inner stats object belongs to. Default value is null.
style: form
explode: true
schema:
type: boolean
- name: lastHour
in: query
description: Boolean value representing whether to fetch data one hour behind from last hour if data is not found in last hour time range
style: form
explode: true
schema:
type: boolean
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
post:
summary: statsaggregateports
description: This operation is used to retrieve ports aggregate stats and it's identical to the GET operation on this URL except that you need to pass a request body containing appliance ids that you want to filter on to it. Depend on what query parameters are provided. The response format may look different.
operationId: statsaggregateports
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: isSource
in: query
description: Integer value representing whether dns is from source or destination
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/isSource'
- description: Integer value representing whether dns is from source or destination
example: 0
- name: isKnown
in: query
description: Integer value representing whether port is assigned to a application(1) or not(0)
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/isKnown'
- description: Integer value representing whether port is assigned to a application(1) or not(0)
example: 0
- name: protocol
in: query
description: Integer value representing whether protocol used by port
style: form
explode: true
schema:
type: integer
format: int32
- name: port
in: query
description: Integer value representing whether port number
style: form
explode: true
schema:
type: integer
format: int32
- name: top
in: query
description: No. of rows to return
style: form
explode: true
schema:
type: integer
format: int32
- name: splitByNe
in: query
description: Boolean value indicating whether you want to split aggregate stats by appliance, if true is provided, there will be an extra level of key inside each stats object indicating what appliance the inner stats object belongs to. Default value is null.
style: form
explode: true
schema:
type: boolean
- name: lastHour
in: query
description: Boolean value representing whether to fetch data one hour behind from last hour if data is not found in last hour time range
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
/stats/aggregate/ports/{nePk}:
get:
summary: GetPortstatsaggregate
description: This operation is used to retrieve ports aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: GetPortstatsaggregate
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: isSource
in: query
description: Integer value representing whether port is from source or destination
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/isSource'
- description: Integer value representing whether port is from source or destination
example: 0
- name: isKnown
in: query
description: Integer value representing whether port is assigned to a application(1) or not(0)
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/isKnown'
- description: Integer value representing whether port is assigned to a application(1) or not(0)
example: 0
- name: protocol
in: query
description: Integer value representing whether protocol used by port
style: form
explode: true
schema:
type: integer
format: int32
- name: port
in: query
description: Integer value representing whether port number
style: form
explode: true
schema:
type: integer
format: int32
- name: top
in: query
description: No. of rows to return
style: form
explode: true
schema:
type: integer
format: int32
- name: splitByNe
in: query
description: Boolean value indicating whether you want to split aggregate stats by appliance, if true is provided, there will be an extra level of key inside each stats object indicating what appliance the inner stats object belongs to. Default value is null.
style: form
explode: true
schema:
type: boolean
- name: lastHour
in: query
description: Boolean value representing whether to fetch data one hour behind from last hour if data is not found in last hour time range
style: form
explode: true
schema:
type: boolean
- name: nePk
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
/stats/aggregate/securityPolicy:
post:
summary: securitypolicyaggregatestats
description: This operation is used to retrieve security policy aggregate stats.
operationId: securitypolicyaggregatestats
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: top
in: query
description: Indicate top x items
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv, and the response data format would be different if this field is provided
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv, and the response data format would be different if this field is provided
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance. Default value is true.
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SecurityPolicyAggregateStats'
description: No response was specified
deprecated: false
/stats/aggregate/securityPolicy/{nePk}:
get:
summary: Getsecuritypolicyaggregatestats
description: This operation is used to retrieve security policy aggregate stats.
operationId: Getsecuritypolicyaggregatestats
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: fromZone
in: query
description: Filter for data which come from the zone indicated by this zone internal ID
required: true
style: form
explode: true
schema:
type: string
- name: toZone
in: query
description: Filter for data which go to the zone indicated by this zone internal ID
required: true
style: form
explode: true
schema:
type: string
- name: top
in: query
description: Indicate top x items
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv, and the response data format would be different if this field is provided
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv, and the response data format would be different if this field is provided
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SecurityPolicyAggregateStats'
description: No response was specified
deprecated: false
/stats/aggregate/topTalkers:
get:
summary: topTalkersstatsaggregate
description: This operation is used to retrieve topTalkers aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: topTalkersstatsaggregate
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: top
in: query
description: No. of rows to return
style: form
explode: true
schema:
type: integer
format: int32
- name: splitByNe
in: query
description: Boolean value indicating whether you want to split aggregate stats by appliance, if true is provided, there will be an extra level of key inside each stats object indicating what appliance the inner stats object belongs to. Default value is null.
style: form
explode: true
schema:
type: boolean
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/topTalkersAggregateStatsFields'
description: No response was specified
deprecated: false
post:
summary: statsaggregatetopTalkers
description: This operation is used to retrieve topTalkers aggregate stats and it's identical to the GET operation on this URL except that you need to pass a request body containing appliance ids that you want to filter on to it. Depend on what query parameters are provided. The response format may look different.
operationId: statsaggregatetopTalkers
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: top
in: query
description: No. of rows to return
style: form
explode: true
schema:
type: integer
format: int32
- name: splitByNe
in: query
description: Boolean value indicating whether you want to split aggregate stats by appliance, if true is provided, there will be an extra level of key inside each stats object indicating what appliance the inner stats object belongs to. Default value is null.
style: form
explode: true
schema:
type: boolean
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/topTalkersAggregateStatsFields'
description: No response was specified
deprecated: false
/stats/aggregate/topTalkers/split/{nePk}:
get:
summary: GetstatsaggregatetopTalkers
description: This operation is used to retrieve topTalkers aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: GetstatsaggregatetopTalkers
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: sourceIp
in: query
description: Source IP address
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/topTalkersAggregateStatsFields'
description: No response was specified
deprecated: false
/stats/aggregate/topTalkers/{nePk}:
get:
summary: GetstatsaggregatetopTalkers1
description: This operation is used to retrieve topTalkers aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: GetstatsaggregatetopTalkers1
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: top
in: query
description: No. of rows to return
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/topTalkersAggregateStatsFields'
description: No response was specified
deprecated: false
/stats/aggregate/trafficBehavior:
get:
summary: TrafficBehavior
description: This operation is used to retrieve Traffic Behavioral aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: TrafficBehavior
parameters:
- name: startTime
in: query
description: Start time ( epoch time in seconds ) of time range that stats are requested for
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: End time ( epoch time in seconds ) of time range that stats are requested for
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: groupPk
in: query
description: Filter data for a specific group
style: form
explode: true
schema:
type: string
- name: behavioralCate
in: query
description: Filter for data which belongs to behavioral Category with name { behavioral_category }
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/trafficBehaviorAggregateStatsFields'
description: No response was specified
deprecated: false
post:
summary: PostTrafficBehavior
description: This operation is used to retrieve Traffic Behavioral stats. Depend on what query parameters are provided. The response format may look different.
operationId: PostTrafficBehavior
parameters:
- name: startTime
in: query
description: Start time ( epoch time in seconds ) of time range that stats are requested for
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: End time ( epoch time in seconds ) of time range that stats are requested for
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: behavioralCate
in: query
description: Filter for data which belongs to behavioral Category with name { behavioral_category }
style: form
explode: true
schema:
type: string
- name: application
in: query
description: Filter for data which belongs to application with name {application}
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv
- name: top
in: query
description: Restrict Applications for each behavior category to Top N
style: form
explode: true
schema:
type: integer
format: int32
- name: lastHour
in: query
description: Boolean value representing whether to fetch data one hour behind from last hour if data is not found in last hour time range
style: form
explode: true
schema:
type: boolean
- name: isAggregated
in: query
description: Get (aggregate) Traffic Behavioral stats data
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/trafficBehaviorStatsFields'
description: No response was specified
deprecated: false
/stats/aggregate/trafficBehavior/{nePk}:
get:
summary: GetTrafficBehavior
description: This operation is used to retrieve Traffic Behavioral stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: GetTrafficBehavior
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Start time ( epoch time in seconds ) of time range that stats are requested for
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: End time ( epoch time in seconds ) of time range that stats are requested for
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: behavioralCate
in: query
description: Filter for data which belongs to behavioral Category with name { behavioral_category }
style: form
explode: true
schema:
type: string
- name: application
in: query
description: Filter for data which belongs to application with name {application}
style: form
explode: true
schema:
type: string
- name: top
in: query
description: Restrict Applications for each behavior category to Top N
style: form
explode: true
schema:
type: integer
format: int32
- name: lastHour
in: query
description: Boolean value representing whether to fetch data one hour behind from last hour if data is not found in last hour time range
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/trafficBehaviorAggregateStatsFields'
description: No response was specified
deprecated: false
/stats/aggregate/trafficClass:
get:
summary: statsaggregatetrafficclass
description: This operation is used to retrieve traffic class aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: statsaggregatetrafficclass
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Filter data for a specific group
style: form
explode: true
schema:
type: string
- name: trafficClass
in: query
description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficClass1'
- description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
example: 1
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficClassAggregateStats'
deprecated: false
post:
summary: Poststatsaggregatetrafficclass
description: This operation is used to retrieve traffic class aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: Poststatsaggregatetrafficclass
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficClass
in: query
description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficClass1'
- description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
example: 1
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficClassAggregateStats'
deprecated: false
/stats/aggregate/trafficClass/{nePk}:
get:
summary: Getstatsaggregatetrafficclass
description: This operation is used to retrieve trafficClass aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: Getstatsaggregatetrafficclass
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficClass
in: query
description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficClass1'
- description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
example: 1
- name: trafficType
in: query
description: Filter for data for given traffic type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficClassAggregateStats'
deprecated: false
/stats/aggregate/tunnel:
get:
summary: Getstatsaggregatetunnel12
description: This operation is used to retrieve tunnel aggregate stats. Depend on what query parameters are provided. The response format may look different.
operationId: Getstatsaggregatetunnel12
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Filter data for a specific group
style: form
explode: true
schema:
type: string
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: overlay
in: query
description: when it is 'all',return all bonded tunnels;when it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelAggregateStats'
deprecated: false
post:
summary: Poststatsaggregatetunnel1
description: This operation is used to retrieve tunnel aggregate stats and it's identical to the GET operation on this URL except that you need to pass a request body containing appliance ids that you want to filter on to it. Depend on what query parameters are provided. The response format may look different.
operationId: Poststatsaggregatetunnel1
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: overlay
in: query
description: when it is 'all',return all bonded tunnels;when it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelAggregateStats'
deprecated: false
/stats/aggregate/tunnel/{nePk}:
get:
summary: Getstatsaggregatetunnel123
description: This operation is used to retrieve tunnel aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.
operationId: Getstatsaggregatetunnel123
parameters:
- name: nePk
in: path
description: Appliance internal id to filter from.
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: tunnelName
in: query
description: Filter for data which belongs to tunnel with name {tunnelName}
style: form
explode: true
schema:
type: string
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key.
style: form
explode: true
schema:
type: boolean
- name: metric
in: query
description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/metric'
- description: If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.
- name: top
in: query
description: This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.
style: form
explode: true
schema:
type: integer
format: int32
- name: overlay
in: query
description: when it is 'all',return all bonded tunnels;when it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format1'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: groupByNE
in: query
description: Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelAggregateStats'
deprecated: false
/stats/dnsInfo/{ip}:
get:
summary: statsdnsInfo
description: Get domain name by IP address from dns stats table
operationId: statsdnsInfo
parameters:
- name: ip
in: path
description: IP address to get dns name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/dnsInfo'
deprecated: false
/stats/timeseries/appliance:
get:
summary: statstimeseriesappliance
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: statstimeseriesappliance
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Internal group ID of a group for which you want to retrieve stats
style: form
explode: true
schema:
type: string
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsAppliance'
deprecated: false
post:
summary: Poststatstimeseriesappliance
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Poststatstimeseriesappliance
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsAppliance'
deprecated: false
/stats/timeseries/appliance/{nePk}:
get:
summary: Getstatstimeseriesappliance
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Getstatstimeseriesappliance
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsOneAppliance'
deprecated: false
/stats/timeseries/applianceProcessState/{nePk}:
get:
summary: statsofapplianceProcessState
description: This operation returns a JSON object containing Appliance Process State.
operationId: statsofapplianceProcessState
parameters:
- name: nePk
in: path
description: nepk id
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApplianceProcessState'
description: No response was specified
deprecated: false
/stats/timeseries/application:
get:
summary: statstimeseriesapplication
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: statstimeseriesapplication
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Internal group ID of a group for which you want to retrieve stats
style: form
explode: true
schema:
type: string
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: application
in: query
description: Filter for data which belongs to application with name {application}
required: true
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsMultiAppliances'
deprecated: true
post:
summary: Poststatstimeseriesapplication
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Poststatstimeseriesapplication
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: application
in: query
description: Filter for data which belongs to application with name {application}
required: true
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsMultiAppliances'
deprecated: true
/stats/timeseries/application/{nePk}:
get:
summary: Getstatstimeseriesapplication
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Getstatstimeseriesapplication
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: application
in: query
description: Filter for data which belongs to application with name {application}
required: true
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStats'
deprecated: true
/stats/timeseries/application2:
get:
summary: Getstatstimeseriesapplication1
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Getstatstimeseriesapplication1
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: application
in: query
description: Filter for data which belongs to application with name {application}
required: true
style: form
explode: true
schema:
type: string
- name: groupPk
in: query
description: Internal group ID of a group for which you want to retrieve stats
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: total
in: query
description: get all app's total value
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsMultiAppliances2'
deprecated: false
post:
summary: Poststatstimeseriesapplication1
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Poststatstimeseriesapplication1
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: application
in: query
description: Filter for data which belongs to application with name {application}
required: true
style: form
explode: true
schema:
type: string
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: total
in: query
description: get all app's total value
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsMultiAppliances2'
deprecated: false
/stats/timeseries/application2/{nePk}:
get:
summary: Getstatstimeseriesapplication12
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Getstatstimeseriesapplication12
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: application
in: query
description: Filter for data which belongs to application with name {application}
required: true
style: form
explode: true
schema:
type: string
- name: total
in: query
description: get all app's total value
style: form
explode: true
schema:
type: boolean
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsMultiAppliances2'
deprecated: false
/stats/timeseries/boost/{nePk}:
get:
summary: Boosttimeseriesstats
description: This operation is used to retrieve boost time series stats. Depend on what query parameters are provided. The response format may look different.
operationId: Boosttimeseriesstats
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TimeSeriesBoostStats'
description: No response was specified
deprecated: false
/stats/timeseries/drc:
get:
summary: statstimeseriesdrctunnel
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: statstimeseriesdrctunnel
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Internal group ID of a group for which you want to retrieve stats
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesDrcStatsMultiAppliances'
deprecated: false
post:
summary: Poststatstimeseriesdrctunnel
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Poststatstimeseriesdrctunnel
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesDrcStatsMultiAppliances'
deprecated: false
/stats/timeseries/drc/{nePk}:
get:
summary: Getstatstimeseriesdrctunnel
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Getstatstimeseriesdrctunnel
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: tunnelName
in: query
description: Filter for data which belongs to tunnel with name {tunnelName}
required: true
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesDrcStats'
deprecated: false
/stats/timeseries/dscp:
get:
summary: statstimeseriesdscp
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: statstimeseriesdscp
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Internal group ID of a group for which you want to retrieve stats
style: form
explode: true
schema:
type: string
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: dscp
in: query
description: 'Filter for data which belongs to a certain flow type. Valid DSCP: 0 - 63'
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DSCPTimeSeriesStatsMultiAppliances'
deprecated: false
post:
summary: Poststatstimeseriesdscp
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Poststatstimeseriesdscp
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: dscp
in: query
description: 'Filter for data which belongs to a certain flow type. Valid DSCP: 0 - 63'
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DSCPTimeSeriesStatsMultiAppliances'
deprecated: false
/stats/timeseries/dscp/{nePk}:
get:
summary: Getstatstimeseriesdscp
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Getstatstimeseriesdscp
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: dscp
in: query
description: 'Filter for data which belongs to a certain flow type. Valid DSCP: 0 - 63'
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DSCPTimeSeriesStatsSingleAppliances'
deprecated: false
/stats/timeseries/flow:
get:
summary: statstimeseriesflow
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: statstimeseriesflow
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Internal group ID of a group for which you want to retrieve stats
style: form
explode: true
schema:
type: string
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: flowType
in: query
description: Filter for data which belongs to a certain flow type.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/flowType'
- description: Filter for data which belongs to a certain flow type.
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FlowTimeSeriesStatsMultiAppliances'
deprecated: false
post:
summary: Poststatstimeseriesflow
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Poststatstimeseriesflow
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: flowType
in: query
description: Filter for data which belongs to a certain flow type.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/flowType'
- description: Filter for data which belongs to a certain flow type.
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/FlowTimeSeriesStatsMultiAppliances'
deprecated: false
/stats/timeseries/flow/{nePk}:
get:
summary: Getstatstimeseriesflow
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Getstatstimeseriesflow
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: flowType
in: query
description: Filter for data which belongs to a certain flow type.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/flowType'
- description: Filter for data which belongs to a certain flow type.
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/FlowTimeSeriesStatsItems'
- description: An array that contains the stats data of a certain timestamp.
deprecated: false
/stats/timeseries/interface/{nePk}:
get:
summary: interfacetimeseriesstats
description: This operation returns a JSON object containing data objects of each interface is an array, each data object contains the stats for a particular timestamp.
operationId: interfacetimeseriesstats
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: interfaceName
in: query
description: Filter for data which belongs to interface with name {interface}
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InterfaceTimeSeriesStats'
description: No response was specified
deprecated: false
/stats/timeseries/interfaceOverlay/{nePk}:
get:
summary: interfaceoverlaytransporttimeseriesstats
description: This operation returns a JSON object containing data objects of each interface overlay transport is an array, each data object contains the stats for a particular timestamp.
operationId: interfaceoverlaytransporttimeseriesstats
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: overlay
in: query
description: When it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InterfaceOverlayTimeSeriesStats'
description: No response was specified
deprecated: false
/stats/timeseries/internalDrops/{nePk}:
get:
summary: statstimeseriesinternalDrops
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: statstimeseriesinternalDrops
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InternalDropsTimeSeriesStats'
deprecated: false
/stats/timeseries/metrics:
get:
summary: statstimeseriestunnel
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: statstimeseriestunnel
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: key
in: query
description: for filter resource by key.
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsMultiAppliances'
deprecated: false
/stats/timeseries/mos/{nePk}:
get:
summary: MOStimeseriesstats
description: This operation is used to retrieve mos time series stats. Depend on what query parameters are provided. The response format may look different.
operationId: MOStimeseriesstats
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: tunnel
in: query
description: Filter for data which belongs to tunnel with name
required: true
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TimeSeriesMOSStats'
description: No response was specified
deprecated: false
/stats/timeseries/securityPolicy/{nePk}:
get:
summary: Securitypolicytimeseriesstats
description: This operation is used to retrieve security policy time series stats.
operationId: Securitypolicytimeseriesstats
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: fromZone
in: query
description: Limit the id of source zone from which the traffic passes through.
required: true
style: form
explode: true
schema:
type: string
- name: toZone
in: query
description: Limit the id of destination zone to which the traffic goes.
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityPolicyTimeSeries'
deprecated: false
/stats/timeseries/shaper:
get:
summary: Shapertimeseriesstats
description: Get Shaper time series stats data filter by certain query parameters and certain appliance IDs.
operationId: Shapertimeseriesstats
parameters:
- name: groupPk
in: query
description: Internal group ID of a group for which you want to retrieve stats
style: form
explode: true
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficClass
in: query
description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficClass1'
- description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
example: 1
- name: direction
in: query
description: 0 - Outbound/1 - Inbound
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/direction'
- description: 0 - Outbound/1 - Inbound
example: 0
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ShaperTimeSeriesStatsMultiAppliances'
deprecated: false
post:
summary: PostShapertimeseriesstats
description: Get Shaper time series stats data filter by certain query parameters and certain appliance IDs.
operationId: PostShapertimeseriesstats
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficClass
in: query
description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficClass1'
- description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
example: 1
- name: direction
in: query
description: 0 - Outbound/1 - Inbound
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/direction'
- description: 0 - Outbound/1 - Inbound
example: 0
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ShaperTimeSeriesStatsMultiAppliances'
deprecated: false
/stats/timeseries/trafficClass:
get:
summary: statstimeseriestrafficclass
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: statstimeseriestrafficclass
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Internal group ID of a group for which you want to retrieve stats
style: form
explode: true
schema:
type: string
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: trafficClass
in: query
description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficClass1'
- description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
example: 1
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsMultiAppliances'
deprecated: false
post:
summary: Poststatstimeseriestrafficclass
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Poststatstimeseriestrafficclass
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: trafficClass
in: query
description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficClass1'
- description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
example: 1
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsMultiAppliances'
deprecated: false
/stats/timeseries/trafficClass/{nePk}:
get:
summary: Getstatstimeseriestrafficclass
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Getstatstimeseriestrafficclass
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: trafficType
in: query
description: Filter for data for given traffic type
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficType'
- description: Filter for data for given traffic type
- name: trafficClass
in: query
description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/trafficClass1'
- description: Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10
example: 1
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStats'
deprecated: false
/stats/timeseries/tunnel:
get:
summary: Getstatstimeseriestunnel
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Getstatstimeseriestunnel
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: groupPk
in: query
description: Internal group ID of a group for which you want to retrieve stats
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsMultiAppliances'
deprecated: false
post:
summary: Poststatstimeseriestunnel
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Poststatstimeseriestunnel
parameters:
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: JSON array containing appliance IDs you want to filter on.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: JSON array containing appliance IDs you want to filter on.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStatsMultiAppliances'
deprecated: false
/stats/timeseries/tunnel/{nePk}:
get:
summary: Getstatstimeseriestunnel1
description: This operation returns a JSON object containing COLUMN_DEF and DATA. COLUMN_DEF is an array containing the names indicating what corresponding number in data array means. Data objects of each appliance is an array of data arrays, each data array contains the stats for a particular timestamp. Each number is data array corresponds to a name in COLUMN_DEF.
DATA object contains only values not keys.
operationId: Getstatstimeseriestunnel1
parameters:
- name: nePk
in: path
description: Internal ID of the appliance to filter from
required: true
style: simple
schema:
type: string
- name: startTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: endTime
in: query
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: granularity
in: query
description: Data granularity filtering whether data is minutely data, hourly data or daily data.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/granularity'
- description: Data granularity filtering whether data is minutely data, hourly data or daily data.
- name: tunnelName
in: query
description: Filter for data which belongs to tunnel with name {tunnelName}
required: true
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Limit the number of stats entity retrieved. Default and maximum limits are both 10000.
style: form
explode: true
schema:
type: integer
format: int32
- name: format
in: query
description: The only format other than JSON we support currently is CSV, so format=csv.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/format'
- description: The only format other than JSON we support currently is CSV, so format=csv.
- name: ip
in: query
description: Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false
style: form
explode: true
schema:
type: boolean
- name: latest
in: query
description: 'Instead of providing {startTime} and {endTime}, using {latest} query parameter could provide you stats for, say latest 10 minutes. Unit is minute. Example: latest=10. Default is to use {startTime} and {endTime} but if {latest} is presented then {latest} takes priority.'
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeSeriesStats'
deprecated: false
/subnets/configured/{neId}:
post:
summary: ConfSubnets
description: This api is used only for the older appliance whose version is less than 8.1.7.0.
The subnets list in the request body will be compared to the list of current subnets configured on the appliance. Any subnets which are in posted list but not on the appliance are added. Similarly, missing subnets are removed. Matching subnets are updated.
operationId: ConfSubnets
parameters:
- name: neId
in: path
description: The node Id of the appliance.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurePostData'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/subnets/forDiscovered/{discoveredId}:
get:
summary: GetSubnetsForDiscoveredAppliance
description: Get a discovered appliance's subnets information.
operationId: GetSubnetsForDiscoveredAppliance
parameters:
- name: discoveredId
in: path
description: The appliance's discovered ID
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GetResponse'
deprecated: false
/subnets/setSubnetSharingOptions/{neId}:
post:
summary: setSubnetSharingOptions
description: Configure an appliance's subnet sharing options (enable/disable use shared subnet information and automatically include local subnets.
operationId: setSubnetSharingOptions
parameters:
- name: neId
in: path
description: The node Id of the appliance.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SubnetsSystemJson'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/subnets/{getCachedData}/{neId}:
get:
summary: GetSubnets
description: Get an appliance's subnets information.
operationId: GetSubnets
parameters:
- name: getCachedData
in: path
description: True means to get the information from Orchestrator database, while false means to get from the appliance .
required: true
style: simple
schema:
type: boolean
- name: neId
in: path
description: The node id of the appliance.
required: true
style: simple
schema:
type: string
- name: subnet
in: query
description: The subnet to filter the routes received from the appliance(s). Supports IPv4 and IPv6 address types.
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GetResponse'
deprecated: false
/systemInfo/system/{neId}:
get:
summary: appSystemDeployInfo
description: Get Appliance System Deployment Information
operationId: appSystemDeployInfo
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppSystemDeployInfo'
deprecated: false
/systemInfo/systemForDiscovered/{discoveredId}:
get:
summary: discoveredAppSystemDeployInfo
description: Use this API to get the system information for a discovered appliance.
operationId: discoveredAppSystemDeployInfo
parameters:
- name: discoveredId
in: path
description: The discovered appliance ID
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppSystemDeployInfo'
deprecated: false
/systemInfo/{neId}:
get:
summary: appSystemStateInfo
description: Get Appliance System State Information
operationId: appSystemStateInfo
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppSystemStateInfo'
deprecated: false
/tca/tunnel/{neId}:
get:
summary: getTunnelTca
description: 'Currently the tunnel tca contains: reduction, oop-post-poc, loss-pre-fec, loss-post-fec, latency, utilization and oop-pre-poc.'
operationId: getTunnelTca
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: If true, get data from gmsdb, otherwise get from appliance.
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelTcaInfo'
deprecated: false
/tca/{neId}:
get:
summary: getSystemTca
description: 'Currently the system tca contains: oop-pre-poc, file-system-utilization, utilization, lan-side-rx-throughput, optimized-flows, latency, loss-post-fec, loss-pre-fec, oop-post-poc, wan-side-tx-throughput, reduction and total-flows.'
operationId: getSystemTca
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: If true, get data from gmsdb, otherwise get from appliance.
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TcaInfo'
deprecated: false
/tcpdump/run/:
post:
summary: tcpdumprun
description: This API allows you to start the packet capture process.
operationId: tcpdumprun
parameters: []
requestBody:
description: The run data
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PostRunConfig'
- description: The run data
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/tcpdump/status/{neId}:
get:
summary: tcpdumpstatus
description: This API allows you to retrieve status information of current packet capture process.
operationId: tcpdumpstatus
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TcpdumpStatus'
deprecated: false
/tcpdump/tcpdumpStatus:
get:
summary: tcpdumpStatus
description: Get the primary keys of all running tcp dumps.
operationId: tcpdumpStatus
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
text/html:
schema:
type: string
description: No response was specified
deprecated: false
/template/applianceAssociation/:
get:
summary: associationAll
description: Returns the complete association map of appliances to template groups
operationId: associationAll
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceAssociationGet'
- description: Map of appliance IDs to template group names associated with them
deprecated: false
/template/applianceAssociation/{nePk}:
get:
summary: associationOne
description: Returns the association map of template groups for a single appliance
operationId: associationOne
parameters:
- name: nePk
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceAssociationGetNepk'
- description: Map of appliance IDs to template group names associated with them
deprecated: false
post:
summary: associationOnePost
description: Associates the templates with a specific appliance. The array posted is the complete association for that appliance.
operationId: associationOnePost
parameters:
- name: nePk
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: Template names
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceAssociationGetNepk'
- description: Template names
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: string
description: No response was specified
deprecated: false
/template/history/groupList/{nePk}:
get:
summary: template
description: Returns the list of template groups applied to the appliance
operationId: template
parameters:
- name: nePk
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
/template/history/{nePk}:
get:
summary: Gettemplate
description: Returns history of applied templates by nePk
operationId: Gettemplate
parameters:
- name: nePk
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: latestOnly
in: query
description: ''
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TemplateHistoryItem'
description: No response was specified
deprecated: false
/template/templateCreate:
post:
summary: Posttemplate
description: 'In the request body, you will pass in the templates you want to create/modify with the template group. For details on the structure of the template configuration, please see the default template group. One way to get the exact JSON object to use for your configuration is to view the rest API call the Orchestrator Templates tab makes when you save a template. '
operationId: Posttemplate
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateCreateBody'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/template/templateGroups:
get:
summary: Gettemplate1
description: 'The returned objects inside the array are template-specific. '
operationId: Gettemplate1
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TemplateGroupsItem'
description: No response was specified
deprecated: false
/template/templateGroups/{templateGroup}:
delete:
summary: Deletetemplate
description: Deletes a template group
operationId: Deletetemplate
parameters:
- name: templateGroup
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: object
description: No response was specified
deprecated: false
get:
summary: Gettemplate12
description: 'The returned objects inside the array are template-specific. '
operationId: Gettemplate12
parameters:
- name: templateGroup
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TemplateGroupsItem'
- description: Template group data
deprecated: false
post:
summary: Posttemplate1
description: In the request body, you will pass in the templates you want to create/modify with the template group. For details on the structure of the template configuration, please see the default template group. One way to get the exact JSON object to use for your configuration is to view the rest API call the Orchestrator Templates tab makes when you save a template.
operationId: Posttemplate1
parameters:
- name: templateGroup
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateCreateBody'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/template/templateGroupsPriorities:
get:
summary: groupPrioGet
description: Returns the order that template groups will be applied in
operationId: groupPrioGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TemplateGroupPriorities'
- description: Map of appliance IDs to template group names associated with them
deprecated: false
post:
summary: groupPrioPost
description: Post the order that template groups should be applied in, groups not listed are not in a deterministic order
operationId: groupPrioPost
parameters: []
requestBody:
description: Template names
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TemplateGroupPriorities'
- description: Template names
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/template/templateSelection/{templateGroup}:
get:
summary: template1
description: Returns the selected templates in the template group
operationId: template1
parameters:
- name: templateGroup
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
type: string
description: No response was specified
deprecated: false
post:
summary: Posttemplate11
description: Selects the provided templates in the request body
operationId: Posttemplate11
parameters:
- name: templateGroup
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: Template names
content:
application/json:
schema:
type: array
items:
type: string
description: Template names
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/thirdPartyLicenses:
get:
summary: 3rdPartyLicenses
description: Gets all third party licenses information
operationId: 3rdPartyLicenses
parameters:
- name: format
in: query
description: Type of the response format(currently it supports 'txt' only).
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: array
items:
type: object
description: No response was specified
deprecated: false
/thirdPartyServices/zscaler/configuration:
get:
summary: zscalerConfigurationGet
description: Returns Zscaler configuration, including tunnel setting, selected interface label order
operationId: zscalerConfigurationGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Configuration'
deprecated: false
post:
summary: zscalerConfigurationPost
description: Update Returns Zscaler configuration, including tunnel setting, selected interface label order
operationId: zscalerConfigurationPost
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Configuration'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/thirdPartyServices/zscaler/connectivity:
get:
summary: zscalerConnectivityGet
description: Returns Zscaler connectivity status
operationId: zscalerConnectivityGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Connectivity'
deprecated: false
/thirdPartyServices/zscaler/defaultTunnelSetting:
get:
summary: zscalerDefaultTunnelSettingGet
description: Returns recommend tunnel setting for Zscaler
operationId: zscalerDefaultTunnelSettingGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelSetting'
deprecated: false
/thirdPartyServices/zscaler/pauseOrchestration:
get:
summary: zscalerPauseOrchestrationGet
description: Returns Pause Zscaler Orchestration configuration
operationId: zscalerPauseOrchestrationGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/zscalerPauseOrchestration'
deprecated: false
post:
summary: zscalerPauseOrchestrationPost
description: update pause Zscaler Orchestration configuration
operationId: zscalerPauseOrchestrationPost
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/zscalerPauseOrchestration'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/thirdPartyServices/zscaler/remoteEndpointException:
get:
summary: zscalerRemoteEndpointExceptionGet
description: Returns all user configured ZEN Override data
operationId: zscalerRemoteEndpointExceptionGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointExceptionMap'
deprecated: false
/thirdPartyServices/zscaler/subscription:
delete:
summary: zscalerSubscriptionDelete
description: Make sure to deselect Zscaler Policies in Business Intent Overlay first and wait until all Zscaler config has been deleted
operationId: zscalerSubscriptionDelete
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
get:
summary: zscalerSubscriptionGet
description: Returns Zscaler subscription
operationId: zscalerSubscriptionGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
deprecated: false
post:
summary: zscalerSubscriptionPost
description: Add/Update Subscription
operationId: zscalerSubscriptionPost
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/thirdPartyServices/zscaler/vpnLocationEndpointExceptionSetting:
post:
summary: zscalerVpnLocationExceptionPost
description: Get all VPN, Location, discovered and configured ZEN override data for one or more appliances
operationId: zscalerVpnLocationExceptionPost
parameters: []
requestBody:
description: an array of comma separated nepks.
content:
application/json:
schema:
type: array
items:
type: string
description: an array of comma separated nepks.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ZscalerVpnLocationExceptionConfig'
description: No response was specified
deprecated: false
/tunnels/bonded:
post:
summary: getBondedTunnelsConfigurationAndStates
description: 'The returned data is a tunnels configuration object, it contains tunnel names like: default, passthrough and passthrough-unshaped.'
operationId: getBondedTunnelsConfigurationAndStates
parameters:
- name: overlayId
in: query
description: ID of the overlay to filter on
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: neIds is an array of device keys. The device keys is assigned by Orchestrator, usually look like '0.NE'.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: neIds is an array of device keys. The device keys is assigned by Orchestrator, usually look like '0.NE'.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BondedTunnelsConfigAndStates'
deprecated: true
/tunnels/bonded/state:
post:
summary: getBondedTunnelsStates
description: 'The returned data is a tunnels configuration object, it contains tunnel names like: default, passthrough and passthrough-unshaped.'
operationId: getBondedTunnelsStates
parameters: []
requestBody:
description: neIds is an array of device keys. The device keys is assigned by Orchestrator, usually look like '0.NE'.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: neIds is an array of device keys. The device keys is assigned by Orchestrator, usually look like '0.NE'.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AllStates'
deprecated: false
/tunnels/physical:
post:
summary: getTunnelsConfigurationAndStates
description: 'The returned data is a tunnels configuration object, it contains tunnel names like: default, passthrough and passthrough-unshaped.'
operationId: getTunnelsConfigurationAndStates
parameters:
- name: state
in: query
description: The state regular expression which is used to match a tunnel state
style: form
explode: true
schema:
type: string
requestBody:
description: ids is an array of device keys. The device key is assigned by Orchestrator, usually look like '0.NE'.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: ids is an array of device keys. The device key is assigned by Orchestrator, usually look like '0.NE'.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelsConfigAndStates'
deprecated: true
/tunnels/physical/state:
post:
summary: getTunnelsStates
description: 'The returned data is a tunnels configuration object, it contains tunnel names like: default, passthrough and passthrough-unshaped.'
operationId: getTunnelsStates
parameters:
- name: state
in: query
description: The state regular expression which is used to match a tunnel state
style: form
explode: true
schema:
type: string
requestBody:
description: neIds is an array of device keys. The device keys is assigned by Orchestrator, usually look like '0.NE'.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: neIds is an array of device keys. The device keys is assigned by Orchestrator, usually look like '0.NE'.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AllStates'
deprecated: false
/tunnels/physical/traceroute/{id}:
post:
summary: initiateTraceroute
description: Initiate a traceroute on a tunnel
operationId: initiateTraceroute
parameters:
- name: id
in: path
description: tunnel id
required: true
style: simple
schema:
type: string
requestBody:
description: The nepk of the appliance
content:
text/plain:
schema:
type: string
description: The nepk of the appliance
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/tunnels/physical/tracerouteState/{id}:
post:
summary: tracerouteState
description: Get traceroute state for a tunnel
operationId: tracerouteState
parameters:
- name: id
in: path
description: tunnel id
required: true
style: simple
schema:
type: string
requestBody:
description: The nepk of the appliance
content:
text/plain:
schema:
type: string
description: The nepk of the appliance
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: object
description: No response was specified
deprecated: false
/tunnels/thirdParty:
post:
summary: getThirdPartyTunnelsConfigurationAndStates
description: 'The returned data is a tunnels configuration object, it contains tunnel names like: tunnel1, tunnel2, etc.'
operationId: getThirdPartyTunnelsConfigurationAndStates
parameters:
- name: state
in: query
description: The state regular expression which is used to match a tunnel state
style: form
explode: true
schema:
type: string
requestBody:
description: neIds is an array of device keys. The device keys is assigned by Orchestrator, usually look like '0.NE'.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: neIds is an array of device keys. The device keys is assigned by Orchestrator, usually look like '0.NE'.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdPartyTunnelsConfigAndStates'
deprecated: true
/tunnels/thirdParty/state:
post:
summary: getThirdPartyTunnelsStates
description: 'The returned data is a tunnels state object, it contains tunnel names like: tunnel1, tunnel2, etc.'
operationId: getThirdPartyTunnelsStates
parameters:
- name: state
in: query
description: The state regular expression which is used to match a tunnel state
style: form
explode: true
schema:
type: string
requestBody:
description: neIds is an array of device keys. The device keys is assigned by Orchestrator, usually look like '0.NE'.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: neIds is an array of device keys. The device keys is assigned by Orchestrator, usually look like '0.NE'.
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AllStates'
deprecated: false
/tunnels2:
get:
summary: tunnelsCount
description: The returned data is a map of tunnel count.
operationId: tunnelsCount
parameters:
- name: metaData
in: query
description: Sub-resource type
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelCountMap'
deprecated: false
/tunnels2/bonded:
get:
summary: searchAllBondedTunnels
description: 'NOTE: You should use the limit query parameter to limit the bonded tunnels returned. There could be a lot of bonded tunnels in the network.
The results are returned in an object/map of nePk -> '
operationId: searchAllBondedTunnels
parameters:
- name: limit
in: query
description: The max number of tunnels to return
required: true
style: form
explode: true
schema:
type: number
format: double
- name: matchingAlias
in: query
description: Search for all tunnels that have this string in it's alias
style: form
explode: true
schema:
type: string
- name: overlayId
in: query
description: Only return bonded tunnels that belong to this overlayId.
style: form
explode: true
schema:
type: number
format: double
- name: state
in: query
description: The regular expression to match a tunnel state
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NePkToBondedTunnelsMap'
deprecated: false
/tunnels2/bonded/{nePk}:
get:
summary: searchBondedTunnelsForAppliance
description: 'NOTE: You should use the limit query parameter to limit the bonded tunnels returned. There could be a lot of bonded tunnels in the network.
The results are returned in an object/map of '
operationId: searchBondedTunnelsForAppliance
parameters:
- name: nePk
in: path
description: The appliance's id/nePk
required: true
style: simple
schema:
type: string
- name: limit
in: query
description: The max number of tunnels to return
required: true
style: form
explode: true
schema:
type: number
format: double
- name: matchingAlias
in: query
description: Search for all tunnels that have this string in it's alias
style: form
explode: true
schema:
type: string
- name: overlayId
in: query
description: Only return bonded tunnels that belong to this overlayId.
style: form
explode: true
schema:
type: number
format: double
- name: state
in: query
description: The regular expression to match a tunnel state
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BondedTunnelsIdToTunnelMap'
deprecated: false
/tunnels2/bonded/{nePk}/{bondedTunnelId}:
get:
summary: getOneBondedTunnel
description: Get a specific bonded tunnel for one appliance
operationId: getOneBondedTunnel
parameters:
- name: bondedTunnelId
in: path
description: The bonded tunnel id
required: true
style: simple
schema:
type: string
- name: nePk
in: path
description: The appliance's id/nePk
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BondedTunnelConfig2'
deprecated: false
/tunnels2/bondedTunnelsWithPhysicalTunnel/{nePk}/{physicalTunnelId}:
get:
summary: getBondedTunnelsWithPhysicalTunnels
description: You can use this API to get all the bonded tunnels that have this physical tunnel bonded.
operationId: getBondedTunnelsWithPhysicalTunnels
parameters:
- name: nePk
in: path
description: The appliance's id/nePk
required: true
style: simple
schema:
type: string
- name: physicalTunnelId
in: path
description: A physical tunnel ID, all bonded tunnels that have this tunnel as a child tunnel will be returned
required: true
style: simple
schema:
type: string
- name: state
in: query
description: The regular expression to match a tunnel state
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BondedTunnelsIdToTunnelMap'
deprecated: false
/tunnels2/getTunnelsBetweenAppliances:
post:
summary: GetTunnelsBetweenAppliances
description: Use this API to get all the tunnels between a list of appliances. For all physical tunnels, set overlayId to 0. For all bonded tunnels, set overlayId to 'all'. For a specific overlay, you can set overlayId to the overlay ID
operationId: GetTunnelsBetweenAppliances
parameters:
- name: limit
in: query
description: The max number of tunnels to return
required: true
style: form
explode: true
schema:
type: number
format: double
- name: matchingAlias
in: query
description: Match the tunnel's alias on a text string
style: form
explode: true
schema:
type: string
- name: overlayId
in: query
description: The overlay ID to match tunnels on. 0 would be all physical tunnels, all - would be all bonded tunnels
style: form
explode: true
schema:
type: string
- name: state
in: query
description: The regular expression to match a tunnel state
style: form
explode: true
schema:
type: string
requestBody:
description: List of appliance IDs to retrieve the tunnels between all of them
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceIDs'
- description: List of appliance IDs to retrieve the tunnels between all of them
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TunnelsBetweenResultTunnel'
description: No response was specified
deprecated: false
/tunnels2/passThrough:
get:
summary: searchAllPassThroughTunnels
description: This API will return all the matching tunnels given the query parameters. Please use the 'limit' parameter to ensure the response is not too big.
operationId: searchAllPassThroughTunnels
parameters:
- name: limit
in: query
description: The max number of tunnels to return
required: true
style: form
explode: true
schema:
type: number
format: double
- name: matchingAlias
in: query
description: Search for all tunnels that have this string in it's alias
style: form
explode: true
schema:
type: string
- name: matchingService
in: query
description: Search for all tunnels that have this string in it's Peer/service
style: form
explode: true
schema:
type: string
- name: state
in: query
description: The regular expression to match a tunnel state
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/tunnels2/passThrough/{nePk}:
get:
summary: searchAppliancePassthroughTunnels
description: This API will return all the matching tunnels given the query parameters. Please use the 'limit' parameter to ensure the response is not too big.
operationId: searchAppliancePassthroughTunnels
parameters:
- name: nePk
in: path
description: The appliance's id/nePk
required: true
style: simple
schema:
type: string
- name: limit
in: query
description: The max number of tunnels to return
required: true
style: form
explode: true
schema:
type: number
format: double
- name: matchingAlias
in: query
description: Search for all tunnels that have this string in it's alias
style: form
explode: true
schema:
type: string
- name: matchingService
in: query
description: Search for all tunnels that have this string in it's Peer/service
style: form
explode: true
schema:
type: string
- name: state
in: query
description: The regular expression to match a tunnel state
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PassThroughTunnelIdToTunnelMap'
deprecated: false
/tunnels2/passThrough/{nePk}/{passThroughTunnelId}:
get:
summary: getPassThroughTunnel
description: Get pass through tunnel
operationId: getPassThroughTunnel
parameters:
- name: nePk
in: path
description: The appliance's id/nePk
required: true
style: simple
schema:
type: string
- name: passThroughTunnelId
in: path
description: The ID of the pass through tunnel
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PassThroughTunnel'
deprecated: false
/tunnels2/physical:
get:
summary: searchAllPhysicalTunnels
description: The returned data is a map of nePk -> .
operationId: searchAllPhysicalTunnels
parameters:
- name: limit
in: query
description: The max number of tunnels to return
required: true
style: form
explode: true
schema:
type: number
format: double
- name: matchingAlias
in: query
description: Match the tunnel's alias on a text string
style: form
explode: true
schema:
type: string
- name: state
in: query
description: The regular expression to match a tunnel state
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NePkToPhysicalTunnelsMap'
deprecated: false
/tunnels2/physical/{nePk}:
get:
summary: GetsearchAllPhysicalTunnels
description: The returned data is a map of .
operationId: GetsearchAllPhysicalTunnels
parameters:
- name: nePk
in: path
description: The nePk of the appliance
required: true
style: simple
schema:
type: string
- name: limit
in: query
description: The max number of tunnels to return
required: true
style: form
explode: true
schema:
type: number
format: double
- name: matchingAlias
in: query
description: Match the tunnel's alias on a text string
style: form
explode: true
schema:
type: string
- name: state
in: query
description: The regular expression to match a tunnel state
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PhysicalTunnelsIdToTunnelMap'
deprecated: false
/tunnels2/physical/{nePk}/{tunnelId}:
get:
summary: GetOnePhysicalTunnel
description: Get the details of one physical tunnel with the tunnel id
operationId: GetOnePhysicalTunnel
parameters:
- name: nePk
in: path
description: The nePk of the appliance
required: true
style: simple
schema:
type: string
- name: tunnelId
in: path
description: The tunnel's ID
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: object
description: No response was specified
deprecated: false
/tunnelsConfiguration/deployment:
get:
summary: tunnelsDeploymentInfo
description: This API returns the current deployment mode and list of lan/wan interface details for each appliance managed by this Orchestrator
operationId: tunnelsDeploymentInfo
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelsDeploymentInfo'
deprecated: false
/tunnelsConfiguration/overlayInfo:
get:
summary: tunnelsOverlayInfo
description: This API returns all the tunnels in Orchestrator, in groups of; all physical tunnels, tunnels in each overlay, and all tunnels. The different groups can be found using the root object's keys:
- 0 - all physical tunnels
- 1 - 7 - All bonded tunnels in that overlay (denoted by the underlay id, 1-7)
- all - all physical and bonded tunnels
The tunnels are under two keys, the first is the source appliance (nePk), and the second is the destination appliance (nePk)
operationId: tunnelsOverlayInfo
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TunnelsOverlayInfo'
deprecated: false
/tunnelsConfiguration/passThroughTunnelsInfo:
get:
summary: passThroughTunnelsInfo
description: This API returns all the Pass Through tunnels in Orchestrator
operationId: passThroughTunnelsInfo
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/passThroughTunnelsInfo'
deprecated: false
/uiUsageStats/{uiName}:
post:
summary: uiUsageStats
description: Add usage count for one UI feature.
operationId: uiUsageStats
parameters:
- name: uiName
in: path
description: The title of the dialogue or the name of the tab used
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/upgradeAppliances:
post:
summary: upgradeAppliances
description: The data to post need to contain image filename, install option and nePk id list .
operationId: upgradeAppliances
parameters: []
requestBody:
description: Upgrade appliances post data in JSON
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApplianceUpgradeEntry'
- description: Upgrade appliances post data in JSON
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/UpgradeAppliancesResponse'
deprecated: false
/userAccount/{neId}:
get:
summary: getUserAccount
description: the return data contains users and sessions object. users object is a map of user details keyed by username. sessions object is a map of sessions keyed by session number
operationId: getUserAccount
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: "'cached = true' will retrieve the user account details from cache ."
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/UserAccount'
deprecated: false
/users:
get:
summary: users
description: Returns all the users in the system
operationId: users
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UsersGetItem'
description: No response was specified
deprecated: false
/users/forgotPassword:
post:
summary: forgotPassword
description: Forgot password
operationId: forgotPassword
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForgotPasswordBody'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/users/newTfaKey:
get:
summary: newTfaKey
description: Returns a barcode to scan with an authentication application to set up app based two factor authentication for your account
operationId: newTfaKey
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NewTfaKeyResponse'
deprecated: false
/users/resetPassword:
post:
summary: resetPassword
description: Resets user password
operationId: resetPassword
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ResetPasswordBody'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NewTfaKeyResponse'
deprecated: false
/users/{newUser}:
post:
summary: Postusers
description: "Creates a new user or updates it. 'Status: Active/Inactive. Role: Admin Manager/Network Monitor'"
operationId: Postusers
parameters:
- name: newUser
in: path
description: Flag to indicate new user(=true) or update user details(=false)
required: true
style: simple
schema:
type: boolean
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SaveUpdateUserBody'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/users/{userId}/{userName}:
delete:
summary: Deleteusers
description: Deletes the specified user
operationId: Deleteusers
parameters:
- name: userId
in: path
description: Appliance ID
required: true
style: simple
schema:
type: string
- name: userName
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/users/{userName}:
get:
summary: Getusers
description: Gets user by username
operationId: Getusers
parameters:
- name: userName
in: path
description: User name
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/UsersGetItem'
deprecated: false
/users/{username}/password:
post:
summary: Postusers1
description: Changes user password
operationId: Postusers1
parameters:
- name: username
in: path
description: user name
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChangePasswordBody'
required: true
responses:
'200':
description: No response was specified
headers: {}
content:
text/plain:
schema:
type: string
description: No response was specified
deprecated: false
/virtualif/loopback/{neId}:
get:
summary: loopbackGet
description: Get loopback interface configuration on the appliance
operationId: loopbackGet
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/loopbackConfig'
deprecated: false
/virtualif/vti/{neId}:
get:
summary: vtiGet
description: Get VTI interface configuration on the appliance
operationId: vtiGet
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/vtiConfig'
deprecated: false
/vrrp/{neId}:
get:
summary: vrrpGet
description: Get a list of VRRP instances configured on the appliance
operationId: vrrpGet
parameters:
- name: neId
in: path
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false)
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VRRP_GET'
description: No response was specified
deprecated: false
/vxoaImages:
get:
summary: VXOAImagesGet
description: the return data contains a list of VXOA image object, an image object contains file name, version and build date time.
operationId: VXOAImagesGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ImageItem'
description: No response was specified
deprecated: false
/vxoaImages/{imageFile}:
delete:
summary: VXOAImagesDelete
description: the last url part is the file name of image to delete
operationId: VXOAImagesDelete
parameters:
- name: imageFile
in: path
description: the file name of VXOA image to delete
required: true
style: simple
schema:
type: string
responses:
'200':
description: No response was specified
headers: {}
content:
text/html:
schema:
type: string
description: No response was specified
deprecated: false
/wccp/config/group/{neId}:
get:
summary: WccpConfigGroup
description: the returned data is an object in which each key is the group Id, each value is an object for the service group settings.
operationId: WccpConfigGroup
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/WccpGroup'
deprecated: false
/wccp/config/system/{neId}:
get:
summary: WccpConfigSystem
description: Get WCCP system settings for the appliance
operationId: WccpConfigSystem
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WccpConfigSystem'
deprecated: false
/wccp/state/{neId}:
get:
summary: WccpState
description: Get WCCP state
operationId: WccpState
parameters:
- name: neId
in: path
description: neId is the device key assigned by Orchestrator, usually look like '0.NE'.
required: true
style: simple
schema:
type: string
- name: cached
in: query
description: Get data from cache (true) or from appliance (false).
required: true
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WccpState'
deprecated: false
/zones:
get:
summary: zonesGet
description: Returns all Zones defined in Orchestrator
operationId: zonesGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Zones'
deprecated: false
post:
summary: zonesPost
description: Add/Edit Zones
operationId: zonesPost
parameters:
- name: deleteDependencies
in: query
description: If true, Zones deleted here will be removed from overlays, policies, interfaces and deployment profiles currently using those zones
required: true
style: form
explode: true
schema:
type: boolean
requestBody:
description: JSON object containing all Zones
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Zones'
- description: JSON object containing all Zones
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
/zones/nextId:
get:
summary: nextIdGet
description: Returns Next Id that should be assigned to a new Zone
operationId: nextIdGet
parameters: []
responses:
'200':
description: No response was specified
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NextId'
deprecated: false
post:
summary: nextIdPost
description: Update Next Id
operationId: nextIdPost
parameters: []
requestBody:
description: JSON object containing Next Id
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NextId'
- description: JSON object containing Next Id
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
deprecated: false
components:
schemas:
AEIOverlaySettings:
title: AEIOverlaySettings
type: object
properties:
ipsecUdpPort:
type: string
description: The port to use when building IPSec UDP tunnels on this appliance
isUserDefinedIPSecUDPPort:
type: boolean
description: Is the port defined by the user or assigned by Orchestrator
AccountKeySummary:
title: AccountKeySummary
required:
- key
type: object
properties:
key:
type: string
ActionLog:
title: ActionLog
required:
- completionStatus
- description
- endTime
- guid
- id
- intTaskStatus
- ipAddress
- name
- nepk
- percentComplete
- queuedTime
- result
- startTime
- taskStatus
- user
type: object
properties:
completionStatus:
type: boolean
description: Show if action succeeded or failed
description:
type: string
description: Description of the action
endTime:
type: number
description: End time of the action in milliseconds since epoch
guid:
type: string
description: GUID of a group of related actions
id:
type: number
description: Id of the log entry
intTaskStatus:
type: number
description: Status of the action in integer enum format
ipAddress:
type: string
description: IP Address who performed this action
name:
type: string
description: Name of the action
nepk:
type: string
description: Primary key of the appliance on which this action was performed
percentComplete:
type: number
description: Percentage completion of the action
queuedTime:
type: number
description: Original queued time of the action in milliseconds since epoch
result:
type: string
description: Opaque blob of data related to action. Typically, this is the result of the action.
startTime:
type: number
description: Start time of the action in milliseconds since epoch
taskStatus:
type: string
description: Status of the action
user:
type: string
description: User who performed this action
ActionObject:
title: ActionObject
type: object
properties:
bind_to_device:
type: string
description: sub action is bind to device (true or false)
bypass:
type: string
description: action is force bypass (true or false)
drop:
type: string
description: action is drop(true or false)
passthrough:
type: string
description: action is passthrough unshaped (true or false)
src_ip_based_routing:
type: string
description: sub action is source ip based routing (true or false)
ActiveApplianceAlarmCounts:
title: ActiveApplianceAlarmCounts
required:
- applianceId
- numOfAlarms
- numOfCriticalAlarms
- numOfMajorAlarms
- numOfMinorAlarms
- numOfWarningAlarms
type: object
properties:
applianceId:
type: string
numOfAlarms:
type: integer
format: int32
numOfCriticalAlarms:
type: integer
format: int32
numOfMajorAlarms:
type: integer
format: int32
numOfMinorAlarms:
type: integer
format: int32
numOfWarningAlarms:
type: integer
format: int32
ActiveFlowCounts:
title: ActiveFlowCounts
required:
-
type: object
properties:
:
$ref: '#/components/schemas/ActiveFlowCountsObject'
ActiveFlowCountsObject:
title: ActiveFlowCountsObject
type: object
properties:
NON_TCP_COUNT:
type: integer
format: int32
TCP_ACCELERATED_COUNT:
type: integer
format: int32
TCP_NOT_ACCELERATED_COUNT:
type: integer
format: int32
TIMESTAMP:
type: integer
format: int32
AddressComponent:
title: AddressComponent
type: object
properties:
long_name:
type: string
short_name:
type: string
types:
type: array
items:
type: string
description: 'Different names for the type of the address component (ex: country, postal_town)'
AdminDistanceConfig:
title: AdminDistanceConfig
type: object
properties:
bgp_br:
type: integer
description: Distance of BGP Branch
format: int32
bgp_pe:
type: integer
description: Distance of BGP PE
format: int32
bgp_tr:
type: integer
description: Distance of BGP Transit
format: int32
local:
type: integer
description: Distance of Local
format: int32
ospf:
type: integer
description: Distance of OSPF
format: int32
sub_shared:
type: integer
description: Distance of Subnet Shared - Static Routes
format: int32
sub_shared_bgp:
type: integer
description: Distance of Subnet Shared - BGP Remote
format: int32
sub_shared_ospf:
type: integer
description: Distance of Subnet Shared - OSPF Remote
format: int32
AdvancedProperties:
title: AdvancedProperties
type: object
properties:
ContentSecurityPolicyHeaderEnabled:
type: boolean
description: Default value is true
MultipleOrchestratorsForOneZscalerAccount:
type: boolean
description: Default value is false
ParallelActionTasks:
type: integer
description: Default value is 50
format: int32
ParallelOrchestrationTasks:
type: integer
description: Default value is 50
format: int32
ParallelReachabilityTasks:
type: integer
description: Default value is 20
format: int32
ParallelStatsTasks:
type: integer
description: Default value is 20
format: int32
bondedTunnelReorderWaitTime:
type: integer
description: Default value is 100
format: int32
bridgeCacheExpireTime:
type: integer
description: Default value is 120
format: int32
dbPoolConnectionTimeout:
type: integer
description: Default value is 30000
format: int32
dbPoolIdleTimeout:
type: integer
description: Default value is 120000
format: int32
dbPoolLeakDetectionThreshold:
type: integer
description: Default value is 300000
format: int32
dbPoolMaxConnectionLifeTime:
type: integer
description: Default value is 300000
format: int32
dbPoolMaxConnections:
type: integer
description: Default value is 1000
format: int32
dbPoolMinimumIdleConnections:
type: integer
description: Default value is 10
format: int32
dbPoolValidationTimeout:
type: integer
description: Default value is 3000
format: int32
denyApplianceOnDelete:
type: boolean
description: Default value is true
emailImagesMaxSize:
type: integer
description: Default value is 10
format: int32
excludeTables:
type: boolean
description: Default value is false
excludedTableNames:
type: string
description: Default value is 'dailyapp,dailydrc,dailydrops,dailydscp,dailyflow,dailyinterface,dailyjitter,dailymemory,dailynxtraffic,dailyshaper,dailytrafficclass,dailytunneltraffic,hourlyapp,hourlydns,hourlydrc,hourlydrops,hourlydscp,hourlyflow,hourlyflowapp,hourlyflowapp2,hourlyinterface,hourlyjitter,hourlylatency,hourlyloss,hourlynxtraffic,hourlyport,hourlyshaper,hourlytoptalkers,hourlytrafficclass,hourlytunneltraffic,minuteapp,minutedrc,minutedrops,minutedscp,minuteflow,minuteinterface,minutejitter,minutenxtraffic,minuteshaper,minutetrafficclass,minutetunneltraffic,neconfig2,hourlyBehavioral,minuteinterfaceoverlay,hourlyinterfaceoverlay,dailyinterfaceoverlay,restrequesttimestats,minutemos,hourlymos,dailymos,minuteboost,hourlyboost,dailyboost,minutesecuritypolicy,hourlysecuritypolicy,dailysecuritypolicy'
failedLoginAttemptThreshold:
type: integer
description: Default value is 5
format: int32
fileOpsChunkSize:
type: integer
description: Default value is 1024 * 1024
format: int32
jettyAcceptQueueSize:
type: integer
description: Default value is 1000
format: int32
jettyIdleTimeout:
type: integer
description: Default value is 60000
format: int32
jettyMaxThreads:
type: integer
description: Default value is 128
format: int32
jettyMinThreads:
type: integer
description: Default value is 10
format: int32
mgmtInterface:
type: string
description: Default value is 'eth0'
modifyTunnelBatchSize:
type: integer
description: Default value is 500
format: int32
newSoftwareReleasesNotification:
type: boolean
description: Default value is true
restRequestStatsCollection:
type: boolean
description: Default value is true
restRequestTimeout:
type: integer
description: Default value is 60
format: int32
sslExcludeCiphers:
type: string
description: Default value is '.*NULL.*,.*RC4.*,.*MD5.*,.*DES.*,.*DSS.*'
sslExcludeProtocols:
type: string
description: Default value is 'SSL,SSLv3,SSLv2,SSLv2Hello,TLSv1,TLSv1.1'
sslIncludeCiphers:
type: string
description: Default value is 'TLS_DHE_RSA.*,TLS_ECDHE.*'
sslIncludeProtocols:
type: string
description: Default value is 'TLSv1.2'
threadPoolSize:
type: integer
description: Default value is 1000
format: int32
AdvancedPropertiesMetaData:
title: AdvancedPropertiesMetaData
type: object
properties:
ContentSecurityPolicyHeaderEnabled:
$ref: '#/components/schemas/MataDataObject'
MultipleOrchestratorsForOneZscalerAccount:
$ref: '#/components/schemas/MataDataObject'
ParallelActionTasks:
$ref: '#/components/schemas/MataDataObject'
ParallelOrchestrationTasks:
$ref: '#/components/schemas/MataDataObject'
ParallelReachabilityTasks:
$ref: '#/components/schemas/MataDataObject'
ParallelStatsTasks:
$ref: '#/components/schemas/MataDataObject'
bondedTunnelReorderWaitTime:
$ref: '#/components/schemas/MataDataObject'
bridgeCacheExpireTime:
$ref: '#/components/schemas/MataDataObject'
dbPoolConnectionTimeout:
$ref: '#/components/schemas/MataDataObject'
dbPoolIdleTimeout:
$ref: '#/components/schemas/MataDataObject'
dbPoolLeakDetectionThreshold:
$ref: '#/components/schemas/MataDataObject'
dbPoolMaxConnectionLifeTime:
$ref: '#/components/schemas/MataDataObject'
dbPoolMaxConnections:
$ref: '#/components/schemas/MataDataObject'
dbPoolMinimumIdleConnections:
$ref: '#/components/schemas/MataDataObject'
dbPoolValidationTimeout:
$ref: '#/components/schemas/MataDataObject'
denyApplianceOnDelete:
$ref: '#/components/schemas/MataDataObject'
emailImagesMaxSize:
$ref: '#/components/schemas/MataDataObject'
excludeTables:
$ref: '#/components/schemas/MataDataObject'
excludedTableNames:
$ref: '#/components/schemas/MataDataObject'
failedLoginAttemptThreshold:
$ref: '#/components/schemas/MataDataObject'
fileOpsChunkSize:
$ref: '#/components/schemas/MataDataObject'
jettyAcceptQueueSize:
$ref: '#/components/schemas/MataDataObject'
jettyIdleTimeout:
$ref: '#/components/schemas/MataDataObject'
jettyMaxThreads:
$ref: '#/components/schemas/MataDataObject'
jettyMinThreads:
$ref: '#/components/schemas/MataDataObject'
mgmtInterface:
$ref: '#/components/schemas/MataDataObject'
modifyTunnelBatchSize:
$ref: '#/components/schemas/MataDataObject'
newSoftwareReleasesNotification:
$ref: '#/components/schemas/MataDataObject'
restRequestStatsCollection:
$ref: '#/components/schemas/MataDataObject'
restRequestTimeout:
$ref: '#/components/schemas/MataDataObject'
sslExcludeCiphers:
$ref: '#/components/schemas/MataDataObject'
sslExcludeProtocols:
$ref: '#/components/schemas/MataDataObject'
sslIncludeCiphers:
$ref: '#/components/schemas/MataDataObject'
sslIncludeProtocols:
$ref: '#/components/schemas/MataDataObject'
threadPoolSize:
$ref: '#/components/schemas/MataDataObject'
AlarmAcknowledgementBody:
title: AlarmAcknowledgementBody
required:
- acknowledge
type: object
properties:
acknowledge:
type: boolean
description: Ack (true), Un-Ack(false)
actions:
type: array
items:
$ref: '#/components/schemas/AlarmAction'
description: ''
AlarmAction:
title: AlarmAction
required:
- id
- sequenceId
- source
type: object
properties:
id:
type: integer
description: Appliance alarm primary id
format: int32
sequenceId:
type: integer
description: Appliance alarm sequence id
format: int32
source:
type: string
description: Appliance alarm source
AlarmClearanceBody:
title: AlarmClearanceBody
type: object
properties:
actions:
type: array
items:
$ref: '#/components/schemas/AlarmAction'
description: ''
AlarmDesc:
title: AlarmDesc
type: object
properties:
alarmType:
type: integer
description: Uniquely identifies the type of alarm within a sourceType
format: int32
description:
type: string
description: Alarm description
name:
type: string
description: Alarm name
recommendedAction:
type: string
description: recommended action
serviceAffecting:
type: boolean
description: Is alarm service affecting
severity:
type: string
description: Alarm severity info
source:
type: string
description: Module/system that generates alarm
sourceType:
type: integer
description: Identifies the category of alarm. 1 = Tunnel,2 = Traffic Class, 3 = Equipment, 4 = Software, 5 = Threshold
format: int32
systemType:
type: integer
description: Identifies which system generated the alaram.0 = Appliance,100 = Orchestartor
format: int32
typeId:
type: integer
description: Alarm type id
format: int32
AlarmGetSummary:
title: AlarmGetSummary
required:
- num_critical
- num_equipment_outstanding
- num_major
- num_minor
- num_outstanding
- num_software_outstanding
- num_tca_outstanding
- num_traffic_class_outstanding
- num_tunnel_outstanding
- num_warning
type: object
properties:
num_critical:
type: integer
format: int32
num_equipment_outstanding:
type: integer
format: int32
num_major:
type: integer
format: int32
num_minor:
type: integer
format: int32
num_outstanding:
type: integer
format: int32
num_software_outstanding:
type: integer
format: int32
num_tca_outstanding:
type: integer
format: int32
num_traffic_class_outstanding:
type: integer
format: int32
num_tunnel_outstanding:
type: integer
format: int32
num_warning:
type: integer
format: int32
AlarmItem:
title: AlarmItem
required:
- acknowledged
- clearable
- description
- name
- occurrenceCount
- recommendation
- sequenceId
- serviceAffect
- severity
- source
- time
- type
- typeId
type: object
properties:
acknowledged:
type: boolean
clearable:
type: boolean
description:
type: string
name:
type: string
occurrenceCount:
type: integer
format: int32
recommendation:
type: string
sequenceId:
type: integer
format: int32
serviceAffect:
type: boolean
severity:
type: integer
format: int32
source:
type: string
time:
type: integer
format: int32
type:
type: string
typeId:
type: integer
format: int32
AlarmNotification:
title: AlarmNotification
type: object
properties:
enable:
type: boolean
AlarmPeriodSummary:
title: AlarmPeriodSummary
required:
- alarmCountsInPeriod
- critical
- major
- minor
- warning
type: object
properties:
alarmCountsInPeriod:
$ref: '#/components/schemas/CountSummary'
critical:
$ref: '#/components/schemas/AlarmPeriodSummaryItem'
major:
$ref: '#/components/schemas/AlarmPeriodSummaryItem'
minor:
$ref: '#/components/schemas/AlarmPeriodSummaryItem'
warning:
$ref: '#/components/schemas/AlarmPeriodSummaryItem'
AlarmPeriodSummaryItem:
title: AlarmPeriodSummaryItem
required:
- description
- sequenceId
- time
type: object
properties:
description:
type: string
description: Alarm description
sequenceId:
type: integer
description: Alarm sequence id
format: int32
time:
type: integer
description: Time alarm occurred
format: int32
AlarmSummary:
title: AlarmSummary
required:
- numOfCriticalAlarms
- numOfMajorAlarms
- numOfMinorAlarms
- numOfWarningAlarms
type: object
properties:
numOfCriticalAlarms:
type: integer
format: int32
numOfMajorAlarms:
type: integer
format: int32
numOfMinorAlarms:
type: integer
format: int32
numOfWarningAlarms:
type: integer
format: int32
AllDiscoveredAppliance:
title: AllDiscoveredAppliance
type: object
properties:
applianceInfo:
$ref: '#/components/schemas/applianceInfoObj'
approved:
type: boolean
description: Boolean flag that indicates if appliance is approved, 0 = not approve, 1 = approved
approvedTime:
type: integer
description: Time appliance got approved
format: int32
denied:
type: boolean
description: Boolean flag that indicates if appliance is denied, 0 = not denied, 1 = denied
deniedTime:
type: integer
description: Time appliance got denied
format: int32
discoveredFrom:
type: integer
description: Describe the each enum value and what is means in 1 sentence
format: int32
discoveredTime:
type: integer
description: Time appliance got discovered
format: int32
dynamicUuid:
type: string
id:
type: integer
format: int32
portalObjectId:
type: string
userId:
type: string
description: User who approved or denied it
uuid:
type: string
AllStates:
title: AllStates
type: object
properties:
:
$ref: '#/components/schemas/TunnelState'
AllWanLabelSettings:
title: AllWanLabelSettings
type: object
properties:
:
$ref: '#/components/schemas/WanLabelSettings'
AppSystemDeployInfo:
title: AppSystemDeployInfo
type: object
properties:
auto_ipid:
type: boolean
description: Enable auto IP ID
auto_pol_lookup_intvl:
type: integer
description: Auto policy lookup interval
format: int32
auto_subnet:
$ref: '#/components/schemas/auto_subnet'
auto_syn:
type: boolean
description: Enable auto SYN
auto_tunnel:
type: boolean
description: Enable auto tunnel
bridge_loop_test:
type: boolean
description: Bridge loop test
bw:
allOf:
- $ref: '#/components/schemas/bw'
- description: System bandwidth
disk_encrypt_enable:
type: boolean
description: Enable disk encryption
dpc:
allOf:
- $ref: '#/components/schemas/dpc'
- description: DPC
excess_flow:
allOf:
- $ref: '#/components/schemas/excess_flow'
- description: Excess flow
ha_if:
type: string
description: High availability interface
idrc:
$ref: '#/components/schemas/idrc'
igmp_snooping:
type: boolean
description: Bridge multicast IGMP snooping
int_hairpin:
type: boolean
description: Enable internal hairpinning
ipsec_override:
type: boolean
description: SSL IPSec override
max_tcp_mss:
type: integer
description: Maximum TCP MSS range from 500 to 9000
format: int32
nat:
type: boolean
description: Enable NAT
network_role:
type: integer
description: Network role
format: int32
nm_fsp_enable:
type: boolean
description: Enable network memory FSP
nm_media:
type: integer
description: System network memory media
format: int32
nm_mode:
type: integer
description: System network memory mode
format: int32
node_dns:
$ref: '#/components/schemas/dns'
options:
type: integer
description: Tunnel system level options for future
format: int32
orch_guid:
type: string
description: Orchestrator GUID
passthru_to_sender:
type: boolean
description: Disable passthrough L2 return to sender
port_fwd_rules:
type: string
description: Inbound port forwarding rules
quies_tun_ka_intvl:
type: integer
description: Quiescent-tunnel keep alive time range from 1 to 65535
format: int32
serverMode:
$ref: '#/components/schemas/serverMode'
shaperinbound:
$ref: '#/components/schemas/shaperInbound'
smb_signing:
type: boolean
description: SMB signing optimization
udp_inact_time:
type: integer
description: UDP flow timeout in seconds range from 1 to 65535
format: int32
udp_ipsec_lcl_ports:
type: string
description: List of ports used locally for UDP IPSec tunnels
udp_ipsec_peer_ports:
type: string
description: List of ports used by peers for UDP IPSec tunnels
AppSystemStateInfo:
title: AppSystemStateInfo
required:
- applianceid
- biosVersion
- datetime
- deploymentMode
- gmtOffset
- hasUnsavedChanges
- hostName
- isLicenseInstalled
- licenseExpirationDaysLeft
- licenseExpiryDate
- licenseRequired
- model
- modelShort
- rebootRequired
- release
- releaseWithoutPrefix
- serial
- status
- timezone
- uptime
- uptimeString
- uuid
type: object
properties:
alarmSummary:
allOf:
- $ref: '#/components/schemas/alarmSummary1'
- description: Need description here
applianceid:
type: integer
description: Need description here
format: int32
biosVersion:
type: string
description: Need description here
datetime:
type: string
description: Need description here
deploymentMode:
type: string
description: Need description here
gmtOffset:
type: integer
description: Need description here
format: int32
hasUnsavedChanges:
type: boolean
description: Need description here
hostName:
type: string
description: Need description here
isLicenseInstalled:
type: boolean
description: Need description here
licenseExpirationDaysLeft:
type: integer
description: Need description here
format: int32
licenseExpiryDate:
type: integer
description: Need description here
format: int32
licenseRequired:
type: boolean
description: Need description here
model:
type: string
description: Need description here
modelShort:
type: string
description: Need description here
rebootRequired:
type: boolean
description: Need description here
release:
type: string
description: Need description here
releaseWithoutPrefix:
type: string
description: Need description here
serial:
type: string
description: Need description here
status:
type: string
description: Need description here
timezone:
type: string
description: Need description here
uptime:
type: integer
description: Need description here
format: int32
uptimeString:
type: string
description: Need description here
uuid:
type: string
description: Need description here
ApplianceAggregateStats:
title: ApplianceAggregateStats
required:
-
type: object
properties:
:
$ref: '#/components/schemas/ApplianceAggregateStatsApplianceLevelObject'
ApplianceAggregateStatsApplianceLevelObject:
title: ApplianceAggregateStatsApplianceLevelObject
required:
-
type: object
properties:
:
$ref: '#/components/schemas/TunnelAggregateStatsBase'
ApplianceAggregateStatsBase:
title: ApplianceAggregateStatsBase
required:
- AVG_BW_PCT_UTIL_AVG
- AVG_LATENCY_AVG
- HOSTNAME
- IP
- LATENCY_MIN_FROM_PEAK
- MAX_BW_PCT_UTIL_MAX
- MAX_COMP_L2W
- MAX_COMP_L2WMAX
- MAX_COMP_NOOHEAD_L2W
- MAX_COMP_NOOHEAD_L2WMAX
- MAX_COMP_NOOHEAD_W2L
- MAX_COMP_NOOHEAD_W2LMAX
- MAX_COMP_W2L
- MAX_COMP_W2LMAX
- MAX_CREATED_MAX
- MAX_DELETED_MAX
- MAX_LATENCY_MAX
- MAX_LRX_BYTES_MAX
- MAX_LRX_PKTS_MAX
- MAX_LTX_BYTES_MAX
- MAX_LTX_PKTS_MAX
- MAX_NON_TCP_FLOWS_MAX
- MAX_OHEAD_WRX_BYTES_MAX
- MAX_OHEAD_WRX_HDR_BYTES_MAX
- MAX_OHEAD_WRX_PKTS_MAX
- MAX_OHEAD_WTX_BYTES_MAX
- MAX_OHEAD_WTX_HDR_BYTES_MAX
- MAX_OHEAD_WTX_PKTS_MAX
- MAX_POST_LOSS_MAX
- MAX_POST_PCT_LOSS
- MAX_POST_PCT_LOSS_MAX
- MAX_POST_POCMAX
- MAX_PRE_LOSS_MAX
- MAX_PRE_PCT_LOSS
- MAX_PRE_PCT_LOSS_MAX
- MAX_PRE_PCT_POC
- MAX_PRE_PCT_POCMAX
- MAX_PRE_POCMAX
- MAX_TCP_ACC_FLOWS_MAX
- MAX_TCP_FLOWS_MAX
- MAX_TIMESTAMP
- MAX_WRX_BYTES_MAX
- MAX_WRX_PKTS_MAX
- MAX_WTX_BYTES_MAX
- MAX_WTX_PKTS_MAX
- MIN_LATENCY_MIN
- MIN_TIMESTAMP
- POST_PCT_POCMAX
- SUM_CREATED
- SUM_DELETED
- SUM_LRX_BYTES
- SUM_LRX_PKTS
- SUM_LTX_BYTES
- SUM_LTX_PKTS
- SUM_NON_TCP_FLOWS
- SUM_OHEAD_WRX_BYTES
- SUM_OHEAD_WRX_HDR_BYTES
- SUM_OHEAD_WRX_PKTS
- SUM_OHEAD_WTX_BYTES
- SUM_OHEAD_WTX_HDR_BYTES
- SUM_OHEAD_WTX_PKTS
- SUM_POST_LOSS
- SUM_POST_PCT_POC
- SUM_POST_POC
- SUM_PRE_LOSS
- SUM_PRE_POC
- SUM_TCP_ACC_FLOWS
- SUM_TCP_FLOWS
- SUM_WRX_BYTES
- SUM_WRX_PKTS
- SUM_WTX_BYTES
- SUM_WTX_PKTS
- nePk
type: object
properties:
AVG_BW_PCT_UTIL_AVG:
type: integer
description: Integer value of average bandwidth utilization percentage
format: int32
AVG_LATENCY_AVG:
type: integer
description: Integer value of average latency, unit is millisecond
format: int32
HOSTNAME:
type: string
description: Hostname of the appliance
IP:
type: string
description: Management IP address of appliance
LATENCY_MIN_FROM_PEAK:
type: integer
description: Integer value of the second peak latency
format: int32
MAX_BW_PCT_UTIL_MAX:
type: integer
description: Integer value of maximum peak bandwidth utilization percentage
format: int32
MAX_COMP_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate
format: int32
MAX_COMP_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate
format: int32
MAX_COMP_NOOHEAD_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate without overhead
format: int32
MAX_COMP_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate
format: int32
MAX_COMP_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate
format: int32
MAX_CREATED_MAX:
type: integer
description: Integer value of maximum peak number of created flows
format: int32
MAX_DELETED_MAX:
type: integer
description: Integer value of maximum peak number of deleted flows
format: int32
MAX_LATENCY_MAX:
type: integer
description: Integer value of maximum highest latency, unit is millisecond
format: int32
MAX_LRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side received
format: int32
MAX_LRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side received
format: int32
MAX_LTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side transmitted
format: int32
MAX_LTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side transmitted
format: int32
MAX_NON_TCP_FLOWS_MAX:
type: integer
description: Integer value of maximum peak number of TCP flows
format: int32
MAX_OHEAD_WRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of bytes WAN side received with overhead
format: int32
MAX_OHEAD_WRX_HDR_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of header bytes WAN side received with overhead
format: int32
MAX_OHEAD_WRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of packets WAN side received with overhead
format: int32
MAX_OHEAD_WTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of bytes WAN side transmitted with overhead
format: int32
MAX_OHEAD_WTX_HDR_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of header bytes WAN side transmitted with overhead
format: int32
MAX_OHEAD_WTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of packets WAN side transmitted with overhead
format: int32
MAX_POST_LOSS_MAX:
type: integer
description: Integer value of maximum peak post-corrected packets loss
format: int32
MAX_POST_PCT_LOSS:
type: integer
description: Integer value of maximum post-corrected packets loss percentage
format: int32
MAX_POST_PCT_LOSS_MAX:
type: integer
description: Integer value of maximum peak post-corrected packets loss
format: int32
MAX_POST_POCMAX:
type: integer
description: Integer value of maximum peak post-POC packets loss
format: int32
MAX_PRE_LOSS_MAX:
type: integer
description: Integer value of maximum peak pre-corrected packets loss
format: int32
MAX_PRE_PCT_LOSS:
type: integer
description: Integer value of maximum pre-corrected packets loss percentage
format: int32
MAX_PRE_PCT_LOSS_MAX:
type: integer
description: Integer value of maximum peak pre-corrected packets loss
format: int32
MAX_PRE_PCT_POC:
type: integer
description: Integer value of maximum pre-POC packets loss percentage
format: int32
MAX_PRE_PCT_POCMAX:
type: integer
description: Integer value of maximum peak pre-POC packets loss percentage
format: int32
MAX_PRE_POCMAX:
type: integer
description: Integer value of maximum peak pre-POC packets loss
format: int32
MAX_TCP_ACC_FLOWS_MAX:
type: integer
description: Integer value of maximum peak number of TCP flows
format: int32
MAX_TCP_FLOWS_MAX:
type: integer
description: Integer value of maximum peak number of TCP flows
format: int32
MAX_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual starting boundary of data time range
format: int32
MAX_WRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side received
format: int32
MAX_WRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side received
format: int32
MAX_WTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side transmitted
format: int32
MAX_WTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side transmitted
format: int32
MIN_LATENCY_MIN:
type: integer
description: Integer value of minimum lowest latency, unit is millisecond
format: int32
MIN_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual ending boundary of data time range
format: int32
POST_PCT_POCMAX:
type: integer
description: Integer value of maximum peak post-POC packets loss percentage
format: int32
SUM_CREATED:
type: integer
description: Integer value of total number of created flows
format: int32
SUM_DELETED:
type: integer
description: Integer value of total number of deleted flows
format: int32
SUM_LRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side received
format: int32
SUM_LRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_LTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side transmitted
format: int32
SUM_LTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_NON_TCP_FLOWS:
type: integer
description: Integer value of total number of non-TCP flows
format: int32
SUM_OHEAD_WRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side received with overhead
format: int32
SUM_OHEAD_WRX_HDR_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of header bytes WAN side received with overhead
format: int32
SUM_OHEAD_WRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side received with overhead
format: int32
SUM_OHEAD_WTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side transmitted with overhead
format: int32
SUM_OHEAD_WTX_HDR_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of header bytes WAN side transmitted with overhead
format: int32
SUM_OHEAD_WTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side transmitted with overhead
format: int32
SUM_POST_LOSS:
type: integer
description: Integer value of total number of post-corrected packets loss
format: int32
SUM_POST_PCT_POC:
type: integer
description: Integer value of maximum post-POC packets loss percentage
format: int32
SUM_POST_POC:
type: integer
description: Integer value of total number of post-POC packets loss
format: int32
SUM_PRE_LOSS:
type: integer
description: Integer value of total number of pre-corrected packets loss
format: int32
SUM_PRE_POC:
type: integer
description: Integer value of total number of pre-POC packets loss
format: int32
SUM_TCP_ACC_FLOWS:
type: integer
description: Integer value of total number of TCP accelerated flows
format: int32
SUM_TCP_FLOWS:
type: integer
description: Integer value of total number of TCP flows
format: int32
SUM_WRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side received
format: int32
SUM_WRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side received
format: int32
SUM_WTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side transmitted
format: int32
SUM_WTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side transmitted
format: int32
nePk:
type: string
description: Internal ID of appliance
ApplianceAlarmGetPostBody:
title: ApplianceAlarmGetPostBody
required:
- ids
type: object
properties:
ids:
type: array
items:
type: string
description: Contains appliance IDs
ApplianceAlarmItem:
title: ApplianceAlarmItem
required:
- acknowledged
- applianceId
- clearable
- clearedTimeInMills
- closed
- description
- hostName
- name
- occurrenceCount
- recommendedAction
- sequenceId
- serviceAffect
- severity
- source
- timeOccurredInMills
- type
- typeId
type: object
properties:
acknowledged:
type: boolean
applianceId:
type: string
clearable:
type: boolean
clearedTimeInMills:
type: integer
format: int32
closed:
type: boolean
description:
type: string
hostName:
type: string
name:
type: string
occurrenceCount:
type: integer
format: int32
recommendedAction:
type: string
sequenceId:
type: integer
format: int32
serviceAffect:
type: boolean
severity:
type: string
source:
type: string
timeOccurredInMills:
type: integer
format: int32
type:
type: string
typeId:
type: integer
format: int32
ApplianceAssociationGet:
title: ApplianceAssociationGet
type: object
properties:
nepk:
type: array
items:
type: string
description: Names of the template groups associated with this appliance
description: Map of appliance IDs to template group names associated with them
ApplianceAssociationGetNepk:
title: ApplianceAssociationGetNepk
type: object
properties:
templateIds:
type: array
items:
type: string
description: Names of the template groups associated with this appliance
description: Map of appliance IDs to template group names associated with them
ApplianceChangePasswordPost:
title: ApplianceChangePasswordPost
type: object
properties:
password:
type: string
description: The 'admin' user password for the appliance
ApplianceExtraInfo:
title: ApplianceExtraInfo
type: object
properties:
contact:
$ref: '#/components/schemas/Contact'
location:
$ref: '#/components/schemas/Location'
overlaySettings:
$ref: '#/components/schemas/AEIOverlaySettings'
ApplianceFileInfo:
title: ApplianceFileInfo
type: object
properties:
fileNames:
type: array
items:
type: string
description: The name of the files
group:
type: string
description: The group of the file
ApplianceFiles:
title: ApplianceFiles
type: object
properties:
files:
type: array
items:
$ref: '#/components/schemas/ApplianceFileInfo'
description: ''
nePk:
type: string
description: nePk is the device key assigned by Orchestrator, usually look like '0.NE'.
ApplianceIDs:
title: ApplianceIDs
type: object
properties:
ids:
type: array
items:
type: string
description: ''
ApplianceIds1:
title: ApplianceIds1
required:
- ids
type: object
properties:
ids:
type: array
items:
type: string
description: 'Array of appliance primary keys. Eg: Appliance primary key looks like "1.NE"'
ApplianceItem:
title: ApplianceItem
required:
- IP
- applianceId
- bypass
- discoveredFrom
- dynamicUuid
- groupId
- hardwareRevision
- hasUnsavedChanges
- hostName
- id
- latitude
- longitude
- mode
- model
- nePk
- networkRole
- password
- portalObjectId
- reachabilityChannel
- rebootRequired
- serial
- site
- sitePriority
- softwareVersion
- startupTime
- state
- systemBandwidth
- userName
- uuid
- webProtocol
- webProtocolType
type: object
properties:
IP:
type: string
description: IP Address of the appliance
applianceId:
type: integer
description: This is yet another identifier of the appliance. But it is mainly used by the appliance to identify its peer
format: int32
bypass:
type: boolean
description: If true, appliance is currently in bypass
discoveredFrom:
type: integer
description: How the appliance was added to Orchestrator. 1 = MANUAL, 2 = PORTAL, 3 = APPLIANCE.
format: int32
dynamicUuid:
type: string
description: Need description here.
groupId:
type: string
description: Primary key identifier of the Orchestrator group the appliance belongs to
hardwareRevision:
type: string
description: 'Hardware revision of the appliance. Eg: 200193-004 Rev A'
hasUnsavedChanges:
type: boolean
description: If true, there are unsaved changes on the appliance.
hostName:
type: string
description: Appliance hostname
id:
type: string
description: This is the primary key of the appliance. Every appliance managed by Orchestrator is given a primary key and it uniquely identifies an appliance among all appliances managed by Orchestrator
latitude:
type: number
description: The latitude of the coordinates of the appliance's address
longitude:
type: number
description: The longitude of the coordinates of the appliance's address
mode:
type: string
description: Deployment mode the appliance is configured in
model:
type: string
description: 'Appliance model. Eg: NX-2610'
nePk:
type: string
description: Same as ID field
networkRole:
type: string
description: The network role the appliance is configured in Orchestrator. spoke = 0, hub = 1, mesh= 2
password:
type: string
description: Password used to login to appliance. They are not returned for security reasons
portalObjectId:
type: string
description: Need description here
reachabilityChannel:
type: number
description: Reachability channel of the appliance. 0 - Unknown, 1 - Orchestrator talks to appliance using HTTP/HTTPS using user id and password. This is not used for EdgeConnects and SD-WAN, 2 - Appliance connects to Orchestrator using HTTPS Websocket. Orchestrator uses this permanent connection to configure/monitor appliance. This is done because Appliance may be behind a firewall making it hard for Orchestrator to contact appliance using IP address, 4 - Orchestrator sends configuration/monitoring request to Silver Peak Cloud Portal which relays those requests to Appliance. Appliance sends its response to Cloud Portal which relays it back to Orchestrator.
rebootRequired:
type: boolean
description: If true, the appliance requires a reboot
serial:
type: string
description: Serial number of the appliance
site:
type: string
description: An identifier used to tag an appliance with a site name
sitePriority:
type: integer
description: Priority given to the appliance with the site it belongs to
format: int32
softwareVersion:
type: string
description: Software version running on the appliance
startupTime:
type: integer
description: Need description here.
format: int32
state:
type: integer
description: State of the appliance. 0 - Unknown ( When an appliance is added to Orchestrator, it is in this state ), 1 - Normal ( Appliance is reachable from Orchestrator), 2 - Unreachable ( Appliance is unreachable from Orchestrator ), 3 - Unsupported Version ( Orchestrator does not support this version of the appliance ), 4 - Out of Synchronization ( Orchestrator's cache of appliance configuration/state is out of sync with the configuration/state on the appliance ), 5 - Synchronization in Progress ( Orchestrator is currently synchronizing appliances's configuration and state )
format: int32
systemBandwidth:
type: integer
description: Appliance system bandwidth
format: int32
userName:
type: string
description: User name used to login to appliance
uuid:
type: string
description: This is also an unique identifier. But it is generated and self assigned by the appliance itself.
webProtocol:
type: string
description: String version of the protocol field. Possible values are BOTH, HTTP, HTTPS
webProtocolType:
type: integer
description: Protocol used by Orchestrator to talk to appliance. Http = 1, Https = 2, Both = 3
format: int32
ApplianceNewData:
title: ApplianceNewData
required:
- IP
type: object
properties:
IP:
type: string
description: the IP address of the appliance
groupId:
type: string
description: Orchestrator Group primary key into which this appliance will be added
latitude:
type: number
description: Optional - the latitude of the coordinates of the appliance's address
longitude:
type: object
description: Optional - the longitude of the coordinates of the appliance's address
networkRole:
type: string
description: the network role the appliance is configured in Orchestrator. Choose 0 for spoke , 1 for hub, 2 for mesh
password:
type: string
description: the password for logging into this appliance
userName:
type: string
description: the username for logging into this appliance
webProtocolType:
type: integer
description: protocol used by Orchestrator to talk to appliance. Choose 1 for Http, 2 for Https and 3 both Both
format: int32
AppliancePostData:
title: AppliancePostData
required:
- IP
- networkRole
- password
- userName
- webProtocolType
type: object
properties:
IP:
type: string
description: the IP address of this appliance
networkRole:
type: string
description: the network role the appliance is configured in Orchestrator. spoke = 0, hub = 1, mesh= 2
password:
type: string
description: the password for logging on to this appliance
userName:
type: string
description: the username for logging on to this appliance
webProtocolType:
type: integer
description: protocol used by Orchestrator to talk to appliance. Http = 1, Https = 2, Both = 3
format: int32
ApplianceProcessState:
title: ApplianceProcessState
type: object
properties:
processstate:
$ref: '#/components/schemas/ApplianceProcessStateDetail'
timestamp:
type: integer
format: int32
ApplianceProcessStateDetail:
title: ApplianceProcessStateDetail
type: object
properties:
cifsproxyd:
$ref: '#/components/schemas/ApplianceProcessStateMemoryDetail'
jsond:
$ref: '#/components/schemas/ApplianceProcessStateMemoryDetail'
mgmtd:
$ref: '#/components/schemas/ApplianceProcessStateMemoryDetail'
netflowd:
$ref: '#/components/schemas/ApplianceProcessStateMemoryDetail'
node:
$ref: '#/components/schemas/ApplianceProcessStateMemoryDetail'
pm:
$ref: '#/components/schemas/ApplianceProcessStateMemoryDetail'
snmpd:
$ref: '#/components/schemas/ApplianceProcessStateMemoryDetail'
sslpd:
$ref: '#/components/schemas/ApplianceProcessStateMemoryDetail'
statsd2:
$ref: '#/components/schemas/ApplianceProcessStateMemoryDetail'
sysd:
$ref: '#/components/schemas/ApplianceProcessStateMemoryDetail'
tunneld:
$ref: '#/components/schemas/ApplianceProcessStateMemoryDetail'
ApplianceProcessStateMemoryDetail:
title: ApplianceProcessStateMemoryDetail
type: object
properties:
VmPeak:
type: integer
format: int32
VmRSS:
type: integer
format: int32
VmSize:
type: integer
format: int32
ApplianceStatus:
title: ApplianceStatus
required:
- https
- rest
- ssh
- webSocket
type: object
properties:
https:
type: string
description: The status of the HTTPs
rest:
type: string
description: The status of the REST
ssh:
type: string
description: The status of the SSH
webSocket:
type: string
description: The status of the WebSocket
ApplianceToApplianceTunnel:
title: ApplianceToApplianceTunnel
required:
- destMgmtIp
- destName
- destNeId
- fecRatio
- fecState
- lastUpdatedTime
- localIp
- name
- operState
- remoteIp
- srcMgmtIp
- srcNeId
type: object
properties:
destMgmtIp:
type: string
description: the destination node's management ip address
destName:
type: string
description: the name of the tunnel from the destination node to source node
destNeId:
type: string
description: the destination node's id number in Orchestrator
fecRatio:
type: integer
description: the forward error correction ratio of this tunnel
format: int32
fecState:
type: string
description: the forward error correction state of this tunnel
lastUpdatedTime:
type: integer
description: the time in milliseconds when this tunnel was updated
format: int32
localIp:
type: string
description: the local port ip address of this tunnel
name:
type: string
description: the name of the tunnel from the source node to destination node
operState:
type: string
description: the state of the tunnel
remoteIp:
type: string
description: the remote port ip address of this tunnel
srcMgmtIp:
type: string
description: the source node's management ip address
srcNeId:
type: string
description: the source node's id number
ApplianceTunnels:
title: ApplianceTunnels
required:
-
type: object
properties:
:
type: array
items:
$ref: '#/components/schemas/ApplianceToApplianceTunnel'
description: the tunnels between this appliance and its parent appliance
ApplianceUpgradeEntry:
title: ApplianceUpgradeEntry
required:
- imageName
- installOption
- neList
- version
type: object
properties:
imageName:
type: string
description: The image name that will use to upgrade for the appliances.
installOption:
type: string
description: 'The install option. It include: install_only, install_switch and install_reboot.'
neList:
type: array
items:
type: string
description: The nePk id of appliance.
version:
type: string
description: Version of software to upgrade to
ApplianceUploadToSpPost:
title: ApplianceUploadToSpPost
type: object
properties:
appliances:
type: array
items:
$ref: '#/components/schemas/ApplianceFiles'
description: ''
options:
$ref: '#/components/schemas/Options'
AppliancesSoftwareVersions:
title: AppliancesSoftwareVersions
type: object
properties:
xyz:
type: array
items:
$ref: '#/components/schemas/PartitionSoftwareVersionInfo'
description: ''
Application2AggregateStats:
title: Application2AggregateStats
required:
- APPNAME
- HOSTNAME
- MAX_TIMESTAMP
- MIN_TIMESTAMP
- SUM_LRX_BYTES
- SUM_LRX_PKTS
- SUM_LTX_BYTES
- SUM_LTX_PKTS
- SUM_WRX_BYTES
- SUM_WRX_PKTS
- SUM_WTX_BYTES
- SUM_WTX_PKTS
- nePk
type: object
properties:
APPNAME:
type: string
description: String value of application name to which these stats belong to
HOSTNAME:
type: string
description: Hostname of the appliance
MAX_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual starting boundary of data time range
format: int32
MIN_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual ending boundary of data time range
format: int32
SUM_LRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side received
format: int32
SUM_LRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_LTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side transmitted
format: int32
SUM_LTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_WRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side received
format: int32
SUM_WRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side received
format: int32
SUM_WTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side transmitted
format: int32
SUM_WTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side transmitted
format: int32
nePk:
type: string
description: Internal ID of appliance
ApplicationAggregateStats:
title: ApplicationAggregateStats
required:
-
type: object
properties:
:
$ref: '#/components/schemas/ApplicationAggregateStatsAppLevelObject'
ApplicationAggregateStatsAppLevelObject:
title: ApplicationAggregateStatsAppLevelObject
required:
-
type: object
properties:
:
$ref: '#/components/schemas/ApplicationAggregateStatsApplianceLevelObject'
ApplicationAggregateStatsApplianceLevelObject:
title: ApplicationAggregateStatsApplianceLevelObject
required:
-
type: object
properties:
:
$ref: '#/components/schemas/ApplicationAggregateStatsBase'
ApplicationAggregateStatsBase:
title: ApplicationAggregateStatsBase
required:
- APPNAME
- HOSTNAME
- IP
- MAX_COMP_L2W
- MAX_COMP_L2WMAX
- MAX_COMP_NOOHEAD_L2W
- MAX_COMP_NOOHEAD_L2WMAX
- MAX_COMP_NOOHEAD_W2L
- MAX_COMP_NOOHEAD_W2LMAX
- MAX_COMP_W2L
- MAX_COMP_W2LMAX
- MAX_LRX_BYTES_MAX
- MAX_LRX_PKTS_MAX
- MAX_LTX_BYTES_MAX
- MAX_LTX_PKTS_MAX
- MAX_TIMESTAMP
- MAX_WRX_BYTES_MAX
- MAX_WRX_PKTS_MAX
- MAX_WTX_BYTES_MAX
- MAX_WTX_PKTS_MAX
- MIN_TIMESTAMP
- SUM_LRX_BYTES
- SUM_LRX_PKTS
- SUM_LTX_BYTES
- SUM_LTX_PKTS
- SUM_WRX_BYTES
- SUM_WRX_PKTS
- SUM_WTX_BYTES
- SUM_WTX_PKTS
- TRAFFIC_TYPE
- nePk
type: object
properties:
APPNAME:
type: string
description: String value of application name to which these stats belong to
HOSTNAME:
type: string
description: Hostname of the appliance
IP:
type: string
description: Management IP address of appliance
MAX_COMP_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate
format: int32
MAX_COMP_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate
format: int32
MAX_COMP_NOOHEAD_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate without overhead
format: int32
MAX_COMP_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate
format: int32
MAX_COMP_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate
format: int32
MAX_LRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side received
format: int32
MAX_LRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side received
format: int32
MAX_LTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side transmitted
format: int32
MAX_LTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side transmitted
format: int32
MAX_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual starting boundary of data time range
format: int32
MAX_WRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side received
format: int32
MAX_WRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side received
format: int32
MAX_WTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side transmitted
format: int32
MAX_WTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side transmitted
format: int32
MIN_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual ending boundary of data time range
format: int32
SUM_LRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side received
format: int32
SUM_LRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_LTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side transmitted
format: int32
SUM_LTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_WRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side received
format: int32
SUM_WRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side received
format: int32
SUM_WTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side transmitted
format: int32
SUM_WTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side transmitted
format: int32
TRAFFIC_TYPE:
type: integer
description: 'Integer value indicating the traffic type these stats belong to. 1: Optimized Traffic, 2: Pass-through Shaped, 3: Pass-through Unshaped, 4: All Traffic'
format: int32
nePk:
type: string
description: Internal ID of appliance
ApplicationTrendsGet:
title: ApplicationTrendsGet
required:
- applicationStatsOfAppliances
type: object
properties:
applicationStatsOfAppliances:
$ref: '#/components/schemas/StatsOfAppliances'
ApplicationTrendsItem:
title: ApplicationTrendsItem
required:
- bytes
- milliseconds
- nePKId
- totalInboundOutbound
type: object
properties:
app:
$ref: '#/components/schemas/appObject'
bytes:
type: integer
description: inbound or outbound bytes depending on the query parameter
format: int32
milliseconds:
type: integer
description: the time(in milliseconds) of stats for this application at this time(minute, hour, day)
format: int32
nePKId:
type: string
description: appliance ID
totalInboundOutbound:
type: integer
description: total inbound and outbound traffic in bytes
format: int32
vxoa:
$ref: '#/components/schemas/vxoaObject'
ApplyRmaWizard:
title: ApplyRmaWizard
type: object
properties:
backup:
$ref: '#/components/schemas/BackupGetResponse'
discoveredAppliance:
$ref: '#/components/schemas/AllDiscoveredAppliance'
existingAppliance:
$ref: '#/components/schemas/ApplianceItem'
selectedImage:
$ref: '#/components/schemas/ImageItem'
ApplyWizardGet:
title: ApplyWizardGet
type: object
properties:
actionGroupId:
type: string
description: The handle to poll status with using /action/status?key={actionGroupId}
ApplyWizardPost:
title: ApplyWizardPost
type: object
properties:
wizardData:
$ref: '#/components/schemas/WizardData'
Auth:
title: Auth
required:
- aaa
- radius
- tacacs
type: object
properties:
aaa:
allOf:
- $ref: '#/components/schemas/aaaConfig'
- description: Details of default user and order of authorization
radius:
$ref: '#/components/schemas/RADIUSConfig'
tacacs:
$ref: '#/components/schemas/TACACSConfig'
AuthConfigElement:
title: AuthConfigElement
required:
- name
- self
type: object
properties:
name:
type: string
description: Authentication method
self:
type: integer
description: Order of Authentication method
format: int32
AuthConfigMap:
title: AuthConfigMap
required:
-
type: object
properties:
:
$ref: '#/components/schemas/AuthConfigElement'
description: You can add a maximum of three Authentication Methods.
AuthorConfigElement:
title: AuthorConfigElement
required:
- default-user
- map-order
type: object
properties:
default-user:
type: string
description: default-user to be used for authorization
map-order:
type: string
description: map-order to be used for authorization
AutoLog:
title: AutoLog
required:
- isTimeout
type: object
properties:
isTimeout:
type: string
description: IF need port the waring logout dialog
AutoSubnet1:
title: AutoSubnet1
type: object
properties:
add_local:
type: boolean
description: 'Flag to control Automatically Advertising local subnets.
Note: This field is only applicable for older appliances whose version is less than 8.1.4.'
add_local_lan:
type: boolean
description: 'flag to control Automatically advertise local LAN subnets.
Note: This field is only applicable for appliances whose version is greater than or equal to 8.1.4.'
add_local_wan:
type: boolean
description: 'flag to control Automatically advertise local WAN subnets.
Note: This field is only applicable for appliances whose version is greater than or equal to 8.1.4.'
self:
type: boolean
description: Whether or not to use shared subnet information
BI_bridge:
title: BI_bridge
type: object
properties:
lan0:
allOf:
- $ref: '#/components/schemas/BI_lan0'
- description: Need description here
lan1:
allOf:
- $ref: '#/components/schemas/BI_lan0'
- description: Need description here
wan0:
allOf:
- $ref: '#/components/schemas/BI_wan0'
- description: Need description here
wan1:
allOf:
- $ref: '#/components/schemas/BI_wan0'
- description: Need description here
description: Need description here
BI_lan0:
title: BI_lan0
required:
- link_state
- pthru_tx_if
- state
type: object
properties:
link_state:
type: string
description: Need description here
pthru_tx_if:
type: string
description: Need description here
state:
type: string
description: Need description here
description: Need description here
BI_wan0:
title: BI_wan0
required:
- link_state
- pthru_tx_if
- state
type: object
properties:
link_state:
type: string
description: Need description here
pthru_tx_if:
type: string
description: Need description here
state:
type: string
description: Need description here
description: Need description here
BackupAndRestoreResponse:
title: BackupAndRestoreResponse
required:
- clientKey
type: object
properties:
clientKey:
type: string
description: a client key which can be polled to get progress of the requested operation
BackupFile:
title: BackupFile
required:
- backupFilePk
type: object
properties:
backupFilePk:
type: integer
description: The backup file's id.
format: int32
BackupGetResponse:
title: BackupGetResponse
required:
- backupTime
- comment
- fileName
- id
- runningConfig
- swVersion
type: object
properties:
backupTime:
type: integer
description: When was this backup operation executed.
format: int32
comment:
type: string
description: The comment.
fileName:
type: string
description: The file's name on which the appliance configuration is now based.
id:
type: integer
description: The id number of this backup in Orchestrator database.
format: int32
runningConfig:
type: string
description: The appliance currently active configuration files' data.
swVersion:
type: string
description: The appliance's software version when it was backuped.
BackupPostBody:
title: BackupPostBody
required:
- comment
type: object
properties:
comment:
type: string
neList:
type: array
items:
type: string
description: List of appliance primary keys
BannerInfo:
title: BannerInfo
required:
- issue
- motd
type: object
properties:
issue:
type: string
description: The Message of the Day appears after a successful login
motd:
type: string
description: The Login Message appears before the login prompt
BgpStateSummary:
title: BgpStateSummary
type: object
properties:
bgp_state:
type: integer
description: Overall state of the routerd & bgp processes. The state will be one of the following({0 =Not Enabled, 1 = Down, 2=Mgmt Stub Initializing, 3=Mgmt Stub Active,4=RTM Initializing, 5=RTM Active, 6=RM Initializing,7=RM Active, 8=NM Intitializing, 9=Active, 10=Unknown})
format: int32
bgp_state_str:
type: integer
description: String representation of the bgp state
format: int32
local_asn:
type: integer
description: local asn number
format: int32
local_ip:
type: string
description: local ip address
mgmt_stub_last_err:
type: integer
description: last error code from routerd
format: int32
mgmt_stub_last_err_str:
type: string
description: last error string from routerd
mgmt_stub_last_err_subcode:
type: integer
format: int32
mgmt_stub_last_err_time:
type: integer
description: last routerd error time
format: int32
mgmt_stub_tot_errors:
type: integer
description: total number of errors from routerd
format: int32
num_bgp_rtes_rcvd:
type: integer
description: number of subnets learned from BGP peers
format: int32
num_ebgp_rtes:
type: integer
description: number of subnets learned from EBGP peers
format: int32
num_ibgp_rtes:
type: integer
description: number of subnets learned from IBGP peers
format: int32
num_peers:
type: integer
description: Total number of bgp peers configured
format: int32
num_peers_active:
type: integer
description: active peers count
format: int32
num_rib_rtes:
type: integer
format: int32
num_rtm_rtes:
type: integer
format: int32
num_subs_installed:
type: integer
description: Number of subnets advertised to BGP peers
format: int32
reject_mismatches:
type: integer
description: subnets rejected due to bad scope
format: int32
reject_unpreferred:
type: integer
description: subnets rejected because other preferred
format: int32
rm_status:
type: integer
format: int32
rtm_status:
type: integer
format: int32
rtr_id:
type: string
description: router id
socket_retry_cnt:
type: integer
format: int32
tunbgp_last_err:
type: integer
description: last error code from tunneld-bgp
format: int32
tunbgp_last_err_str:
type: string
description: last error string from tunneld-bgp
tunbgp_last_err_subcode:
type: integer
format: int32
tunbgp_last_err_time:
type: integer
description: last error time from tunneld-bgp
format: int32
tunbgp_tot_errors:
type: integer
description: total tunneld-bgp errors
format: int32
BgpSystemConfig:
title: BgpSystemConfig
type: object
properties:
asn:
type: integer
description: Autonomous System Number
format: int32
enable:
type: boolean
description: Flag to enable/disable bgp
graceful_restart_en:
type: boolean
description: Flag to control graceful restart. This filed is only applicable from 8.1.9.3 or higher appliances.Remove this field before applying to older appliances.
max_restart_time:
type: integer
description: Max waiting time for a bgp peer to restart before deleting its advertised routes from routing tables. value must be between 1 to 3600(inclusive). This filed is only applicable from 8.1.9.3 or higher appliances. Remove this field before applying to older appliances
format: int32
redist_ospf:
type: boolean
description: Flag to control redistribution of routes to ospf
redist_ospf_filter:
type: integer
description: used to filter redistributed routes to ospf
format: int32
remote_as_path_advertise:
type: boolean
description: Flag to control remote as path propagation. This filed is only applicable from 8.1.9.4 or higher appliances.Remove this field before applying to older appliances.
rtr_id:
type: string
description: router id
stale_path_time:
type: integer
description: The stale_path_time specifies the maximum time (in seconds) following a peer restart that SP waits before removing stale routes associated with that peer.value must be between 1 to 3600(inclusive). This filed is only applicable from 8.1.9.3 or higher appliances.
format: int32
BondedTunnelConfig2:
title: BondedTunnelConfig2
type: object
properties:
adminStatus:
type: string
description: The admin status of the tunnel
alias:
type: string
description: The alias, this is the name of the tunnel used in the user interface
children:
type: array
items:
type: object
description: ''
destNePk:
type: string
description: The nePk of the destination appliance for this tunnel
destTunnelAlias:
type: string
description: The tunnel alias of the opposite tunnel on the destination appliance
destTunnelId:
type: string
description: The tunnel id of the opposite tunnel on the destination appliance
gmsMarked:
type: string
description: Whether or not Orchestrator added or modified this tunnel
id:
type: string
description: The id of the tunnel
operStatus:
type: string
description: The current status of the tunnel
overlayId:
type: number
description: The overlay Id for the bonded tunnel
srcNePk:
type: string
description: The nePk of the appliance that this bonded tunnel belongs to
tag:
type: string
description: The overlay name for the bonded tunnel
BondedTunnelConfigData:
title: BondedTunnelConfigData
required:
- admin
- auto_mtu
- bound_tun
- destination
- gre_proto
- id2
- ipsec_arc_window
- ipsec_enable
- max_bw
- max_bw_auto
- min_bw
- mode
- mtu
- self
- source
- tag_name
- udp_flows
type: object
properties:
admin:
type: string
description: "Admin state of the tunnel - takes two values: 'up' or 'down'."
auto_mtu:
type: boolean
description: Determines if the tunnel should have auto MTU detection.
bound_tun:
$ref: '#/components/schemas/BoundTunnels'
ctrl_pkt:
$ref: '#/components/schemas/FecSettings'
destination:
type: string
description: Destination IP address.
gre_proto:
type: integer
description: GRE protocol in the GRE header
format: int32
id2:
type: integer
description: id of overlay 1-7
format: int32
ipsec_arc_window:
type: string
description: IPSec ARC Window - not configurable.
ipsec_enable:
type: boolean
description: A quick shortcut for knowing if tunnel mode is IPSec. You can get the same information using mode property.
max_bw:
type: integer
description: If the tunnel max bandwidth is manually configured, use this field and set max_bw_auto to false. Units Kbps.
format: int32
max_bw_auto:
type: boolean
description: If the tunnel max bandwidth needs to be set to auto, this field must be true.
min_bw:
type: integer
description: Tunnel minimum bandwidth
format: int32
mode:
type: string
description: "Tunnel mode: it can be one of 'gre', 'udp', 'ipsec'"
mtu:
type: integer
description: Tunnel MTU. If 'auto_mtu' is false, user must set a specific tunnel mtu value
format: int32
options:
type: integer
description: Not used
format: int32
pkt:
$ref: '#/components/schemas/FecSettings'
self:
type: string
description: The value is the same as the tunnel name.
source:
type: string
description: Source IP address of the tunnel.
tag_name:
type: string
description: name of overlay
threshold:
$ref: '#/components/schemas/TunnelHealthFailureCount'
type:
type: string
description: Not used
udp_dest_port:
type: integer
description: If the tunnel is of type 'udp', the udp port to use.
format: int32
udp_flows:
type: integer
description: If tunnel mode is udp, this field determines how many different udp flows are used to distribute tunnel traffic
format: int32
BondedTunnelsConfigAndStates:
title: BondedTunnelsConfigAndStates
required:
-
- allTunnelState
type: object
properties:
:
$ref: '#/components/schemas/BondedTunnelConfigData'
allTunnelState:
$ref: '#/components/schemas/AllStates'
BondedTunnelsIdToTunnelMap:
title: BondedTunnelsIdToTunnelMap
type: object
properties:
exampleTunnelId1:
$ref: '#/components/schemas/BondedTunnelConfig2'
exampleTunnelId2:
$ref: '#/components/schemas/BondedTunnelConfig2'
BoostPlus:
title: BoostPlus
type: object
properties:
boost:
$ref: '#/components/schemas/ecBoost'
mini:
$ref: '#/components/schemas/ecMini'
plus:
$ref: '#/components/schemas/ecPlus'
tier:
$ref: '#/components/schemas/ecTier'
BoundTunnels:
title: BoundTunnels
type: object
properties:
:
type: string
description: Physical tunnel name, value should be
:
type: string
description: Physical tunnel name
BrNatPriorities:
title: BrNatPriorities
type: object
properties:
:
$ref: '#/components/schemas/BrNatPriority'
BrNatPriority:
title: BrNatPriority
type: object
properties:
comment:
type: string
dir:
type: string
description: Traffic direction to perform NAT on. Valid values are ['outbound', 'inbound']
gms_marked:
type: boolean
description: For internal use. Flag to determine if this rule was created by Orchestrator
match:
$ref: '#/components/schemas/BrNatPriorityMatch'
set:
$ref: '#/components/schemas/BrNatPrioritySet'
BrNatPriorityMatch:
title: BrNatPriorityMatch
type: object
properties:
dst_subnet:
type: string
description: Destination IP address range to be translated. Must be a valid subnet
intf:
type: string
description: Interface name or label id
src_subnet:
type: string
description: Source IP address range to be translated. Must be a valid subnet
BrNatPrioritySet:
title: BrNatPrioritySet
type: object
properties:
trans_dst:
type: string
description: Translated destination subnet
trans_src:
type: string
description: Translated source subnet or NAT Pool ID
BranchNat:
title: BranchNat
type: object
properties:
maps:
$ref: '#/components/schemas/BranchNatMap'
natPools:
allOf:
- $ref: '#/components/schemas/NATPools'
- description: Object containing all the NATPools
BranchNatMap:
title: BranchNatMap
type: object
properties:
prio:
$ref: '#/components/schemas/BrNatPriorities'
BranchNatMaps:
title: BranchNatMaps
type: object
properties:
map1:
$ref: '#/components/schemas/BranchNatMap'
BridgeInterfaceState:
title: BridgeInterfaceState
type: object
properties:
bridge:
allOf:
- $ref: '#/components/schemas/BI_bridge'
- description: Need description here
BrownoutThreshold:
title: BrownoutThreshold
type: object
properties:
jitter:
type: number
description: The jitter (ms) to classify a tunnel in the brownout state.
latency:
type: number
description: The latency (ms) to classify a tunnel in the brownout state.
loss:
type: number
description: The percentage of loss to classify a tunnel in the 'brownout' state (when the other criteria is also met).
BuiltinAppItem:
title: BuiltinAppItem
required:
- neID
- neIP
type: object
properties:
neID:
type: string
description: the appliance id
neIP:
type: string
description: the appliance IP address
BuiltinApps:
title: BuiltinApps
required:
-
type: object
properties:
:
type: array
items:
$ref: '#/components/schemas/BuiltinAppItem'
description: one built in application's related appliances information
ChangePasswordBody:
title: ChangePasswordBody
required:
- newPassword
- oldPassword
type: object
properties:
newPassword:
type: string
oldPassword:
type: string
ChangedObject:
title: ChangedObject
required:
- clearVal
- is_set
- raiseVal
- sustain
type: object
properties:
clearVal:
type: integer
description: Need description here
format: int32
is_set:
type: boolean
description: Need description here
raiseVal:
type: integer
description: Need description here
format: int32
sustain:
type: integer
description: Need description here
format: int32
CheckApplianceReachability:
title: CheckApplianceReachability
type: object
properties:
err:
type: string
reachable:
type: boolean
description: Appliance reachability info via websockets
ClientKeyBody:
title: ClientKeyBody
type: object
properties:
clientKey:
type: string
description: The action key to get the status of the action
CloudApp:
title: CloudApp
type: object
properties:
app_name:
type: string
client_enabled:
type: boolean
description: Field to indicate if Optimization flag is turned on for this Cloud App
domain:
type: object
description: Collection of domain names associated with this cloud app. Indexed by domain name
enabled:
type: boolean
description: Field to indicate if Advertise flag is turned on for this Cloud App
ports:
type: string
rtt_threshold:
type: number
description: If Advertise/Gateway enable is turned on, RTTs above this threshold will be advertised
self:
type: string
description: SaaS Id value
ssl_enabled:
type: boolean
description: No longer used, default to false
user_modified:
type: boolean
CloudAppSubnet:
title: CloudAppSubnet
type: object
properties:
pingMethod:
type: string
description: 'Type of ping used to find reachability eg: TCP or UDP'
pingPort:
type: number
description: 'Port number used to ping eg: 80 or 443'
reachableIp:
type: string
description: 'First reachable ip from the subnet eg: 173.240.103.65'
subnet:
type: string
description: 'Cloud application subnet eg: 173.240.103.64/26'
ConfigData:
title: ConfigData
required:
- availMACs
- ifInfo
- macIfs
- scalars
- sysConfig
type: object
properties:
availMACs:
type: array
items:
type: string
description: Available MACs' addresses.
ifInfo:
type: array
items:
type: object
description: The network interface configuration information, including 7 objects, which are separately for mgmt0, mgmt1, wan0, wan1, lan0, lan1m and bvi0, because each object has too many properties and the array of a fixed length can not be shown correctly in this version of schema so this array is not expanded.
macIfs:
type: array
items:
type: string
description: MACs' configuration information of this appliance, including six strings which are wan0, wan1, lan0, lan1, mgmt0 and mgmt1.
scalars:
type: object
description: Need description here.
sysConfig:
$ref: '#/components/schemas/sysConfigIfState'
ConfigMemberInfo:
title: ConfigMemberInfo
required:
- auditlog
- flow
- keep_number
- min_priority
- system
- threshold_size
type: object
properties:
auditlog:
type: string
description: The value should be one of the local0, local1, local2, local3, local4, local5, local6 and local7
flow:
type: string
description: The value should be one of the local0, local1, local2, local3, local4, local5, local6 and local7
keep_number:
type: integer
description: The valid range is 1-100, inclusive
format: int32
min_priority:
type: string
description: The value should be one of the none, emergence, alert, critical, error, warning, notice, info and debug
system:
type: string
description: The value should be one of the local0, local1, local2, local3, local4, local5, local6 and local7
threshold_size:
type: integer
description: The valid range is 1M-50M, inclusive
format: int32
ConfigObj:
title: ConfigObj
required:
- members
type: object
properties:
members:
$ref: '#/components/schemas/ConfigMemberInfo'
ConfigResponse:
title: ConfigResponse
required:
- comment
- id
- time
- version
type: object
properties:
comment:
type: string
description: The comment of this backup.
id:
type: string
description: The id of this backup.
time:
type: string
description: The time of this backup.
version:
type: string
description: The appliance software version when backup.
Configuration:
title: Configuration
required:
- interfaces
- locationSetting
- tunnelSetting
type: object
properties:
interfaces:
type: array
items:
type: array
items:
type: string
locationSetting:
$ref: '#/components/schemas/LocationSecuritySetting'
tunnelSetting:
$ref: '#/components/schemas/TunnelSetting'
ConfigurePostData:
title: ConfigurePostData
required:
- ipv4
type: object
properties:
ipv4:
$ref: '#/components/schemas/Ipv4'
Connectivity:
title: Connectivity
type: object
properties:
connectivity:
type: string
description: 1 for connected, 0 for not connected
Contact:
title: Contact
type: object
properties:
email:
type: string
name:
type: string
phoneNumber:
type: string
Controller:
title: Controller
required:
- card_model
- configuration
- drives
- fw_ver
- percent_complete
- self
- size
- status
- type
type: object
properties:
card_model:
type: string
description: Card model
configuration:
type: string
description: Configuration mode
drives:
type: string
description: ID list of disks controlled like '1, 0'
fw_ver:
type: string
description: Firmware version
percent_complete:
type: integer
description: Completion percentage
format: int32
self:
type: string
description: Controller ID
size:
type: integer
description: Size (GB)
format: int32
status:
type: string
description: Status
type:
type: string
description: Type
description: Disk array controller info
ControllerMap:
title: ControllerMap
required:
-
type: object
properties:
:
allOf:
- $ref: '#/components/schemas/Controller'
- description: Disk array controller info
description: Map of hard disk controller info keyed by controller id
CountSummary:
title: CountSummary
type: object
properties:
CRITICAL:
type: integer
format: int32
MAJOR:
type: integer
format: int32
MINOR:
type: integer
format: int32
WARNING:
type: integer
format: int32
CpxSummary:
title: CpxSummary
required:
- enable
- expire
type: object
properties:
enable:
type: boolean
expire:
type: integer
format: int32
CrashHistory:
title: CrashHistory
type: object
properties:
backTraceStr:
type: string
description: String representation of crash dum
crashTime:
type: integer
description: Epoch time of Appliance crash Time
format: int32
nePk:
type: string
description: This is the primary key of the appliance. Every appliance managed by Orchestrator is given a primary key and it uniquely identifies an appliance among all appliances managed by Orchestrator
processName:
type: string
description: Process which caused the crash
sentToPortal:
type: boolean
description: boolean flag to indicate whether the crash record sent to portal or not?
signalName:
type: string
description: Signal which caused the crash
version:
type: string
description: Appliance version before it crashed
DNS1:
title: DNS1
required:
- domain_search
- nameserver
type: object
properties:
domain_search:
type: object
additionalProperties:
$ref: '#/components/schemas/DomainSearchElement'
nameserver:
type: object
additionalProperties:
$ref: '#/components/schemas/NameServerElement'
DNSAggregateStatsFields:
title: DNSAggregateStatsFields
type: object
properties:
CALC_DNS:
type: string
COUNT:
type: integer
format: int32
COUNTRY:
type: string
DNS:
type: string
FLOWS_CREATED:
type: integer
format: int32
FLOWS_DELETED:
type: integer
format: int32
FLOW_COUNT:
type: integer
format: int32
HOSTNAME:
type: string
IPADDR:
type: string
IS_SOURCE:
type: integer
format: int32
LANRX_BYTES:
type: integer
format: int32
LANRX_PKTS:
type: integer
format: int32
LANTX_BYTES:
type: integer
format: int32
LANTX_PKTS:
type: integer
format: int32
MAX_TIME:
type: integer
format: int32
MIN_TIME:
type: integer
format: int32
NEPK:
type: string
NE_IPADDR:
type: string
SERVICE_ID:
type: integer
format: int32
SPLIT_TYPE:
type: integer
format: int32
WANRX_BYTES:
type: integer
format: int32
WANRX_PKTS:
type: integer
format: int32
WANTX_BYTES:
type: integer
format: int32
WANTX_PKTS:
type: integer
format: int32
DSCPTimeSeriesStatsData:
title: DSCPTimeSeriesStatsData
type: object
properties:
COMP_L2W:
type: integer
description: LAN to WAN compression
format: int32
COMP_L2WMAX:
type: integer
description: Peak LAN to WAN compression for one second interval
format: int32
COMP_L2WMAX_TS:
type: integer
description: Timestamp of when peak LAN to WAN compression occurred
format: int32
COMP_NOOHEAD_L2W:
type: integer
description: LAN to WAN compression without protocol headers
format: int32
COMP_NOOHEAD_L2WMAX:
type: integer
description: Peak LAN to WAN compression without protocol headers
format: int32
COMP_NOOHEAD_L2WMAX_TS:
type: integer
description: Timestamp of when peak LAN to WAN compression without protocol headers occurred
format: int32
COMP_NOOHEAD_W2L:
type: integer
description: WAN to LAN compression without protocol headers
format: int32
COMP_NOOHEAD_W2LMAX:
type: integer
description: Peak WAN to LAN compression without protocol headers
format: int32
COMP_NOOHEAD_W2LMAX_TS:
type: integer
description: Timestamp of when peak WAN to LAN compression without protocol headers occurred
format: int32
COMP_W2L:
type: integer
description: WAN to LAN compression
format: int32
COMP_W2LMAX:
type: integer
description: Peak WAN to LAN compression for one second interval
format: int32
COMP_W2LMAX_TS:
type: integer
description: Timestamp of when peak WAN to LAN compression occurred
format: int32
DSCP:
type: integer
description: DSCP value
format: int32
LRX_BYTES:
type: integer
description: Number of bytes LAN side received
format: int32
LRX_BYTES_MAX:
type: integer
description: Peak number of bytes LAN side received in one second
format: int32
LRX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes LAN side received
format: int32
LRX_PKTS:
type: integer
description: Number of packets LAN side received
format: int32
LRX_PKTS_MAX:
type: integer
description: Peak number of packets LAN side received in one second
format: int32
LRX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets LAN side received
format: int32
LTX_BYTES:
type: integer
description: Number of bytes LAN side transmitted
format: int32
LTX_BYTES_MAX:
type: integer
description: Peak number of bytes LAN side transmitted in one second
format: int32
LTX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes LAN side transmitted
format: int32
LTX_PKTS:
type: integer
description: Number of packets LAN side transmitted
format: int32
LTX_PKTS_MAX:
type: integer
description: Peak number of packets LAN side transmitted in one second
format: int32
LTX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets LAN side transmitted
format: int32
TIMESTAMP:
type: integer
description: Timestamp in EPOCH time, all timestamp fields are in EPOCH time
format: int32
TRAFFIC_TYPE:
type: integer
description: 'Integer value indicating the traffic type these stats belong to. 1: Optimized Traffic, 2: Pass-through Shaped, 3: Pass-through Unshaped, 4: All Traffic'
format: int32
WRX_BYTES:
type: integer
description: Number of bytes WAN side received
format: int32
WRX_BYTES_MAX:
type: integer
description: Peak number of bytes WAN side received in one second
format: int32
WRX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes WAN side received
format: int32
WRX_PKTS:
type: integer
description: Number of packets WAN side received
format: int32
WRX_PKTS_MAX:
type: integer
description: Peak number of packets WAN side received in one second
format: int32
WRX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets WAN side received
format: int32
WTX_BYTES:
type: integer
description: Number of bytes WAN side transmitted
format: int32
WTX_BYTES_MAX:
type: integer
description: Peak number of bytes WAN side transmitted in one second
format: int32
WTX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes WAN side transmitted
format: int32
WTX_PKTS:
type: integer
description: Number of packets WAN side transmitted
format: int32
WTX_PKTS_MAX:
type: integer
description: Peak number of packets WAN side transmitted in one second
format: int32
WTX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets WAN side transmitted
format: int32
description: An array that contains the stats data of a certain timestamp.
DSCPTimeSeriesStatsDataMultiAppliances:
title: DSCPTimeSeriesStatsDataMultiAppliances
type: object
properties:
:
type: array
items:
$ref: '#/components/schemas/DSCPTimeSeriesStatsData'
description: ''
DSCPTimeSeriesStatsMultiAppliances:
title: DSCPTimeSeriesStatsMultiAppliances
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
$ref: '#/components/schemas/DSCPTimeSeriesStatsDataMultiAppliances'
DSCPTimeSeriesStatsSingleAppliances:
title: DSCPTimeSeriesStatsSingleAppliances
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
allOf:
- $ref: '#/components/schemas/DSCPTimeSeriesStatsData'
- description: An array that contains the stats data of a certain timestamp.
DbPartitionInfo:
title: DbPartitionInfo
type: object
properties:
isReadOnlyPartition:
type: boolean
partitionEndTime:
type: string
partitionName:
type: string
partitionSize:
type: integer
format: int32
partitionStartTime:
type: string
readOnlyPartition:
type: boolean
rows:
type: integer
format: int32
tableName:
type: string
DebugFileInfo:
title: DebugFileInfo
type: object
properties:
name:
type: string
description: The name of the file
stats:
$ref: '#/components/schemas/DebugFileInfoStats'
DebugFileInfoStats:
title: DebugFileInfoStats
type: object
properties:
atime:
type: string
description: The access time of the file
blksize:
type: integer
description: The size of the block
format: int32
blocks:
type: integer
description: The blocks of the file
format: int32
ctime:
type: string
description: The change time of the file
dev:
type: integer
description: Need description here
format: int32
gid:
type: integer
description: Need description here
format: int32
ino:
type: integer
description: Need description here
format: int32
mode:
type: integer
description: The mode of the file
format: int32
mtime:
type: string
description: The modified time of the file
nlink:
type: integer
description: Need description here
format: int32
rdev:
type: integer
description: Need description here
format: int32
size:
type: integer
description: The size of the file
format: int32
uid:
type: integer
description: Need description here
format: int32
DebugFiles:
title: DebugFiles
type: object
properties:
debugDump:
type: array
items:
$ref: '#/components/schemas/DebugFileInfo'
description: The info of the Sys Dump file
debugFile:
type: array
items:
$ref: '#/components/schemas/DebugFileInfo'
description: The info of the debug file
log:
type: array
items:
$ref: '#/components/schemas/DebugFileInfo'
description: The info of the Log file
snapshots:
type: array
items:
$ref: '#/components/schemas/DebugFileInfo'
description: The info of the Snapshot file
tcpDump:
type: array
items:
$ref: '#/components/schemas/DebugFileInfo'
description: The info of the TCP Dump file
techDump:
type: array
items:
$ref: '#/components/schemas/DebugFileInfo'
description: The info of the Show Tech file
DelayNotificationRequest:
title: DelayNotificationRequest
required:
- delayByHours
type: object
properties:
delayByHours:
type: number
description: The number of hours to delay the notification by
DeleteGMSDebugFile:
title: DeleteGMSDebugFile
type: object
properties:
fileName:
type: string
description: The name of the file
DeleteInfoClass:
title: DeleteInfoClass
type: object
properties:
group:
type: string
description: The group of the file which need to delete
local_filename:
type: string
description: The name of the file which need to delete
DeploymentBackgroundClientKey:
title: DeploymentBackgroundClientKey
type: object
properties:
clientKey:
type: string
description: The client key that can be used to check the status of the deployment apply.
DeploymentGet:
title: DeploymentGet
type: object
properties:
dhcpFailover:
allOf:
- $ref: '#/components/schemas/dhcpFailover'
- description: List of dhcp failover settings configured on the interfaces
dpRoutes:
type: array
items:
$ref: '#/components/schemas/dpRoute'
description: ''
mgmtIfData:
$ref: '#/components/schemas/mgmtIfData'
modeIfs:
type: array
items:
$ref: '#/components/schemas/modeIf'
description: ''
scalars:
type: string
description: The port to use when building IPSec UDP tunnels on this appliance
sysConfig:
allOf:
- $ref: '#/components/schemas/sysConfig'
- description: Appliance's system configuration
vifs:
allOf:
- $ref: '#/components/schemas/vifs'
- description: List of virtual interface names configured on this appliance
DeploymentPost:
title: DeploymentPost
required:
- dpRoutes
- modeIfs
- sysConfig
type: object
properties:
dhcpFailover:
allOf:
- $ref: '#/components/schemas/dhcpFailover'
- description: List of dhcp failover settings configured on the interfaces
dpRoutes:
type: array
items:
$ref: '#/components/schemas/dpRoute'
description: ''
modeIfs:
type: array
items:
$ref: '#/components/schemas/modeIf'
description: ''
sysConfig:
allOf:
- $ref: '#/components/schemas/sysConfig'
- description: Appliance's system configuration
DeploymentPut:
title: DeploymentPut
required:
- dpRoutes
- modeIfs
- sysConfig
type: object
properties:
dpRoutes:
type: array
items:
$ref: '#/components/schemas/dpRoute'
description: ''
modeIfs:
type: array
items:
$ref: '#/components/schemas/modeIf'
description: ''
sysConfig:
allOf:
- $ref: '#/components/schemas/sysConfig'
- description: Appliance's system configuration
DeploymentValidate:
title: DeploymentValidate
required:
- dpRoutes
- modeIfs
- sysConfig
type: object
properties:
dhcpFailover:
type: array
items:
$ref: '#/components/schemas/dhcpFailover'
description: ''
dpRoutes:
type: array
items:
$ref: '#/components/schemas/dpRoute'
description: ''
modeIfs:
type: array
items:
$ref: '#/components/schemas/modeIf'
description: ''
sysConfig:
allOf:
- $ref: '#/components/schemas/sysConfig'
- description: Appliance's system configuration
DeploymentValidateResult:
title: DeploymentValidateResult
required:
- err
- rebootRequired
type: object
properties:
err:
type: string
description: 'Deployment data validation result - OK: null, or in case of error, the error message here'
rebootRequired:
type: boolean
description: Indicates whether reboot is required if the deployment data provided is applied,
DestNepkToPhysicalTunnelsMap:
title: DestNepkToPhysicalTunnelsMap
type: object
properties:
destinationNePk:
type: array
items:
$ref: '#/components/schemas/OverlayPhysicalTunnelsInfo'
description: ''
description: A map of destination appliances (nePk) to an array of tunnels
DestNepkToTunnelsMap:
title: DestNepkToTunnelsMap
type: object
properties:
destinationNePk:
type: array
items:
$ref: '#/components/schemas/OverlayBondedTunnelsInfo'
description: ''
description: A map of destination appliances (nePk) to an array of tunnels
DftData:
title: DftData
required:
- enable
- falling
- rising
type: object
properties:
enable:
type: boolean
description: Need description here
falling:
$ref: '#/components/schemas/ChangedObject'
rising:
$ref: '#/components/schemas/ChangedObject'
DiscoveryConfiguration:
title: DiscoveryConfiguration
type: object
properties:
emails:
type: array
items:
type: string
description: An array of email addresses to send the discovery (discovered, approved and denied EdgeConnects) email to.
Disk:
title: Disk
required:
- is_removable
- pair
- percent_complete
- self
- serial_num
- size
- status
type: object
properties:
is_removable:
type: boolean
description: Whether it is removable
pair:
type: integer
description: ID of the pair disk, if no pair, it is -1
format: int32
percent_complete:
type: integer
description: Completion percentage
format: int32
self:
type: string
description: Disk ID
serial_num:
type: string
description: Serial number
size:
type: integer
description: Size (GB)
format: int32
status:
type: string
description: Status
description: Disk info
DiskMap:
title: DiskMap
required:
-
type: object
properties:
:
allOf:
- $ref: '#/components/schemas/Disk'
- description: Disk info
description: Map of disk info keyed by disk ID
DisksGet:
title: DisksGet
required:
- controller
- diskImage
- disks
type: object
properties:
controller:
allOf:
- $ref: '#/components/schemas/ControllerMap'
- description: Map of hard disk controller info keyed by controller id
diskImage:
type: string
description: Filename of disk image
disks:
allOf:
- $ref: '#/components/schemas/DiskMap'
- description: Map of disk info keyed by disk ID
DnsCacheConfig:
title: DnsCacheConfig
type: object
properties:
http:
type: boolean
description: enable/disable flag for DNS http snooping
DnsObj:
title: DnsObj
type: object
properties:
domain:
type: string
name:
type: string
priority:
type: integer
format: int32
DnsProxyConfig:
title: DnsProxyConfig
required:
- active
- enable
- interface
type: object
properties:
active:
type: string
description: Active map
domaingroup:
$ref: '#/components/schemas/DomainGroups'
enable:
type: boolean
description: Enable DNS proxy
interface:
type: string
description: Loopback interface
map:
$ref: '#/components/schemas/Maps'
profile:
$ref: '#/components/schemas/Profile'
DnsProxyConfigPost:
title: DnsProxyConfigPost
type: object
properties:
config:
$ref: '#/components/schemas/DnsProxyConfig'
Domain:
title: Domain
type: object
properties:
application:
type: string
description: Cloud application name
domain:
type: string
description: Domain name
saasId:
type: string
DomainGroups:
title: DomainGroups
type: object
properties:
:
$ref: '#/components/schemas/DomainGroupsObj'
DomainGroupsObj:
title: DomainGroupsObj
required:
- domains
type: object
properties:
domains:
type: string
description: Domains
DomainSearch:
title: DomainSearch
required:
- domain_search
type: object
properties:
domain_search:
type: object
additionalProperties:
$ref: '#/components/schemas/DomainSearchElement'
description: Details of the Domain Names
DomainSearchElement:
title: DomainSearchElement
required:
- domainname
- self
type: object
properties:
domainname:
type: string
description: Primary Domain Name
self:
type: integer
format: int32
DownloadFilePost:
title: DownloadFilePost
type: object
properties:
appliances:
type: array
items:
$ref: '#/components/schemas/ApplianceFiles'
description: ''
DscpAggregateStats:
title: DscpAggregateStats
required:
-
type: object
properties:
:
$ref: '#/components/schemas/DscpAggregateStatsDscpLevelObject'
DscpAggregateStatsApplianceLevelObject:
title: DscpAggregateStatsApplianceLevelObject
required:
-
type: object
properties:
:
$ref: '#/components/schemas/DscpAggregateStatsBase'
DscpAggregateStatsBase:
title: DscpAggregateStatsBase
required:
- DSCP
- HOSTNAME
- IP
- MAX_COMP_L2W
- MAX_COMP_L2WMAX
- MAX_COMP_NOOHEAD_L2W
- MAX_COMP_NOOHEAD_L2WMAX
- MAX_COMP_NOOHEAD_W2L
- MAX_COMP_NOOHEAD_W2LMAX
- MAX_COMP_W2L
- MAX_COMP_W2LMAX
- MAX_LRX_BYTES_MAX
- MAX_LRX_PKTS_MAX
- MAX_LTX_BYTES_MAX
- MAX_LTX_PKTS_MAX
- MAX_TIMESTAMP
- MAX_WRX_BYTES_MAX
- MAX_WRX_PKTS_MAX
- MAX_WTX_BYTES_MAX
- MAX_WTX_PKTS_MAX
- MIN_TIMESTAMP
- SUM_LRX_BYTES
- SUM_LRX_PKTS
- SUM_LTX_BYTES
- SUM_LTX_PKTS
- SUM_WRX_BYTES
- SUM_WRX_PKTS
- SUM_WTX_BYTES
- SUM_WTX_PKTS
- TRAFFIC_TYPE
- nePk
type: object
properties:
DSCP:
type: integer
description: Integer value indicating DSCP to which the stats object belongs.
format: int32
HOSTNAME:
type: string
description: Hostname of the appliance
IP:
type: string
description: Management IP address of appliance
MAX_COMP_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate
format: int32
MAX_COMP_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate
format: int32
MAX_COMP_NOOHEAD_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate without overhead
format: int32
MAX_COMP_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate
format: int32
MAX_COMP_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate
format: int32
MAX_LRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side received
format: int32
MAX_LRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side received
format: int32
MAX_LTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side transmitted
format: int32
MAX_LTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side transmitted
format: int32
MAX_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual starting boundary of data time range
format: int32
MAX_WRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side received
format: int32
MAX_WRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side received
format: int32
MAX_WTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side transmitted
format: int32
MAX_WTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side transmitted
format: int32
MIN_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual ending boundary of data time range
format: int32
SUM_LRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side received
format: int32
SUM_LRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_LTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side transmitted
format: int32
SUM_LTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_WRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side received
format: int32
SUM_WRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side received
format: int32
SUM_WTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side transmitted
format: int32
SUM_WTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side transmitted
format: int32
TRAFFIC_TYPE:
type: integer
description: 'Integer value indicating the traffic type these stats belong to. 1: Optimized Traffic, 2: Pass-through Shaped, 3: Pass-through Unshaped, 4: All Traffic'
format: int32
nePk:
type: string
description: Internal ID of appliance
DscpAggregateStatsDscpLevelObject:
title: DscpAggregateStatsDscpLevelObject
required:
-
type: object
properties:
:
$ref: '#/components/schemas/DscpAggregateStatsApplianceLevelObject'
DynamicPreferenceResponse:
title: DynamicPreferenceResponse
type: object
properties:
latitude:
type: number
description: The latitude of the map's initial center
longitude:
type: number
description: The longitude of the map's initial center
zoom:
type: number
description: Zoom level of the map
DynamicPreferenceSave:
title: DynamicPreferenceSave
type: object
properties:
latitude:
type: number
description: The latitude of the map's initial center
longitude:
type: number
description: The longitude of the map's initial center
zoom:
type: number
description: Zoom level of the map
DynamicPreferencesSaveForUser:
title: DynamicPreferencesSaveForUser
required:
- username
type: object
properties:
username:
$ref: '#/components/schemas/DynamicPreferenceSave'
DynamicTopologyConfiguration:
title: DynamicTopologyConfiguration
type: object
properties:
key:
$ref: '#/components/schemas/DynamicPreferenceResponse'
DynamicTopologySaveRequest:
title: DynamicTopologySaveRequest
type: object
properties:
username:
$ref: '#/components/schemas/DynamicPreferenceSave'
ECPostData:
title: ECPostData
type: object
properties:
license:
$ref: '#/components/schemas/BoostPlus'
EcspSummary:
title: EcspSummary
required:
- enable
type: object
properties:
enable:
type: boolean
EndpointException:
title: EndpointException
required:
- ip1
- ip2
type: object
properties:
ip1:
type: string
description: Primary IPv4 address
ip2:
type: string
description: Secondary IPv4 address
EndpointExceptionLabelMap:
title: EndpointExceptionLabelMap
type: object
properties:
:
$ref: '#/components/schemas/EndpointException'
EndpointExceptionMap:
title: EndpointExceptionMap
type: object
properties:
:
$ref: '#/components/schemas/EndpointExceptionLabelMap'
EraseNmPost:
title: EraseNmPost
required:
- erase
- neList
type: object
properties:
erase:
type: boolean
description: Should be always true, if you want to erase NM
neList:
type: array
items:
type: string
description: "Array of appliance keys, for eg: ['0.NE','1.NE']"
FecSettings:
title: FecSettings
type: object
properties:
fec_enable_str:
allOf:
- $ref: '#/components/schemas/FecEnableStr'
- description: Enable Forward Error Correction(FEC)
fec_reset_intvl:
allOf:
- $ref: '#/components/schemas/FecResetIntvl'
- description: Forward Error Correction Ratio
example: 2
frag_enable:
type: boolean
description: Enable tunnel packet fragmentation and reassembly
reorder_wait:
type: integer
description: Amount of time in milliseconds to wait for Packet Order Correction algorithm
format: int32
FileCreationBody:
title: FileCreationBody
required:
- data
- fileName
type: object
properties:
data:
type: string
fileName:
type: string
FlowAggregateStats:
title: FlowAggregateStats
required:
-
type: object
properties:
:
$ref: '#/components/schemas/FlowAggregateStatsFlowLevelObject'
FlowAggregateStatsApplianceLevelObject:
title: FlowAggregateStatsApplianceLevelObject
required:
-
type: object
properties:
:
$ref: '#/components/schemas/FlowAggregateStatsBase'
FlowAggregateStatsBase:
title: FlowAggregateStatsBase
required:
- FLOW_TYPE
- HOSTNAME
- IP
- MAX_COMP_L2W
- MAX_COMP_L2WMAX
- MAX_COMP_NOOHEAD_L2W
- MAX_COMP_NOOHEAD_L2WMAX
- MAX_COMP_NOOHEAD_W2L
- MAX_COMP_NOOHEAD_W2LMAX
- MAX_COMP_W2L
- MAX_COMP_W2LMAX
- MAX_CREATED_MAX
- MAX_DELETED_MAX
- MAX_FLOW_EXT_PEAK
- MAX_FLOW_MAX
- MAX_FLOW_PEAK
- MAX_LRX_BYTES_MAX
- MAX_LRX_PKTS_MAX
- MAX_LTX_BYTES_MAX
- MAX_LTX_PKTS_MAX
- MAX_TIMESTAMP
- MAX_WRX_BYTES_MAX
- MAX_WRX_PKTS_MAX
- MAX_WTX_BYTES_MAX
- MAX_WTX_PKTS_MAX
- MIN_TIMESTAMP
- SUM_CREATED
- SUM_DELETED
- SUM_EXT
- SUM_LRX_BYTES
- SUM_LRX_PKTS
- SUM_LTX_BYTES
- SUM_LTX_PKTS
- SUM_WRX_BYTES
- SUM_WRX_PKTS
- SUM_WTX_BYTES
- SUM_WTX_PKTS
- TRAFFIC_TYPE
- nePk
type: object
properties:
FLOW_TYPE:
type: integer
description: 'Integer value indicating flow type to which the stats object belongs. 1: TCP_Accelerated, 2: TCP_Not_Accelerated, 3: Non_TCP'
format: int32
HOSTNAME:
type: string
description: Hostname of the appliance
IP:
type: string
description: Management IP address of appliance
MAX_COMP_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate
format: int32
MAX_COMP_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate
format: int32
MAX_COMP_NOOHEAD_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate without overhead
format: int32
MAX_COMP_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate
format: int32
MAX_COMP_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate
format: int32
MAX_CREATED_MAX:
type: integer
description: Integer value of maximum number of flows created
format: int32
MAX_DELETED_MAX:
type: integer
description: Integer value of maximum number of flows deleted
format: int32
MAX_FLOW_EXT_PEAK:
type: integer
description: Integer value of maximum peak number of flows exist
format: int32
MAX_FLOW_MAX:
type: integer
description: Integer value of maximum number of flows exist
format: int32
MAX_FLOW_PEAK:
type: integer
description: Integer value of maximum peak number of flows
format: int32
MAX_LRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side received
format: int32
MAX_LRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side received
format: int32
MAX_LTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side transmitted
format: int32
MAX_LTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side transmitted
format: int32
MAX_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual starting boundary of data time range
format: int32
MAX_WRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side received
format: int32
MAX_WRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side received
format: int32
MAX_WTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side transmitted
format: int32
MAX_WTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side transmitted
format: int32
MIN_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual ending boundary of data time range
format: int32
SUM_CREATED:
type: integer
description: Integer value of total number of flows created
format: int32
SUM_DELETED:
type: integer
description: Integer value of total number of flows deleted
format: int32
SUM_EXT:
type: integer
description: Integer value of total number of flows exist
format: int32
SUM_LRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side received
format: int32
SUM_LRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_LTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side transmitted
format: int32
SUM_LTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_WRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side received
format: int32
SUM_WRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side received
format: int32
SUM_WTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side transmitted
format: int32
SUM_WTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side transmitted
format: int32
TRAFFIC_TYPE:
type: integer
description: 'Integer value indicating the traffic type these stats belong to. 1: Optimized Traffic, 2: Pass-through Shaped, 3: Pass-through Unshaped, 4: All Traffic'
format: int32
nePk:
type: string
description: Internal ID of appliance
FlowAggregateStatsFlowLevelObject:
title: FlowAggregateStatsFlowLevelObject
required:
-
type: object
properties:
:
$ref: '#/components/schemas/FlowAggregateStatsApplianceLevelObject'
FlowDetails:
title: FlowDetails
required:
- Optimization
- QoS
- Route
- Stats
type: object
properties:
Optimization:
type: array
items:
type: object
description: ''
QoS:
type: array
items:
type: object
description: ''
Route:
type: array
items:
type: object
description: ''
Stats:
type: array
items:
type: object
description: ''
FlowDetails2:
title: FlowDetails2
required:
- General
- NAT Info
- TCP Info
type: object
properties:
General:
$ref: '#/components/schemas/FlowDetails2General'
NAT Info:
$ref: '#/components/schemas/FlowDetails2NatInfo'
TCP Info:
$ref: '#/components/schemas/FlowDetails2TCPInfo'
FlowDetails2General:
title: FlowDetails2General
required:
- Optimization
- QoS
- Route
- Stats
type: object
properties:
Optimization:
type: array
items:
type: object
description: ''
QoS:
type: array
items:
type: object
description: ''
Route:
type: array
items:
type: object
description: ''
Stats:
type: array
items:
type: object
description: ''
FlowDetails2NatInfo:
title: FlowDetails2NatInfo
required:
- NAT
type: object
properties:
NAT:
type: array
items:
type: object
description: ''
FlowDetails2TCPInfo:
title: FlowDetails2TCPInfo
required:
- TCP-Stats
type: object
properties:
TCP-Stats:
type: array
items:
type: object
description: ''
FlowTimeSeriesStatsItems:
title: FlowTimeSeriesStatsItems
type: object
properties:
COMP_L2W:
type: integer
description: LAN to WAN compression
format: int32
COMP_L2WMAX:
type: integer
description: Peak LAN to WAN compression for one second interval
format: int32
COMP_L2WMAX_TS:
type: integer
description: Timestamp of when peak LAN to WAN compression occurred
format: int32
COMP_NOOHEAD_L2W:
type: integer
description: LAN to WAN compression without protocol headers
format: int32
COMP_NOOHEAD_L2WMAX:
type: integer
description: Peak LAN to WAN compression without protocol headers
format: int32
COMP_NOOHEAD_L2WMAX_TS:
type: integer
description: Timestamp of when peak LAN to WAN compression without protocol headers occurred
format: int32
COMP_NOOHEAD_W2L:
type: integer
description: WAN to LAN compression without protocol headers
format: int32
COMP_NOOHEAD_W2LMAX:
type: integer
description: Peak WAN to LAN compression without protocol headers
format: int32
COMP_NOOHEAD_W2LMAX_TS:
type: integer
description: Timestamp of when peak WAN to LAN compression without protocol headers occurred
format: int32
COMP_W2L:
type: integer
description: WAN to LAN compression
format: int32
COMP_W2LMAX:
type: integer
description: Peak WAN to LAN compression for one second interval
format: int32
COMP_W2LMAX_TS:
type: integer
description: Timestamp of when peak WAN to LAN compression occurred
format: int32
CREATED:
type: integer
description: Number of created flows
format: int32
CREATED_MAX:
type: integer
description: Peak number of created flows
format: int32
CREATED_MAX_TS:
type: integer
description: Timestamp of when peak number of created flows occurred
format: int32
DELETED:
type: integer
description: Number of deleted flows
format: int32
DELETED_MAX:
type: integer
description: Peak number of deleted flows
format: int32
DELETED_MAX_TS:
type: integer
description: Timestamp of when peak number of deleted flows occurred
format: int32
EXT:
type: integer
description: Number of existing flows at the time when the stats sample was taken
format: int32
FLOW_EXT_PEAK:
type: integer
description: Peak number of existing flows at the time when the stats sample was taken
format: int32
FLOW_EXT_PEAK_TS:
type: integer
description: Timestamp of when peak number of existing flow occurred
format: int32
FLOW_MAX:
type: integer
description: Peak number of flows
format: int32
FLOW_PEAK:
type: integer
description: Same as FLOW_MAX
format: int32
FLOW_PEAK_TS:
type: integer
description: Timestamp of when peak number of flows occurred
format: int32
FLOW_TYPE:
type: integer
description: Number of bytes of protocol headers WAN side received
format: int32
LRX_BYTES:
type: integer
description: Number of bytes LAN side received
format: int32
LRX_BYTES_MAX:
type: integer
description: Peak number of bytes LAN side received in one second
format: int32
LRX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes LAN side received
format: int32
LRX_PKTS:
type: integer
description: Number of packets LAN side received
format: int32
LRX_PKTS_MAX:
type: integer
description: Peak number of packets LAN side received in one second
format: int32
LRX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets LAN side received
format: int32
LTX_BYTES:
type: integer
description: Number of bytes LAN side transmitted
format: int32
LTX_BYTES_MAX:
type: integer
description: Peak number of bytes LAN side transmitted in one second
format: int32
LTX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes LAN side transmitted
format: int32
LTX_PKTS:
type: integer
description: Number of packets LAN side transmitted
format: int32
LTX_PKTS_MAX:
type: integer
description: Peak number of packets LAN side transmitted in one second
format: int32
LTX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets LAN side transmitted
format: int32
TIMESTAMP:
type: integer
description: Timestamp in EPOCH time, all timestamp fields are in EPOCH time
format: int32
TRAFFIC_TYPE:
type: integer
description: 'Integer value indicating the traffic type these stats belong to. 1: Optimized Traffic, 2: Pass-through Shaped, 3: Pass-through Unshaped, 4: All Traffic'
format: int32
WRX_BYTES:
type: integer
description: Number of bytes WAN side received
format: int32
WRX_BYTES_MAX:
type: integer
description: Peak number of bytes WAN side received in one second
format: int32
WRX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes WAN side received
format: int32
WRX_PKTS:
type: integer
description: Number of packets WAN side received
format: int32
WRX_PKTS_MAX:
type: integer
description: Peak number of packets WAN side received in one second
format: int32
WRX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets WAN side received
format: int32
WTX_BYTES:
type: integer
description: Number of bytes WAN side transmitted
format: int32
WTX_BYTES_MAX:
type: integer
description: Peak number of bytes WAN side transmitted in one second
format: int32
WTX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes WAN side transmitted
format: int32
WTX_PKTS:
type: integer
description: Number of packets WAN side transmitted
format: int32
WTX_PKTS_MAX:
type: integer
description: Peak number of packets WAN side transmitted in one second
format: int32
WTX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets WAN side transmitted
format: int32
description: An array that contains the stats data of a certain timestamp.
FlowTimeSeriesStatsMultiAppliances:
title: FlowTimeSeriesStatsMultiAppliances
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
type: array
items:
$ref: '#/components/schemas/FlowTimeSeriesStatsItems'
description: ''
FlowsGet:
title: FlowsGet
required:
- active
- err_msg
- flows
- flows_management
- flows_optimized
- flows_passthrough
- flows_with_ignores
- flows_with_issues
- inactive
- inconsistent_flows
- matched_flows
- now
- ret_code
- returned_flows
- stale_flows
- total_flows
type: object
properties:
active:
$ref: '#/components/schemas/FlowsGetActivePart'
err_msg:
type: string
flows:
type: array
items:
type: array
items:
type: object
flows_management:
type: integer
format: int32
flows_optimized:
type: integer
format: int32
flows_passthrough:
type: integer
format: int32
flows_with_ignores:
type: integer
format: int32
flows_with_issues:
type: integer
format: int32
inactive:
$ref: '#/components/schemas/FlowsGetInactivePart'
inconsistent_flows:
type: integer
format: int32
matched_flows:
type: integer
format: int32
now:
type: integer
format: int32
ret_code:
type: integer
format: int32
returned_flows:
type: integer
format: int32
stale_flows:
type: integer
format: int32
total_flows:
type: integer
format: int32
FlowsGetActivePart:
title: FlowsGetActivePart
required:
- flows_asymmetric
- flows_firewall_dropped
- flows_management
- flows_optimized
- flows_passthrough
- flows_route_dropped
- flows_with_ignores
- flows_with_issues
- inconsistent_flows
- stale_flows
- total_flows
type: object
properties:
flows_asymmetric:
type: integer
format: int32
flows_firewall_dropped:
type: integer
format: int32
flows_management:
type: integer
format: int32
flows_optimized:
type: integer
format: int32
flows_passthrough:
type: integer
format: int32
flows_route_dropped:
type: integer
format: int32
flows_with_ignores:
type: integer
format: int32
flows_with_issues:
type: integer
format: int32
inconsistent_flows:
type: integer
format: int32
stale_flows:
type: integer
format: int32
total_flows:
type: integer
format: int32
FlowsGetInactivePart:
title: FlowsGetInactivePart
required:
- flows_asymmetric
- flows_firewall_dropped
- flows_management
- flows_optimized
- flows_passthrough
- flows_route_dropped
- flows_with_ignores
- flows_with_issues
- inconsistent_flows
- stale_flows
- total_flows
type: object
properties:
flows_asymmetric:
type: integer
format: int32
flows_firewall_dropped:
type: integer
format: int32
flows_management:
type: integer
format: int32
flows_optimized:
type: integer
format: int32
flows_passthrough:
type: integer
format: int32
flows_route_dropped:
type: integer
format: int32
flows_with_ignores:
type: integer
format: int32
flows_with_issues:
type: integer
format: int32
inconsistent_flows:
type: integer
format: int32
stale_flows:
type: integer
format: int32
total_flows:
type: integer
format: int32
FlowsResetBody:
title: FlowsResetBody
required:
- spIds
type: object
properties:
spIds:
type: array
items:
type: integer
format: int32
description: Contains the flow IDs.
FlowsResetResponse:
title: FlowsResetResponse
required:
- rc
- results
- value
type: object
properties:
rc:
allOf:
- $ref: '#/components/schemas/Rc'
- description: Indicates success or failure
example: 0
results:
type: array
items:
type: object
description: ''
value:
type: string
ForgotPasswordBody:
title: ForgotPasswordBody
required:
- userName
type: object
properties:
userName:
type: string
description: User name
FxSummary:
title: FxSummary
required:
- base
- boost
- boostExpire
- enable
- expire
- mini
- plus
- tier
type: object
properties:
base:
type: integer
format: int32
boost:
type: integer
format: int32
boostExpire:
type: integer
format: int32
enable:
type: boolean
expire:
type: integer
format: int32
mini:
type: integer
format: int32
plus:
type: integer
format: int32
tier:
$ref: '#/components/schemas/TierSummary'
GRNode:
title: GRNode
required:
- appliance
- groupId
- latitude
- longitude
- sourceId
- wx
- wy
type: object
properties:
appliance:
type: boolean
description: Appliance(true), Group(false)
groupId:
type: string
description: ID of the group belonged to
id:
type: string
description: ID, assigned by Orchestrator like 1.GrNode
latitude:
type: number
description: Latitude
longitude:
type: number
description: Longitude
sourceId:
type: string
description: 'Source ID: appliance(neId like 0.NE), group(group ID like 10.Network)'
wx:
type: integer
description: Coordinates X in map window
format: int32
wy:
type: integer
description: Coordinates Y in map window
format: int32
GRNodeUpdatePostBody:
title: GRNodeUpdatePostBody
required:
- latitude
- longitude
- wx
- wy
type: object
properties:
latitude:
type: number
description: Latitude
longitude:
type: number
description: Longitude
wx:
type: integer
description: Coordinates X in map window
format: int32
wy:
type: integer
description: Coordinates Y in map window
format: int32
GeoLocationObject:
title: GeoLocationObject
type: object
properties:
city:
type: string
country:
type: string
countryCode:
type: string
ip:
type: integer
description: IP address for which geo location is calculated
format: int32
isp:
type: string
latitude:
type: number
longitude:
type: number
org:
type: string
postalCode:
type: integer
format: int32
rangeIpEnd:
type: integer
description: End IP of subnet that the geolocated IP falls under
format: int32
rangeIpStart:
type: integer
description: Start IP of subnet that the geolocated IP falls under
format: int32
GeoLocationResponse:
title: GeoLocationResponse
type: object
properties:
:
$ref: '#/components/schemas/GeoLocationObject'
description: Collection of GeoLocationObject indexed by ip address value
Geometry:
title: Geometry
type: object
properties:
bounds:
$ref: '#/components/schemas/GeometryBounds'
location:
$ref: '#/components/schemas/GeometryLatLng'
location_type:
type: string
description: A string describing how accurate the location is
viewport:
$ref: '#/components/schemas/GeometryBounds'
GeometryBounds:
title: GeometryBounds
type: object
properties:
northeast:
$ref: '#/components/schemas/GeometryLatLng'
southwest:
$ref: '#/components/schemas/GeometryLatLng'
GeometryLatLng:
title: GeometryLatLng
type: object
properties:
lat:
type: number
description: The latitude value of the coordinate
lng:
type: number
description: The longitude value of the coordinate
GetResponse:
title: GetResponse
required:
- moduleInfo
- peers
- subnets
type: object
properties:
moduleInfo:
$ref: '#/components/schemas/ModuleInfo'
peers:
type: array
items:
$ref: '#/components/schemas/OnePeer'
description: Each element of this array is an object describing one peer's detail information, and the minimum number of the elements is 0
subnets:
$ref: '#/components/schemas/Subnets'
GmsAlarm:
title: GmsAlarm
required:
- acknowledged
- clearable
- clearedTimeInMills
- closed
- description
- id
- name
- occurrenceCount
- recommendedAction
- serviceAffect
- severity
- source
- timeOccurredInMills
- type
- typeId
type: object
properties:
acknowledged:
type: boolean
clearable:
type: boolean
clearedTimeInMills:
type: integer
format: int32
closed:
type: boolean
description:
type: string
id:
type: integer
format: int32
name:
type: string
occurrenceCount:
type: integer
format: int32
recommendedAction:
type: string
serviceAffect:
type: boolean
severity:
type: string
source:
type: string
timeOccurredInMills:
type: integer
format: int32
type:
type: string
typeId:
type: integer
format: int32
GmsAlarmAcknowledgementBody:
title: GmsAlarmAcknowledgementBody
required:
- acknowledge
- ids
type: object
properties:
acknowledge:
type: boolean
description: Ack (true), Un-Ack(false)
ids:
type: array
items:
type: integer
format: int32
description: Orchestrator alarm IDs
GmsAlarmClearanceBody:
title: GmsAlarmClearanceBody
required:
- ids
type: object
properties:
ids:
type: array
items:
type: integer
format: int32
description: Orchestrator alarm IDs
GmsBackupConfigObject:
title: GmsBackupConfigObject
required:
- directory
- hostname
- maxBackups
- password
- port
- protocol
- username
type: object
properties:
directory:
type: string
description: The directory of the remote server
hostname:
type: string
description: The hostname of the remote server
maxBackups:
type: integer
description: The number of the backup files in the directory
format: int32
example: 10
password:
type: string
description: The password of the remote server
port:
type: integer
description: The port of the remote server
format: int32
example: 21
protocol:
type: integer
description: The protocol of the remote server
format: int32
example: 2
username:
type: string
description: The username of the remote server
GmsBackupResponseObject:
title: GmsBackupResponseObject
required:
- message
type: object
properties:
message:
type: string
description: Return schedule orchestrator backup successful message.
GmsBriefInfo:
title: GmsBriefInfo
type: object
properties:
hostName:
type: string
description: host name of the orchestrator server
ip:
type: string
description: IP address of the GSM
time:
type: string
description: current time
uptime:
type: string
description: Duration since the server is up
version:
type: string
description: Current GSM version
GmsConfigCreation:
title: GmsConfigCreation
required:
- configData
- resourceBase
type: object
properties:
configData:
type: object
description: could be any type of json object/array
resourceBase:
type: string
description: name of the main resource
resourceKey:
type: string
description: name of the sub-resource. this is optional
GmsConfigItem:
title: GmsConfigItem
required:
- configData
- resourceBase
- resourceKey
- version
type: object
properties:
configData:
type: object
description: could be any type of json object/array
resourceBase:
type: string
description: name of the main resource
resourceKey:
type: string
description: name of the sub-resource. this is optional, so if the sub-resource is not available, it will be null
version:
type: integer
description: current version of the Orchestrator config resource, gets incremented with updates
format: int32
GmsConfigUpdate:
title: GmsConfigUpdate
required:
- configData
- version
type: object
properties:
configData:
type: object
description: could be any type of json object/array
version:
type: integer
description: version of the orchestrator config resource, gets incremented with updates
format: int32
GmsPingInfo:
title: GmsPingInfo
type: object
properties:
hostName:
type: string
description: host name of the orchestrator server
message:
type: string
description: status message of Server
time:
type: integer
description: time
format: int32
timeStr:
type: string
description: timeStr
uptime:
type: string
description: Duration since the server is up
version:
type: string
description: Current GSM version
GmsRemoteAuthGet:
title: GmsRemoteAuthGet
required:
- authOrder
- authOrderStr
- netReadPrivilege
- netReadWritePrivilege
- primaryHost
- primaryPort
- primaryRadiusKey
- protocol
- protocolStr
- radiusType
- secondaryHost
- secondaryPort
- secondaryRadiusKey
- type
type: object
properties:
authOrder:
type: integer
description: Need description here
format: int32
authOrderStr:
type: string
description: Need description here
netReadPrivilege:
type: integer
description: Need description here
format: int32
netReadWritePrivilege:
type: integer
description: Need description here
format: int32
primaryHost:
type: string
description: Need description here
primaryPort:
type: string
description: Need description here
primaryRadiusKey:
type: string
description: Need description here
protocol:
type: integer
description: Need description here
format: int32
protocolStr:
type: string
description: Need description here
radiusType:
type: string
description: Need description here
secondaryHost:
type: string
description: Need description here
secondaryPort:
type: string
description: Need description here
secondaryRadiusKey:
type: string
description: Need description here
type:
type: string
description: Need description here
GmsRemoteAuthPost:
title: GmsRemoteAuthPost
required:
- authOrderStr
- authenticationOrder
- hasChanges
- hasError
- netReadPrivilege
- netReadWritePrivilege
- primaryHost
- primaryPort
- primaryRadiusKey
- privileges
- protocolStr
- radiusAuth
- radiusType
- secondaryHost
- secondaryPort
- secondaryRadiusKey
- tacascAuth
- type
type: object
properties:
authOrderStr:
type: string
description: Need description here
authenticationOrder:
type: array
items:
type: string
description: 'Consists of the following items : ["Local first", "Remote first"]'
hasChanges:
type: boolean
description: Need description here
hasError:
type: boolean
description: Need description here
netReadPrivilege:
allOf:
- $ref: '#/components/schemas/NetReadPrivilege'
- description: Need description here
example: 0
netReadWritePrivilege:
allOf:
- $ref: '#/components/schemas/NetReadWritePrivilege'
- description: Need description here
example: 0
primaryHost:
type: string
description: Need description here
primaryPort:
type: string
description: Need description here
primaryRadiusKey:
type: string
description: Need description here
privileges:
type: array
items:
type: integer
format: int32
description: 'Consists of the following items : [0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15]'
protocolStr:
type: string
description: Need description here
example: Local
radiusAuth:
type: array
items:
type: string
description: 'Consists of the following items : ["CHAP","PAP","MSCHAP","MSCHAPv2","EAP-MSCHAPv2"]'
radiusType:
type: string
description: Need description here
secondaryHost:
type: string
description: Need description here
secondaryPort:
type: string
description: Need description here
secondaryRadiusKey:
type: string
description: Need description here
tacascAuth:
type: array
items:
type: string
description: 'Consists of the following items : ["CHAP","PAP","MSCHAP"]'
type:
type: string
description: Need description here
GmsServerInfo:
title: GmsServerInfo
type: object
properties:
host:
type: string
description: orchestrator host IP number
domain:
type: string
description: Orchestrator domain name
freeDiskSpace:
type: string
description: Remaining disk Memory
hostName:
type: string
description: host name of the orchestrator server
hwRev:
type: string
description: hwRev
inContainerMode:
type: boolean
description: container mode
loadAverage:
type: integer
description: loadAverage
format: int32
memSize:
type: integer
description: Total memory of the server
format: int32
model:
type: string
description: Orchestrator server model number
numActiveUsers:
type: integer
description: number of active user accessing the Orchestrator
format: int32
numCpus:
type: integer
description: Number of CPUs
format: int32
osRev:
type: string
description: Operating System Version
release:
type: string
description: orchestrator release version
role:
type: integer
description: role
format: int32
serialNumber:
type: string
description: orchestrator server serialNumber
time:
type: integer
description: time
format: int32
uptime:
type: string
description: uptime
usedDiskSpace:
type: string
description: Total disk Memory used so far
Group:
title: Group
required:
- backgroundImage
- id
- name
- parentId
- subType
type: object
properties:
backgroundImage:
type: string
description: image filename
id:
type: string
description: Group primary key, like '10.Network'
name:
type: string
description: Unique name given to a group
parentId:
type: string
description: Primary key of parent group. If this group has no parent, the value will be null
subType:
type: integer
description: 'Network sub type: Root Group(0), Auto discovered group(2), User defined group(3)'
format: int32
GroupIdObject:
title: GroupIdObject
required:
- id
type: object
properties:
id:
type: string
description: The Orchestrator Group ID to add the appliance to.
latitude:
type: number
description: Optional - the latitude of the coordinates of the appliance's address
longitude:
type: number
description: Optional - the longitude of the coordinates of the appliance's address
GroupNewPostBody:
title: GroupNewPostBody
required:
- name
- parentId
type: object
properties:
backgroundImage:
type: string
description: image filename
name:
type: string
description: Unique group name
parentId:
type: string
description: Primary key of parent group. Like '10.Network'
GroupUpdatePostBody:
title: GroupUpdatePostBody
required:
- id
- name
type: object
properties:
backgroundImage:
type: string
description: Optional image filename
id:
type: string
description: Primarky key. Like '10.Network'
name:
type: string
description: Unique group name
HaAppliance:
title: HaAppliance
required:
- nePk
type: object
properties:
nePk:
type: string
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
description: Properties of appliances which are paired in a HA configuration
HaGroup:
title: HaGroup
required:
- appliances
- mask
- subnet
- vlanStart
type: object
properties:
appliances:
type: array
items:
$ref: '#/components/schemas/HaAppliance'
description: Appliance pair
mask:
type: number
description: Mask value to be assigned to internal HA VLAN interfaces. This value will be used to carve out smaller ip blocks from above larger subnet, default is 30
subnet:
type: string
description: Subnet to be used to allocate IPs to internal HA VLAN interfaces, default is 169.254.1.0/24.
vlanStart:
type: number
description: Starting VLAN id value to be assigned to internal HA VLAN interfaces. Will increment by 1 for multiple VLAN interfaces, default start value is 100
HaGroups:
title: HaGroups
type: object
properties:
:
$ref: '#/components/schemas/HaGroup'
HealthSummaryGetPostBody:
title: HealthSummaryGetPostBody
required:
- applianceIds
- from
- overlayId
- to
- verticals
type: object
properties:
applianceIds:
type: array
items:
type: string
description: Contains appliance IDs
from:
type: integer
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range
format: int32
overlayId:
type: integer
description: Overlay id. -1 == all overlays
format: int32
to:
type: integer
description: Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range
format: int32
verticals:
type: array
items:
type: string
description: Contains vertical IDs
HealthSummaryResp:
title: HealthSummaryResp
required:
- appliance-id
type: object
properties:
appliance-id:
type: array
items:
$ref: '#/components/schemas/appliance-Item1'
description: ''
HistoricalJobItem:
title: HistoricalJobItem
required:
- assocId
- config
- description
- endTime
- id
- jobCategory
- jobType
- startTime
- status
- statusText
- targetAppliance
type: object
properties:
assocId:
type: integer
description: Every job is related to one scheduled job identified using this primary key
format: int32
config:
type: string
description: Job configuration
description:
type: string
description: Job description
endTime:
type: integer
description: Time when job ended
format: int32
id:
type: integer
description: Every job is uniquely identified using this primary key
format: int32
jobCategory:
type: string
description: Identifies the type of job. 1=TestJob, 2=Orchestrator Report, 3=Orchestrator Backup, 4 - Appliance Reboot/Shutdown, 5 = Appliance QOS Scheduling
jobType:
type: integer
description: 1=User defined job and 2=System job
format: int32
startTime:
type: integer
description: Time when job started
format: int32
status:
type: integer
description: 1-Started, 2-Success, 3 - Failed
format: int32
statusText:
type: integer
description: Job Status summary
format: int32
targetAppliance:
$ref: '#/components/schemas/targetAppliance'
description: The detail historical job information for one item.
HostName:
title: HostName
type: object
properties:
gms_hostname:
type: string
description: HostName of Orchestrator
HubInternetPolicies:
title: HubInternetPolicies
type: object
properties:
:
$ref: '#/components/schemas/HubInternetPolicy'
HubInternetPolicy:
title: HubInternetPolicy
type: object
properties:
internetPolicy:
$ref: '#/components/schemas/InternetPolicy'
IkelessSeedStatusForAppliance:
title: IkelessSeedStatusForAppliance
type: object
properties:
activationStatus:
type: boolean
description: If the key is active
arbitrary:
type: integer
description: arbitrary id for key for debugging
format: int32
hasCurrentSeed:
type: boolean
description: If the appliance has the current key
IkelessSeedStatusGetAll:
title: IkelessSeedStatusGetAll
type: object
properties:
:
$ref: '#/components/schemas/IkelessSeedStatusForAppliance'
ImageItem:
title: ImageItem
required:
- NxImage.buildDate
- NxImage.fileName
- NxImage.version
type: object
properties:
NxImage.buildDate:
type: string
description: image build date time
NxImage.fileName:
type: string
description: image filename
NxImage.version:
type: string
description: image version
InstBNameData:
title: InstBNameData
required:
-
type: object
properties:
:
$ref: '#/components/schemas/InstBNameObject'
InstBNameObject:
title: InstBNameObject
required:
- descr
- name
- self
type: object
properties:
descr:
type: string
description: Need description here
name:
type: string
description: Need description here
self:
type: integer
description: The value should be a number and equal with its parent node key(a number from 1 to 1000)
format: int32
Interface:
title: Interface
type: object
properties:
adminStatus:
type: boolean
description: To set admin up or down
area:
type: string
description: area of the ospf interface in doted decimal format
authKey:
type: string
description: key for plain text authentication. Should only use either of plain text or md5 authentication
authType:
type: string
description: Type of the authentication. Allowed values are 'Text ot 'MD5'
comment:
type: string
description: comments
cost:
type: integer
description: cost of the ospf interface
format: int32
deadInterval:
type: integer
description: To set the interval(in Seconds) during which at least one hello packet must be received from a neighbor before the router declares that neighbor as down
format: int32
helloInterval:
type: integer
description: To specify the interval(in Seconds) between hello packets that OSPF sends on the interface.
format: int32
md5Key:
type: integer
description: key for md5 authentication. Should only use either of plain text or md5 authentication
format: int32
md5Password:
type: string
description: password for md5 authentication. Should only use either of plain text or md5 authentication
priority:
type: integer
description: priority of the ospf interface
format: int32
InterfaceAggregateStats:
title: InterfaceAggregateStats
type: object
properties:
HOSTNAME:
type: string
INTERFACE:
type: string
IP:
type: string
MAX_FWDROPS_RX_BYTES_MAX:
type: integer
format: int32
MAX_FWDROPS_RX_PKTS_MAX:
type: integer
format: int32
MAX_FWDROPS_TX_BYTES_MAX:
type: integer
format: int32
MAX_FWDROPS_TX_PKTS_MAX:
type: integer
format: int32
MAX_OHEAD_RX_BYTES_MAX:
type: integer
format: int32
MAX_OHEAD_RX_PKTS_MAX:
type: integer
format: int32
MAX_OHEAD_TX_BYTES_MAX:
type: integer
format: int32
MAX_OHEAD_TX_PKTS_MAX:
type: integer
format: int32
MAX_RX_BYTES_MAX:
type: integer
format: int32
MAX_RX_PKTS_MAX:
type: integer
format: int32
MAX_TIMESTAMP:
type: integer
format: int32
MAX_TX_BYTES_MAX:
type: integer
format: int32
MAX_TX_PKTS_MAX:
type: integer
format: int32
MIN_TIMESTAMP:
type: integer
format: int32
SUM_FWDROPS_RX_BYTES:
type: integer
format: int32
SUM_FWDROPS_RX_PKTS:
type: integer
format: int32
SUM_FWDROPS_TX_BYTES:
type: integer
format: int32
SUM_FWDROPS_TX_PKTS:
type: integer
format: int32
SUM_OHEAD_RX_BYTES:
type: integer
format: int32
SUM_OHEAD_RX_PKTS:
type: integer
format: int32
SUM_OHEAD_TX_BYTES:
type: integer
format: int32
SUM_OHEAD_TX_PKTS:
type: integer
format: int32
SUM_RX_BYTES:
type: integer
format: int32
SUM_RX_PKTS:
type: integer
format: int32
SUM_TX_BYTES:
type: integer
format: int32
SUM_TX_PKTS:
type: integer
format: int32
TRAFFIC_TYPE:
type: integer
format: int32
nePk:
type: string
InterfaceLabel:
title: InterfaceLabel
type: object
properties:
active:
type: boolean
description: Whether or not the label is 'active'/deleted
name:
type: string
description: The name of the label
topology:
type: integer
description: Allowed topology for building tunnels
format: int32
InterfaceLabels:
title: InterfaceLabels
type: object
properties:
lan:
type: object
additionalProperties:
$ref: '#/components/schemas/InterfaceLabel'
wan:
type: object
additionalProperties:
$ref: '#/components/schemas/InterfaceLabel'
InterfaceOverlayAggregateStats:
title: InterfaceOverlayAggregateStats
type: object
properties:
INTERFACE:
type: string
ISWANSIDE:
type: boolean
LABELID:
type: integer
format: int32
LABELNAME:
type: string
MAX_OHEAD_RX_BYTES_MAX:
type: integer
format: int32
MAX_OHEAD_RX_PKTS_MAX:
type: integer
format: int32
MAX_OHEAD_TX_BYTES_MAX:
type: integer
format: int32
MAX_OHEAD_TX_PKTS_MAX:
type: integer
format: int32
MAX_RX_BYTES_MAX:
type: integer
format: int32
MAX_RX_PKTS_MAX:
type: integer
format: int32
MAX_TIMESTAMP:
type: integer
format: int32
MAX_TX_BYTES_MAX:
type: integer
format: int32
MAX_TX_PKTS_MAX:
type: integer
format: int32
MIN_TIMESTAMP:
type: integer
format: int32
OVERLAY_ID:
type: integer
format: int32
SUM_OHEAD_RX_BYTES:
type: integer
format: int32
SUM_OHEAD_RX_PKTS:
type: integer
format: int32
SUM_OHEAD_TX_BYTES:
type: integer
format: int32
SUM_OHEAD_TX_PKTS:
type: integer
format: int32
SUM_RX_BYTES:
type: integer
format: int32
SUM_RX_PKTS:
type: integer
format: int32
SUM_TX_BYTES:
type: integer
format: int32
SUM_TX_PKTS:
type: integer
format: int32
TUNNEL_TYPE:
type: integer
format: int32
InterfaceOverlayTimeSeriesStats:
title: InterfaceOverlayTimeSeriesStats
type: object
properties:
INTERFACE:
type: string
description: Interface name
ISWANSIDE:
type: boolean
description: Boolean value to get wan/lan data
LABELID:
type: integer
description: Label internal id
format: int32
LABELNAME:
type: string
description: Label name
MAX_BW_RX:
type: integer
description: Max received bandwidth
format: int32
MAX_BW_TX:
type: integer
description: Max transmit bandwidth
format: int32
OHEAD_RX_BYTES:
type: integer
description: Received overhead bandwidth
format: int32
OHEAD_RX_BYTES_MAX:
type: integer
description: Max received overhead bandwidth
format: int32
OHEAD_RX_PKTS:
type: integer
description: Received overhead packets
format: int32
OHEAD_RX_PKTS_MAX:
type: integer
description: Max received overhead packets
format: int32
OHEAD_TX_BYTES:
type: integer
description: Transmitted overhead bandwidth
format: int32
OHEAD_TX_BYTES_MAX:
type: integer
description: Max Transmit overhead bandwidth
format: int32
OHEAD_TX_PKTS:
type: integer
description: Transmit overhead packets
format: int32
OHEAD_TX_PKTS_MAX:
type: integer
description: Max transmit overhead packets
format: int32
OVERLAY_ID:
type: integer
description: Overlay id
format: int32
RX_BYTES:
type: string
description: Number of bytes received
RX_BYTES_MAX:
type: integer
description: Peak number of bytes received in one second
format: int32
RX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes received
format: int32
RX_PKTS:
type: integer
description: Number of packets received
format: int32
RX_PKTS_MAX:
type: integer
description: Peak number of packets received in one second
format: int32
RX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets received
format: int32
TIMESTAMP:
type: integer
description: Timestamp in EPOCH time, all timestamp fields are in EPOCH time
format: int32
TUNNEL_TYPE:
type: integer
description: Tunnel type like sliver-peak, non silver-peak, pass through
format: int32
TX_BYTES:
type: integer
description: Number of bytes transmitted
format: int32
TX_BYTES_MAX:
type: integer
description: Peak number of bytes transmitted in one second
format: int32
TX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes transmitted
format: int32
TX_PKTS:
type: integer
description: Number of packets transmitted
format: int32
TX_PKTS_MAX:
type: integer
description: Peak number of packets transmitted in one second
format: int32
TX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets transmitted
format: int32
InterfacePropertiesObj:
title: InterfacePropertiesObj
type: object
properties:
behindNAT:
type: boolean
description: Whether this interface is connected to a NAT device
dhcp:
type: boolean
description: Whether DHCP is enabled on this interface
harden:
type: boolean
description: Whether this interface is hardened
inboundBandwidth:
type: number
description: Inbound Shaping kbps value, 0 if not configured
ipAddress:
type: string
description: Interface IP Address
ipv4:
type: boolean
description: Whether interface IP address is IP version 4
label:
type: string
description: Interface label id. Empty string if no label configured for this interface
lanSide:
type: boolean
description: Whether this interface has lanSide tag (applicable for inline router mode only)
mask:
type: number
description: Interface Subnet Mask
name:
type: string
description: Interface name
outboundBandwidth:
type: number
description: Outbound Shaping kbps value, 0 if not configured
parentInterfaceName:
type: string
publicIPv4:
type: boolean
description: Whether interface public IP addres is IP version 4
publicIpAddress:
type: string
description: Resolved Public IP Address of this interface. Empty string if nothing resolved
subInterface:
type: number
description: Sub interface id, 0 if not a sub interface
vlan:
type: number
description: VLAN id, 0 if not a VLAN
wanNextHop:
type: string
description: IP Address of WAN gateway. 0.0.0.0 if not configured
wanSide:
type: boolean
description: Whether this interface has wanSide tag (appliacable for inline router mode only)
InterfaceTimeSeriesStats:
title: InterfaceTimeSeriesStats
type: object
properties:
fwdrops_rx_bytes:
type: integer
format: int32
fwdrops_rx_bytes_max:
type: integer
format: int32
fwdrops_rx_bytes_max_ts:
type: integer
format: int32
fwdrops_rx_pkts:
type: integer
format: int32
fwdrops_rx_pkts_max:
type: integer
format: int32
fwdrops_rx_pkts_max_ts:
type: integer
format: int32
fwdrops_tx_bytes:
type: integer
format: int32
fwdrops_tx_bytes_max:
type: integer
format: int32
fwdrops_tx_bytes_max_ts:
type: integer
format: int32
fwdrops_tx_pkts:
type: integer
format: int32
fwdrops_tx_pkts_max:
type: integer
format: int32
fwdrops_tx_pkts_max_ts:
type: integer
format: int32
interfaceName:
type: string
max_bw_rx:
type: integer
format: int32
max_bw_tx:
type: integer
format: int32
ohead_rx_bytes:
type: integer
format: int32
ohead_rx_bytes_max:
type: integer
format: int32
ohead_rx_bytes_max_ts:
type: integer
format: int32
ohead_rx_pkts:
type: integer
format: int32
ohead_rx_pkts_max:
type: integer
format: int32
ohead_rx_pkts_max_ts:
type: integer
format: int32
ohead_tx_bytes:
type: integer
format: int32
ohead_tx_bytes_max:
type: integer
format: int32
ohead_tx_bytes_max_ts:
type: integer
format: int32
ohead_tx_pkts:
type: integer
format: int32
ohead_tx_pkts_max:
type: integer
format: int32
ohead_tx_pkts_max_ts:
type: integer
format: int32
rx_bytes:
type: integer
format: int32
rx_bytes_max:
type: integer
format: int32
rx_bytes_max_ts:
type: integer
format: int32
rx_pkts:
type: integer
format: int32
rx_pkts_max:
type: integer
format: int32
rx_pkts_max_ts:
type: integer
format: int32
timestamp:
type: integer
format: int32
trafficType:
type: integer
format: int32
tx_bytes:
type: integer
format: int32
tx_bytes_max:
type: integer
format: int32
tx_bytes_max_ts:
type: integer
format: int32
tx_pkts:
type: integer
format: int32
tx_pkts_max:
type: integer
format: int32
tx_pkts_max_ts:
type: integer
format: int32
Interfaces:
title: Interfaces
type: object
properties:
:
$ref: '#/components/schemas/Interface'
NameOfTheInterface2>:
$ref: '#/components/schemas/Interface'
InternalDropsTimeSeriesStats:
title: InternalDropsTimeSeriesStats
type: object
properties:
data:
$ref: '#/components/schemas/InternalDropsTimeSeriesStatsData'
InternalDropsTimeSeriesStatsData:
title: InternalDropsTimeSeriesStatsData
type: object
properties:
:
type: array
items:
type: array
items:
type: object
InternalSubnetsApiObject:
title: InternalSubnetsApiObject
type: object
properties:
ipv4:
type: array
items:
type: string
description: ''
ipv6:
type: array
items:
type: string
description: ''
nonDefaultRoutes:
type: boolean
InternetPolicy:
title: InternetPolicy
type: object
properties:
localBreakout:
$ref: '#/components/schemas/LocalBreakout'
policyList:
type: array
items:
type: string
description: An array of the different internet policies, in the order of priority. This could be one of the standard options, or a pass through tunnel name to send the internet traffic on. See API notes for more details.
IpIntelTmpObj:
title: IpIntelTmpObj
type: object
properties:
country:
type: string
country_code:
type: string
description:
type: string
ip_end:
type: integer
description: Ending IPv4 address in 32-bit integer format
format: int64
ip_start:
type: integer
description: Starting IPv4 address in 32-bit integer format
format: int64
name:
type: string
org:
type: string
priority:
type: integer
format: int32
saas_id:
type: integer
description: Saas id
format: int32
search:
type: string
service_id:
type: integer
description: Service id
format: int32
IpWhitelistDrop:
title: IpWhitelistDrop
required:
- ip
- lastContact
- resource
- xForwardedFor
type: object
properties:
ip:
type: string
description: The source IP address of the dropped request on this server
lastContact:
type: integer
description: The epoch time in milliseconds when the request was dropped
format: int32
resource:
type: string
description: The dropped request's url path
xForwardedFor:
type: string
description: The X-Forwarded-For attribute of the dropped request on this server
Ipv4:
title: Ipv4
type: object
properties:
:
$ref: '#/components/schemas/One_subnet'
JitterAggregateStatsBase:
title: JitterAggregateStatsBase
required:
- AVG_JITTER
- HOSTNAME
- IP
- MAX_JITTER
- MAX_TIMESTAMP
- MIN_TIMESTAMP
- TUNNEL
- nePk
type: object
properties:
AVG_JITTER:
type: integer
description: Average jitter
format: int32
HOSTNAME:
type: string
description: Hostname of the appliance
IP:
type: string
description: Management IP address of appliance
MAX_JITTER:
type: integer
description: Maximum jitter
format: int32
MAX_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual starting boundary of data time range
format: int32
MIN_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual ending boundary of data time range
format: int32
TUNNEL:
type: string
description: Name of the tunnel
nePk:
type: string
description: Internal ID of appliance
JitterPeriodSummary:
title: JitterPeriodSummary
required:
- criticalMins
- healthStatus
- majorMins
- max
- normalMins
- tunnelId
type: object
properties:
criticalMins:
type: integer
description: Total critical loss minutes
format: int32
healthStatus:
allOf:
- $ref: '#/components/schemas/HealthStatus'
- description: health status
majorMins:
type: integer
description: Total major loss minutes
format: int32
max:
type: integer
description: Max jitter
format: int32
normalMins:
type: integer
description: Total normal minutes
format: int32
tunnelId:
type: string
description: Tunnel on which latency occurred
KPTState:
title: KPTState
required:
- cur_fec_enable
- cur_fec_reset_intvl
type: object
properties:
cur_fec_enable:
type: string
description: Need description here
cur_fec_reset_intvl:
type: string
description: Need description here
LabelDetails:
title: LabelDetails
required:
- ipOrDns
- labelId
type: object
properties:
ipOrDns:
type: string
description: IP or DNS
labelId:
type: integer
description: label Id
format: int32
LatencyPeriodSummary:
title: LatencyPeriodSummary
required:
- criticalMins
- healthStatus
- majorMins
- max
- normalMins
- tunnelId
type: object
properties:
criticalMins:
type: integer
description: Total critical loss minutes
format: int32
healthStatus:
allOf:
- $ref: '#/components/schemas/HealthStatus'
- description: health status
majorMins:
type: integer
description: Total major loss minutes
format: int32
max:
type: integer
description: Max latency
format: int32
normalMins:
type: integer
description: Total normal minutes
format: int32
tunnelId:
type: string
description: Tunnel on which latency occurred
LicenseInfoByGet:
title: LicenseInfoByGet
required:
- availableAppliances
- code
- daysToExpiration
- expirationDate
- licenseKey
- maxAppliances
- message
- serialNumber
- usedAppliances
type: object
properties:
availableAppliances:
type: integer
description: count of available appliances
format: int32
code:
type: integer
description: If license key decryption fails it returns -1 otherwise it returns 0
format: int32
daysToExpiration:
type: integer
description: Number of days left for the license to expire
format: int32
expirationDate:
type: string
description: date of expiry - epoch time in milliseconds
licenseKey:
type: string
description: license key
maxAppliances:
type: integer
description: total Appliances allowed for this license
format: int32
message:
type: string
description: message
serialNumber:
type: string
description: serialNumber
usedAppliances:
type: integer
description: count of used Appliances
format: int32
LicenseInfoByPost:
title: LicenseInfoByPost
required:
- availableAppliances
- code
- daysToExpiration
- expirationDate
- licenseKey
- maxAppliances
- message
- rc
- serialNumber
- usedAppliances
type: object
properties:
availableAppliances:
type: integer
description: count of available appliances
format: int32
code:
type: integer
description: If license key decryption fails it returns -1 otherwise it returns 0
format: int32
daysToExpiration:
type: integer
description: Number of days left for the license to expire
format: int32
expirationDate:
type: string
description: date of expiry - epoch time in milliseconds
licenseKey:
type: string
description: license key
maxAppliances:
type: integer
description: total Appliances allowed for this license
format: int32
message:
type: string
description: message
rc:
type: integer
description: value is set to -1 if any exception occurs during license key validation
format: int32
serialNumber:
type: string
description: serialNumber
usedAppliances:
type: integer
description: count of used Appliances
format: int32
LicenseInfoByValidate:
title: LicenseInfoByValidate
required:
- code
- licenseKey
- maxAppliances
- message
- serialNumber
type: object
properties:
code:
type: integer
description: If license key decryption fails it returns -1 otherwise it returns 0
format: int32
licenseKey:
type: string
description: license key
maxAppliances:
type: integer
description: total Appliances allowed for this license
format: int32
message:
type: string
description: message
serialNumber:
type: string
description: serialNumber
LicenseKey:
title: LicenseKey
required:
- licenseKey
type: object
properties:
licenseKey:
type: string
description: new license key value
LinkIntegrityStatus:
title: LinkIntegrityStatus
required:
- active
- result
type: object
properties:
active:
type: boolean
description: Boolean value indicating whether link integrity test is running
result:
type: string
description: Console output of current link integrity test
LinkIntegrityTestAppliance:
title: LinkIntegrityTestAppliance
required:
- bandwidth
- nePk
- path
type: object
properties:
bandwidth:
type: string
description: Data transfer rate to try to use from this appliance.
nePk:
type: string
description: Internal ID of the appliance. Use /appliance rest api to fetch the IDs. They look like 1.NE, 2.NE etc.,
path:
type: string
description: Path setups for link integrity test. Path could be either 'pass-through', 'pass-through-unshaped' or '{tunnelID}'. Fetch the tunnelIDs using tunnels rest apis. They typically look like tunnel_1, tunnel_2 etc.,
LinkIntegrityTestRun:
title: LinkIntegrityTestRun
required:
- DSCP
- duration
- testProgram
type: object
properties:
DSCP:
type: string
description: DSCP setup for link integrity test. If you don't want to specify a DSCP value, put 'any'.
appA:
$ref: '#/components/schemas/LinkIntegrityTestAppliance'
appB:
$ref: '#/components/schemas/LinkIntegrityTestAppliance'
duration:
type: string
description: Duration of the run for each side. Unit is second.
testProgram:
type: string
description: Test program desired for link integrity test. Currently we support 'iperf' and 'tcpperf'.
LinkIntegrityTestTunnelEndPoint:
title: LinkIntegrityTestTunnelEndPoint
required:
- localIP
- mgmtIP
- name
- remoteIP
type: object
properties:
localIP:
type: string
description: Tunnel local IP
mgmtIP:
type: string
description: Management IP of appliance of this tunnel.
name:
type: string
description: Tunnel name
remoteIP:
type: string
description: Tunnel remote IP
LocalBreakout:
title: LocalBreakout
type: object
properties:
backup:
type: array
items:
type: string
description: The backup WAN interface label IDs to be used to break internet traffic out locally (The traffic will be sent out on the passthrough tunnel for that label id for each overlay)
primary:
type: array
items:
type: string
description: An array of the WAN interface label IDs to be used to break internet traffic out locally (The traffic will be sent out on the passthrough tunnel for that label id for each overlay)
Location:
title: Location
type: object
properties:
address:
type: string
description: The first address line of the location address.
address2:
type: string
description: The second address line of the location address.
city:
type: string
description: The name of the city of the location
country:
type: string
state:
type: string
description: The state abbreviation if the location is in the United States
zipCode:
type: string
LocationObject:
title: LocationObject
type: object
properties:
address_components:
type: array
items:
$ref: '#/components/schemas/AddressComponent'
description: ''
formatted_address:
type: string
description: The formatted address string
geometry:
$ref: '#/components/schemas/Geometry'
place_id:
type: string
types:
type: array
items:
type: string
description: The type of address found
LocationSecuritySetting:
title: LocationSecuritySetting
type: object
properties:
authRequired:
type: boolean
ofwEnabled:
type: boolean
sslScanEnabled:
type: boolean
xffForwardEnabled:
type: boolean
LoggingSettings:
title: LoggingSettings
required:
- config
- remote
type: object
properties:
config:
$ref: '#/components/schemas/ConfigObj'
remote:
$ref: '#/components/schemas/RemoteObj'
Login:
title: Login
required:
- password
- user
type: object
properties:
password:
type: string
description: Password
token:
type: string
description: 2-factor code, it is optional if you are not using 2-factor for the user
user:
type: string
description: User id
LoginStatus:
title: LoginStatus
required:
- isLoggedIn
- user
type: object
properties:
isLoggedIn:
type: string
description: True if the current HTTP session is authenticated
user:
type: string
description: Current user for the HTTP session
LoginToken:
title: LoginToken
required:
- password
- user
type: object
properties:
password:
type: string
description: Password
user:
type: string
description: User id
LossPeriodSummary:
title: LossPeriodSummary
required:
- criticalMins
- healthStatus
- majorMins
- maxLossPercentage
- normalMins
- tunnelId
type: object
properties:
criticalMins:
type: integer
description: Total critical loss minutes
format: int32
healthStatus:
allOf:
- $ref: '#/components/schemas/HealthStatus'
- description: health status
majorMins:
type: integer
description: Total major loss minutes
format: int32
maxLossPercentage:
type: number
description: Max loss percentage
normalMins:
type: integer
description: Total normal minutes
format: int32
tunnelId:
type: string
description: Tunnel on which loss occurred
MaintenanceModeData:
title: MaintenanceModeData
required:
- pauseOrchestration
- suppressAlarm
type: object
properties:
pauseOrchestration:
type: array
items:
type: string
description: NePk list whose orchestrations are or would be paused
suppressAlarm:
type: array
items:
type: string
description: NePk list whose alarms are or would be disabled
MaintenanceModePostBody:
title: MaintenanceModePostBody
required:
- action
- data
type: object
properties:
action:
type: string
description: Take 'add' or 'remove' as values, which means add appliances identified by nePk list into pause orchestration and/or suppress alarm lists, or remove them from the lists
data:
$ref: '#/components/schemas/MaintenanceModeData'
MapEntryObject:
title: MapEntryObject
type: object
properties:
action:
$ref: '#/components/schemas/ActionObject'
comment:
type: string
description: comment of the map entry
matchCriteria:
$ref: '#/components/schemas/MatchCriteriaObject'
priority:
type: string
description: integer value of the rule priority
MapSave:
title: MapSave
type: object
properties:
image:
type: string
description: Background image name
Maps:
title: Maps
type: object
properties:
map1:
$ref: '#/components/schemas/MapsObj'
MapsObj:
title: MapsObj
type: object
properties:
prio:
$ref: '#/components/schemas/PrioObj'
MataDataObject:
title: MataDataObject
type: object
properties:
customValue:
type: string
description: "User changed value. Note: The data type 'string' may vary based on the property. It can be either of integer,boolean or string"
defaultValue:
type: string
description: "The initial default value. Note: The data type 'string' may vary based on the property. It can be either of integer,boolean or string"
isRestartRequired:
type: boolean
description: Flag indicate whether to restart GMS or not to affect the property value change in the application
MatchCriteriaObject:
title: MatchCriteriaObject
type: object
properties:
application:
type: string
description: Application Name
bind_to_device_traffic:
type: string
description: Bind to device traffic
dst_ip:
type: string
description: The destination IP to match on
dst_port:
type: string
description: The destination port to match on.
protocol:
allOf:
- $ref: '#/components/schemas/Protocol'
- description: Name of protocol or protocol number in the IP header
src_ip:
type: string
description: The source IP to match on
src_port:
type: string
description: The source port to match on.
MaxOverlaysResponse:
title: MaxOverlaysResponse
type: object
properties:
max:
type: number
description: The max number of overlays you are allowed to have on this orchestrator
MenuMap:
title: MenuMap
required:
- net_read
- net_read_write
type: object
properties:
net_read:
type: array
items:
type: string
description: ''
net_read_write:
type: array
items:
type: string
description: ''
description: Effective role features.
MeterFlowObj:
title: MeterFlowObj
type: object
properties:
mid:
type: integer
format: int32
name:
type: string
priority:
type: integer
format: int32
MeteredSummary:
title: MeteredSummary
required:
- enable
- expire
type: object
properties:
enable:
type: boolean
expire:
type: integer
format: int32
MgmInterfaceInfoDefault:
title: MgmInterfaceInfoDefault
required:
- defaultIPOrDns
type: object
properties:
defaultIPOrDns:
type: string
description: default IP or dns
label:
type: object
additionalProperties:
$ref: '#/components/schemas/LabelDetails'
MgmInterfaceInfoDefault2:
title: MgmInterfaceInfoDefault2
required:
- customDefaultIP
- internalManagementIP
type: object
properties:
customDefaultIP:
type: string
description: The user set default domain or IP to send to appliances
internalManagementIP:
type: string
description: The Orchestrator's management IP
label:
type: object
additionalProperties:
$ref: '#/components/schemas/LabelDetails'
MgmInterfaceInfoDefault2Post:
title: MgmInterfaceInfoDefault2Post
required:
- customDefaultIP
type: object
properties:
customDefaultIP:
type: string
description: The user set default domain or IP to send to appliances
label:
type: object
additionalProperties:
$ref: '#/components/schemas/LabelDetails'
ModuleInfo:
title: ModuleInfo
required:
- last change
- last peer index
- last time
- last tx msg count
- last tx rec count
- last tx trans
- local change
- my system id
- rx invalid msg
- rx unknown msg
- time since change
type: object
properties:
last change:
type: string
description: Need description here.
last peer index:
type: string
description: Need description here.
last time:
type: string
description: Need description here.
last tx msg count:
type: string
description: Need description here.
last tx rec count:
type: string
description: Need description here.
last tx trans:
type: string
description: Need description here.
local change:
type: string
description: Need description here.
my system id:
type: string
description: My system id.
rx invalid msg:
type: string
description: Need description here.
rx unknown msg:
type: string
description: Need description here.
time since change:
type: string
description: The seconds that have passed since last change.
MosAggregateStats:
title: MosAggregateStats
type: object
properties:
ALIAS:
type: string
description: Alias/Name of tunnel
HOSTNAME:
type: string
description: Hostname of the appliance
IP:
type: string
description: Management IP address of appliance
TUNNEL:
type: string
description: ID of the tunnel
destNePk:
type: string
description: Internal ID of remote appliance
destTunnelAlias:
type: string
description: Alias/Name of remote tunnel
destTunnelId:
type: string
description: ID of the remote tunnel
isPassThrough:
type: boolean
description: is pass through tunnel
min_mos:
type: integer
description: Minimum Mean Opinion Score
format: int32
min_mos_ts:
type: integer
description: Minimum Mean Opinion Score time stamp
format: int32
mos:
type: integer
description: Mean Opinion Score
format: int32
nePk:
type: string
description: Internal ID of appliance
MosPeriodSummary:
title: MosPeriodSummary
required:
- criticalMins
- healthStatus
- majorMins
- max
- normalMins
- tunnelId
type: object
properties:
criticalMins:
type: integer
description: Total critical MOS minutes
format: int32
healthStatus:
allOf:
- $ref: '#/components/schemas/HealthStatus'
- description: health status
majorMins:
type: integer
description: Total major MOS minutes
format: int32
max:
type: integer
description: Max MOS
format: int32
normalMins:
type: integer
description: Total normal minutes
format: int32
tunnelId:
type: string
description: Tunnel on which latency occurred
NATPool:
title: NATPool
required:
- dir
- name
- pat
- subnet
type: object
properties:
comment:
type: string
description: User comments
dir:
type: string
description: Traffic direction to perform NAT on. Valid values are ['outbound', 'inbound']
name:
type: string
description: Name of NATPool
pat:
type: number
description: Enable Port Address Translation. Valid values are 0:Disabled or 1:Enabled
subnet:
type: string
description: Pool of IPs to be used for NAT
description: Object to hold properties of a NATPool
NATPools:
title: NATPools
type: object
properties:
:
allOf:
- $ref: '#/components/schemas/NATPool'
- description: Object to hold properties of a NATPool
description: Object containing all the NATPools
NEList:
title: NEList
type: object
properties:
neList:
type: array
items:
type: string
description: The NePk list
NXLicenseItem:
title: NXLicenseItem
required:
- applianceId
- hostname
- licenseType
- model
- saasEnabled
- serialNum
type: object
properties:
applianceId:
type: string
hostname:
type: string
licenseType:
type: string
model:
type: string
saasEnabled:
type: boolean
description: Tells whether SaaS optimization is enabled on this appliance
serialNum:
type: string
NameServer:
title: NameServer
required:
- nameserver
type: object
properties:
nameserver:
type: object
additionalProperties:
$ref: '#/components/schemas/NameServerElement'
description: Details of the Name Servers
NameServerElement:
title: NameServerElement
required:
- address
- self
type: object
properties:
address:
type: string
description: IP Address of Name Server
self:
type: integer
description: Order of Name Server
format: int32
NePkToBondedTunnelsMap:
title: NePkToBondedTunnelsMap
type: object
properties:
1.NE:
$ref: '#/components/schemas/BondedTunnelsIdToTunnelMap'
2.NE:
$ref: '#/components/schemas/BondedTunnelsIdToTunnelMap'
NePkToPassThroughTunnelsMap:
title: NePkToPassThroughTunnelsMap
type: object
properties:
1.NE:
$ref: '#/components/schemas/PassThroughTunnelIdToTunnelMap'
2.NE:
$ref: '#/components/schemas/PassThroughTunnelIdToTunnelMap'
NePkToPhysicalTunnelsMap:
title: NePkToPhysicalTunnelsMap
type: object
properties:
1.NE:
$ref: '#/components/schemas/PhysicalTunnelsIdToTunnelMap'
2.NE:
$ref: '#/components/schemas/PhysicalTunnelsIdToTunnelMap'
Neighbor:
title: Neighbor
required:
- as_prepend
- export_map
- hold
- import_rtes
- in_med
- ka
- loc_pref
- med
- password
- remote_as
- self
- type
type: object
properties:
as_prepend:
type: integer
description: Count of additional times to prepend the local AS in the AS path
format: int32
enable:
type: boolean
description: flag to enable/disable neighbor bgp session
export_map:
type: integer
description: "Integer value of the 'Routes Export Policies' bitmask. Right now we have nine Route Export policies for each Peer Type namely
1) Locally configured,
2) Learned via subnet sharing,
3) Learned from a local BGP branch peer,
4) Learned from a local BGP branch-transit peer,
5)Learned from a local BGP PE router,
6)Remote BGP,
7) Remote BGP branch-transit peer, 8) Learned from a local OSPF peer,
9) Learned from a Remote OSPF peer.
These seven policies are represented with 9 binary values from right to left (1111111). We can turn on/off the policy by simple modifying respective binary value. For Example, to turn off export route policies 1 and 3 the bit map will look like 111111010. The equivalent decimal value for the bitmask is 506. So the rest API field should look like 'export_map': 506. Some of the predefined import_map values for the different Peer Types are {'Branch':511, 'Branch-transit':431 and 'PE-router':141}.By default we send a decimal value 4294967295 indicating the predefined bitmask of the Peer Type is not modified"
format: int32
hold:
type: integer
description: Time in seconds - specifies how long the device will wait for a KEEP ALIVE or UPDATE message from a neighbor before concluding that the neighbor is dead
format: int32
import_rtes:
type: boolean
description: flag to enable/disable importing routes of the neighbor
in_med:
type: integer
description: input metric of routes received from the neighbor
format: int32
ka:
type: integer
description: Time in seconds - specifies how frequently the device will send KEEP ALIVE messages to its BGP neighbors
format: int32
loc_pref:
type: integer
description: Local preference for advertised routes to the neighbor
format: int32
med:
type: integer
description: Multi-Exit Discriminator to use for advertised routes to the neighbor
format: int32
next_hop_self:
type: boolean
description: Flag to send own ip as nexthop when advertising route to others. This filed is only applicable from 8.1.9.4 or higher appliances.Remove this field before applying to older appliances.
password:
type: string
description: MD5 Password of the neighbor
remote_as:
type: integer
description: Remote Autonomous System Number of the neighbor
format: int32
self:
type: string
description: Ip address of the neighbor
type:
type: string
description: Peer Type of the neighbor
NeighborStateInfo:
title: NeighborStateInfo
type: object
properties:
neighborCount:
type: integer
description: Count of number of neighbor
format: int32
neighborState:
type: object
additionalProperties:
$ref: '#/components/schemas/neighborState'
Neighbors:
title: Neighbors
type: object
properties:
IpAddress1:
$ref: '#/components/schemas/Neighbor'
NetFlowData:
title: NetFlowData
required:
- active_timeout
- collector_type1
- collector_type2
- enable
- if_lan_rx
- if_lan_tx
- if_wan_rx
- if_wan_tx
- ipaddr1
- ipaddr2
- ipfix_tmplt_rfrsh_t
- port1
- port2
type: object
properties:
active_timeout:
type: integer
description: Specify NetFlow timeout (1..30) mins
format: int32
collector_type1:
type: string
description: NetFlow or IPFIX collector type
collector_type2:
type: string
description: NetFlow or IPFIX collector type
enable:
type: boolean
description: Need description here
if_lan_rx:
type: boolean
description: Need description here
if_lan_tx:
type: boolean
description: Need description here
if_wan_rx:
type: boolean
description: Need description here
if_wan_tx:
type: boolean
description: Need description here
ipaddr1:
type: string
description: valid ip address
ipaddr2:
type: string
description: valid ip address
ipfix_tmplt_rfrsh_t:
type: integer
description: Specify IPFIX template refresh timeout (1..1440) mins
format: int32
port1:
type: integer
description: Need description here
format: int32
port2:
type: integer
description: Need description here
format: int32
NewOverlayConfig:
title: NewOverlayConfig
type: object
properties:
bondingPolicy:
type: number
description: The number of the bonding policy for the overlay. 1 - high availability, 2 - high throughput.
boostTraffic:
type: boolean
description: Whether or not to boost the traffic for this overlay.
brownoutThresholds:
$ref: '#/components/schemas/BrownoutThreshold'
hubInternetPolicies:
$ref: '#/components/schemas/HubInternetPolicies'
internetPolicy:
$ref: '#/components/schemas/InternetPolicy'
lanDscp:
type: string
description: The LAN QoS to use in the QoS policy created for this Overlay. See the QoS policy page for valid values
match:
$ref: '#/components/schemas/OverlayMatch'
name:
type: string
description: The name of the overlay.
overlayFallbackOption:
type: string
description: The fallback option of the overlay.
topology:
$ref: '#/components/schemas/OverlayTopology'
trafficClass:
type: string
description: The shaper traffic class ID to use in the overlay. (These are the keys in the traffic class, see the shaper api for more information).
tunnelUsagePolicy:
type: string
description: The port to use when building IPSec UDP tunnels on this appliance
useBackupOnBrownout:
type: boolean
description: Use the backup WAN ports when the primary WAN ports meet the brownout conditions.
wanDscp:
type: string
description: The WAN QoS to use in the QoS policy created for this Overlay. See the QoS policy page for valid values
wanPorts:
$ref: '#/components/schemas/OverlayWanPorts'
NewTfaKeyResponse:
title: NewTfaKeyResponse
type: object
properties:
barcodeBase64Jpeg:
type: string
description: Base 64 encoded string of a jpeg for a 2D barcode.
NewTunnelGroupConfig:
title: NewTunnelGroupConfig
type: object
properties:
crossConnect:
type: boolean
description: Whether or not to cross connect the WAN ports.
name:
type: string
topology:
$ref: '#/components/schemas/OverlayTopology'
useAllAvailableInterfaces:
type: boolean
description: Use all the available interfaces found on the appliances
wanPorts:
type: array
items:
type: string
description: An array of WAN label ids to use as the primary WAN ports this overlay.
NextId:
title: NextId
required:
- nextId
type: object
properties:
nextId:
type: number
description: Zone Next Id
NotificationConfig:
title: NotificationConfig
required:
- author
- message
type: object
properties:
author:
type: string
description: the user who wrote the message
message:
type: string
description: the message of notification
NotificationGet:
title: NotificationGet
required:
- configData
- resourceBase
- resourceKey
- version
type: object
properties:
configData:
$ref: '#/components/schemas/NotificationConfig'
resourceBase:
type: string
description: name of the main resource
resourceKey:
type: string
description: name of the sub-resource.it will be null
version:
type: integer
description: current version of the Orchestrator config resource, gets incremented with updates
format: int32
NumTierSummary:
title: NumTierSummary
required:
-
type: object
properties:
:
type: integer
format: int32
OSPFInterfaceStateResp:
title: OSPFInterfaceStateResp
type: object
properties:
interfaceState:
type: array
items:
$ref: '#/components/schemas/interfaceStateObj'
description: ''
OSPFNeighborsStateResp:
title: OSPFNeighborsStateResp
type: object
properties:
interfaceState:
type: array
items:
$ref: '#/components/schemas/neighborStateObj'
description: ''
OSPFStateObj:
title: OSPFStateObj
type: object
properties:
extnl_lsa_cnt:
type: integer
description: external lsa count
format: int32
extnl_lsa_refresh_intvl:
type: integer
description: external link state advertisement refresh interval
format: int32
hold_ls_intvl:
type: integer
description: hold link state advertisement interval
format: int32
max_ls_intvl:
type: integer
description: Maximum link state advertisement interval
format: int32
min_lsa_arrival:
type: integer
description: min link state advertisement count
format: int32
min_lsa_interval:
type: integer
description: Minimum link state advertisement interval
format: int32
num_learned_extnl_ospf:
type: integer
format: int32
num_nbrs:
type: integer
description: neighbors count
format: int32
originated_new_lsas:
type: integer
description: Originated new LSAs
format: int32
ospf_enabled:
type: boolean
description: Flag to enable/disable OSPF
pm_admin_state:
type: string
description: Process manager admin state
proto_version:
type: integer
description: Protocol version
format: int32
redist_bgp:
type: boolean
description: boolean Flag to control redistribution of BGP routes to OSPF
redist_bgp_metric:
type: integer
description: metric assign to the redistributed bgp routes to OSPF
format: int32
redist_bgp_route_tag:
type: integer
description: tag assign to the redistributed bgp routes to OSPF
format: int32
redist_bgp_route_type:
type: integer
description: used to specify metric type for redistributed bgp routes to OSPF (1 - E1 and 2 - E2)
format: int32
redist_local:
type: boolean
description: boolean Flag to control redistribution of local routes to OSPF
redist_local_metric:
type: integer
description: metric assign to the redistributed local routes to OSPF
format: int32
redist_local_route_tag:
type: integer
description: tag assign to the redistributed local routes to OSPF
format: int32
redist_local_route_type:
type: integer
description: used to specify metric type for redistributed local routes to OSPF (1 - E1 and 2 - E2)
format: int32
redist_subshared:
type: boolean
description: boolean Flag to control redistribution of Silver Peak to OSPF
redist_subshared_metric:
type: integer
description: metric assign to the redistributed silver peak routes to OSPF
format: int32
redist_subshared_route_tag:
type: integer
description: tag assign to the redistributed silver peak routes to OSPF
format: int32
redist_subshared_route_type:
type: integer
description: used to specify metric type for redistributed silver peak routes to OSPF (1 - E1 and 2 - E2)
format: int32
route_calc_max_delay:
type: integer
description: Route calculation max delay
format: int32
router_id:
type: string
description: ospf router id
OSPFSystemConfig:
title: OSPFSystemConfig
type: object
properties:
bgpRedistMetric:
type: integer
description: metric assign to the redistributed bgp routes to OSPF
format: int32
bgpRedistMetricType:
type: integer
description: used to specify metric type for redistributed bgp routes to OSPF (1 - E1 and 2 - E2)
format: int32
bgpRedistTag:
type: integer
description: tag assign to the redistributed bgp routes to OSPF
format: int32
enable:
type: boolean
description: Flag to enable/disable OSPF
localRedistMetric:
type: integer
description: metric assign to the redistributed local routes to OSPF
format: int32
localRedistMetricType:
type: integer
description: used to specify metric type for redistributed local routes to OSPF (1 - E1 and 2 - E2)
format: int32
localRedistTag:
type: integer
description: tag assign to the redistributed local routes to OSPF
format: int32
redistBgp:
type: boolean
description: boolean Flag to control redistribution of BGP routes to OSPF
redistLocal:
type: boolean
description: boolean Flag to control redistribution of local routes to OSPF
redistSubnetShare:
type: boolean
description: boolean Flag to control redistribution of Silver Peak to OSPF
routerId:
type: string
description: router id
subnetShareRedistMetric:
type: integer
description: metric assign to the redistributed silver peak routes to OSPF
format: int32
subnetShareRedistMetricType:
type: integer
description: used to specify metric type for redistributed silver peak routes to OSPF (1 - E1 and 2 - E2)
format: int32
subnetShareRedistTag:
type: integer
description: tag assign to the redistributed silver peak routes to OSPF
format: int32
OnePeer:
title: OnePeer
required:
- index
- peerIP
- peerid
- rxrecs
- rxsecs
- rxtabs
- rxtrans
- txsecs
- txtrans
type: object
properties:
index:
type: string
description: Index.
peerIP:
type: string
description: The ip address.
peerid:
type: integer
description: The id.
format: int32
rxrecs:
type: integer
description: Need description here.
format: int32
rxsecs:
type: integer
description: Need description here.
format: int32
rxtabs:
type: integer
description: Need description here.
format: int32
rxtrans:
type: integer
description: Need description here.
format: int32
txsecs:
type: integer
description: Need description here.
format: int32
txtrans:
type: integer
description: Need description here.
format: int32
One_subnet:
title: One_subnet
type: object
properties:
advert:
type: boolean
description: Whether it advertises to peers.
comment:
type: string
description: Some comments.
local:
type: boolean
description: Whether this subnet is local.
metric:
type: integer
description: The metric value.
format: int32
Options:
title: Options
type: object
properties:
caseDesc:
type: string
description: The case description
caseKey:
type: string
description: The case number
OverlayConfig:
title: OverlayConfig
type: object
properties:
bondingPolicy:
type: number
description: The number of the bonding policy for the overlay. 1 - high availability, 2 - high throughput.
boostTraffic:
type: boolean
description: Whether or not to boost the traffic for this overlay.
brownoutThresholds:
$ref: '#/components/schemas/BrownoutThreshold'
hubInternetPolicies:
$ref: '#/components/schemas/HubInternetPolicies'
id:
type: string
description: The id of the overlay.
internetPolicy:
$ref: '#/components/schemas/InternetPolicy'
lanDscp:
type: string
description: The LAN QoS to use in the QoS policy created for this Overlay. See the QoS policy page for valid values
match:
$ref: '#/components/schemas/OverlayMatch'
name:
type: string
description: The name of the overlay.
overlayFallbackOption:
type: number
description: The fallback option of the overlay.
topology:
$ref: '#/components/schemas/OverlayTopology'
trafficClass:
type: string
description: The shaper traffic class to use in the overlay.
tunnelUsagePolicy:
type: string
description: The port to use when building IPSec UDP tunnels on this appliance
useBackupOnBrownout:
type: boolean
description: Use the backup WAN ports when the primary WAN ports meet the brownout conditions.
wanDscp:
type: string
description: The WAN QoS to use in the QoS policy created for this Overlay. See the QoS policy page for valid values
wanPorts:
$ref: '#/components/schemas/OverlayWanPorts'
OverlayBondedTunnelsInfo:
title: OverlayBondedTunnelsInfo
type: object
properties:
adminStatus:
type: string
description: Whether the tunnel was set as up or down (admin up/ admin down)
alias:
type: string
description: The name of the tunnel, in the Web UI tunnels will be identified and displayed with this name
children:
type: array
items:
$ref: '#/components/schemas/OverlayPhysicalTunnelsInfo'
description: ''
destNePk:
type: string
description: The nePk of the appliance that is the destination appliance of this tunnel
destTunnelAlias:
type: string
description: The tunnel alias of this tunnel on the destination appliance
destTunnelId:
type: string
description: The tunnel ID of this tunnel on the destination appliance
fecRation:
type: string
fecStatus:
type: string
gmsMarked:
type: boolean
description: Whether or not Orchestrator is managing the tunnel.
id:
type: string
description: The tunnel's ID
operStatus:
type: string
description: The status of the tunnel (whether it's up/down/down in progress)
overlayId:
type: string
description: The ID of the overlay this tunnel belongs to.
srcNePk:
type: string
description: The nePk of the appliance that is the source appliance of this tunnel
tag:
type: string
description: The name of the overlay that this tunnel belongs to
OverlayIdToRegionalOverlay:
title: OverlayIdToRegionalOverlay
type: object
properties:
:
$ref: '#/components/schemas/RegionToOverlay'
OverlayManagerProperties:
title: OverlayManagerProperties
required:
- autoReclassifyValues
- enable
- enableAutoSaveOnVXOA
- enableTemplateApply
- ipsecPresharedKey
- overlayPaused
- pollingInterval
- resetAllFlows
- tunnelMode
type: object
properties:
autoReclassifyValues:
type: integer
description: The integer value of auto reclassify
format: int32
enable:
type: boolean
description: Enable to resume the overlay work or disable to pause it
enableAutoSaveOnVXOA:
type: boolean
description: When this flag is true, auto save changes on appliances in each overlay loop
enableTemplateApply:
type: boolean
description: When this flag is true, auto apply templates to appliances in each overlay loop
ipsecPresharedKey:
type: string
description: The IPsec preshared key property
overlayPaused:
type: boolean
description: Whether overlay manager is paused
pollingInterval:
type: integer
description: How often to poll, in seconds, the value should not be less than 60.
format: int32
resetAllFlows:
type: boolean
description: Whether to reset all flows
settings:
$ref: '#/components/schemas/AllWanLabelSettings'
tunnelMode:
allOf:
- $ref: '#/components/schemas/TunnelMode'
- description: The tunnel mode property
OverlayManagerPropertiesPost:
title: OverlayManagerPropertiesPost
required:
- autoReclassifyValues
- enable
- ipsecPresharedKey
- pollingInterval
- resetAllFlows
- tunnelMode
type: object
properties:
autoReclassifyValues:
type: integer
description: The integer value of auto reclassify
format: int32
enable:
type: boolean
description: Enable to resume the overlay work or disable to pause it
enableAutoSaveOnVXOA:
type: boolean
description: When this flag is true, auto save changes on appliances in each overlay loop
enableTemplateApply:
type: boolean
description: When this flag is true, auto apply templates to appliances in each overlay loop
ipsecPresharedKey:
type: string
description: The IPsec preshared key property
pollingInterval:
type: integer
description: How often to poll, in seconds, the value should not be less than 60.
format: int32
resetAllFlows:
type: boolean
description: Whether to reset all flows
settings:
$ref: '#/components/schemas/AllWanLabelSettings'
tunnelMode:
allOf:
- $ref: '#/components/schemas/TunnelMode'
- description: The tunnel mode property
OverlayMatch:
title: OverlayMatch
type: object
properties:
acl:
type: string
description: The name of the ACL class (defined on the appliance). If this key exists, you should not have the interfaceLabel or overlayAcl keys.
interfaceLabel:
type: string
description: The name of the LAN interface, if this key exists, you should not have the acl or overlayAcl keys.
overlayAcl:
type: string
description: The contents of the overlay ACL that is built into this overlay configuration and that will be created on the appliance. If this key exists, you should not have the acl or interfaceLabel keys
OverlayPhysicalTunnelsInfo:
title: OverlayPhysicalTunnelsInfo
type: object
properties:
adminStatus:
type: string
description: Whether the tunnel was set as up or down (admin up/ admin down)
alias:
type: string
description: The name of the tunnel, in the Web UI tunnels will be identified and displayed with this name
destIpAddress:
type: string
description: The destination IP of the tunnel
destNePk:
type: string
description: The nePk of the appliance that is the destination appliance of this tunnel
destTunnelAlias:
type: string
description: The tunnel alias of this tunnel on the destination appliance
destTunnelId:
type: string
description: The tunnel ID of this tunnel on the destination appliance
fecRation:
type: string
fecStatus:
type: string
id:
type: string
description: The tunnel's ID
ipsec_enabled:
type: string
mode:
type: string
description: The mode of the tunnel
operStatus:
type: string
description: The status of the tunnel (whether it's up/down/down in progress)
parallelTunnelId:
type: number
presharedkey:
type: string
sourceIpAddress:
type: string
description: The source IP address of the tunnel
srcNePk:
type: string
description: The nePk of the appliance that is the source appliance of this tunnel
tag:
type: string
description: Describes which labels are used in the tunnel (labelId1 - labelId2)
tunnelThreshold:
$ref: '#/components/schemas/TCTunnelsThreshold'
OverlayTopology:
title: OverlayTopology
type: object
properties:
externalHubs:
type: array
items:
type: string
description: An array of the NE.PKs (appliance id) for the external hubs of this regional overlay.
hubs:
type: array
items:
type: string
description: An array of the NE.PKs (appliance id) for the hubs of this overlay.
topologyType:
type: number
description: The number corresponding to the type of topology. (1 - mesh, 2 - hub and spoke)
useRegions:
type: boolean
description: Connect appliances based on region
OverlayWanPorts:
title: OverlayWanPorts
type: object
properties:
backup:
type: array
items:
type: string
description: An array of WAN interface label IDs to use as the backup WAN ports of this overlay.
crossConnect:
type: array
items:
type: string
description: An array of WAN interface label IDs to cross connect tunnels between
primary:
type: array
items:
type: string
description: An array of WAN interface label IDs to use as the primary WAN ports this overlay.
PartitionSoftwareVersionInfo:
title: PartitionSoftwareVersionInfo
type: object
properties:
active:
type: boolean
build_time:
type: string
build_version:
type: string
fallback_boot:
type: boolean
next_boot:
type: boolean
partition:
type: integer
format: int32
PassThroughTunnel:
title: PassThroughTunnel
type: object
properties:
adminStatus:
type: string
description: Whether or not the tunnel is admin'ed up or down
alias:
type: string
description: The alias of the tunnel
destIpAddress:
type: string
description: The destination IP address (if applicable)
destNePk:
type: string
description: The nePk of the destination appliance (if applicable)
fecRatio:
type: number
description: The ratio of the fec
fecStatus:
type: string
description: The status of the FEC
gmsMarked:
type: boolean
description: Whether or not Orchestrator has created/modified this tunnel
id:
type: string
description: The ID of the pass through tunnel
max_bw:
type: number
description: The max bandwidth of the tunnel
max_bw_auto:
type: boolean
mode:
type: string
description: The mode of the tunnel
natMode:
type: string
description: Configured NAT mode
operStatus:
type: string
description: The current state of the tunnel
peerName:
type: string
description: The name of the service or peer for this pass through tunnel
sourceIpAddress:
type: string
description: The source IP address of the tunnel
srcNePk:
type: string
description: The nePk of the appliance the tunnel belongs to
PassThroughTunnelIdToTunnelMap:
title: PassThroughTunnelIdToTunnelMap
type: object
properties:
exampleTunnelId1:
$ref: '#/components/schemas/PassThroughTunnel'
exampleTunnelId2:
$ref: '#/components/schemas/PassThroughTunnel'
PeerPriorityGet:
title: PeerPriorityGet
type: object
properties:
peerlist:
$ref: '#/components/schemas/peerlist'
PhysicalTunnelsIdToTunnelMap:
title: PhysicalTunnelsIdToTunnelMap
type: object
properties:
exampleTunnelId1:
type: object
exampleTunnelId2:
type: object
PortForwardingEntry:
title: PortForwardingEntry
required:
- comment
- destPort
- destSubnet
- gms_marked
- protocol
- srcSubnet
- targetIp
- targetPort
type: object
properties:
comment:
type: string
description: Comment
destPort:
type: string
description: Destination port or port range of the rule, for example 123 or 123-234, and would be 0 for ICMP protocol
destSubnet:
type: string
description: Destination subnet of the rule
gms_marked:
type: boolean
description: To indicate whether this rule was generated by GMS or by user
protocol:
type: string
description: Protocol of the rule, could be any of UDP, TCP and ICMP
srcSubnet:
type: string
description: Source subnet of the rule
targetIp:
type: string
description: If a packet header matches this rule, the packet would be translated to this new IP address
targetPort:
type: string
description: If a packet header matches this rule, the packet would be translated to this new port or port range
description: One port forwarding rule
PortProtocolMap:
title: PortProtocolMap
type: object
properties:
portNumber:
type: array
items:
$ref: '#/components/schemas/PortProtocolObj'
description: ''
PortProtocolObj:
title: PortProtocolObj
type: object
properties:
description:
type: string
name:
type: string
port:
type: string
priority:
type: integer
format: int32
protocol:
type: integer
format: int32
PortProtocolTmp:
title: PortProtocolTmp
type: object
properties:
applicationTags:
type: object
portProtocolWithPriority:
$ref: '#/components/schemas/PortProtocolMap'
PortalApplianceLicenseRequestPart:
title: PortalApplianceLicenseRequestPart
required:
- fx
type: object
properties:
fx:
$ref: '#/components/schemas/PortalApplianceRequestFxPart'
PortalApplianceLicensesBasePart:
title: PortalApplianceLicensesBasePart
required:
- enable
type: object
properties:
enable:
type: boolean
PortalApplianceLicensesBoostPart:
title: PortalApplianceLicensesBoostPart
required:
- bandwidth
- enable
type: object
properties:
bandwidth:
type: integer
format: int32
enable:
type: boolean
PortalApplianceLicensesFxPart:
title: PortalApplianceLicensesFxPart
required:
- base
- boost
- mini
- plus
- tier
type: object
properties:
base:
$ref: '#/components/schemas/PortalApplianceLicensesBasePart'
boost:
$ref: '#/components/schemas/PortalApplianceLicensesBoostPart'
mini:
$ref: '#/components/schemas/PortalApplianceLicensesMiniPart'
plus:
$ref: '#/components/schemas/PortalApplianceLicensesPlusPart'
tier:
$ref: '#/components/schemas/PortalApplianceLicensesTierPart'
PortalApplianceLicensesMiniPart:
title: PortalApplianceLicensesMiniPart
required:
- enable
type: object
properties:
enable:
type: boolean
PortalApplianceLicensesPart:
title: PortalApplianceLicensesPart
required:
- fx
type: object
properties:
fx:
$ref: '#/components/schemas/PortalApplianceLicensesFxPart'
PortalApplianceLicensesPlusPart:
title: PortalApplianceLicensesPlusPart
required:
- enable
type: object
properties:
enable:
type: boolean
PortalApplianceLicensesTierPart:
title: PortalApplianceLicensesTierPart
required:
- bandwidth
- display
type: object
properties:
bandwidth:
type: integer
format: int32
display:
type: string
PortalApplianceRequestFxBoostPart:
title: PortalApplianceRequestFxBoostPart
required:
- bandwidth
- enable
type: object
properties:
bandwidth:
type: integer
format: int32
enable:
type: boolean
PortalApplianceRequestFxMiniPart:
title: PortalApplianceRequestFxMiniPart
required:
- enable
type: object
properties:
enable:
type: boolean
PortalApplianceRequestFxPart:
title: PortalApplianceRequestFxPart
required:
- boost
- mini
- plus
- tier
type: object
properties:
boost:
$ref: '#/components/schemas/PortalApplianceRequestFxBoostPart'
mini:
$ref: '#/components/schemas/PortalApplianceRequestFxMiniPart'
plus:
$ref: '#/components/schemas/PortalApplianceRequestFxPlusPart'
tier:
$ref: '#/components/schemas/PortalApplianceRequestFxTierPart'
PortalApplianceRequestFxPlusPart:
title: PortalApplianceRequestFxPlusPart
required:
- enable
type: object
properties:
enable:
type: boolean
PortalApplianceRequestFxTierPart:
title: PortalApplianceRequestFxTierPart
required:
- bandwidth
- display
type: object
properties:
bandwidth:
type: integer
format: int32
display:
type: string
PortalLicenseItem:
title: PortalLicenseItem
required:
- applianceId
- enabled
- hostname
- id
- isPortalLicensed
- licenseRequest
- licenses
- model
- portalLicenseType
- saasEnabled
- serial
type: object
properties:
applianceId:
type: string
enabled:
type: boolean
hostname:
type: string
id:
type: string
isPortalLicensed:
type: boolean
licenseRequest:
$ref: '#/components/schemas/PortalApplianceLicenseRequestPart'
licenses:
$ref: '#/components/schemas/PortalApplianceLicensesPart'
model:
type: string
portalLicenseType:
type: integer
format: int32
saasEnabled:
type: boolean
serial:
type: string
PortalLicenseSummary:
title: PortalLicenseSummary
required:
- licenseState
- licenses
type: object
properties:
licenseState:
$ref: '#/components/schemas/PortalSummaryLicenseStatePart'
licenses:
$ref: '#/components/schemas/PortalSummaryLicensesPart'
PortalRegistrationResponse:
title: PortalRegistrationResponse
type: object
properties:
accountKey:
type: string
description: Unique key per account generated by Portal.
accountName:
type: string
emails:
type: array
items:
type: string
description: Array of email addresses associated with this Portal account
enabled:
type: boolean
description: Flag to denote if Orchestrator has registered with Portal and has been (manually or auto) approved by Administrator
group:
type: string
description: Account group name. 'Unassigned' if empty.
pendingPoll:
type: boolean
description: Flag to denote if Orchestrator is currently polling for registration status from portal
registered:
type: boolean
description: Flag to denote if Orchestrator has registered with Portal
site:
type: string
description: Account site name. 'Unassigned' if empty.
PortalSummaryLicenseStateFxPart:
title: PortalSummaryLicenseStateFxPart
required:
- numBase
- numBoost
- numPlus
- numTier
type: object
properties:
numBase:
type: integer
format: int32
numBoost:
type: integer
format: int32
numPlus:
type: integer
format: int32
numTier:
$ref: '#/components/schemas/NumTierSummary'
PortalSummaryLicenseStatePart:
title: PortalSummaryLicenseStatePart
required:
- fx
type: object
properties:
fx:
$ref: '#/components/schemas/PortalSummaryLicenseStateFxPart'
PortalSummaryLicensesPart:
title: PortalSummaryLicensesPart
required:
- accountKey
- cpx
- ecsp
- fx
- metered
- saas
type: object
properties:
accountKey:
$ref: '#/components/schemas/AccountKeySummary'
cpx:
$ref: '#/components/schemas/CpxSummary'
ecsp:
$ref: '#/components/schemas/EcspSummary'
fx:
$ref: '#/components/schemas/FxSummary'
metered:
$ref: '#/components/schemas/MeteredSummary'
saas:
$ref: '#/components/schemas/SaasSummary'
PostCancelConfig:
title: PostCancelConfig
required:
- pmpKey
type: object
properties:
pmpKey:
type: string
PostRunConfig:
title: PostRunConfig
required:
- max_packet
- nePks
type: object
properties:
ip:
type: string
description: Filter only for this IP to capture
max_packet:
type: string
description: Desired number of packets to capture
example: '1000'
nePks:
type: array
items:
type: string
description: The nePks of the appliances
port:
type: string
description: Filter only for this port to capture
PreferenceResponse:
title: PreferenceResponse
type: object
properties:
dynamic:
type: boolean
description: True if using map server, false for static image
image:
type: string
description: Background image name
panx:
type: string
description: The x position of the pan
pany:
type: string
description: The y position of the pan
zoomLevel:
type: number
description: Zoom level of the background image
PreferenceSave:
title: PreferenceSave
type: object
properties:
panx:
type: string
description: 'The x position of the pan. Example: 10px'
pany:
type: string
description: 'The y position of the pan. Example: 10px'
zoomLevel:
type: number
description: Zoom level of the background image
PreferencesSaveForUser:
title: PreferencesSaveForUser
required:
- username
type: object
properties:
username:
$ref: '#/components/schemas/PreferenceSave'
PrioObj:
title: PrioObj
type: object
properties:
:
$ref: '#/components/schemas/Priority'
Priority:
title: Priority
required:
- match
- set
type: object
properties:
comment:
type: string
gms_marked:
type: boolean
description: For internal use. Flag to determine if this rule was created by Orchestrator.
match:
type: string
description: 'Match the domains under the specified domain group. Format: "domain_group:group_name" or "any"'
set:
type: string
description: 'Set action to the specified profile. Format: profile_name:profile_name'
Profile:
title: Profile
type: object
properties:
:
$ref: '#/components/schemas/ProfileObj'
ProfileObj:
title: ProfileObj
required:
- servers
- caching
type: object
properties:
servers:
type: string
description: DNS server addresses
caching:
type: string
description: Enable caching
ProxyConfig:
title: ProxyConfig
required:
- proxyHost
- proxyPassword
- proxyPort
- proxyUser
- useProxy
type: object
properties:
proxyHost:
type: string
description: The host of the proxy
proxyPassword:
type: string
description: The password
proxyPort:
type: integer
description: The port of the proxy
format: int32
example: 80
proxyUser:
type: string
description: The user name
useProxy:
type: boolean
description: Use the proxy or not
RADIUSConfig:
title: RADIUSConfig
required:
- server
type: object
properties:
server:
allOf:
- $ref: '#/components/schemas/RADIUSConfigMap'
- description: You can add a maximum of three RADIUS servers.
RADIUSConfigElement:
title: RADIUSConfigElement
required:
- address
- auth-port
- enable
- key
- retransmit
- self
- timeout
type: object
properties:
address:
type: string
description: IP Address of RADIUS server
auth-port:
type: integer
description: Port used by RADIUS server
format: int32
enable:
type: boolean
description: To enable/disable RADIUS server
key:
type: string
description: Shared key used for RADIUS authentication requests
retransmit:
type: integer
description: Number of retransmit limits for RADIUS server
format: int32
self:
type: integer
description: Order of RADIUS Servers
format: int32
timeout:
type: integer
description: timeout in seconds for authentication requests
format: int32
RADIUSConfigMap:
title: RADIUSConfigMap
required:
-
type: object
properties:
:
$ref: '#/components/schemas/RADIUSConfigElement'
description: You can add a maximum of three RADIUS servers.
ReachabilityGMS:
title: ReachabilityGMS
required:
- actualWebProtocolType
- hostName
- id
- neId
- state
- unsavedChanges
- userName
type: object
properties:
actualWebProtocolType:
type: string
description: The actual web protocol type
hostName:
type: string
description: The hostname of the appliance
id:
type: string
description: The device key assigned by Orchestrator
neId:
type: string
description: The IP of the appliance
state:
type: integer
description: The state of the appliance
format: int32
unsavedChanges:
type: integer
description: The status of the unsavedChanges(1-Yes, 0-NO)
format: int32
userName:
type: string
description: User Name
ReachabiltyAppliance:
title: ReachabiltyAppliance
required:
- neIP
type: object
properties:
neIP:
$ref: '#/components/schemas/ApplianceStatus'
RealTimeStats:
title: RealTimeStats
required:
- filter
- name
- type
type: object
properties:
filter:
allOf:
- $ref: '#/components/schemas/Filter'
- description: 'For traffic Type : 0 - optimized traffic, 1 - passthrough-shaped, 2 - passthrough-unshaped, 3 - all traffic. Default is 0 - optimized traffic if omitted. For traffic direction: 1 - inbound, 0-outbound'
example: 0
name:
type: string
type:
$ref: '#/components/schemas/Type'
RebootHistory:
title: RebootHistory
type: object
properties:
nePk:
type: string
description: This is the primary key of the appliance. Every appliance managed by Orchestrator is given a primary key and it uniquely identifies an appliance among all appliances managed by Orchestrator
rootCause:
type: string
description: Root cause for the reboot. 'Normal' indicates reboot was initiated by user. 'Unexpected shutdown'- indicates there could be a appliance crash
sentToPortal:
type: boolean
description: boolean flag to indicate whether the reboot record sent to portal or not?
time:
type: integer
description: Epoch time of Appliance reboot Time
format: int32
version:
type: string
description: Appliance version before it rebooted
RegionAssociationGETModel:
title: RegionAssociationGETModel
type: object
properties:
nePk:
type: string
description: Appliance ID
regionId:
type: integer
description: ID of region
format: int32
regionName:
type: string
description: name of region
RegionAssociationPutModel:
title: RegionAssociationPutModel
type: object
properties:
regionId:
type: integer
description: ID of region
format: int32
RegionModel:
title: RegionModel
type: object
properties:
regionId:
type: integer
description: ID of region
format: int32
regionName:
type: string
description: Name of region
RegionPostModel:
title: RegionPostModel
type: object
properties:
regionName:
type: string
description: Name of region
RegionToOverlay:
title: RegionToOverlay
type: object
properties:
:
$ref: '#/components/schemas/OverlayConfig'
Release:
title: Release
type: object
properties:
description:
type: string
description: A description of new features or bug fixes in the release
product:
type: string
description: The product type, either Orchestrator or vxoa
releaseDate:
type: number
description: The unix timestamp representing the date of the release
releaseType:
type: string
description: 'The type of release, ex: BETA'
version:
type: string
description: The version of the release
ReleaseInfo:
title: ReleaseInfo
required:
- gmsbuilds
- vxoabuilds
type: object
properties:
gmsbuilds:
type: array
items:
$ref: '#/components/schemas/Release'
description: list of available orchestrator version
vxoabuilds:
type: array
items:
$ref: '#/components/schemas/Release'
description: list of available vxoa version
ReleaseNotification:
title: ReleaseNotification
type: object
properties:
description:
type: string
description: The description to text to show in the notification
nextTime:
type: number
description: The next time the notification needs to be shown, in unix timestamp
product:
type: number
description: A number indicating which product the notification is for, 1 - Orchestrator, 2 - VXOA
version:
type: string
description: The software version for the release
RemoteInfo:
title: RemoteInfo
required:
- fac
- min_severity
type: object
properties:
fac:
type: string
description: The value should be one of the all, local0, local1, local2, local3, local4, local5, local6 and local7
min_severity:
type: string
description: The value should be one of the none, emergence, alert, critical, error, warning, notice, info and debug
RemoteItem:
title: RemoteItem
required:
- ip
- self
type: object
properties:
ip:
type: string
description: valid ip address
self:
$ref: '#/components/schemas/RemoteInfo'
RemoteObj:
title: RemoteObj
required:
- elements
type: object
properties:
elements:
type: array
items:
$ref: '#/components/schemas/RemoteItem'
description: ''
RequestLoginToken:
title: RequestLoginToken
required:
- password
- user
type: object
properties:
TempCode:
type: boolean
description: Request a temporary authentication code be sent to your email even if email based two factor authentication is not enabled for your account
password:
type: string
description: Password
user:
type: string
description: User id
ResetPasswordBody:
title: ResetPasswordBody
required:
- confirmPassword
- id
- password
- tfaApp
- tfaEmail
type: object
properties:
confirmPassword:
type: string
description: confirmPassword
id:
type: string
description: Reset Password Identifier
password:
type: string
description: password
tfaApp:
type: boolean
description: Use application based two factor authentication
tfaEmail:
type: boolean
description: Use email based two factor authentication
ResetPasswordToken:
title: ResetPasswordToken
required:
- token
type: object
properties:
token:
type: string
description: Token for the reset password request
RestRequestTimeStatsDetails:
title: RestRequestTimeStatsDetails
required:
- avgRestRequestTime
- channel
- maxRestRequestTime
- method
- minRestRequestTime
- nePk
- queryTime
- resourceUrl
- timedout
- timeouts
- timestamp
- totalRequests
type: object
properties:
avgRestRequestTime:
type: integer
description: Nonsense
format: int32
channel:
type: integer
description: Nonsense
format: int32
maxRestRequestTime:
type: integer
description: Nonsense
format: int32
method:
type: string
description: Nonsense
minRestRequestTime:
type: integer
description: Nonsense
format: int32
nePk:
type: string
description: Nonsense
queryTime:
type: integer
description: The time spent for this request to return, if this is a timeout request this value is 0
format: int32
resourceUrl:
type: string
description: The whole resource string of the request
timedout:
type: boolean
description: To indicate whether it is a timeout request
timeouts:
type: integer
description: Nonsense
format: int32
timestamp:
type: integer
description: The epoch time when the request returned
format: int32
totalRequests:
type: integer
description: Nonsense
format: int32
description: Details of one rest request sent to the appliance's specific resource through web socket or portal web socket
RestRequestTimeStatsSummary:
title: RestRequestTimeStatsSummary
required:
- avgRestRequestTime
- channel
- maxRestRequestTime
- method
- minRestRequestTime
- nePk
- queryTime
- resourceBase
- timedout
- timeouts
- timestamp
- totalRequests
type: object
properties:
avgRestRequestTime:
type: integer
description: The average time spent for the requests to return, and the timeout requests are not taken into account
format: int32
channel:
type: integer
description: Through what web socket the requests were sent, 2 -- portal web socket, 1 -- direct web socket
format: int32
maxRestRequestTime:
type: integer
description: The maximum time spent for the requests to return, and the timeout requests are not taken into account
format: int32
method:
type: string
description: Request method like GET/POST/PUT/DELETE
minRestRequestTime:
type: integer
description: The minimum time spent for the requests to return, and the timeout requests are not taken into account
format: int32
nePk:
type: string
description: The nePk of the appliance
queryTime:
type: integer
description: Nonsense
format: int32
resourceBase:
type: string
description: The base resource of the request
timedout:
type: boolean
description: Nonsense
timeouts:
type: integer
description: The count of the timeout requests
format: int32
timestamp:
type: integer
description: Nonsense
format: int32
totalRequests:
type: integer
description: The count of requests sent to this appliance's this resource
format: int32
description: Summary of rest requests sent to the appliance's specific resource through web socket or portal web socket
ResyncAppliancePost:
title: ResyncAppliancePost
required:
- ids
type: object
properties:
ids:
type: array
items:
type: string
description: "Array of appliance keys, for eg: ['0.NE','1.NE']"
Role:
title: Role
required:
- menuTypeItems
- net_read
type: object
properties:
menuTypeItems:
type: array
items:
type: string
description: It should contain at least one menuId. It should not be empty or null
net_read:
type: boolean
description: assign true value to grant read-write level access
description: Role Definition
RoleMap:
title: RoleMap
required:
-
type: object
properties:
:
allOf:
- $ref: '#/components/schemas/Role'
- description: Role Definition
description: roleName to roleDefinition mapping pairs
SMTP:
title: SMTP
required:
- emailAuthentication
- emailSender
- emailSsl
- password
- requireEmailVerification
- server
- smtpPort
- userID
type: object
properties:
emailAuthentication:
type: boolean
description: boolean values for emailAuthentication
emailSender:
type: string
description: E-mail address used to send E-mails
emailSsl:
type: boolean
description: Enable or disable Enable SSL
password:
type: string
description: E-mail server password
requireEmailVerification:
type: boolean
description: Verification required before sending email
server:
type: string
description: Address of the E-mail server
smtpPort:
type: integer
description: SMTP server port
format: int32
userID:
type: string
description: ID
SMTPInfo:
title: SMTPInfo
required:
- smtp
type: object
properties:
smtp:
$ref: '#/components/schemas/SMTP'
SMTPTest:
title: SMTPTest
required:
- emailRecepients
- smtp
type: object
properties:
emailRecepients:
type: string
description: Test email address
smtp:
$ref: '#/components/schemas/SMTP'
SaasSummary:
title: SaasSummary
required:
- enable
- expire
type: object
properties:
enable:
type: boolean
expire:
type: integer
format: int32
SampleServiceSet:
title: SampleServiceSet
type: object
properties:
service_1:
$ref: '#/components/schemas/Service'
service_2:
$ref: '#/components/schemas/Service'
SampleThirdPartyServiceSet:
title: SampleThirdPartyServiceSet
type: object
properties:
:
$ref: '#/components/schemas/ThirdPartyService'
SaveChangesPostBody:
title: SaveChangesPostBody
required:
- ids
type: object
properties:
ids:
type: array
items:
type: string
description: an array of neIds, neId is the device key assigned by Orchestrator, usually look like '0.NE'.
SaveUpdateUserBody:
title: SaveUpdateUserBody
required:
- createDisplayTime
- email
- firstName
- isTwoFactorEmail
- isTwoFactorTime
- lastName
- password
- phone
- repeatPassword
- role
- status
- userPk
- username
type: object
properties:
createDisplayTime:
type: string
email:
type: string
firstName:
type: string
isTwoFactorEmail:
type: boolean
isTwoFactorTime:
type: boolean
lastName:
type: string
password:
type: string
phone:
type: string
repeatPassword:
type: string
role:
type: string
description: "'Admin Manager' for admin role, 'Network Monitor' for monitor role"
status:
type: string
description: Takes values 'Active' or 'Inactive'
userPk:
type: string
description: Primary key of the user object. Leave it empty if you are creating new user
username:
type: string
ScheduleTimezoneConfiguration:
title: ScheduleTimezoneConfiguration
type: object
properties:
defaultTimezone:
type: string
description: An array of email addresses to send the discovery (discovered, approved and denied EdgeConnects) email to.
ScheduledJob2Get:
title: ScheduledJob2Get
required:
- config
- cron
- currentlyRunning
- description
- group
- id
- jobCategory
- jobType
- name
- nextFireTime
- prevFireTime
- runNow
- schedule
type: object
properties:
config:
type: string
description: Job configuration
cron:
allOf:
- $ref: '#/components/schemas/cronInfo'
- description: Provides the cron expression for the job schedule
currentlyRunning:
type: boolean
description: Indicates if the job is currently running
description:
type: string
description: Job description
group:
type: string
description: Job group the job belongs to. (name, group) form the key for a job in Quartz scheduler
id:
type: integer
description: Every job is uniquely identified using this primary key
format: int32
jobCategory:
type: string
description: Identifies the type of job. 1=TestJob, 2=Orchestrator Report, 3=Orchestrator Backup, 4=Appliance Reboot/Shutdown, 5 = Appliance QOS Scheduling, 6 = IPsec Pre-shared Key Rotation
jobType:
type: integer
description: 1=User defined job and 2=System job
format: int32
name:
type: string
description: Job name, unique identifier for a job in Quartz scheduler
nextFireTime:
type: integer
description: Indicates the next time the job will fire in epoch sec
format: int32
prevFireTime:
type: integer
description: Indicates the previous time the job fired in epoch sec
format: int32
runNow:
type: boolean
description: Indicates if the job is a 'run now' job. If runNow = false, the job is scheduled to run at a specific time
schedule:
type: string
description: Schedule of this job
description: Describes all the fields in a scheduled job.
ScheduledJob2Post:
title: ScheduledJob2Post
required:
- config
- description
- jobCategory
- schedule
type: object
properties:
config:
type: string
description: Job configuration
description:
type: string
description: Job description
jobCategory:
type: string
description: Identifies the type of job. 1=TestJob, 2=Orchestrator Report, 3=Orchestrator Backup, 4 - Appliance Reboot/Shutdown, 5 = Appliance QOS Scheduling, 6 = IPsec Pre-shared Key Rotation
schedule:
type: string
description: Schedule of this job
targetAppliance:
$ref: '#/components/schemas/targetAppliance'
description: New job fields
SecMapPriorities:
title: SecMapPriorities
type: object
properties:
:
$ref: '#/components/schemas/SecMapPriority'
SecMapPriority:
title: SecMapPriority
type: object
properties:
comment:
type: string
gms_marked:
type: boolean
description: For internal use. Flag to determine if this rule was created by Orchestrator.
match:
type: object
description: Object containing rules to match traffic.
misc:
type: object
description: Object to hold miscellaneous field like rule, logging, logging priority, etc.
self:
type: object
set:
type: object
description: 'Object to hold set action eg: action: allow/deny'
SecurityMap:
title: SecurityMap
type: object
properties:
prio:
$ref: '#/components/schemas/SecMapPriorities'
SecurityMaps:
title: SecurityMaps
type: object
properties:
map1:
$ref: '#/components/schemas/SecurityMapsObj'
SecurityMapsObj:
title: SecurityMapsObj
type: object
properties:
:
$ref: '#/components/schemas/SecurityMap'
SecurityPolicyAggregateStats:
title: SecurityPolicyAggregateStats
required:
- HOSTNAME
- IP
- MAX_TIMESTAMP
- MIN_TIMESTAMP
- flows_allowed
- flows_dropped
- fromZone
- nePk
- policy_drop_bytes
- policy_drop_pkts
- routing_drop_bytes
- routing_drop_pkts
- rx_bytes
- rx_pkts
- toZone
- tx_bytes
- tx_pkts
type: object
properties:
HOSTNAME:
type: string
description: The host name of the appliance to which the data belong, if groupByNE was set false, this field means nothing
IP:
type: string
description: The IP address of the appliance to which the data belong, if groupByNE was set false, this field means nothing
MAX_TIMESTAMP:
type: integer
description: The maximum timestamp of the stats data of this appliance to aggregate
format: int32
MIN_TIMESTAMP:
type: integer
description: The minimum timestamp of the stats data of this appliance to aggregate
format: int32
flows_allowed:
type: integer
description: The number allowed flows
format: int32
flows_dropped:
type: integer
description: The number dropped flows
format: int32
fromZone:
type: string
description: The ID of the source zone of this zone pair
nePk:
type: string
description: The internal ID of the appliance to which the data belong, if groupByNE was set false, this field means nothing
policy_drop_bytes:
type: integer
description: The number dropped bytes because of policy configuration
format: int32
policy_drop_pkts:
type: integer
description: The number dropped packets because of policy configuration
format: int32
routing_drop_bytes:
type: integer
description: The number dropped bytes because of routing
format: int32
routing_drop_pkts:
type: integer
description: The number dropped packets because of routing
format: int32
rx_bytes:
type: integer
description: The number inbound bytes into the destination zone, please mind that the acknowledge traffic would also be included
format: int32
rx_pkts:
type: integer
description: The number inbound packets into the destination zone, please mind that the acknowledge traffic would also be included
format: int32
toZone:
type: string
description: The ID of the destination zone of this zone pair
tx_bytes:
type: integer
description: The number outbound bytes
format: int32
tx_pkts:
type: integer
description: The number outbound packets
format: int32
SecurityPolicyTimeSeries:
title: SecurityPolicyTimeSeries
required:
- column_def
- data
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
type: array
items:
type: array
items:
type: object
Service:
title: Service
type: object
properties:
name:
type: string
description: The name of the service
ServiceIdToSaasId:
title: ServiceIdToSaasId
type: object
properties:
country:
type: string
countryCode:
type: string
displayName:
type: string
description: Combination of country, org, saasAppName. Used to display this entry in the UI.
org:
type: string
saasAppName:
type: string
saasId:
type: integer
format: int32
ServiceIdToSaasIdCountGet:
title: ServiceIdToSaasIdCountGet
type: object
properties:
count:
type: number
ServiceIdToSaasIdCountriesGet:
title: ServiceIdToSaasIdCountriesGet
type: object
properties:
country:
type: array
items:
type: string
description: Array representing service details [serviceId, saasId, country, countryCode, org, saasAppName, displayName, priority]
ServiceIdToSaasIdGet:
title: ServiceIdToSaasIdGet
type: object
properties:
serviceId:
type: array
items:
type: string
description: Array representing service details [serviceId, saasId, country, countryCode, org, saasAppName, displayName, priority]
Session:
title: Session
required:
- gid
- idle_time
- login_time
- port
- remote_host
- username
type: object
properties:
gid:
type: integer
description: gid of the user
format: int32
idle_time:
type: string
description: Idle time of the user
login_time:
type: string
description: User login time
port:
type: string
description: The value is web by default
remote_host:
type: string
description: Remote host IP address
username:
type: string
description: Logged in user name
SessionGetItem:
title: SessionGetItem
required:
- lastInteractionTime
- loggedInTime
- userName
- webClient
type: object
properties:
lastInteractionTime:
type: integer
format: int32
loggedInTime:
type: integer
format: int32
role:
type: string
userName:
type: string
webClient:
type: boolean
SessionMap:
title: SessionMap
required:
-
type: object
properties:
:
$ref: '#/components/schemas/Session'
ShaperTimeSeriesStatsData:
title: ShaperTimeSeriesStatsData
type: object
properties:
DIRECTION:
type: integer
description: Traffic class value
format: int32
TIMESTAMP:
type: integer
description: Timestamp in EPOCH time, all timestamp fields are in EPOCH time
format: int32
TRAFFIC_CLASS:
type: integer
description: Traffic class value
format: int32
otherDrops:
type: integer
description: Other drops
format: int32
qosDrops:
type: integer
description: QOS drops
format: int32
shapedBytes:
type: integer
description: Shaped Bytes
format: int32
shapedPkts:
type: integer
description: Shaped Packets
format: int32
totalBytes:
type: integer
description: Total Bytes
format: int32
totalWait:
type: integer
description: Total wait
format: int32
waitCount:
type: integer
description: Wait count
format: int32
description: An array that contains the stats data of a certain timestamp.
ShaperTimeSeriesStatsDataMultiAppliances:
title: ShaperTimeSeriesStatsDataMultiAppliances
type: object
properties:
:
type: array
items:
$ref: '#/components/schemas/ShaperTimeSeriesStatsData'
description: ''
ShaperTimeSeriesStatsMultiAppliances:
title: ShaperTimeSeriesStatsMultiAppliances
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
$ref: '#/components/schemas/ShaperTimeSeriesStatsDataMultiAppliances'
SingleNextHop:
title: SingleNextHop
required:
- metric
type: object
properties:
comment:
type: string
description: A comment associated with the subnet entry
dir:
type: string
description: 'A tag to specify a generic route property eg: direction. Currently supported enums are [ANY, FROM_LAN, FROM_WAN]'
metric:
type: integer
description: A metric value between 1 and 100. Lower values have higher priority
format: int32
SingleSubnet:
title: SingleSubnet
required:
- nhop
type: object
properties:
advert:
type: boolean
description: Advertize this subnet to other Silverpeak appliances
advert_bgp:
type: boolean
description: flag to enable/disable capability to advertise learned subnet routes to bgp
exclude:
type: boolean
description: Use this to exclude advertizement of a sub-subnet from a bigger advertized subnet
nhop:
$ref: '#/components/schemas/nextHop'
SnmpAccess:
title: SnmpAccess
required:
- rocommunity
type: object
properties:
rocommunity:
type: string
description: SNMP read-only community string
SnmpAdmin:
title: SnmpAdmin
required:
- auth_key
- enable
- hash_type
- privacy_key
- privacy_type
- self
type: object
properties:
auth_key:
type: string
description: Hashed authentication password
enable:
type: boolean
description: Is admin user enabled as SNMP v3 user
hash_type:
type: string
description: Hashing algorithm used for encrypting authentication password
privacy_key:
type: string
description: Hashed privacy password
privacy_type:
type: string
description: Hashing algorithm used for encrypting privacy password
self:
type: string
description: admin user, only admin user is available as an SNMP v3 user
SnmpItem:
title: SnmpItem
required:
- access
- auto_launch
- listen
- syscontact
- sysdescr
- syslocation
- traps
- v3
type: object
properties:
access:
$ref: '#/components/schemas/SnmpAccess'
auto_launch:
type: boolean
description: Is SNMP Agent enabled at system start up
listen:
$ref: '#/components/schemas/SnmpListen'
syscontact:
type: string
description: SNMP MIB II object 'sysContact' value
sysdescr:
type: string
description: SNMP MIB II object 'sysDescr' value
syslocation:
type: string
description: SNMP MIB II object 'sysLocation' value
traps:
$ref: '#/components/schemas/SnmpTraps'
v3:
$ref: '#/components/schemas/SnmpV3UserInfo'
SnmpListen:
title: SnmpListen
required:
- enable
type: object
properties:
enable:
type: boolean
description: Is SNMP agent listening at SNMP port (161)
SnmpTraps:
title: SnmpTraps
required:
- enable
- trap_community
type: object
properties:
enable:
type: boolean
description: Is SNMP trap event enabled
trap_community:
type: string
description: Community string for SNMP trap event
SnmpUser:
title: SnmpUser
required:
- admin
type: object
properties:
admin:
$ref: '#/components/schemas/SnmpAdmin'
SnmpV3UserInfo:
title: SnmpV3UserInfo
required:
- users
type: object
properties:
users:
$ref: '#/components/schemas/SnmpUser'
SourceNePkToDestNePkPhysicalTunnelsMap:
title: SourceNePkToDestNePkPhysicalTunnelsMap
type: object
properties:
nePk:
allOf:
- $ref: '#/components/schemas/DestNepkToPhysicalTunnelsMap'
- description: A map of destination appliances (nePk) to an array of tunnels
SourceNePkToDestNePkTunnelsMap:
title: SourceNePkToDestNePkTunnelsMap
type: object
properties:
nePk:
allOf:
- $ref: '#/components/schemas/DestNepkToTunnelsMap'
- description: A map of destination appliances (nePk) to an array of tunnels
SpPortalAccountLicenseFeature:
title: SpPortalAccountLicenseFeature
type: object
properties:
displayName:
type: string
expire:
type: number
name:
type: string
description: Portal account license feature information
SpPortalAccountLicenseType:
title: SpPortalAccountLicenseType
type: object
properties:
displayName:
type: string
name:
type: string
description: Portal account type information
SpPortalApplianceToLicenseMap:
title: SpPortalApplianceToLicenseMap
required:
- applianceId
- licenseId
type: object
properties:
applianceId:
type: string
description: Portal mongo object id for the appliance
licenseId:
type: string
description: Portal mongo object id for the ecsp license
SpPortalConfig:
title: SpPortalConfig
type: object
properties:
host:
type: string
port:
type: number
registration:
$ref: '#/components/schemas/SpPortalConfigRegistration'
description: Portal registration information
SpPortalConfigRegistration:
title: SpPortalConfigRegistration
type: object
properties:
account:
type: string
accountId:
type: string
group:
type: string
key:
type: string
oldKey:
type: string
site:
type: string
SpPortalConnectivityGet:
title: SpPortalConnectivityGet
type: object
properties:
portal:
type: integer
format: int32
SpPortalECSPLicense:
title: SpPortalECSPLicense
type: object
properties:
_id:
type: string
account:
type: string
appliance:
type: string
bandwidth:
type: number
boostBandwidth:
type: number
desc:
type: string
endDate:
type: number
name:
type: string
numOverlays:
type: number
quantity:
type: number
salesforceId:
type: string
salesforceSerial:
type: string
startDate:
type: number
subAccount:
type: string
description: EC-SP license details
SpPortalECSPLicenseAssign:
title: SpPortalECSPLicenseAssign
required:
- licenses
type: object
properties:
licenses:
type: array
items:
$ref: '#/components/schemas/SpPortalApplianceToLicenseMap'
description: ''
SpPortalECSPLicenseUnassign:
title: SpPortalECSPLicenseUnassign
required:
- licenses
type: object
properties:
licenses:
type: array
items:
$ref: '#/components/schemas/SpPortalLicenseCollection'
description: ''
SpPortalLicenseCollection:
title: SpPortalLicenseCollection
required:
- licenseId
type: object
properties:
licenseId:
type: string
description: Portal mongo object id for the ecsp license
SpPortalService:
title: SpPortalService
type: object
properties:
enabled:
type: boolean
inProgress:
type: boolean
state:
$ref: '#/components/schemas/SpPortalServiceState'
SpPortalServiceState:
title: SpPortalServiceState
type: object
properties:
fail:
type: number
description: Number of failed runs since Orchestrator service start.
lastFail:
type: number
description: Timestamp of last failed run.
lastOk:
type: number
description: Timestamp of last successful run.
ok:
type: number
description: Number of successful runs since Orchestrator service start.
pollFailInterval:
type: number
description: Polling schedule after failure in minutes.
pollInterval:
type: number
description: Polling schedule in minutes.
tickCount:
type: number
description: Number of minutes remaining until next execution.
SpPortalStatusGetResponse:
title: SpPortalStatusGetResponse
type: object
properties:
:
$ref: '#/components/schemas/SpPortalService'
description: Collection of GeoLocationObject indexed by ip address value
StateObj:
title: StateObj
type: object
properties:
neighbor:
$ref: '#/components/schemas/NeighborStateInfo'
summary:
$ref: '#/components/schemas/BgpStateSummary'
StatsConfig:
title: StatsConfig
required:
- app
- dns
- flows_csv_enable
- ip
- minuteRetention
- port
- verticalRetention
type: object
properties:
app:
$ref: '#/components/schemas/StatsOfOneType'
dns:
$ref: '#/components/schemas/StatsOfOneType'
flows_csv_enable:
type: boolean
description: Need some description here....
ip:
$ref: '#/components/schemas/StatsOfOneType'
minuteRetention:
type: integer
description: The setting of how many minutes of minute stats this appliance will keep
format: int32
port:
$ref: '#/components/schemas/StatsOfOneType'
verticalRetention:
type: integer
description: The setting of how many days of vertical stats this appliance will keep
format: int32
StatsOfAppliances:
title: StatsOfAppliances
required:
- appliance-name
type: object
properties:
appliance-name:
$ref: '#/components/schemas/appliance-Entity'
StatsOfOneType:
title: StatsOfOneType
required:
- evict_enable
- max_items
type: object
properties:
evict_enable:
type: boolean
description: Need some description here....
max_items:
type: integer
description: -1 indicates that appliance controls the number of entries
format: int32
Subnet:
title: Subnet
type: object
properties:
advertized:
type: string
description: No-not advertised, Yes-advertised
application:
type: string
description: Cloud Application name
domain:
type: string
description: Comma separated list of domains
ip_addr:
type: string
description: Reachable IP Address of this subnet
nat_action:
type: number
ping_method:
type: string
description: Protocol used to ping this IP (TCP/UDP)
ping_port:
type: string
description: Port used to ping (80/443)
priority:
type: number
rtt:
type: number
description: Calculated RTT value for this ip in ms. 9999 if its not reachable
saas_id:
type: string
subnet:
type: string
description: Cloud Application subnet value
subnet_action:
type: number
threshold:
type: number
description: RTT threshold value in ms. RTTs above this are advertised
SubnetKeyVal:
title: SubnetKeyVal
type: object
properties:
x.x.x.x/x:
$ref: '#/components/schemas/SingleSubnet'
y.y.y.y/y:
$ref: '#/components/schemas/SingleSubnet'
Subnets:
title: Subnets
required:
- count
- entries
- max
type: object
properties:
count:
type: integer
description: The number of the subnets.
format: int32
entries:
type: array
items:
type: object
description: Each element of this array is one object describing a subnet's detail information, and the minimum number of the elements is 0
max:
type: integer
description: The max number of the subnets this appliance can have.
format: int32
SubnetsPost:
title: SubnetsPost
type: object
properties:
data:
$ref: '#/components/schemas/SubnetsPostData'
options:
$ref: '#/components/schemas/SubnetsPostOptions'
SubnetsPostData:
title: SubnetsPostData
type: object
properties:
prefix:
$ref: '#/components/schemas/SubnetKeyVal'
SubnetsPostOptions:
title: SubnetsPostOptions
type: object
properties:
auto_subnet:
$ref: '#/components/schemas/AutoSubnet1'
SubnetsSystemJson:
title: SubnetsSystemJson
type: object
properties:
auto_subnet:
$ref: '#/components/schemas/AutoSubnet1'
Subscription:
title: Subscription
required:
- cloud
- domain
- partnerKey
- username
type: object
properties:
cloud:
type: string
description: Zscaler Cloud. e.g. 'admin.zscalerthree.net'
domain:
type: string
description: Domain to use for VPN credentials
partnerKey:
type: string
description: Zscaler Third Party Key for SilverPeak.
password:
type: string
description: Zscaler Third Party Admin User Password. Required for the first time or if you want to change password
username:
type: string
description: Zscaler Third Party Admin Username. e.g. 'adminuser@company.com'
TACACSConfig:
title: TACACSConfig
required:
- server
type: object
properties:
server:
allOf:
- $ref: '#/components/schemas/TACACSConfigMap'
- description: You can add a maximum of three TACACS servers.
TACACSConfigElement:
title: TACACSConfigElement
required:
- address
- auth-port
- auth-type
- enable
- key
- retransmit
- self
- timeout
type: object
properties:
address:
type: string
description: IP Address of TACACS server
auth-port:
type: integer
description: Port used by TACACS server
format: int32
auth-type:
type: string
description: Authentication type used by TACACS server
enable:
type: boolean
description: To enable/disable TACACS server
key:
type: string
description: Shared key used for TACACS authentication requests
retransmit:
type: integer
description: Number of retransmit limits for TACACS server
format: int32
self:
type: integer
description: Order of TACACS Servers
format: int32
timeout:
type: integer
description: timeout in seconds for authentication requests
format: int32
TACACSConfigMap:
title: TACACSConfigMap
required:
-
type: object
properties:
:
$ref: '#/components/schemas/TACACSConfigElement'
description: You can add a maximum of three TACACS servers.
TCTunnelsThreshold:
title: TCTunnelsThreshold
type: object
properties:
fastfail:
type: number
TcaDataInfo:
title: TcaDataInfo
required:
- UI
- allow_disable
- allow_falling
- allow_rising
- dft
- threshold_max
- threshold_min
type: object
properties:
UI:
$ref: '#/components/schemas/TcaUIInfo'
allow_disable:
type: boolean
description: Need description here
allow_falling:
type: boolean
description: Need description here
allow_rising:
type: boolean
description: Need description here
dft:
$ref: '#/components/schemas/DftData'
threshold_max:
type: integer
description: Need description here
format: int32
threshold_min:
type: integer
description: Need description here
format: int32
TcaInfo:
title: TcaInfo
required:
- file-system-utilization
- lan-side-rx-throughput
- latency
- loss-post-fec
- loss-pre-fec
- oop-post-poc
- oop-pre-poc
- optimized-flows
- reduction
- total-flows
- utilization
- wan-side-tx-throughput
type: object
properties:
file-system-utilization:
$ref: '#/components/schemas/TcaDataInfo'
lan-side-rx-throughput:
$ref: '#/components/schemas/TcaDataInfo'
latency:
$ref: '#/components/schemas/TcaDataInfo'
loss-post-fec:
$ref: '#/components/schemas/TcaDataInfo'
loss-pre-fec:
$ref: '#/components/schemas/TcaDataInfo'
oop-post-poc:
$ref: '#/components/schemas/TcaDataInfo'
oop-pre-poc:
$ref: '#/components/schemas/TcaDataInfo'
optimized-flows:
$ref: '#/components/schemas/TcaDataInfo'
reduction:
$ref: '#/components/schemas/TcaDataInfo'
total-flows:
$ref: '#/components/schemas/TcaDataInfo'
utilization:
$ref: '#/components/schemas/TcaDataInfo'
wan-side-tx-throughput:
$ref: '#/components/schemas/TcaDataInfo'
TcaUIInfo:
title: TcaUIInfo
required:
- allow_config
- descr
- units
type: object
properties:
allow_config:
type: boolean
description: Need description here
descr:
type: string
description: Need description here
inst_bname:
$ref: '#/components/schemas/InstBNameData'
units:
type: string
description: Need description here
TcpdumpStatus:
title: TcpdumpStatus
required:
- active
- lastOneDone
- progress
type: object
properties:
active:
type: boolean
description: Boolean value indicating whether packet capture process is running
lastOneDone:
type: boolean
description: Boolean value indication whether packet capture is already finish but still remains in post run processing stage
progress:
type: number
description: Progress info of current packet capture, percentage
TemplateApplyResponse:
title: TemplateApplyResponse
required:
- groupName
- nePk
- status
- templateName
type: object
properties:
groupName:
type: string
description: Name of the template group
nePk:
type: string
description: Appliance ID
status:
$ref: '#/components/schemas/TemplateApplyStatusResponse'
templateName:
type: string
description: Name of the template
TemplateApplyStatusResponse:
title: TemplateApplyStatusResponse
required:
- message
- statusCode
type: object
properties:
message:
type: string
statusCode:
type: integer
format: int32
TemplateCreateBody:
title: TemplateCreateBody
required:
- name
- templates
type: object
properties:
name:
type: string
templates:
type: array
items:
$ref: '#/components/schemas/TemplatePOST'
description: An array of the templates you want to create/update
TemplateGroupPriorities:
title: TemplateGroupPriorities
type: object
properties:
priorities:
type: array
items:
type: string
description: Names of the template groups associated with this appliance
description: Map of appliance IDs to template group names associated with them
TemplateGroupsItem:
title: TemplateGroupsItem
type: object
properties:
name:
type: string
description: Name of the template group
selectedTemplates:
type: array
items:
type: object
description: All selected template(s) data in the template group
templates:
type: array
items:
type: object
description: All templates data in the template group
description: Template group data
TemplateHistoryItem:
title: TemplateHistoryItem
required:
- appliedOn
- nePk
- status
- statusMessage
- templateGroup
- templateName
- user
type: object
properties:
appliedOn:
type: integer
format: int32
nePk:
type: string
status:
type: string
statusMessage:
type: string
templateGroup:
type: string
templateName:
type: string
user:
type: string
TemplateItem:
title: TemplateItem
required:
- buildVersion
- isselected
- lastSaved
- name
- path
- valObject
- value
type: object
properties:
buildVersion:
type: string
isselected:
type: boolean
lastSaved:
type: integer
format: int32
name:
type: string
path:
type: string
valObject:
type: object
value:
type: object
TemplatePOST:
title: TemplatePOST
type: object
properties:
name:
type: string
description: The name of the template. See the default template group for all the names of the templates
valObject:
type: object
description: The template data to configure.
ThirdPartyService:
title: ThirdPartyService
type: object
properties:
enabled:
type: boolean
description: Service is enabled/used
img:
type: string
description: Path to the third party icon image
name:
type: string
description: The display name of the service. Pass through tunnel will use a dynamically generated service/peer name
peerName:
type: string
description: Service peer name(wildcard)
ThirdPartyTunnelConfigData:
title: ThirdPartyTunnelConfigData
required:
- admin
- auto_mtu
- bound_tun
- destination
- gre_proto
- id2
- ipsec_arc_window
- ipsec_enable
- max_bw
- max_bw_auto
- min_bw
- mode
- mtu
- self
- source
- tag_name
- udp_flows
type: object
properties:
admin:
type: string
description: "Admin state of the tunnel - takes two values: 'up' or 'down'."
auto_mtu:
type: boolean
description: Determines if the tunnel should have auto MTU detection.
bound_tun:
$ref: '#/components/schemas/BoundTunnels'
ctrl_pkt:
$ref: '#/components/schemas/FecSettings'
destination:
type: string
description: Destination IP address.
gre_proto:
type: integer
description: GRE protocol in the GRE header
format: int32
id2:
type: integer
description: id of overlay 1-7
format: int32
ipsec_arc_window:
type: string
description: IPSec ARC Window - not configurable.
ipsec_enable:
type: boolean
description: A quick shortcut for knowing if tunnel mode is IPSec. You can get the same information using mode property.
max_bw:
type: integer
description: If the tunnel max bandwidth is manually configured, use this field and set max_bw_auto to false. Units Kbps.
format: int32
max_bw_auto:
type: boolean
description: If the tunnel max bandwidth needs to be set to auto, this field must be true.
min_bw:
type: integer
description: Tunnel minimum bandwidth
format: int32
mode:
type: string
description: "Tunnel mode: it can be one of 'gre', 'udp', 'ipsec'"
mtu:
type: integer
description: Tunnel MTU. If 'auto_mtu' is false, user must set a specific tunnel mtu value
format: int32
options:
type: integer
description: Not used
format: int32
pkt:
$ref: '#/components/schemas/FecSettings'
self:
type: string
description: The value is the same as the tunnel name.
source:
type: string
description: Source IP address of the tunnel.
tag_name:
type: string
description: name of overlay
threshold:
$ref: '#/components/schemas/TunnelHealthFailureCount'
type:
type: string
description: Not used
udp_dest_port:
type: integer
description: If the tunnel is of type 'udp', the udp port to use.
format: int32
udp_flows:
type: integer
description: If tunnel mode is udp, this field determines how many different udp flows are used to distribute tunnel traffic
format: int32
ThirdPartyTunnelsConfigAndStates:
title: ThirdPartyTunnelsConfigAndStates
required:
-
- allTunnelState
type: object
properties:
:
$ref: '#/components/schemas/ThirdPartyTunnelConfigData'
allTunnelState:
$ref: '#/components/schemas/AllStates'
Tier:
title: Tier
required:
- count
- display
type: object
properties:
count:
type: integer
format: int32
display:
type: string
TierSummary:
title: TierSummary
required:
-
type: object
properties:
:
$ref: '#/components/schemas/Tier'
TimeSeriesBoostStats:
title: TimeSeriesBoostStats
required:
- column_def
- data
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
type: array
items:
$ref: '#/components/schemas/TimeSeriesBoostStatsData'
description: An array that contains the stats data of specific tunnel of current appliance
TimeSeriesBoostStatsData:
title: TimeSeriesBoostStatsData
type: object
properties:
MAX_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual starting boundary of data time range
format: int32
MIN_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual ending boundary of data time range
format: int32
boost:
type: integer
description: Insufficient Boost
format: int32
boost_bytes:
type: integer
description: Number of packets LAN side transmitted
format: int32
configured:
type: integer
description: System configured boost
format: int32
nePk:
type: string
description: Internal ID of the appliance
seconds_not_boosted:
type: integer
description: Seconds not boosted in selected time range
format: int32
description: An array that contains the stats data of a certain timestamp
TimeSeriesDrcStats:
title: TimeSeriesDrcStats
required:
- column_def
- data
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
type: array
items:
$ref: '#/components/schemas/TimeSeriesDrcStatsItems'
description: An array that contains the stats data of specific tunnel of current appliance
TimeSeriesDrcStatsDataMultiAppliances:
title: TimeSeriesDrcStatsDataMultiAppliances
required:
-
type: object
properties:
:
type: array
items:
$ref: '#/components/schemas/TimeSeriesDrcStatsItems'
description: An array that contains the stats data of current appliance
TimeSeriesDrcStatsItems:
title: TimeSeriesDrcStatsItems
type: object
properties:
ERC_MAX_RX:
type: integer
description: ERC max received
format: int32
ERC_MAX_RX_TS:
type: integer
description: ERC max received timestamp
format: int32
ERC_MAX_TX:
type: integer
description: ERC max transmitted
format: int32
ERC_MAX_TX_TS:
type: integer
description: ERC max transmitted timestamp
format: int32
ERC_MIN_RX:
type: integer
description: ERC min received
format: int32
ERC_MIN_RX_TS:
type: integer
description: ERC min received timestamp
format: int32
ERC_MIN_TX:
type: integer
description: ERC min transmitted
format: int32
ERC_MIN_TX_TS:
type: integer
description: ERC min transmitted timestamp
format: int32
TIMESTAMP:
type: integer
description: Timestamp in EPOCH time, all timestamp fields are in EPOCH time
format: int32
TUNNEL:
type: integer
description: Tunnel
format: int32
TimeSeriesDrcStatsMultiAppliances:
title: TimeSeriesDrcStatsMultiAppliances
required:
- column_def
- data
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
$ref: '#/components/schemas/TimeSeriesDrcStatsDataMultiAppliances'
TimeSeriesMOSStats:
title: TimeSeriesMOSStats
required:
- column_def
- data
type: object
properties:
column_def:
type: array
items:
$ref: '#/components/schemas/TimeSeriesMOSStatsColumnDef'
description: These names correspond to each stats field in the array of stats.
data:
type: array
items:
type: array
items:
type: object
TimeSeriesMOSStatsColumnDef:
title: TimeSeriesMOSStatsColumnDef
type: object
properties:
min_mos:
type: string
description: The port to use when building IPSec UDP tunnels on this appliance
min_mos_ts:
type: integer
description: Min. Mean Opinion Score timestamp
format: int32
mos:
type: string
description: The port to use when building IPSec UDP tunnels on this appliance
time:
type: integer
description: Time stamp
format: int32
tunnel:
type: string
description: Tunnel
TimeSeriesStats:
title: TimeSeriesStats
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
type: array
items:
$ref: '#/components/schemas/TimeSeriesStatsData'
description: ''
TimeSeriesStatsAppliance:
title: TimeSeriesStatsAppliance
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
$ref: '#/components/schemas/TimeSeriesStatsDataAppliance'
TimeSeriesStatsData:
title: TimeSeriesStatsData
type: object
properties:
BW_PCT_UTIL_AVG:
type: integer
description: Average bandwidth utilization percentage
format: int32
BW_PCT_UTIL_MAX:
type: integer
description: Peak bandwidth utilization percentage
format: int32
BW_PCT_UTIL_MAX_TS:
type: integer
description: Timestamp of when peak bandwidth utilization percentage occurred
format: int32
COMP_L2W:
type: integer
description: LAN to WAN compression
format: int32
COMP_L2WMAX:
type: integer
description: Peak LAN to WAN compression for one second interval
format: int32
COMP_L2WMAX_TS:
type: integer
description: Timestamp of when peak LAN to WAN compression occurred
format: int32
COMP_NOOHEAD_L2W:
type: integer
description: LAN to WAN compression without protocol headers
format: int32
COMP_NOOHEAD_L2WMAX:
type: integer
description: Peak LAN to WAN compression without protocol headers
format: int32
COMP_NOOHEAD_L2WMAX_TS:
type: integer
description: Timestamp of when peak LAN to WAN compression without protocol headers occurred
format: int32
COMP_NOOHEAD_W2L:
type: integer
description: WAN to LAN compression without protocol headers
format: int32
COMP_NOOHEAD_W2LMAX:
type: integer
description: Peak WAN to LAN compression without protocol headers
format: int32
COMP_NOOHEAD_W2LMAX_TS:
type: integer
description: Timestamp of when peak WAN to LAN compression without protocol headers occurred
format: int32
COMP_W2L:
type: integer
description: WAN to LAN compression
format: int32
COMP_W2LMAX:
type: integer
description: Peak WAN to LAN compression for one second interval
format: int32
COMP_W2LMAX_TS:
type: integer
description: Timestamp of when peak WAN to LAN compression occurred
format: int32
CREATED:
type: integer
description: Number of created flows
format: int32
CREATED_MAX:
type: integer
description: Peak number of created flows
format: int32
CREATED_MAX_TS:
type: integer
description: Timestamp of when peak number of created flows occurred
format: int32
DELETED:
type: integer
description: Number of deleted flows
format: int32
DELETED_MAX:
type: integer
description: Peak number of deleted flows
format: int32
DELETED_MAX_TS:
type: integer
description: Timestamp of when peak number of deleted flows occurred
format: int32
LATENCY_AVG:
type: integer
description: Average latency
format: int32
LATENCY_MAX:
type: integer
description: Peak latency
format: int32
LATENCY_MAX_TS:
type: integer
description: Timestamp of when peak latency occurred
format: int32
LATENCY_MIN:
type: integer
description: Lowest latency
format: int32
LATENCY_MIN_FROM_PEAK:
type: integer
description: Different between lowest latency and peak latency
format: int32
LATENCY_MIN_TS:
type: integer
description: Timestamp of when lowest latency occurred
format: int32
LRX_BYTES:
type: integer
description: Number of bytes LAN side received
format: int32
LRX_BYTES_MAX:
type: integer
description: Peak number of bytes LAN side received in one second
format: int32
LRX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes LAN side received
format: int32
LRX_PKTS:
type: integer
description: Number of packets LAN side received
format: int32
LRX_PKTS_MAX:
type: integer
description: Peak number of packets LAN side received in one second
format: int32
LRX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets LAN side received
format: int32
LTX_BYTES:
type: integer
description: Number of bytes LAN side transmitted
format: int32
LTX_BYTES_MAX:
type: integer
description: Peak number of bytes LAN side transmitted in one second
format: int32
LTX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes LAN side transmitted
format: int32
LTX_PKTS:
type: integer
description: Number of packets LAN side transmitted
format: int32
LTX_PKTS_MAX:
type: integer
description: Peak number of packets LAN side transmitted in one second
format: int32
LTX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets LAN side transmitted
format: int32
NON_TCP_FLOWS:
type: integer
description: Number of non-TCP flows
format: int32
NON_TCP_FLOWS_MAX:
type: integer
description: Peak number of non-TCP flows
format: int32
NON_TCP_FLOWS_MAX_TS:
type: integer
description: Timestamp of when peak number of non-TCP flows occurred
format: int32
OHEAD_WRX_BYTES:
type: integer
description: Number of bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_BYTES_MAX:
type: integer
description: Peak number of bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_HDR_BYTES:
type: integer
description: Number of header bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_HDR_BYTES_MAX:
type: integer
description: Peak number of header bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_HDR_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of header bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_PKTS:
type: integer
description: Number of packets of protocol headers WAN side received
format: int32
OHEAD_WRX_PKTS_MAX:
type: integer
description: Peak number of packets of protocol headers WAN side received
format: int32
OHEAD_WRX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets of protocol headers WAN side received
format: int32
OHEAD_WTX_BYTES:
type: integer
description: Number of bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_BYTES_MAX:
type: integer
description: Peak number of bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_HDR_BYTES:
type: integer
description: Number of header bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_HDR_BYTES_MAX:
type: integer
description: Peak number of header bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_HDR_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of header bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_PKTS:
type: integer
description: Number of packets of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_PKTS_MAX:
type: integer
description: Peak number of packets of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets of protocol headers WAN side transmitted
format: int32
POST_LOSS:
type: integer
description: Number of packets loss after correction
format: int32
POST_LOSS_MAX:
type: integer
description: Peak number of packets loss after correction
format: int32
POST_LOSS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets loss occurred after correction
format: int32
POST_PCT_LOSS:
type: integer
description: Percentage of packets loss after correction
format: int32
POST_PCT_LOSS_MAX:
type: integer
description: Peak number of percentage of packets loss after correction
format: int32
POST_PCT_LOSS_MAX_TS:
type: integer
description: Timestamp of when peak number of percentage of packets loss occurred after correction
format: int32
POST_PCT_POC:
type: integer
description: Percentage of out of order packets after correction
format: int32
POST_PCT_POCMAX:
type: integer
description: Peak number of percentage of packets out of order after correction
format: int32
POST_PCT_POCMAX_TS:
type: integer
description: Timestamp of when peak number of percentage of packets out of order occurred after correction
format: int32
POST_POC:
type: integer
description: Number of packets out of order after correction
format: int32
POST_POCMAX:
type: integer
description: Peak number of packets out of order after correction
format: int32
POST_POCMAX_TS:
type: integer
description: Timestamp of when peak number of packets out of order occurred after correction
format: int32
PRE_LOSS:
type: integer
description: Number of packets loss before correction
format: int32
PRE_LOSS_MAX:
type: integer
description: Peak number of packets loss before correction
format: int32
PRE_LOSS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets loss occurred before correction
format: int32
PRE_PCT_LOSS:
type: integer
description: Percentage of packets loss before correction
format: int32
PRE_PCT_LOSS_MAX:
type: integer
description: Peak number of percentage of packets loss before correction
format: int32
PRE_PCT_LOSS_MAX_TS:
type: integer
description: Timestamp of when peak number of percentage of packets loss occurred before correction
format: int32
PRE_PCT_POC:
type: integer
description: Percentage of out of order packets before correction
format: int32
PRE_PCT_POCMAX:
type: integer
description: Peak number of percentage of packets out of order before correction
format: int32
PRE_PCT_POCMAX_TS:
type: integer
description: Timestamp of when peak number of percentage of packets out of order occurred before correction
format: int32
PRE_POC:
type: integer
description: Number of packets out of order before correction
format: int32
PRE_POCMAX:
type: integer
description: Peak number of packets out of order before correction
format: int32
PRE_POCMAX_TS:
type: integer
description: Timestamp of when peak number of packets out of order occurred before correction
format: int32
TCP_ACC_FLOWS:
type: integer
description: Number of TCP unaccelerated flows
format: int32
TCP_ACC_FLOWS_MAX:
type: integer
description: Peak number of TCP unaccelerated flows
format: int32
TCP_ACC_FLOWS_MAX_TS:
type: integer
description: Timestamp of when peak number of TCP unaccelerated flows occurred
format: int32
TCP_FLOWS:
type: integer
description: Number of TCP accelerated flows
format: int32
TCP_FLOWS_MAX:
type: integer
description: Peak number of TCP accelerated flows
format: int32
TCP_FLOWS_MAX_TS:
type: integer
description: Timestamp of when peak number of TCP accelerated flows occurred
format: int32
TIMESTAMP:
type: integer
description: Timestamp in EPOCH time, all timestamp fields are in EPOCH time
format: int32
WRX_BYTES:
type: integer
description: Number of bytes WAN side received
format: int32
WRX_BYTES_MAX:
type: integer
description: Peak number of bytes WAN side received in one second
format: int32
WRX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes WAN side received
format: int32
WRX_PKTS:
type: integer
description: Number of packets WAN side received
format: int32
WRX_PKTS_MAX:
type: integer
description: Peak number of packets WAN side received in one second
format: int32
WRX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets WAN side received
format: int32
WTX_BYTES:
type: integer
description: Number of bytes WAN side transmitted
format: int32
WTX_BYTES_MAX:
type: integer
description: Peak number of bytes WAN side transmitted in one second
format: int32
WTX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes WAN side transmitted
format: int32
WTX_PKTS:
type: integer
description: Number of packets WAN side transmitted
format: int32
WTX_PKTS_MAX:
type: integer
description: Peak number of packets WAN side transmitted in one second
format: int32
WTX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets WAN side transmitted
format: int32
description: An array that contains the stats data of a certain timestamp.
TimeSeriesStatsDataAppliance:
title: TimeSeriesStatsDataAppliance
type: object
properties:
:
type: array
items:
$ref: '#/components/schemas/TimeSeriesStatsItems'
description: ''
TimeSeriesStatsDataMultiAppliances:
title: TimeSeriesStatsDataMultiAppliances
type: object
properties:
:
type: array
items:
$ref: '#/components/schemas/TimeSeriesStatsData'
description: ''
TimeSeriesStatsDataMultiAppliances2:
title: TimeSeriesStatsDataMultiAppliances2
type: object
properties:
APPNAME:
type: string
description: Application name
LRX_BYTES:
type: integer
description: Number of bytes LAN side received
format: int32
LRX_PKTS:
type: integer
description: Number of packets LAN side received
format: int32
LTX_BYTES:
type: integer
description: Number of bytes LAN side transmitted
format: int32
LTX_PKTS:
type: integer
description: Number of packets LAN side transmitted
format: int32
TIMESTAMP:
type: integer
description: Timestamp in EPOCH time, all timestamp fields are in EPOCH time
format: int32
WRX_BYTES:
type: integer
description: Number of bytes WAN side received
format: int32
WRX_PKTS:
type: integer
description: Number of packets WAN side received
format: int32
WTX_BYTES:
type: integer
description: Number of bytes WAN side transmitted
format: int32
WTX_PKTS:
type: integer
description: Number of packets WAN side transmitted
format: int32
nePk:
type: string
description: Internal ID of the appliance
TimeSeriesStatsItems:
title: TimeSeriesStatsItems
type: object
properties:
BW_PCT_UTIL_AVG:
type: integer
description: Average bandwidth utilization percentage
format: int32
BW_PCT_UTIL_MAX:
type: integer
description: Peak bandwidth utilization percentage
format: int32
BW_PCT_UTIL_MAX_TS:
type: integer
description: Timestamp of when peak bandwidth utilization percentage occurred
format: int32
COMP_L2W:
type: integer
description: LAN to WAN compression
format: int32
COMP_L2WMAX:
type: integer
description: Peak LAN to WAN compression for one second interval
format: int32
COMP_L2WMAX_TS:
type: integer
description: Timestamp of when peak LAN to WAN compression occurred
format: int32
COMP_NOOHEAD_L2W:
type: integer
description: LAN to WAN compression without protocol headers
format: int32
COMP_NOOHEAD_L2WMAX:
type: integer
description: Peak LAN to WAN compression without protocol headers
format: int32
COMP_NOOHEAD_L2WMAX_TS:
type: integer
description: Timestamp of when peak LAN to WAN compression without protocol headers occurred
format: int32
COMP_NOOHEAD_W2L:
type: integer
description: WAN to LAN compression without protocol headers
format: int32
COMP_NOOHEAD_W2LMAX:
type: integer
description: Peak WAN to LAN compression without protocol headers
format: int32
COMP_NOOHEAD_W2LMAX_TS:
type: integer
description: Timestamp of when peak WAN to LAN compression without protocol headers occurred
format: int32
COMP_W2L:
type: integer
description: WAN to LAN compression
format: int32
COMP_W2LMAX:
type: integer
description: Peak WAN to LAN compression for one second interval
format: int32
COMP_W2LMAX_TS:
type: integer
description: Timestamp of when peak WAN to LAN compression occurred
format: int32
CREATED:
type: integer
description: Number of created flows
format: int32
CREATED_MAX:
type: integer
description: Peak number of created flows
format: int32
CREATED_MAX_TS:
type: integer
description: Timestamp of when peak number of created flows occurred
format: int32
DELETED:
type: integer
description: Number of deleted flows
format: int32
DELETED_MAX:
type: integer
description: Peak number of deleted flows
format: int32
DELETED_MAX_TS:
type: integer
description: Timestamp of when peak number of deleted flows occurred
format: int32
LATENCY_AVG:
type: integer
description: Average latency
format: int32
LATENCY_MAX:
type: integer
description: Peak latency
format: int32
LATENCY_MAX_TS:
type: integer
description: Timestamp of when peak latency occurred
format: int32
LATENCY_MIN:
type: integer
description: Lowest latency
format: int32
LATENCY_MIN_FROM_PEAK:
type: integer
description: Different between lowest latency and peak latency
format: int32
LATENCY_MIN_TS:
type: integer
description: Timestamp of when lowest latency occurred
format: int32
LRX_BYTES:
type: integer
description: Number of bytes LAN side received
format: int32
LRX_BYTES_MAX:
type: integer
description: Peak number of bytes LAN side received in one second
format: int32
LRX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes LAN side received
format: int32
LRX_PKTS:
type: integer
description: Number of packets LAN side received
format: int32
LRX_PKTS_MAX:
type: integer
description: Peak number of packets LAN side received in one second
format: int32
LRX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets LAN side received
format: int32
LTX_BYTES:
type: integer
description: Number of bytes LAN side transmitted
format: int32
LTX_BYTES_MAX:
type: integer
description: Peak number of bytes LAN side transmitted in one second
format: int32
LTX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes LAN side transmitted
format: int32
LTX_PKTS:
type: integer
description: Number of packets LAN side transmitted
format: int32
LTX_PKTS_MAX:
type: integer
description: Peak number of packets LAN side transmitted in one second
format: int32
LTX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets LAN side transmitted
format: int32
NON_TCP_FLOWS:
type: integer
description: Number of non-TCP flows
format: int32
NON_TCP_FLOWS_MAX:
type: integer
description: Peak number of non-TCP flows
format: int32
NON_TCP_FLOWS_MAX_TS:
type: integer
description: Timestamp of when peak number of non-TCP flows occurred
format: int32
OHEAD_WRX_BYTES:
type: integer
description: Number of bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_BYTES_MAX:
type: integer
description: Peak number of bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_HDR_BYTES:
type: integer
description: Number of header bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_HDR_BYTES_MAX:
type: integer
description: Peak number of header bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_HDR_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of header bytes of protocol headers WAN side received
format: int32
OHEAD_WRX_PKTS:
type: integer
description: Number of packets of protocol headers WAN side received
format: int32
OHEAD_WRX_PKTS_MAX:
type: integer
description: Peak number of packets of protocol headers WAN side received
format: int32
OHEAD_WRX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets of protocol headers WAN side received
format: int32
OHEAD_WTX_BYTES:
type: integer
description: Number of bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_BYTES_MAX:
type: integer
description: Peak number of bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_HDR_BYTES:
type: integer
description: Number of header bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_HDR_BYTES_MAX:
type: integer
description: Peak number of header bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_HDR_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of header bytes of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_PKTS:
type: integer
description: Number of packets of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_PKTS_MAX:
type: integer
description: Peak number of packets of protocol headers WAN side transmitted
format: int32
OHEAD_WTX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets of protocol headers WAN side transmitted
format: int32
POST_LOSS:
type: integer
description: Number of packets loss after correction
format: int32
POST_LOSS_MAX:
type: integer
description: Peak number of packets loss after correction
format: int32
POST_LOSS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets loss occurred after correction
format: int32
POST_PCT_LOSS:
type: integer
description: Percentage of packets loss after correction
format: int32
POST_PCT_LOSS_MAX:
type: integer
description: Peak number of percentage of packets loss after correction
format: int32
POST_PCT_LOSS_MAX_TS:
type: integer
description: Timestamp of when peak number of percentage of packets loss occurred after correction
format: int32
POST_PCT_POC:
type: integer
description: Percentage of out of order packets after correction
format: int32
POST_PCT_POCMAX:
type: integer
description: Peak number of percentage of packets out of order after correction
format: int32
POST_PCT_POCMAX_TS:
type: integer
description: Timestamp of when peak number of percentage of packets out of order occurred after correction
format: int32
POST_POC:
type: integer
description: Number of packets out of order after correction
format: int32
POST_POCMAX:
type: integer
description: Peak number of packets out of order after correction
format: int32
POST_POCMAX_TS:
type: integer
description: Timestamp of when peak number of packets out of order occurred after correction
format: int32
PRE_LOSS:
type: integer
description: Number of packets loss before correction
format: int32
PRE_LOSS_MAX:
type: integer
description: Peak number of packets loss before correction
format: int32
PRE_LOSS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets loss occurred before correction
format: int32
PRE_PCT_LOSS:
type: integer
description: Percentage of packets loss before correction
format: int32
PRE_PCT_LOSS_MAX:
type: integer
description: Peak number of percentage of packets loss before correction
format: int32
PRE_PCT_LOSS_MAX_TS:
type: integer
description: Timestamp of when peak number of percentage of packets loss occurred before correction
format: int32
PRE_PCT_POC:
type: integer
description: Percentage of out of order packets before correction
format: int32
PRE_PCT_POCMAX:
type: integer
description: Peak number of percentage of packets out of order before correction
format: int32
PRE_PCT_POCMAX_TS:
type: integer
description: Timestamp of when peak number of percentage of packets out of order occurred before correction
format: int32
PRE_POC:
type: integer
description: Number of packets out of order before correction
format: int32
PRE_POCMAX:
type: integer
description: Peak number of packets out of order before correction
format: int32
PRE_POCMAX_TS:
type: integer
description: Timestamp of when peak number of packets out of order occurred before correction
format: int32
TCP_ACC_FLOWS:
type: integer
description: Number of TCP unaccelerated flows
format: int32
TCP_ACC_FLOWS_MAX:
type: integer
description: Peak number of TCP unaccelerated flows
format: int32
TCP_ACC_FLOWS_MAX_TS:
type: integer
description: Timestamp of when peak number of TCP unaccelerated flows occurred
format: int32
TCP_FLOWS:
type: integer
description: Number of TCP accelerated flows
format: int32
TCP_FLOWS_MAX:
type: integer
description: Peak number of TCP accelerated flows
format: int32
TCP_FLOWS_MAX_TS:
type: integer
description: Timestamp of when peak number of TCP accelerated flows occurred
format: int32
TIMESTAMP:
type: integer
description: Timestamp in EPOCH time, all timestamp fields are in EPOCH time
format: int32
TRAFFIC_TYPE:
type: integer
description: 'Integer value indicating the traffic type these stats belong to. 1: Optimized Traffic, 2: Pass-through Shaped, 3: Pass-through Unshaped, 4: All Traffic'
format: int32
WRX_BYTES:
type: integer
description: Number of bytes WAN side received
format: int32
WRX_BYTES_MAX:
type: integer
description: Peak number of bytes WAN side received in one second
format: int32
WRX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes WAN side received
format: int32
WRX_PKTS:
type: integer
description: Number of packets WAN side received
format: int32
WRX_PKTS_MAX:
type: integer
description: Peak number of packets WAN side received in one second
format: int32
WRX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets WAN side received
format: int32
WTX_BYTES:
type: integer
description: Number of bytes WAN side transmitted
format: int32
WTX_BYTES_MAX:
type: integer
description: Peak number of bytes WAN side transmitted in one second
format: int32
WTX_BYTES_MAX_TS:
type: integer
description: Timestamp of when peak number of bytes WAN side transmitted
format: int32
WTX_PKTS:
type: integer
description: Number of packets WAN side transmitted
format: int32
WTX_PKTS_MAX:
type: integer
description: Peak number of packets WAN side transmitted in one second
format: int32
WTX_PKTS_MAX_TS:
type: integer
description: Timestamp of when peak number of packets WAN side transmitted
format: int32
description: An array that contains the stats data of a certain timestamp.
TimeSeriesStatsMultiAppliances:
title: TimeSeriesStatsMultiAppliances
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
$ref: '#/components/schemas/TimeSeriesStatsDataMultiAppliances'
TimeSeriesStatsMultiAppliances2:
title: TimeSeriesStatsMultiAppliances2
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimeSeriesStatsDataMultiAppliances2'
description: ''
TimeSeriesStatsOneAppliance:
title: TimeSeriesStatsOneAppliance
type: object
properties:
column_def:
type: array
items:
type: string
description: These names correspond to each stats field in the array of stats.
data:
type: array
items:
$ref: '#/components/schemas/TimeSeriesStatsItems'
description: ''
TopologyConfiguration:
title: TopologyConfiguration
type: object
properties:
key:
$ref: '#/components/schemas/PreferenceResponse'
TopologySaveMapRequest:
title: TopologySaveMapRequest
type: object
properties:
default:
$ref: '#/components/schemas/MapSave'
TopologySaveRequest:
title: TopologySaveRequest
type: object
properties:
username:
$ref: '#/components/schemas/PreferenceSave'
TrafficClassAggregateStats:
title: TrafficClassAggregateStats
required:
-
type: object
properties:
:
$ref: '#/components/schemas/TrafficClassAggregateStatsTrafficClassLevelObject'
TrafficClassAggregateStatsApplianceLevelObject:
title: TrafficClassAggregateStatsApplianceLevelObject
required:
-
type: object
properties:
:
$ref: '#/components/schemas/TrafficClassAggregateStatsBase'
TrafficClassAggregateStatsBase:
title: TrafficClassAggregateStatsBase
required:
- HOSTNAME
- IP
- MAX_COMP_L2W
- MAX_COMP_L2WMAX
- MAX_COMP_NOOHEAD_L2W
- MAX_COMP_NOOHEAD_L2WMAX
- MAX_COMP_NOOHEAD_W2L
- MAX_COMP_NOOHEAD_W2LMAX
- MAX_COMP_W2L
- MAX_COMP_W2LMAX
- MAX_LRX_BYTES_MAX
- MAX_LRX_PKTS_MAX
- MAX_LTX_BYTES_MAX
- MAX_LTX_PKTS_MAX
- MAX_TIMESTAMP
- MAX_WRX_BYTES_MAX
- MAX_WRX_PKTS_MAX
- MAX_WTX_BYTES_MAX
- MAX_WTX_PKTS_MAX
- MIN_TIMESTAMP
- SUM_LRX_BYTES
- SUM_LRX_PKTS
- SUM_LTX_BYTES
- SUM_LTX_PKTS
- SUM_WRX_BYTES
- SUM_WRX_PKTS
- SUM_WTX_BYTES
- SUM_WTX_PKTS
- TRAFFIC_CLASS
- TRAFFIC_TYPE
- nePk
type: object
properties:
HOSTNAME:
type: string
description: Hostname of the appliance
IP:
type: string
description: Management IP address of appliance
MAX_COMP_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate
format: int32
MAX_COMP_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate
format: int32
MAX_COMP_NOOHEAD_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate without overhead
format: int32
MAX_COMP_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate
format: int32
MAX_COMP_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate
format: int32
MAX_LRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side received
format: int32
MAX_LRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side received
format: int32
MAX_LTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side transmitted
format: int32
MAX_LTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side transmitted
format: int32
MAX_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual starting boundary of data time range
format: int32
MAX_WRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side received
format: int32
MAX_WRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side received
format: int32
MAX_WTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side transmitted
format: int32
MAX_WTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side transmitted
format: int32
MIN_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual ending boundary of data time range
format: int32
SUM_LRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side received
format: int32
SUM_LRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_LTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side transmitted
format: int32
SUM_LTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_WRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side received
format: int32
SUM_WRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side received
format: int32
SUM_WTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side transmitted
format: int32
SUM_WTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side transmitted
format: int32
TRAFFIC_CLASS:
type: integer
description: Integer value of traffic class to which these stats belong to
format: int32
TRAFFIC_TYPE:
type: integer
description: 'Integer value indicating the traffic type these stats belong to. 1: Optimized Traffic, 2: Pass-through Shaped, 3: Pass-through Unshaped, 4: All Traffic'
format: int32
nePk:
type: string
description: Internal ID of appliance
TrafficClassAggregateStatsTrafficClassLevelObject:
title: TrafficClassAggregateStatsTrafficClassLevelObject
required:
-
type: object
properties:
:
$ref: '#/components/schemas/TrafficClassAggregateStatsApplianceLevelObject'
TunnelAggregateDrcStatsBase:
title: TunnelAggregateDrcStatsBase
required:
- AVG_ERC_MAX_RX
- AVG_ERC_MAX_RX_TS
- AVG_ERC_MAX_TX
- AVG_ERC_MAX_TX_TS
- AVG_ERC_MIN_RX
- AVG_ERC_MIN_RX_TS
- AVG_ERC_MIN_TX
- AVG_ERC_MIN_TX_TS
- MAX_ERC_MAX_RX
- MAX_ERC_MAX_RX_TS
- MAX_ERC_MAX_TX
- MAX_ERC_MAX_TX_TS
- MAX_ERC_MIN_RX
- MAX_ERC_MIN_RX_TS
- MAX_ERC_MIN_TX
- MAX_ERC_MIN_TX_TS
- MAX_TIMESTAMP
- MIN_ERC_MAX_RX
- MIN_ERC_MAX_RX_TS
- MIN_ERC_MAX_TX
- MIN_ERC_MAX_TX_TS
- MIN_ERC_MIN_RX
- MIN_ERC_MIN_RX_TS
- MIN_ERC_MIN_TX
- MIN_ERC_MIN_TX_TS
- MIN_TIMESTAMP
- PEAK_THROUGHPUT
- SUM_ERC_MAX_RX
- SUM_ERC_MAX_RX_TS
- SUM_ERC_MAX_TX
- SUM_ERC_MAX_TX_TS
- SUM_ERC_MIN_RX
- SUM_ERC_MIN_RX_TS
- SUM_ERC_MIN_TX
- SUM_ERC_MIN_TX_TS
- TUNNEL
- isPassThrough
- nePk
type: object
properties:
AVG_ERC_MAX_RX:
type: integer
description: Need description here...
format: int32
AVG_ERC_MAX_RX_TS:
type: integer
description: Need description here...
format: int32
AVG_ERC_MAX_TX:
type: integer
description: Need description here...
format: int32
AVG_ERC_MAX_TX_TS:
type: integer
description: Need description here...
format: int32
AVG_ERC_MIN_RX:
type: integer
description: Need description here...
format: int32
AVG_ERC_MIN_RX_TS:
type: integer
description: Need description here...
format: int32
AVG_ERC_MIN_TX:
type: integer
description: Need description here...
format: int32
AVG_ERC_MIN_TX_TS:
type: integer
description: Need description here...
format: int32
MAX_ERC_MAX_RX:
type: integer
description: Need description here...
format: int32
MAX_ERC_MAX_RX_TS:
type: integer
description: Need description here...
format: int32
MAX_ERC_MAX_TX:
type: integer
description: Need description here...
format: int32
MAX_ERC_MAX_TX_TS:
type: integer
description: Need description here...
format: int32
MAX_ERC_MIN_RX:
type: integer
description: Need description here...
format: int32
MAX_ERC_MIN_RX_TS:
type: integer
description: Need description here...
format: int32
MAX_ERC_MIN_TX:
type: integer
description: Need description here...
format: int32
MAX_ERC_MIN_TX_TS:
type: integer
description: Need description here...
format: int32
MAX_TIMESTAMP:
type: integer
description: Need description here...
format: int32
MIN_ERC_MAX_RX:
type: integer
description: Need description here...
format: int32
MIN_ERC_MAX_RX_TS:
type: integer
description: Need description here...
format: int32
MIN_ERC_MAX_TX:
type: integer
description: Need description here...
format: int32
MIN_ERC_MAX_TX_TS:
type: integer
description: Need description here...
format: int32
MIN_ERC_MIN_RX:
type: integer
description: Need description here...
format: int32
MIN_ERC_MIN_RX_TS:
type: integer
description: Need description here...
format: int32
MIN_ERC_MIN_TX:
type: integer
description: Need description here...
format: int32
MIN_ERC_MIN_TX_TS:
type: integer
description: Need description here...
format: int32
MIN_TIMESTAMP:
type: integer
description: Need description here...
format: int32
PEAK_THROUGHPUT:
type: integer
description: Need description here...
format: int32
SUM_ERC_MAX_RX:
type: integer
description: Need description here...
format: int32
SUM_ERC_MAX_RX_TS:
type: integer
description: Need description here...
format: int32
SUM_ERC_MAX_TX:
type: integer
description: Need description here...
format: int32
SUM_ERC_MAX_TX_TS:
type: integer
description: Need description here...
format: int32
SUM_ERC_MIN_RX:
type: integer
description: Need description here...
format: int32
SUM_ERC_MIN_RX_TS:
type: integer
description: Need description here...
format: int32
SUM_ERC_MIN_TX:
type: integer
description: Need description here...
format: int32
SUM_ERC_MIN_TX_TS:
type: integer
description: Need description here...
format: int32
TUNNEL:
type: string
description: The name of this tunnel
isPassThrough:
type: boolean
description: Need description here...
nePk:
type: string
description: The id of this appliance in Orchestrator
TunnelAggregateStats:
title: TunnelAggregateStats
required:
-
type: object
properties:
:
$ref: '#/components/schemas/TunnelAggregateStatsApplianceLevelObject'
TunnelAggregateStatsApplianceLevelObject:
title: TunnelAggregateStatsApplianceLevelObject
required:
-
type: object
properties:
:
$ref: '#/components/schemas/TunnelAggregateStatsBase'
TunnelAggregateStatsBase:
title: TunnelAggregateStatsBase
required:
- AVG_BW_PCT_UTIL_AVG
- AVG_LATENCY_AVG
- HOSTNAME
- IP
- LATENCY_MIN_FROM_PEAK
- MAX_BW_PCT_UTIL_MAX
- MAX_COMP_L2W
- MAX_COMP_L2WMAX
- MAX_COMP_NOOHEAD_L2W
- MAX_COMP_NOOHEAD_L2WMAX
- MAX_COMP_NOOHEAD_W2L
- MAX_COMP_NOOHEAD_W2LMAX
- MAX_COMP_W2L
- MAX_COMP_W2LMAX
- MAX_CREATED_MAX
- MAX_DELETED_MAX
- MAX_LATENCY_MAX
- MAX_LRX_BYTES_MAX
- MAX_LRX_PKTS_MAX
- MAX_LTX_BYTES_MAX
- MAX_LTX_PKTS_MAX
- MAX_NON_TCP_FLOWS_MAX
- MAX_OHEAD_WRX_BYTES_MAX
- MAX_OHEAD_WRX_HDR_BYTES_MAX
- MAX_OHEAD_WRX_PKTS_MAX
- MAX_OHEAD_WTX_BYTES_MAX
- MAX_OHEAD_WTX_HDR_BYTES_MAX
- MAX_OHEAD_WTX_PKTS_MAX
- MAX_POST_LOSS_MAX
- MAX_POST_PCT_LOSS
- MAX_POST_PCT_LOSS_MAX
- MAX_POST_POCMAX
- MAX_PRE_LOSS_MAX
- MAX_PRE_PCT_LOSS
- MAX_PRE_PCT_LOSS_MAX
- MAX_PRE_PCT_POC
- MAX_PRE_PCT_POCMAX
- MAX_PRE_POCMAX
- MAX_TCP_ACC_FLOWS_MAX
- MAX_TCP_FLOWS_MAX
- MAX_TIMESTAMP
- MAX_WRX_BYTES_MAX
- MAX_WRX_PKTS_MAX
- MAX_WTX_BYTES_MAX
- MAX_WTX_PKTS_MAX
- MIN_LATENCY_MIN
- MIN_TIMESTAMP
- POST_PCT_POCMAX
- SUM_CREATED
- SUM_DELETED
- SUM_LRX_BYTES
- SUM_LRX_PKTS
- SUM_LTX_BYTES
- SUM_LTX_PKTS
- SUM_NON_TCP_FLOWS
- SUM_OHEAD_WRX_BYTES
- SUM_OHEAD_WRX_HDR_BYTES
- SUM_OHEAD_WRX_PKTS
- SUM_OHEAD_WTX_BYTES
- SUM_OHEAD_WTX_HDR_BYTES
- SUM_OHEAD_WTX_PKTS
- SUM_POST_LOSS
- SUM_POST_PCT_POC
- SUM_POST_POC
- SUM_PRE_LOSS
- SUM_PRE_POC
- SUM_TCP_ACC_FLOWS
- SUM_TCP_FLOWS
- SUM_WRX_BYTES
- SUM_WRX_PKTS
- SUM_WTX_BYTES
- SUM_WTX_PKTS
- nePk
type: object
properties:
AVG_BW_PCT_UTIL_AVG:
type: integer
description: Integer value of average bandwidth utilization percentage
format: int32
AVG_LATENCY_AVG:
type: integer
description: Integer value of average latency, unit is millisecond
format: int32
HOSTNAME:
type: string
description: Hostname of the appliance
IP:
type: string
description: Management IP address of appliance
LATENCY_MIN_FROM_PEAK:
type: integer
description: Integer value of the second peak latency
format: int32
MAX_BW_PCT_UTIL_MAX:
type: integer
description: Integer value of maximum peak bandwidth utilization percentage
format: int32
MAX_COMP_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate
format: int32
MAX_COMP_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate
format: int32
MAX_COMP_NOOHEAD_L2W:
type: integer
description: Integer value of maximum LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_L2WMAX:
type: integer
description: Integer value of maximum peak LAN to WAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate without overhead
format: int32
MAX_COMP_NOOHEAD_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate without overhead
format: int32
MAX_COMP_W2L:
type: integer
description: Integer value of maximum WAN to LAN compression rate
format: int32
MAX_COMP_W2LMAX:
type: integer
description: Integer value of maximum peak WAN to LAN compression rate
format: int32
MAX_CREATED_MAX:
type: integer
description: Integer value of maximum peak number of created flows
format: int32
MAX_DELETED_MAX:
type: integer
description: Integer value of maximum peak number of deleted flows
format: int32
MAX_LATENCY_MAX:
type: integer
description: Integer value of maximum highest latency, unit is millisecond
format: int32
MAX_LRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side received
format: int32
MAX_LRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side received
format: int32
MAX_LTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes LAN side transmitted
format: int32
MAX_LTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets LAN side transmitted
format: int32
MAX_NON_TCP_FLOWS_MAX:
type: integer
description: Integer value of maximum peak number of TCP flows
format: int32
MAX_OHEAD_WRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of bytes WAN side received with overhead
format: int32
MAX_OHEAD_WRX_HDR_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of header bytes WAN side received with overhead
format: int32
MAX_OHEAD_WRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of packets WAN side received with overhead
format: int32
MAX_OHEAD_WTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of bytes WAN side transmitted with overhead
format: int32
MAX_OHEAD_WTX_HDR_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of header bytes WAN side transmitted with overhead
format: int32
MAX_OHEAD_WTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of maximum peak number of packets WAN side transmitted with overhead
format: int32
MAX_POST_LOSS_MAX:
type: integer
description: Integer value of maximum peak post-corrected packets loss
format: int32
MAX_POST_PCT_LOSS:
type: integer
description: Integer value of maximum post-corrected packets loss percentage
format: int32
MAX_POST_PCT_LOSS_MAX:
type: integer
description: Integer value of maximum peak post-corrected packets loss
format: int32
MAX_POST_POCMAX:
type: integer
description: Integer value of maximum peak post-POC packets loss
format: int32
MAX_PRE_LOSS_MAX:
type: integer
description: Integer value of maximum peak pre-corrected packets loss
format: int32
MAX_PRE_PCT_LOSS:
type: integer
description: Integer value of maximum pre-corrected packets loss percentage
format: int32
MAX_PRE_PCT_LOSS_MAX:
type: integer
description: Integer value of maximum peak pre-corrected packets loss
format: int32
MAX_PRE_PCT_POC:
type: integer
description: Integer value of maximum pre-POC packets loss percentage
format: int32
MAX_PRE_PCT_POCMAX:
type: integer
description: Integer value of maximum peak pre-POC packets loss percentage
format: int32
MAX_PRE_POCMAX:
type: integer
description: Integer value of maximum peak pre-POC packets loss
format: int32
MAX_TCP_ACC_FLOWS_MAX:
type: integer
description: Integer value of maximum peak number of TCP flows
format: int32
MAX_TCP_FLOWS_MAX:
type: integer
description: Integer value of maximum peak number of TCP flows
format: int32
MAX_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual starting boundary of data time range
format: int32
MAX_WRX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side received
format: int32
MAX_WRX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side received
format: int32
MAX_WTX_BYTES_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of bytes WAN side transmitted
format: int32
MAX_WTX_PKTS_MAX:
type: integer
description: Long(Signed 64 bits) value of peak number of packets WAN side transmitted
format: int32
MIN_LATENCY_MIN:
type: integer
description: Integer value of minimum lowest latency, unit is millisecond
format: int32
MIN_TIMESTAMP:
type: integer
description: Long(Signed 64 bits) value of EPOCH time indicating actual ending boundary of data time range
format: int32
POST_PCT_POCMAX:
type: integer
description: Integer value of maximum peak post-POC packets loss percentage
format: int32
SUM_CREATED:
type: integer
description: Integer value of total number of created flows
format: int32
SUM_DELETED:
type: integer
description: Integer value of total number of deleted flows
format: int32
SUM_LRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side received
format: int32
SUM_LRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_LTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes LAN side transmitted
format: int32
SUM_LTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets LAN side transmitted
format: int32
SUM_NON_TCP_FLOWS:
type: integer
description: Integer value of total number of non-TCP flows
format: int32
SUM_OHEAD_WRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side received with overhead
format: int32
SUM_OHEAD_WRX_HDR_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of header bytes WAN side received with overhead
format: int32
SUM_OHEAD_WRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side received with overhead
format: int32
SUM_OHEAD_WTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side transmitted with overhead
format: int32
SUM_OHEAD_WTX_HDR_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of header bytes WAN side transmitted with overhead
format: int32
SUM_OHEAD_WTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side transmitted with overhead
format: int32
SUM_POST_LOSS:
type: integer
description: Integer value of total number of post-corrected packets loss
format: int32
SUM_POST_PCT_POC:
type: integer
description: Integer value of maximum post-POC packets loss percentage
format: int32
SUM_POST_POC:
type: integer
description: Integer value of total number of post-POC packets loss
format: int32
SUM_PRE_LOSS:
type: integer
description: Integer value of total number of pre-corrected packets loss
format: int32
SUM_PRE_POC:
type: integer
description: Integer value of total number of pre-POC packets loss
format: int32
SUM_TCP_ACC_FLOWS:
type: integer
description: Integer value of total number of TCP accelerated flows
format: int32
SUM_TCP_FLOWS:
type: integer
description: Integer value of total number of TCP flows
format: int32
SUM_WRX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side received
format: int32
SUM_WRX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side received
format: int32
SUM_WTX_BYTES:
type: integer
description: Long(Signed 64 bits) value of total number of bytes WAN side transmitted
format: int32
SUM_WTX_PKTS:
type: integer
description: Long(Signed 64 bits) value of total number of packets WAN side transmitted
format: int32
nePk:
type: string
description: Internal ID of appliance
TunnelConfigData:
title: TunnelConfigData
required:
- admin
- auto_mtu
- destination
- gre_proto
- ipsec_arc_window
- ipsec_enable
- max_bw
- max_bw_auto
- min_bw
- mode
- mtu
- self
- source
- udp_flows
type: object
properties:
admin:
type: string
description: "Admin state of the tunnel - takes two values: 'up' or 'down'."
auto_mtu:
type: boolean
description: Determines if the tunnel should have auto MTU detection.
ctrl_pkt:
$ref: '#/components/schemas/FecSettings'
destination:
type: string
description: Destination IP address.
gre_proto:
type: integer
description: GRE protocol in the GRE header
format: int32
ipsec_arc_window:
type: string
description: IPSec ARC Window - not configurable.
ipsec_enable:
type: boolean
description: A quick shortcut for knowing if tunnel mode is IPSec. You can get the same information using mode property.
max_bw:
type: integer
description: If the tunnel max bandwidth is manually configured, use this field and set max_bw_auto to false. Units Kbps.
format: int32
max_bw_auto:
type: boolean
description: If the tunnel max bandwidth needs to be set to auto, this field must be true.
min_bw:
type: integer
description: Tunnel minimum bandwidth
format: int32
mode:
type: string
description: "Tunnel mode: it can be one of 'gre', 'udp', 'ipsec'"
mtu:
type: integer
description: Tunnel MTU. If 'auto_mtu' is false, user must set a specific tunnel mtu value
format: int32
options:
type: integer
description: Not used
format: int32
pkt:
$ref: '#/components/schemas/FecSettings'
self:
type: string
description: The value is the same as the tunnel name.
source:
type: string
description: Source IP address of the tunnel.
threshold:
$ref: '#/components/schemas/TunnelHealthFailureCount'
type:
type: string
description: Not used
udp_dest_port:
type: integer
description: If the tunnel is of type 'udp', the udp port to use.
format: int32
udp_flows:
type: integer
description: If tunnel mode is udp, this field determines how many different udp flows are used to distribute tunnel traffic
format: int32
TunnelCountMap:
title: TunnelCountMap
required:
- totalTunnelCount
type: object
properties:
totalTunnelCount:
type: integer
description: Total tunnel count
format: int32
TunnelExceptionEntry:
title: TunnelExceptionEntry
type: object
properties:
appliance_id_1:
type: string
description: Id of appliance
appliance_id_2:
type: string
description: Id of appliance
description:
type: string
description: Description of this tunnel exception
id:
type: integer
description: ID of tunnel exception entry
format: int32
interface_label_1:
type: string
description: Interface label name
interface_label_2:
type: string
description: Interface label name
TunnelGroupConfig:
title: TunnelGroupConfig
type: object
properties:
crossConnect:
type: boolean
description: Whether or not to cross connect the WAN ports.
id:
type: string
name:
type: string
topology:
$ref: '#/components/schemas/OverlayTopology'
useAllAvailableInterfaces:
type: boolean
description: Use all the available interfaces found on the appliances
wanPorts:
type: array
items:
type: string
description: An array of WAN label ids to use as the primary WAN ports this overlay.
TunnelGroupPropertiesGet:
title: TunnelGroupPropertiesGet
type: object
properties:
enable:
type: boolean
description: Whether or not the tunnel group manager is enabled
tunnelGroupPaused:
type: boolean
description: The current state of whether or not the tunnel group manager is paused
TunnelGroupPropertiesSet:
title: TunnelGroupPropertiesSet
type: object
properties:
enable:
type: boolean
description: Enable or disable the tunnel group manager
TunnelHealthFailureCount:
title: TunnelHealthFailureCount
type: object
properties:
dbw_aimd:
type: boolean
description: Obsolete
dbw_rserc:
type: boolean
description: Obsolete
retry_count:
type: integer
description: How many packets which are sent once per second should be missed before a tunnel is declared down
format: int32
TunnelPolicyDetail:
title: TunnelPolicyDetail
type: object
properties:
condition:
type: integer
description: If the links in this policy detail matches the condition (1-green, 2-up), use these links, if not move on to the next policy detail.
format: int32
example: 1
links:
type: array
items:
type: string
description: "An array of strings that specify which ports to use (ex: ['MPLS', 'MPLS-Internet'])"
TunnelSetting:
title: TunnelSetting
required:
- admin
- authenticationAlgorithm
- autoMaxBandwidthEnabled
- dhgroup
- dpdDelay
- dpdRetry
- encryptionAlgorithm
- exchangeMode
- ikeAuthenticationAlgorithm
- ikeEncryptionAlgorithm
- ikeLifetime
- ipsecAntiReplayWindow
- lifebytes
- lifetime
- mode
- natMode
- pfs
- pfsgroup
type: object
properties:
admin:
type: string
description: admin status
authenticationAlgorithm:
type: string
description: IPsec authentication algorithm
autoMaxBandwidthEnabled:
type: boolean
description: auto max bandwidth
dhgroup:
type: string
description: Diffie-Hellman Group
dpdDelay:
type: number
description: Dead Peer Detection delay time in seconds
dpdRetry:
type: number
description: Dead Peer Detection Retry Count
encryptionAlgorithm:
type: string
description: IPsec encryption algorithm
exchangeMode:
type: string
description: IKE Phase 1 Mode
idStr:
type: string
description: IKE Identifier string
idType:
type: string
description: IKE Identifier type
ikeAuthenticationAlgorithm:
type: string
description: IKE authentication algorithm
ikeEncryptionAlgorithm:
type: string
description: IKE encryption algorithm
ikeLifetime:
type: number
description: IKE Lifetime
ipsecAntiReplayWindow:
type: string
description: IPsec Anti-replay Window
lifebytes:
type: number
description: IPsec Lifetime in megabytes
lifetime:
type: number
description: IPsec Lifetime in minutes
mode:
type: string
description: Pass through tunnel mode
natMode:
type: string
description: nat mode
pfs:
type: boolean
description: Perfect Forward Secrecy Group (disabled)
pfsgroup:
type: string
description: Perfect Forward Secrecy Group
presharedKey:
type: string
description: pre-shared key
TunnelState:
title: TunnelState
required:
- auto_mtu
- config_bin
- cur_max_bw
- cur_min_bw
- cur_mtu
- cur_set_max_bw
- details
- encap
- encap_brief
- ipsec_debug
- ipsec_health
- ipsec_sas
- ipsec_stats
- num_ipsec_sas
- oper
- qos_stats
- quiescence
- refunk
- rem_sys_bw
- remote_id
- self
- state_bin
- uptime
type: object
properties:
auto_mtu:
type: integer
description: Determines if the tunnel should have auto MTU detection.
format: int32
config_bin:
type: string
description: Need description here
cur_max_bw:
type: string
description: current max bandwidth
cur_min_bw:
type: string
description: current min bandwidth
cur_mtu:
type: string
description: current mtu
cur_set_max_bw:
type: string
description: current setted max bandwidth
details:
type: string
description: Need description here
encap:
type: string
description: Need description here
encap_brief:
type: string
description: Need description here
ipsec_debug:
type: string
description: Need description here
ipsec_health:
type: string
description: Need description here
ipsec_sas:
type: string
description: Need description here
ipsec_stats:
type: string
description: Need description here
num_ipsec_sas:
type: string
description: Need description here
oper:
type: string
description: Need description here
pkt:
$ref: '#/components/schemas/KPTState'
qos_stats:
type: string
description: Need description here
quiescence:
type: boolean
description: Need description here
refunk:
type: boolean
description: Need description here
rem_sys_bw:
type: string
description: Need description here
remote_id:
type: integer
description: Need description here
format: int32
self:
type: string
description: The value is a tunnel name. It is the same as parent node key - tunnel name
state_bin:
type: string
description: Need description here
uptime:
type: integer
description: Tunnel up time in milliseconds
format: int32
TunnelTcaDataInfo:
title: TunnelTcaDataInfo
required:
- UI
- allow_disable
- allow_falling
- allow_rising
- dft
- threshold_max
- threshold_min
type: object
properties:
UI:
$ref: '#/components/schemas/TcaUIInfo'
allow_disable:
type: boolean
description: Need description here
allow_falling:
type: boolean
description: Need description here
allow_rising:
type: boolean
description: Need description here
dft:
$ref: '#/components/schemas/DftData'
threshold_max:
type: integer
description: Need description here
format: int32
threshold_min:
type: integer
description: Need description here
format: int32
wc:
$ref: '#/components/schemas/WCData'
TunnelTcaInfo:
title: TunnelTcaInfo
required:
- latency
- loss-post-fec
- loss-pre-fec
- oop-post-poc
- oop-pre-poc
- reduction
- utilization
type: object
properties:
latency:
$ref: '#/components/schemas/TunnelTcaDataInfo'
loss-post-fec:
$ref: '#/components/schemas/TunnelTcaDataInfo'
loss-pre-fec:
$ref: '#/components/schemas/TunnelTcaDataInfo'
oop-post-poc:
$ref: '#/components/schemas/TunnelTcaDataInfo'
oop-pre-poc:
$ref: '#/components/schemas/TunnelTcaDataInfo'
reduction:
$ref: '#/components/schemas/TunnelTcaDataInfo'
utilization:
$ref: '#/components/schemas/TunnelTcaDataInfo'
TunnelThreshold2:
title: TunnelThreshold2
type: object
properties:
fastfail:
type: number
description: The fastfail threshold
retry_count:
type: number
Tunnels:
title: Tunnels
required:
-
type: object
properties:
:
$ref: '#/components/schemas/ApplianceTunnels'
TunnelsBetweenResultTunnel:
title: TunnelsBetweenResultTunnel
type: object
properties:
alias:
type: string
description: The tunnel alias
destNePk:
type: string
description: The destination nePk
destTunnelAlias:
type: string
description: The opposite tunnel alias
destTunnelId:
type: string
description: The opposite tunnel Id on the other appliance
id:
type: string
description: The tunnel ID
isBondedTunnel:
type: boolean
description: Whether or not this tunnel is a bonded tunnel
isPassThrough:
type: boolean
description: Whether or not this tunnel is pass through
nePk:
type: string
description: The source nePk of the tunnel
overlayId:
type: number
description: If this tunnel is a bonded tunnel, this is the overlayId for the overlay it belongs to
TunnelsConfigAndStates:
title: TunnelsConfigAndStates
required:
-
- allTunnelState
- default
- pass-through
- pass-through-unshaped
type: object
properties:
:
$ref: '#/components/schemas/TunnelConfigData'
allTunnelState:
$ref: '#/components/schemas/AllStates'
default:
$ref: '#/components/schemas/TunnelsConfigAndStatesDefault'
pass-through:
$ref: '#/components/schemas/TunnelsConfigAndStatesDefault'
pass-through-unshaped:
$ref: '#/components/schemas/TunnelsConfigAndStatesDefault'
TunnelsConfigAndStatesDefault:
title: TunnelsConfigAndStatesDefault
required:
- admin
- auto_mtu
- ctrl_pkt
- cur_max_bw
- destination
- gre_proto
- id2
- ipsec_arc_window
- ipsec_enable
- isRediscoveringMTU
- max_bw
- max_bw_auto
- min_bw
- mode
- mtu
- options
- pkt
- self
- source
- status
- tag_name
- threshold
- type
- udp_dest_port
- udp_flows
- uptime
type: object
properties:
admin:
type: string
description: Need description here
auto_mtu:
type: boolean
description: Determines if the tunnel should have auto MTU detection
ctrl_pkt:
$ref: '#/components/schemas/TunnelsConfigAndStatesDefaultCtrl_pkt'
cur_max_bw:
type: integer
description: current maximum bandwidth
format: int32
destination:
type: string
description: Need description here
gre_proto:
type: integer
description: Need description here
format: int32
id2:
type: integer
description: Need description here
format: int32
ipsec_arc_window:
type: string
description: Need description here
ipsec_enable:
type: boolean
description: Need description here
isRediscoveringMTU:
type: boolean
description: Need description here
max_bw:
type: integer
description: Tunnel maximum bandwidth
format: int32
max_bw_auto:
type: boolean
description: whether to automatically set maximum tunnel bandwidth
min_bw:
type: integer
description: Tunnel minimum bandwidth
format: int32
mode:
type: string
description: Need description here
mtu:
type: integer
description: Tunnel MTU. If 'auto_mtu' is false, user must set a specific tunnel mtu value
format: int32
options:
type: integer
description: Need description here
format: int32
pkt:
$ref: '#/components/schemas/TunnelsConfigAndStatesDefaultPkt'
self:
type: string
description: The value is a tunnel name. It is the same as parent node key - tunnel name
source:
type: string
description: Need description here
status:
type: string
description: Need description here
tag_name:
type: string
description: Need description here
threshold:
$ref: '#/components/schemas/TunnelsConfigAndStatesDefaultThreshold'
type:
type: string
description: Need description here
udp_dest_port:
type: integer
description: Need description here
format: int32
udp_flows:
type: integer
description: Need description here
format: int32
uptime:
type: integer
description: Tunnel up time in milliseconds
format: int32
TunnelsConfigAndStatesDefaultCtrl_pkt:
title: TunnelsConfigAndStatesDefaultCtrl_pkt
required:
- dscp
type: object
properties:
dscp:
type: string
description: description
TunnelsConfigAndStatesDefaultPkt:
title: TunnelsConfigAndStatesDefaultPkt
required:
- fec_enable_str
- fec_reset_intvl
- frag_enable
- reorder_wait
type: object
properties:
fec_enable_str:
type: string
description: Need description here
fec_reset_intvl:
type: integer
description: Need description here
format: int32
frag_enable:
type: boolean
description: Need description here
reorder_wait:
type: integer
description: Need description here
format: int32
TunnelsConfigAndStatesDefaultThreshold:
title: TunnelsConfigAndStatesDefaultThreshold
required:
- dbw_aimd
- dbw_rserc
- retry_count
type: object
properties:
dbw_aimd:
type: boolean
description: Need description here
dbw_rserc:
type: boolean
description: Need description here
retry_count:
type: integer
description: how many packets which are sent once per second should be missed before a tunnel is declared down
format: int32
TunnelsDeploymentInfo:
title: TunnelsDeploymentInfo
type: object
properties:
nePk:
$ref: '#/components/schemas/TunnelsDeploymentInfoObj'
TunnelsDeploymentInfoObj:
title: TunnelsDeploymentInfoObj
type: object
properties:
lanInterfaces:
type: array
items:
$ref: '#/components/schemas/InterfacePropertiesObj'
description: List of lan interfaces for this appliance
mode:
type: string
description: 'Deployment mode of appliance eg: INLINE_ROUTER, ROUTER, BRIDGE, SERVER'
TunnelsOverlayInfo:
title: TunnelsOverlayInfo
type: object
properties:
'0':
$ref: '#/components/schemas/SourceNePkToDestNePkPhysicalTunnelsMap'
1-7:
$ref: '#/components/schemas/SourceNePkToDestNePkTunnelsMap'
all:
$ref: '#/components/schemas/SourceNePkToDestNePkTunnelsMap'
UpgradeAppliancesResponse:
title: UpgradeAppliancesResponse
required:
- clientKey
type: object
properties:
clientKey:
type: string
description: The client key of appliances upgrade background task.
UploadToSp:
title: UploadToSp
type: object
properties:
caseDesc:
type: string
description: The case description
caseKey:
type: string
description: The case number
fileName:
type: string
description: The name of the file
User:
title: User
required:
- enable
- gid
- password
- self
type: object
properties:
enable:
type: boolean
description: Whether a user account is active or inactive
gid:
type: integer
description: 'Role ID: admin(0), monitor(1001)'
format: int32
password:
type: string
description: Password of the user account
self:
type: string
description: Username
UserAccount:
title: UserAccount
required:
- sessions
- users
type: object
properties:
sessions:
$ref: '#/components/schemas/SessionMap'
users:
$ref: '#/components/schemas/UserMap'
UserApps:
title: UserApps
required:
-
type: object
properties:
:
type: array
items:
$ref: '#/components/schemas/BuiltinAppItem'
description: one user application's related appliances information
UserMap:
title: UserMap
type: object
properties:
:
$ref: '#/components/schemas/User'
UserSessionInfo:
title: UserSessionInfo
required:
- configData
- resourceBase
type: object
properties:
configData:
$ref: '#/components/schemas/sessionDetail'
resourceBase:
type: string
description: name of the main resource
resourceKey:
type: string
description: name of the sub-resource. this is optional
version:
type: integer
description: id
format: int32
UsersGetItem:
title: UsersGetItem
required:
- createTime
- email
- firstName
- isTwoFactorEmail
- isTwoFactorTime
- lastName
- password
- phone
- role
- salt
- status
- userPk
- username
type: object
properties:
createTime:
type: integer
format: int32
email:
type: string
firstName:
type: string
isTwoFactorEmail:
type: boolean
isTwoFactorTime:
type: boolean
lastName:
type: string
password:
type: string
phone:
type: string
role:
type: string
salt:
type: string
status:
type: string
userPk:
type: string
username:
type: string
VRRP_GET:
title: VRRP_GET
required:
- adv_timer
- auth
- desc
- enable
- groupId
- holddown
- interface
- master_transitions
- masterip
- mode
- pkt_trace
- preempt
- priority
- uptime
- vipaddr
- vipowner
- vmac
type: object
properties:
adv_timer:
type: integer
description: Time interval between advertisements. Default is 1 second. Must be between 1-255
format: int32
auth:
type: string
description: Authentication string. Maximum 8 characters
desc:
type: string
description: Description string. Maximum 64 characters
enable:
type: string
description: Enable/Disable the VRRP instance, valid options are 'Up' or 'Down'
groupId:
type: integer
description: Identifier assigned to the two peers. Depending on the deployment, the group can consist of an appliance and a router (or L3 switch), or two appliances. Must be between 1-255
format: int32
holddown:
type: integer
description: Default is 10. Must be between 1-255
format: int32
interface:
type: string
description: Name of interface that VRRP is using for peering. Eg. wan0
master_transitions:
type: integer
description: Number of times the VRRP instance went from Master to Backup and vice versa. A high number of transitions indicates a problematic VRRP configuration or environment. If this is the case, check the configuration of all local appliances and routers, and review the log files
format: int32
masterip:
type: string
description: Current VRRP Master's Interface or local IP address
mode:
type: string
description: "There are three options for the VRRP instance - Backup : Instance is in VRRP backup state. Init : Instance is initializing, it's disabled, or the interface is down. Master : Instance is the current VRRP master"
pkt_trace:
type: boolean
description: Default is false
preempt:
type: boolean
description: If true the appliance with the highest priority comes back online and again assumes primary responsibility. Default is true
priority:
type: integer
description: The greater the number, the higher the priority. The appliance with the higher priority is the VRRP Master. Must be between 1-254
format: int32
uptime:
type: string
description: "Time elapsed since the VRRP instance entered the state it's in. Sample format: 0 days 11 hrs 49 mins 41 secs"
vipaddr:
type: string
description: Must be valid ip address and not match any of the existing interface ips on the appliance
vipowner:
type: boolean
description: A Silver Peak appliance cannot use one of its own IP addresses as the VRRP IP, so this will always be false
vmac:
type: string
description: MAC Address that the VRRP instance is using. On an NX Appliance, this is in 00-00-5E-00-01-{VRID} format. On virtual appliances, the VRRP instance uses the interface's assigned MAC Address (for example, the MAC address that the hypervisor assigned to wan0)
VXLicenseItem:
title: VXLicenseItem
required:
- applianceId
- hostname
- licenseExpirationDate
- licenseStartDate
- licenseType
- model
- saasEnabled
- serialNum
type: object
properties:
applianceId:
type: string
hostname:
type: string
licenseExpirationDate:
type: integer
format: int32
licenseStartDate:
type: integer
format: int32
licenseType:
type: string
model:
type: string
saasEnabled:
type: boolean
serialNum:
type: string
VersionInfo:
title: VersionInfo
type: object
properties:
current:
type: string
description: Current installed version of gsm
installed:
type: array
items:
type: string
description: list of 3 available orchestrator version
VxoaHostname:
title: VxoaHostname
type: object
properties:
hostname:
type: string
description: The hostname you want to apply to the appliance
WccpGroupState:
title: WccpGroupState
type: object
properties:
app_id:
type: string
assignment:
type: string
description: assignment information for the WCCP service group
debug:
type: string
description: debug information for the WCCP service group
num_appliances:
type: integer
description: number of appliances for the WCCP service group
format: int32
num_routers:
type: integer
description: number of routers for the WCCP service group
format: int32
oper:
type: string
description: operational status for the WCCP service group
self:
type: integer
description: integer value of the group Id
format: int32
uptime:
type: integer
description: uptime for the WCCP service group
format: int32
WCCPSystemLevelState:
title: WCCPSystemLevelState
required:
- debug_all
- debug_global
- is_alive
- proto_ver
type: object
properties:
debug_all:
type: string
description: all debug information for WCCP
debug_global:
type: string
description: global debug information for WCCP
is_alive:
type: string
description: is alive information for WCCP
proto_ver:
type: string
description: prototype version information for WCCP
WCData:
title: WCData
required:
-
type: object
properties:
:
$ref: '#/components/schemas/WcObject'
WanLabelSettings:
title: WanLabelSettings
required:
- admin
- authenticationAlgorithm
- autoMaxBandwidthEnabled
- autoMtu
- dhgroup
- dpdDelay
- dpdRetry
- dscp
- encryptionAlgorithm
- exchangeMode
- fastfailWaitBase
- fastfailWaitRtt
- fecMaxRatio
- fecMinRatio
- idStr
- idType
- ikeAuthenticationAlgorithm
- ikeEncryptionAlgorithm
- ikeLifetime
- ipsecAntiReplayWindow
- jitter
- latency
- lifebytes
- lifetime
- lossVal
- mode
- mtu
- pfs
- pfsgroup
- reorderWait
- retryCount
- selectedFastfail
- selectedFec
- udpDestinationPort
- udpFlows
type: object
properties:
admin:
type: string
description: admin up or down
authenticationAlgorithm:
type: string
description: IPsec authentication algorithm
autoMaxBandwidthEnabled:
type: boolean
description: Automatically use max bandwidth
autoMtu:
type: boolean
description: Auto Mtu
dhgroup:
type: string
description: IKE Diffie-Hellman Group
dpdDelay:
type: number
description: IKE Dead Peer Detection Delay time
dpdRetry:
type: number
description: IKE Dead Peer Detection Retry Count
dscp:
type: string
description: Differentiated Services Code Point
encryptionAlgorithm:
type: string
description: IPsec encryption algorithm
exchangeMode:
type: string
description: IKE Phase 1 Mode
fastfailWaitBase:
type: number
description: Fastfail Wait-time Base Offset
fastfailWaitRtt:
type: number
description: Fastfail RTT Multiplication Factor
fecMaxRatio:
type: number
description: Fec Maximum Ratio, set this the same as selectedFecVal
fecMinRatio:
type: number
description: Fec Minimum Ratio, set this to 0
idStr:
type: string
description: IKE Identifier string
idType:
type: string
description: IKE Identifier type
ikeAuthenticationAlgorithm:
type: string
description: IKE Authentication Algorithm
ikeEncryptionAlgorithm:
type: string
description: IKE Encryption Algorithm
ikeLifetime:
type: number
description: IKE Lifetime
ipsecAntiReplayWindow:
type: string
description: IPsec anti replay window
jitter:
type: number
description: Jitter
latency:
type: number
description: Latency
lifebytes:
type: number
description: IPsec Lifetime in megabytes
lifetime:
type: number
description: IPsec Lifetime in minutes
lossVal:
type: number
description: Loss
mode:
type: string
description: Tunnel mode - ipsec, udp, or gre
mtu:
type: number
description: Mtu
pfs:
type: boolean
description: Perfect Forward Secrecy Group Enabled
pfsgroup:
type: string
description: Perfect Forward Secrecy Group number
reorderWait:
type: number
description: Reorder Wait time
retryCount:
type: number
description: retry count in seconds
selectedFastfail:
type: number
description: 'Fastfail Enabled (1: enable, 2: continue, 3: disable)'
selectedFec:
type: string
description: Fec
udpDestinationPort:
type: number
description: Receiver's port that will receive udp packets
udpFlows:
type: number
description: Max udp flows
WanNextHopHealthGet:
title: WanNextHopHealthGet
required:
- enable
- hold_down_count
- interval
- retry_count
type: object
properties:
enable:
type: boolean
description: Enable or disable health check
hold_down_count:
type: integer
description: Hold down count
format: int32
interval:
type: integer
description: Interval
format: int32
retry_count:
type: integer
description: Retry count
format: int32
WcObject:
title: WcObject
required:
- enable
- falling
- rising
- self
type: object
properties:
enable:
type: boolean
description: Need description here
falling:
$ref: '#/components/schemas/ChangedObject'
rising:
$ref: '#/components/schemas/ChangedObject'
self:
type: string
description: The value should be the same as its parent node tunnel name.
WccpGroup:
title: WccpGroup
type: object
properties:
assign_detail:
type: string
description: WCCP service group assignment detail
assign_method:
type: string
description: Assignment Method
compatibility:
type: string
description: 'WCCP service group compatibility mode. Valid values: ios, nexus'
encap:
type: string
description: WCCP service group forwarding method
force_l2_return:
type: boolean
description: WCCP service group force l2 return
hash_dst_ip:
type: boolean
description: WCCP service group hash destination ip
hash_dst_port:
type: boolean
description: WCCP service group hash destination port
hash_src_ip:
type: boolean
description: WCCP service group hash source ip
hash_src_port:
type: boolean
description: WCCP service group hash source port
interface:
type: string
description: WCCP service group interface.
mask_dst_ip:
type: integer
description: WCCP service group mask destination ip
format: int32
mask_dst_port:
type: integer
description: WCCP service group mask destination port
format: int32
mask_src_ip:
type: integer
description: WCCP service group mask source ip
format: int32
mask_src_port:
type: integer
description: WCCP service group mask source port
format: int32
password:
type: string
description: WCCP service group password
priority:
type: integer
description: 'WCCP service group priority. Valid range: [0, 255].'
format: int32
protocol:
type: string
description: WCCP service group protocol
router:
type: object
additionalProperties:
$ref: '#/components/schemas/generatedObject'
self:
type: integer
description: Integer value of service group Id
format: int32
weight:
type: integer
description: WCCP service group weight
format: int32
WccpConfigSystem:
title: WccpConfigSystem
type: object
properties:
enable:
type: boolean
mcast_ttl:
type: integer
format: int32
WccpState:
title: WccpState
required:
- group
- system
type: object
properties:
group:
type: object
additionalProperties:
$ref: '#/components/schemas/WccpGroupState'
system:
$ref: '#/components/schemas/WCCPSystemLevelState'
WizardData:
title: WizardData
type: object
properties:
applianceExtraInfo:
$ref: '#/components/schemas/ApplianceExtraInfo'
applianceImage:
type: string
description: Upgrade the appliance before applying the wizard using this image. Appliance image object comes from /release or /vxoaImages
approve:
type: object
coordinates:
$ref: '#/components/schemas/GRNodeUpdatePostBody'
deployment:
$ref: '#/components/schemas/DeploymentPut'
ecLicense:
type: string
description: ID of the EC-Term license to apply to this appliance (if using EC-Term)
hostname:
type: string
labels:
type: object
overlayRegion:
type: string
overlays:
type: array
items:
type: integer
format: int32
description: ''
password:
$ref: '#/components/schemas/ApplianceChangePasswordPost'
subnets:
$ref: '#/components/schemas/SubnetsPost'
templates:
type: array
items:
type: string
description: Array of template group names
Zone:
title: Zone
required:
- name
type: object
properties:
name:
type: string
description: Zone name
Zones:
title: Zones
type: object
properties:
:
$ref: '#/components/schemas/Zone'
ZscalerVpnLocationExceptionConfig:
title: ZscalerVpnLocationExceptionConfig
required:
- endpointException
- endpointExceptionTimestamp
- fqdn
- nepk
- presharedKey
- vpnLocation
- vpnLocationTimestamp
type: object
properties:
endpointException:
type: string
description: user configured tunnel ZEN override data
endpointExceptionTimestamp:
type: number
description: user configured ZEN override data last update time
fqdn:
type: string
description: discovered endpoint
nepk:
type: string
description: appliance nepk
presharedKey:
type: string
description: encrypted pre-shared key
vpnLocation:
type: string
description: Vpn and location data
vpnLocationTimestamp:
type: number
description: vpn and location last update time
aaaConfig:
title: aaaConfig
required:
- auth_method
- author
type: object
properties:
auth_method:
allOf:
- $ref: '#/components/schemas/AuthConfigMap'
- description: You can add a maximum of three Authentication Methods.
author:
$ref: '#/components/schemas/AuthorConfigElement'
description: Details of default user and order of authorization
accessConfigMap:
title: accessConfigMap
required:
-
type: object
properties:
:
allOf:
- $ref: '#/components/schemas/applianceAccess'
- description: One array should be empty
description: appliance access group name to value map
activeSessionsItems:
title: activeSessionsItems
required:
- idle_time
- login_time
- remote_host
- type
- username
type: object
properties:
idle_time:
type: integer
format: int32
login_time:
type: integer
format: int32
remote_host:
type: string
type:
type: string
username:
type: string
alarmDebounceConfig:
title: alarmDebounceConfig
type: object
properties:
duration:
type: integer
description: Alarm email delay duration in seconds.
format: int32
alarmSummary1:
title: alarmSummary1
required:
- num_critical
- num_equipment_outstanding
- num_major
- num_minor
- num_outstanding
- num_software_outstanding
- num_tca_outstanding
- num_traffic_class_outstanding
- num_tunnel_outstanding
- num_warning
type: object
properties:
num_critical:
type: integer
description: Need description here
format: int32
num_equipment_outstanding:
type: integer
description: Need description here
format: int32
num_major:
type: integer
description: Need description here
format: int32
num_minor:
type: integer
description: Need description here
format: int32
num_outstanding:
type: integer
description: Need description here
format: int32
num_software_outstanding:
type: integer
description: Need description here
format: int32
num_tca_outstanding:
type: integer
description: Need description here
format: int32
num_traffic_class_outstanding:
type: integer
description: Need description here
format: int32
num_tunnel_outstanding:
type: integer
description: Need description here
format: int32
num_warning:
type: integer
description: Need description here
format: int32
description: Need description here
allApplianceAccessConfigs:
title: allApplianceAccessConfigs
type: object
properties:
:
allOf:
- $ref: '#/components/schemas/applianceAccess'
- description: One array should be empty
:
allOf:
- $ref: '#/components/schemas/applianceAccess'
- description: One array should be empty
description: Multiple pairs of applianceAccessGroupName to value
appObj:
title: appObj
type: object
properties:
apps:
type: array
items:
type: string
description: ''
parentGroup:
type: array
items:
type: string
description: ''
appObject:
title: appObject
required:
- appName
type: object
properties:
appName:
type: string
appTagsBody:
title: appTagsBody
type: object
properties:
:
$ref: '#/components/schemas/appObj'
appliance-Entity:
title: appliance-Entity
required:
- appName
type: object
properties:
appName:
type: array
items:
$ref: '#/components/schemas/ApplicationTrendsItem'
description: ''
appliance-Item1:
title: appliance-Item1
required:
- blank
- configChange
- reboot
- status
- time
type: object
properties:
blank:
type: boolean
description: whether health info was collected in that hour
configChange:
type: boolean
description: whether config change occurred
reboot:
type: boolean
description: whether reboot occurred
status:
$ref: '#/components/schemas/Status'
time:
type: integer
description: starting hour boundary
format: int32
applianceAccess:
title: applianceAccess
required:
- applianceGroups
- applianceRegions
type: object
properties:
applianceGroups:
type: array
items:
type: string
description: list of accessible Group_Ids
applianceRegions:
type: array
items:
type: string
description: list of accessible Region_Ids
description: One array should be empty
applianceIP:
title: applianceIP
required:
- ip
- mask
- subif
- wanNexthop
type: object
properties:
behindNAT:
type: string
description: Determines if this interface is connected to a Network Address Translation device (only applicable to WAN interfaces). Valid values are 'auto', 'none', ''. 'auto' means interface is behind a NAT device. 'none' or '' mean interface is NOT behind a NAT device
brifs:
$ref: '#/components/schemas/brifs'
comment:
type: string
description: User comments
dhcp:
type: boolean
description: Determines if DHCP is enabled for this interface (only applicable for WAN side main interface IPs in inline router mode)
dhcpd:
$ref: '#/components/schemas/dhcpd'
harden:
type: number
description: Determines if this interface has firewall configured (only applicable for WAN side main/VLAN interfaces in router mode). Valid values are 0:Allow All, 1:Hardened, 2:Stateful, 3:Stateful+SNAT
ip:
type: string
description: Appliance interface IP address
label:
type: string
description: Interface label assigned to this interface.
lanSide:
type: boolean
description: Determines if this interface is on LAN side.
mask:
type: integer
description: IP address network mask
format: int32
maxBW:
$ref: '#/components/schemas/maxBW'
subif:
type: string
description: Sub-interface ID
vlan:
type: string
description: VLAN ID
wanNexthop:
type: string
description: Next hop IP address
wanSide:
type: boolean
description: Determines if this interface is on WAN side.
zone:
type: number
description: Zone id assigned to this interface. 0 if no zone assigned
applianceInfoObj:
title: applianceInfoObj
type: object
properties:
group:
type: string
hostname:
type: string
ip:
type: string
isLicenseRequired:
type: string
model:
type: string
portalLicenseType:
type: string
reachabilityStatus:
type: number
description: Whether or not the appliance is reachable to Orchestrator. 1 - Reachable, 2 - Unreachable, 0 - Status not available yet
serial:
type: string
site:
type: string
softwareVersion:
type: string
applicationGet:
title: applicationGet
type: object
properties:
appType:
type: string
description: Type of application it can be either built-in or user-defined
applicationName:
type: string
description: Name of the application
applicationGroups:
title: applicationGroups
type: object
properties:
citrix:
$ref: '#/components/schemas/citrixInfo'
encrypted:
type: object
interactive:
type: object
real-time:
type: object
replication:
$ref: '#/components/schemas/replicationInfo'
auth1:
title: auth1
type: object
properties:
Unique key that identify the cert:
$ref: '#/components/schemas/sslCACertId'
auto_subnet:
title: auto_subnet
type: object
properties:
add_local:
type: boolean
description: 'Enable automatic advertising local subnets. Note: Only applicable for appliances whose version is less than 8.1.4.'
add_local_lan:
type: boolean
description: 'Enable automatic advertising local subnets for LAN interfaces only. Note: Only applicable for appliances whose version is greater than or equal to 8.1.4.'
add_local_metric:
type: integer
description: Metric assigned to subnets of interfaces on this appliance
format: int32
add_local_wan:
type: boolean
description: 'Enable automatic advertising local subnets for WAN interfaces only. Note: Only applicable for appliances whose version is greater than or equal to 8.1.4.'
local_ospf_filter:
type: integer
description: Filter for locally learned OSPF routes
format: int32
redist_bgp:
type: boolean
description: Enable redistribution of learned BGP routes via subnet sharing
redist_ospf:
type: boolean
description: Enable redistribution of learned OSPF routes via subnet sharing
redist_ospf_filter:
type: integer
description: Filter for OSPF routes redistributed to subnet sharing
format: int32
redist_ospf_metric:
type: integer
description: Add metric to OSPF routes to be redistributed to subnet sharing
format: int32
self:
type: boolean
description: Flag to enable and disable subnet sharing
avcMode:
title: avcMode
required:
- avc
type: object
properties:
avc:
type: string
description: "'mixed', it means that there are both old appliances(below 8.1.6 version) and new appliances(8.1.6 and above) in Orch.; 'all', it means that all of appliances in Orch are new(8.1.6 and above).'none', it means that all of appliances in Orch are old(below 8.1.6 version)"
brifConfig:
title: brifConfig
type: object
properties:
comment:
type: string
description: User comments
harden:
type: string
description: Firewall configuration for bridge interface. Valid values are 0:Allow All, 1:Hardened, 2:Stateful, 3:Stateful+SNAT
label:
type: string
description: Bridge lan/wan side interface label
lanSide:
type: boolean
description: This bridge interface is on LAN side
wanSide:
type: boolean
description: This bridge interface is on WAN side
brifs:
title: brifs
type: object
properties:
(ifname):
$ref: '#/components/schemas/brifConfig'
broadcastCliBody:
title: broadcastCliBody
required:
- cmdList
- neList
type: object
properties:
cmdList:
type: array
items:
type: string
description: Commands to be executed in a list format
neList:
type: array
items:
type: string
description: List of Device key Ids assigned by Orchestrator, usually look like '0.NE'
bw:
title: bw
required:
- if_rx_target
type: object
properties:
if_rx_target:
type: boolean
description: Target bandwidth enabled
description: System bandwidth
bypassBody:
title: bypassBody
required:
- enable
- neList
type: object
properties:
enable:
type: boolean
description: bypass flag
neList:
type: array
items:
type: string
description: List of Device key Ids assigned by Orchestrator, usually look like '0.NE'
bypassGetBody:
title: bypassGetBody
required:
- bypass_actual
- bypass_config
- status
type: object
properties:
bypass_actual:
type: boolean
description: Tells whether it is actually currently in bypass mode
bypass_config:
type: boolean
description: Tells whether it is currently configured to be in bypass mode
status:
allOf:
- $ref: '#/components/schemas/Status1'
- description: Tells whether it is actually currently in bypass or normal mode by text.
certKeyValidation:
title: certKeyValidation
required:
- certificateData
- keyData
type: object
properties:
certificateData:
type: string
intermediateCertFileContent:
type: string
keyData:
type: string
checkApplianceReachabilityUsingWSResponse:
title: checkApplianceReachabilityUsingWSResponse
type: object
properties:
directWS:
allOf:
- $ref: '#/components/schemas/CheckApplianceReachability'
- description: Appliance reachability info via websockets
portalWS:
allOf:
- $ref: '#/components/schemas/CheckApplianceReachability'
- description: Appliance reachability info via websockets
description: Appliance reachability information
citrixInfo:
title: citrixInfo
type: object
properties:
citrix-bcast:
type: string
citrix-cgp:
type: string
citrix-ica:
type: string
citrix-ima:
type: string
cloudAppsConfig:
title: cloudAppsConfig
type: object
properties:
application:
type: object
additionalProperties:
$ref: '#/components/schemas/CloudApp'
enable:
type: boolean
description: Flag to enable/disable SaaS Optimization
num_pings:
type: number
description: Number of ping requests per ip address when averaging out RTT values
ping_src_intf:
type: string
description: 'Ping to the specified interface. Format for labels: side/interfaceId. E.g. lan/7'
rtt_interval:
type: number
description: How often to run RTT re-calculation (in seconds)
user_modifed:
type: boolean
description: Flag to tell if configuration has been modified by user (used internally)
cloudAppsMonitor:
title: cloudAppsMonitor
type: object
properties:
domains:
type: array
items:
$ref: '#/components/schemas/Domain'
description: ''
subnets:
type: array
items:
$ref: '#/components/schemas/Subnet'
description: ''
compound:
title: compound
required:
- confidence
- description
- disabled
- dscp
- dst_dns
- dst_geo
- dst_ip
- dst_port
- dst_service
- either_dns
- either_geo
- either_ip
- either_port
- either_service
- id
- name
- protocol
- src_dns
- src_geo
- src_ip
- src_port
- src_service
- vlan
type: object
properties:
confidence:
type: number
description: minimum 0, maximum 100
description:
type: string
disabled:
type: boolean
dscp:
type: string
description: DSCP. Leave this empty if you don't want to config this field
dst_dns:
type: string
description: destination dns. Leave this empty if you don't want to config this field
dst_geo:
type: string
description: destination geo location. Leave this empty if you don't want to config this field
dst_ip:
type: string
description: destination ip(IPv4) with subnet or range, e.g '1.1.1.1/32' or '1.1.1.1-222' or '1.1.1.1/32, 1.1.1.1-222'. Leave this empty if you don't want to config this field
dst_port:
type: string
description: destination port number or range, e.g '12345' or '123-456' or '33,44,55-66'. Leave this empty if you don't want to config this field
dst_service:
type: string
description: destination service (saas app name or organization). Leave this empty if you don't want to config this field
either_dns:
type: string
description: either dns. If you specified the 'src_dns' or 'dst_dns', please leave this empty. Leave this empty if you don't want to config this field
either_geo:
type: string
description: either geo location. If you specified the 'src_geo' or 'dst_geo', please leave this empty. Leave this empty if you don't want to config this field
either_ip:
type: string
description: either ip(IPv4) with subnet or range, e.g '1.1.1.1/32' or '1.1.1.1-222' or '1.1.1.1/32, 1.1.1.1-222'. If you specified the 'src_ip' or 'dst_ip', please leave this empty. Leave this empty if you don't want to config this field
either_port:
type: string
description: either src or destination port number or range, e.g '12345' or '123-456' or '33,44,55-66'. If you specified the 'src_port' or 'dst_port', please leave this empty. Leave this empty if you don't want to config this field
either_service:
type: string
description: either service (saas app name or organization). If you specified the 'src_service' or 'dst_service', please leave this empty. Leave this empty if you don't want to config this field
id:
type: number
description: Record id. id > 50000 is the record from portal modified by user. Please use the get api to find id
name:
type: string
description: application name
protocol:
type: string
description: protocol, e.g 'tcp'. Leave this empty if you don't want to config this field
src_dns:
type: string
description: src dns. Leave this empty if you don't want to config this field
src_geo:
type: string
description: src geo location. Leave this empty if you don't want to config this field
src_ip:
type: string
description: src ip(IPv4) with subnet or range, e.g '1.1.1.1/32' or '1.1.1.1-222' or '1.1.1.1/32, 1.1.1.1-222'. Leave this empty if you don't want to config this field
src_port:
type: string
description: src port number or range, e.g '12345' or '123-456' or '33,44,55-66'. Leave this empty if you don't want to config this field
src_service:
type: string
description: src service (saas app name or organization). Leave this empty if you don't want to config this field
vlan:
type: string
description: interface. Leave this empty if you don't want to config this field
compoundObj:
title: compoundObj
required:
- confidence
- description
- disabled
- dscp
- dst_dns
- dst_geo
- dst_ip
- dst_port
- dst_service
- either_dns
- either_geo
- either_ip
- either_port
- either_service
- id
- name
- protocol
- src_dns
- src_geo
- src_ip
- src_port
- src_service
- vlan
type: object
properties:
confidence:
type: number
description: minimum 0, maximum 100
description:
type: string
disabled:
type: boolean
dscp:
type: string
description: DSCP
dst_dns:
type: string
description: destination dns
dst_geo:
type: string
description: destination geo location
dst_ip:
type: string
description: destination ip(IPv4)
dst_port:
type: string
description: destination port number or range
dst_service:
type: string
description: destination service (saas app name or organization)
either_dns:
type: string
description: either dns
either_geo:
type: string
description: either geo location
either_ip:
type: string
description: either ip(IPv4)
either_port:
type: string
description: either src or destination port number or range
either_service:
type: string
description: either service (saas app name or organization)
id:
type: number
name:
type: string
description: application name
protocol:
type: string
description: protocol
src_dns:
type: string
description: src dns
src_geo:
type: string
description: src geo location
src_ip:
type: string
description: src ip(IPv4)
src_port:
type: string
description: src port number or range
src_service:
type: string
description: src service (saas app name or organization)
vlan:
type: string
description: interface
compoundTmp:
title: compoundTmp
required:
- id#
type: object
properties:
id#:
$ref: '#/components/schemas/compoundObj'
configCertIdInfo:
title: configCertIdInfo
type: object
properties:
cert:
type: string
description: Certificate information
key:
type: string
description: Key information
self:
type: string
configHostInfo:
title: configHostInfo
type: object
properties:
Unique key that identify the cert:
$ref: '#/components/schemas/configCertIdInfo'
configInfo:
title: configInfo
type: object
properties:
host:
$ref: '#/components/schemas/configHostInfo'
createPreconfig:
title: createPreconfig
type: object
properties:
autoApply:
type: boolean
description: Automatically apply this preconfiguration to the matched appliance when Orchestrator discovers it
comment:
type: string
description: User provided comment for the preconfiguration
configData:
type: string
description: Base64 encoded preconfiguration YAML string
name:
type: string
description: Name of preconfiguration
serialNum:
type: string
description: Serial number to match on
tag:
type: string
description: Tag to match on
createPreconfigResponse:
title: createPreconfigResponse
type: object
properties:
id:
type: string
description: ID of preconfiguration
cronInfo:
title: cronInfo
required:
- cronExpression
- recurrenceDefinedAsCron
- recurringSchedule
type: object
properties:
cronExpression:
type: string
description: Cron expression representing job schedule
recurrenceDefinedAsCron:
type: boolean
description: Indicates if the job recurrence can be defined as a cron expression
recurringSchedule:
type: boolean
description: Indicates if the job is a recurring job
description: Provides the cron expression for the job schedule
dhcpConfig:
title: dhcpConfig
type: object
properties:
dhcpFoSetting:
$ref: '#/components/schemas/failoverConfig'
mode:
type: string
description: Default DHCP mode setting per appliance interface, options are ['server', 'relay', 'none')
relayConfig:
$ref: '#/components/schemas/dhcpRelayConfig'
serverConfig:
$ref: '#/components/schemas/dhcpServerConfig'
dhcpFailover:
title: dhcpFailover
type: object
properties:
(ifname):
$ref: '#/components/schemas/failoverConfig'
description: List of dhcp failover settings configured on the interfaces
dhcpHost:
title: dhcpHost
type: object
properties:
ip:
type: string
description: IP Address of the host device
mac:
type: string
description: MAC Address of the host device
dhcpHosts:
title: dhcpHosts
type: object
properties:
(hostName):
$ref: '#/components/schemas/dhcpHost'
dhcpOptions:
title: dhcpOptions
type: object
properties:
(dhcpOptionId):
type: string
description: Field containing the string value for the DHCP Option
dhcpRelay:
title: dhcpRelay
type: object
properties:
dhcpserver:
type: array
items:
type: string
description: Array of destination DHCP server IP addresses
option82:
type: boolean
description: Determine whether option 82 is enabled
option82_policy:
type: string
description: Enum to determine option 82 policy used if option 82 is enabled. Valid values are 'append', 'replace', 'forward', 'discard'
dhcpRelayConfig:
title: dhcpRelayConfig
type: object
properties:
destDhcpServer:
type: string
description: Destination DHCP server ip(s), separate multiple ips with comma
opt82:
type: boolean
opt82Policy:
type: string
description: Options are ['append', 'replace', 'forward', 'discard']. Defaults to 'append'
dhcpReservation:
title: dhcpReservation
type: object
properties:
ifName:
type: string
description: 'LAN side interface name on appliance, for eg: lan0'
mask:
type: number
description: Mask value of DHCP pool reservation
neId:
type: string
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
startIp:
type: string
description: Start IP address for DHCP pool reservation
dhcpReservationGms:
title: dhcpReservationGms
type: object
properties:
ifName:
type: string
description: 'LAN side interface name on appliance, for eg: lan0'
ip:
type: string
description: Subnet address
mask:
type: number
description: Subnet mask
neId:
type: string
description: "Unique key assigned by Orchestrator to each appliance, for eg: '0.NE'"
source:
type: string
description: 'Enum to donate if reservation has been pushed to appliance. 0: Appliance, 1: Orchestrator'
dhcpServer:
title: dhcpServer
type: object
properties:
host:
$ref: '#/components/schemas/dhcpHosts'
defaultLease:
type: number
description: Default lease time in seconds
dns:
type: array
items:
type: string
description: DNS server(s) IP Address
failover:
type: boolean
description: Determine if appliance enable DHCP failover
gw:
type: array
items:
type: string
description: Gateway IP Address
ipEnd:
type: string
description: IP within the DHCP server subnet till where IPs can be allocated
ipStart:
type: string
description: IP within the DHCP server subnet from where to start allocating IPs
maxLease:
type: number
description: Maximum lease time in seconds
netbios:
type: array
items:
type: string
description: NetBIOS name server(s) IP Address
netbiosNodeType:
type: string
description: Enum denoting the type of NetBIOS server. Valid values are 'B', 'P', 'M', 'H'
ntpd:
type: array
items:
type: string
description: NTP server(s) IP Address
options:
$ref: '#/components/schemas/dhcpOptions'
prefix:
type: string
description: 'DHCP server subnet and mask value eg: 10.3.171.0/24'
dhcpServerConfig:
title: dhcpServerConfig
type: object
properties:
applianceReservations:
type: array
items:
$ref: '#/components/schemas/dhcpReservation'
description: Collection of subnets that have been reserved in the DHCP pool from appliance (this list is built from the data that Orchestrator fetches from the appliance)
blockMask:
type: string
description: Subnet mask of the DHCP pool
blockStartIp:
type: string
description: Subnet ip of the DHCP pool
defaultGateway:
type: string
description: Default gateway ip
defaultGatewayEnabled:
type: boolean
description: Pre fill default gateway from the poll?
defaultLease:
type: number
description: In seconds
defaultSubnetMask:
type: string
description: Default subnet mask for a reservation block per interface
dnsServers:
type: array
items:
type: string
description: ''
endIp:
type: string
description: End Ip within the reservation subnet. (subnet end - end offset)
endOffset:
type: number
description: Number of reserved ips at the end of subnet.
failover:
type: boolean
description: Determine if appliance enable DHCP failover
localReservations:
type: array
items:
$ref: '#/components/schemas/dhcpReservation'
description: Collection of subnets that have been reserved in the DHCP pool locally on the orchestrator (this list is built from the Deployment Profiles on Orchestrator)
maxLease:
type: number
description: In seconds
netBiosNodeType:
type: string
description: Enum with options ['B', 'P', 'M', 'H']. Defaults to 'B'
netBiosServers:
type: array
items:
type: string
description: ''
ntpServers:
type: array
items:
type: string
description: ''
reservations:
type: array
items:
$ref: '#/components/schemas/dhcpReservation'
description: Collection of subnets that have been reserved in the DHCP pool
startIp:
type: string
description: Start Ip within the reservation subnet (subnet start + start offset)
startOffset:
type: number
description: Number of reserved ips at the beginning of subnet.
dhcpd:
title: dhcpd
type: object
properties:
relay:
$ref: '#/components/schemas/dhcpRelay'
server:
$ref: '#/components/schemas/dhcpServer'
type:
type: string
description: Enum to determine if this LAN interface is acting like a DHCP server, relay or none. Valid values are 'server', 'relay', 'none'
dhcpdFailoverState:
title: dhcpdFailoverState
type: object
properties:
failoverstate:
type: string
description: Interface name
mclt:
type: integer
description: Maximum client lead time
format: int32
mystate:
type: string
description: Primary server state
mytime:
type: string
description: Primary server last communication time (UTC epoch in seconds)
partnerstate:
type: string
description: Peer server state
partnertime:
type: string
description: Peer server last communication time (UTC epoch in seconds)
description: DHCP server lease report of failover state record
dhcpdFailoverStates:
title: dhcpdFailoverStates
type: object
properties:
:
allOf:
- $ref: '#/components/schemas/dhcpdFailoverState'
- description: DHCP server lease report of failover state record
description: DHCP server lease report of failover state records
dhcpdLease:
title: dhcpdLease
type: object
properties:
cltt:
type: integer
description: client's last transaction time
format: int32
ends:
type: integer
description: leased end time (UTC epoch in seconds)
format: int32
lease:
type: string
description: leased IP address
mac:
type: string
description: client hardware address
nextState:
type: string
description: next lease state
starts:
type: integer
description: leased start time (UTC epoch in seconds)
format: int32
state:
type: string
description: current lease state
tstp:
type: integer
description: the time the peer has been told the lease expires
format: int32
description: DHCP server lease record
dhcpdLeases:
title: dhcpdLeases
type: object
properties:
:
allOf:
- $ref: '#/components/schemas/dhcpdLease'
- description: DHCP server lease record
description: DHCP server lease records
disabledAlarmsConfig:
title: disabledAlarmsConfig
required:
- alarmTypeIds
- applianceIds
type: object
properties:
alarmTypeIds:
type: array
items:
type: integer
format: int32
description: List of alarm type ids.
applianceIds:
type: array
items:
type: string
description: List of appliance ids.
disabledAlarmsConfigRequest:
title: disabledAlarmsConfigRequest
required:
- action
- alarmTypeIds
- applianceIds
type: object
properties:
action:
type: string
description: "'ENABLE' or 'DISABLE' are possible values. Field can not be empty or null."
alarmTypeIds:
type: array
items:
type: integer
format: int32
description: List of alarm type ids. Value can not be null.
applianceIds:
type: array
items:
type: string
description: List of appliance ids. Value can not be null.
dns:
title: dns
required:
- enable
type: object
properties:
enable:
type: boolean
description: Enable DNS lookup
ipaddr:
type: string
description: DNS IP address
dnsConfig:
title: dnsConfig
required:
- description
- disabled
- domain
- name
- priority
type: object
properties:
description:
type: string
disabled:
type: boolean
domain:
type: string
description: Domain name, no slash
name:
type: string
description: application name
priority:
type: number
description: minimum 0, maximum 100
dnsInfo:
title: dnsInfo
type: object
properties:
dns:
type: string
dpRoute:
title: dpRoute
required:
- intf
- metric
- nexthop
- prefix
- type
type: object
properties:
intf:
type: string
description: Interface name for this route entry, auto or bvi0/bvi1/VLAN for bridge mode
metric:
type: integer
description: Routing metric value, lower values have higher priority
format: int32
nexthop:
type: string
description: Next hop IP address for this route entry
prefix:
type: string
description: Subnetwork prefix, for example, 2.2.2.0/24
type:
type: string
description: Route entry type, gw is the only option for now
description: Datapath IP route entries
dpc:
title: dpc
type: object
properties:
tunfail:
type: string
description: DPC tunnel failover behavior
description: DPC
ecBoost:
title: ecBoost
type: object
properties:
bandwidth:
type: integer
description: Boost bandwidth request in kbps
format: int32
enable:
type: boolean
description: enable or disable boost license request
ecLicense:
title: ecLicense
type: object
properties:
ecBoost:
type: boolean
description: Is EC Boost license enabled
ecBoostBW:
type: integer
description: Boost bandwidth in Kbps
format: int32
ecMini:
type: boolean
description: Is EC Mini license enabled
ecPlus:
type: boolean
description: Is EC Plus license enabled
ecTier:
type: string
description: EC Tier license name
ecTierBW:
type: integer
description: EC Tier bandwidth in Kbps
format: int32
ecMini:
title: ecMini
type: object
properties:
enable:
type: boolean
description: enable or disable mini license request
ecPlus:
title: ecPlus
type: object
properties:
enable:
type: boolean
description: enable or disable plus license request
ecTier:
title: ecTier
type: object
properties:
bandwidth:
type: integer
description: Tier bandwidth request in kbps
format: int32
display:
type: string
description: Display name for tier license request
excess_flow:
title: excess_flow
type: object
properties:
dscp_marking:
type: boolean
description: Excess flow DSCP marking
policy:
type: string
description: Excess flow policy
description: Excess flow
failoverConfig:
title: failoverConfig
required:
- my_ip
- peer_ip
- role
type: object
properties:
load_bal_max:
type: number
description: Defines a threshold to compare with the secs field of the client's DHCP packet in order to override load balancing.
max_resp_delay:
type: number
description: Tells the DHCP server how many seconds may pass without receiving a message from its failover peer before it assumes that connection has failed.
max_unack_updates:
type: number
description: Tells the remote DHCP server how many BNDUPD messages it can send before it receives a BNDACK from the local system.
mclt:
type: number
description: Define the Maximum Client Lead Time.
my_ip:
type: string
description: Define the address that the server should listen for connections from its failover peer
my_port:
type: number
description: Defines which TCP port the server should listen for connections from its failover peer.
peer_ip:
type: string
description: Define which server it should connect to reach its failover peer.
peer_port:
type: number
description: Define which TCP port to connect to its failover peer for failover messages.
role:
allOf:
- $ref: '#/components/schemas/Role2'
- description: Specify if the server is the primary or secondary.
split:
type: number
description: Specify the split between the primary and secondary
fetchingParam:
title: fetchingParam
required:
- id
- logType
type: object
properties:
id:
type: array
items:
type: string
description: ''
logType:
type: integer
description: The type of log
format: int32
description: The sequence id(s) of the log item, input can be a single number or a range. Eg.["1", "3", "100-200"]
fileNameObj:
title: fileNameObj
type: object
properties:
fileName:
type: string
description: File name
fileNames:
title: fileNames
type: object
properties:
backgroundImage:
$ref: '#/components/schemas/fileNameObj'
idrc:
title: idrc
type: object
properties:
param_delta:
type: number
description: Parameter delta for IDRC
param_g:
type: number
description: Parameter g for IDRC
param_m:
type: number
description: Parameter m for IDRC
param_y:
type: number
description: Parameter y for IDRC
ifLabel:
title: ifLabel
type: object
properties:
id:
type: number
description: Unique label ID
name:
type: string
description: 'Label name eg: Voice, Data, MPLS...'
ifLabels:
title: ifLabels
type: object
properties:
lan:
type: array
items:
$ref: '#/components/schemas/ifLabel'
description: Available LAN interface labels
wan:
type: array
items:
$ref: '#/components/schemas/ifLabel'
description: Available WAN interface labels
interfaceEnableModel:
title: interfaceEnableModel
type: object
properties:
enable:
type: boolean
interfaceModel:
title: interfaceModel
type: object
properties:
:
$ref: '#/components/schemas/interfaceEnableModel'
interfaceStateObj:
title: interfaceStateObj
type: object
properties:
activeNeighbors:
type: integer
description: All neighbors count
format: int32
admin_status:
type: string
description: Admin status
area:
type: string
description: Area
bkup_desig_rtr:
type: string
description: Backup Designated Router address
dead_interval:
type: integer
description: Dead interval(in Seconds)
format: int32
desig_rtr:
type: string
description: Designated Router address
hello_interval:
type: integer
description: Hello interval in seconds
format: int32
if_max_bandwidth:
type: integer
description: interface max bandwidth in bps
format: int32
ifname:
type: string
description: interface name
interface_state:
type: string
description: interface state
ip_addr:
type: string
description: IP address
lsa_refresh_intvl:
type: integer
description: LSA Refresh Interval in seconds
format: int32
ospf_if_type:
type: string
description: OSPF interface type
rtr_priority:
type: integer
description: Router priority
format: int32
totalNeighbors:
type: integer
description: All neighbors count
format: int32
transmit_delay:
type: integer
description: Transmit delay in seconds
format: int32
ipIntelligence:
title: ipIntelligence
required:
- country
- country_code
- description
- name
- org
- priority
type: object
properties:
country:
type: string
country_code:
type: string
description:
type: string
ip_end:
type: integer
description: Ending IPv4 address in 32-bit integer format
format: int64
ip_start:
type: integer
description: Starting IPv4 address in 32-bit integer format
format: int64
name:
type: string
description: application name
org:
type: string
priority:
type: number
description: minimum 0, maximum 100
loopbackConfig:
title: loopbackConfig
type: object
properties:
:
$ref: '#/components/schemas/loopbackConfigDetail'
loopbackConfigDetail:
title: loopbackConfigDetail
required:
- admin
- ipaddr
- label
- nmask
- zone
type: object
properties:
admin:
type: boolean
description: admin status
ipaddr:
type: string
description: Interface IP
label:
type: string
description: label id
nmask:
type: number
description: mask
zone:
type: number
description: zone id
matchPreconfig:
title: matchPreconfig
type: object
properties:
serial:
type: string
description: Serial number to match on
tag:
type: string
description: Tag to match on
maxBW:
title: maxBW
required:
- outbound
type: object
properties:
inbound:
type: number
description: Maximum inbound (WAN to LAN) bandwidth for this interface in Kbps
outbound:
type: number
description: Maximum outbound (LAN to WAN) bandwidth for this interface in Kbps
menuType:
title: menuType
required:
- menuTypeName
type: object
properties:
menuTypeName:
$ref: '#/components/schemas/menuTypeConfig'
menuTypeConfig:
title: menuTypeConfig
required:
- defaultMenuType
- menuTypeItems
- users
type: object
properties:
defaultMenuType:
type: boolean
description: Whether this is a default menu type
menuTypeItems:
type: array
items:
type: string
description: The checked menu item ids
users:
type: array
items:
type: string
description: The user names configured for this menu type
meterFlow:
title: meterFlow
required:
- description
- disabled
- flowType
- mid
- name
- priority
type: object
properties:
description:
type: string
disabled:
type: boolean
flowType:
type: string
description: flow type, e.g. MF
mid:
type: number
description: id, starting from 1
name:
type: string
description: application name
priority:
type: number
description: minimum 0, maximum 100
meterFlowTmp:
title: meterFlowTmp
type: object
properties:
flowType:
type: array
items:
$ref: '#/components/schemas/MeterFlowObj'
description: ''
mgmtIf:
title: mgmtIf
type: object
properties:
dhcp:
type: boolean
description: Is DHCP on or off on this management interface
ip:
type: string
description: Management interface IP address
mask:
type: number
description: Management interface network mask
nexthop:
type: string
description: Management interface gateway IP address
mgmtIfData:
title: mgmtIfData
type: object
properties:
(ifName):
$ref: '#/components/schemas/mgmtIf'
modeIf:
title: modeIf
required:
- applianceIPs
- devNum
- ifName
type: object
properties:
applianceIPs:
type: array
items:
$ref: '#/components/schemas/applianceIP'
description: Deployment interface IP addresses assignment
devNum:
type: string
description: Deployment interface type - rtr1/rtr2, bdg1/bdg2
ifName:
type: string
description: Deployment interface name - wan0/lan0 for router mode, bvi0/bvi1 for bridge mode
description: Deployment mode interface configuration
multicastConfigModel:
title: multicastConfigModel
required:
- igmp
- pim
- rp
type: object
properties:
igmp:
$ref: '#/components/schemas/interfaceModel'
pim:
$ref: '#/components/schemas/interfaceModel'
rp:
type: string
description: rendezvous point IP (IPv4)
multicastEnableModel:
title: multicastEnableModel
required:
- enable
type: object
properties:
enable:
type: boolean
description: enable or disable multicast
multicastInterfaceState:
title: multicastInterfaceState
required:
- DRIP
- DRPriority
- generationID
- interface
- interfaceIP
type: object
properties:
DRIP:
type: string
description: designated router IP
DRPriority:
type: string
description: designated router priority
generationID:
type: string
description: generation id
interface:
type: string
description: Interface
interfaceIP:
type: string
description: Interface IP
multicastNeighborState:
title: multicastNeighborState
required:
- interface
- neighborDRPriority
- neighborGenerationID
- neighborIP
type: object
properties:
interface:
type: string
description: Interface
neighborDRPriority:
type: string
description: neighbor designated router priority
neighborGenerationID:
type: string
description: neighbor generation id
neighborIP:
type: string
description: neighbor IP
multicastRouteState:
title: multicastRouteState
required:
- group
- inIntf
- outIntfList
- source
type: object
properties:
group:
type: string
description: group
inIntf:
type: string
description: incoming interface
outIntfList:
type: string
description: outgoing interfaces
source:
type: string
description: source IP
neighborState:
title: neighborState
type: object
properties:
asn:
type: integer
description: Autonomous System Number of the neighbor
format: int32
last_err:
type: integer
description: last error code
format: int32
last_err_subcode:
type: integer
description: Last Subnet Error Code
format: int32
local_ip:
type: string
description: Local Ip address of the neighbor
peer_caps:
type: string
peer_ip:
type: string
description: Ip address of the neighbor
peer_state:
type: integer
description: state of the neighbor session
format: int32
peer_state_str:
type: string
description: Router ip address
rcvd_last_err:
type: integer
description: Last received error code
format: int32
rcvd_last_err_subcode:
type: integer
description: Last received subnet error code
format: int32
rcvd_last_err_time:
type: string
description: The port to use when building IPSec UDP tunnels on this appliance
rcvd_pfxs:
type: integer
description: Number of routes received from neighbor
format: int32
rcvd_updates:
type: integer
description: Number of updates received from neighbor
format: int32
rtr_id:
type: string
description: Router ip address
sent_last_err:
type: integer
description: Last error code send by neighbor
format: int32
sent_last_err_subcode:
type: integer
description: Last subnet error code send by neighbor
format: int32
sent_last_err_time:
type: integer
description: Last sent error time
format: int32
sent_pfxs:
type: integer
description: Number of routes send by neighbor
format: int32
sent_updates:
type: integer
description: Number of updates send by neighbor
format: int32
time_established:
type: integer
description: bgp session established time
format: int32
time_last_update:
type: integer
description: last updated received time
format: int32
neighborStateObj:
title: neighborStateObj
type: object
properties:
admin_status:
type: string
description: admin status
area:
type: string
description: Area of the neighbors
dead_time:
type: integer
description: Dead time
format: int32
desig_rtr_state:
type: string
description: Designated router state
hello_suppressed:
type: boolean
description: flag to indicate whether hello suppressed or not
interfaceName:
type: string
description: interface name
ip_addr:
type: string
description: Neighbor Ip
local_if_addr:
type: string
description: local interface address
neighbor_state:
type: string
description: Neighbor state
oper_status:
type: string
description: Operation status
priority:
type: integer
description: priority
format: int32
router_id:
type: string
description: Router ID
nepkToPassThroughTunnelsMap1:
title: nepkToPassThroughTunnelsMap1
type: object
properties:
passThroughTunnelId:
$ref: '#/components/schemas/passThroughTunnelIdMap'
description: A map of appliances (nePk) to an objects of tunnels
networkRoleAndSiteGet:
title: networkRoleAndSiteGet
required:
- IP
- applianceId
- bypass
- groupId
- hardwareRevision
- hasUnsavedChanges
- hostName
- id
- mode
- model
- nePk
- networkRole
- password
- rebootRequired
- serial
- site
- sitePriority
- softwareVersion
- startupTime
- state
- systemBandwidth
- userName
- uuid
- webProtocol
- webProtocolType
type: object
properties:
IP:
type: string
description: Need description here
applianceId:
type: integer
description: Need description here
format: int32
bypass:
type: boolean
description: Need description here
groupId:
type: string
description: Need description here
hardwareRevision:
type: string
description: Need description here
hasUnsavedChanges:
type: boolean
description: Need description here
hostName:
type: string
description: Need description here
id:
type: string
description: Need description here
mode:
type: string
description: Need description here
model:
type: string
description: Need description here
nePk:
type: string
description: Need description here
networkRole:
type: string
description: Need description here
password:
type: string
description: Need description here
rebootRequired:
type: boolean
description: Need description here
serial:
type: string
description: Need description here
site:
type: string
description: Need description here
sitePriority:
type: integer
description: Need description here
format: int32
softwareVersion:
type: string
description: Need description here
startupTime:
type: string
description: Need description here
state:
type: integer
description: Need description here
format: int32
systemBandwidth:
type: integer
description: Need description here
format: int32
userName:
type: string
description: Need description here
uuid:
type: string
description: Need description here
webProtocol:
type: string
description: Need description here
webProtocolType:
type: integer
description: Need description here
format: int32
networkRulesPostBody:
title: networkRulesPostBody
required:
- id
- networkRole
- site
- sitePriority
type: object
properties:
id:
type: string
description: Need description here
networkRole:
allOf:
- $ref: '#/components/schemas/NetworkRole'
- description: Need description here
example: 0
site:
type: string
description: Need description here
sitePriority:
type: integer
description: Need description here
format: int32
nextHop:
title: nextHop
type: object
properties:
x.x.x.x:
$ref: '#/components/schemas/SingleNextHop'
onePreconfig:
title: onePreconfig
type: object
properties:
autoApply:
type: boolean
description: Automatically apply this preconfiguration to the matched appliance when Orchestrator discovers it
comment:
type: string
description: User provided comment for the preconfiguration
completionStatus:
type: boolean
description: Whether the apply was successful or not, only look at this if taskStatus == 2
configData:
type: string
description: Base64 encoded preconfiguration YAML string
createdtime:
type: integer
description: Time when preconfiguration was created in epoch milliseconds
format: int64
discoveredId:
type: string
description: Discovered appliance ID that preconfig was last applied to (the id of appliances in the discovered tab are different than when the appliance is approved)
endtime:
type: integer
description: End time of last apply in epoch milliseconds
format: int64
guid:
type: string
description: ID of the log created in actionlog when the preconfiguration was applied
id:
type: integer
description: Id of the preconfiguration, used to reference this preconfiguration in the other APIs
format: int32
modifiedtime:
type: integer
description: Time when preconfiguration was last modified in epoch milliseconds
format: int64
name:
type: string
description: Name of preconfiguration
nepk:
type: string
description: Appliance ID that preconfig was last applied to
result:
type: array
items:
$ref: '#/components/schemas/resultItem'
description: ''
serialNum:
type: string
description: Serial number to match on
starttime:
type: integer
description: Start time of last apply in epoch milliseconds
format: int64
tag:
type: string
description: Tag to match on
taskStatus:
type: integer
description: 'The current status of the preconfig apply. 0: Not Started, 1: In Progress, 2: Finished'
format: int64
passThroughTunnelIdMap:
title: passThroughTunnelIdMap
type: object
properties:
adminStatus:
type: string
alias:
type: string
destIpAddress:
type: string
destNePk:
type: string
destTunnelAlias:
type: string
destTunnelId:
type: string
fecRatio:
type: integer
format: int32
fecStatus:
type: string
gmsMarked:
type: boolean
id:
type: string
ipsec_enabled:
type: boolean
max_bw:
type: integer
format: int32
max_bw_auto:
type: boolean
mode:
type: string
operStatus:
type: string
parallelTunnelId:
type: integer
format: int32
peerName:
type: string
sourceIpAddress:
type: string
srcNePk:
type: string
tag:
type: string
tunnelThreshold:
$ref: '#/components/schemas/TunnelThreshold'
passThroughTunnelsInfo:
title: passThroughTunnelsInfo
type: object
properties:
nePk:
allOf:
- $ref: '#/components/schemas/nepkToPassThroughTunnelsMap1'
- description: A map of appliances (nePk) to an objects of tunnels
peerName:
title: peerName
type: object
properties:
peer_weight:
type: integer
description: Peer weight
format: int32
self:
type: string
peerlist:
title: peerlist
type: object
properties:
:
$ref: '#/components/schemas/peerName'
portProfilesApplianceIP:
title: portProfilesApplianceIP
required:
- ip
- mask
- subif
- wanNexthop
type: object
properties:
behindNAT:
type: string
description: Determines if this interface is connected to a Network Address Translation device (only applicable to WAN interfaces). Valid values are 'auto', 'none', ''. 'auto' means interface is behind a NAT device. 'none' or '' mean interface is NOT behind a NAT device
brifs:
$ref: '#/components/schemas/brifs'
comment:
type: string
description: User comments
dhcp:
type: boolean
description: Determines if DHCP is enabled for this interface (only applicable for WAN side main interface IPs in inline router mode).
dhcpd:
$ref: '#/components/schemas/dhcpd'
harden:
type: string
description: Determines if this interface has firewall configured (only applicable for WAN side main/VLAN interfaces in router mode). Valid values are 0:Allow All, 1:Hardened, 2:Stateful, 3:Stateful+SNAT
ip:
type: string
description: Appliance interface IP address
label:
type: string
description: Determines which interface label name is assigned to this interface. If empty that means no label is assigned.
lanSide:
type: boolean
description: Determines if this interface is on LAN side.
mask:
type: integer
description: IP address network mask
format: int32
maxBW:
$ref: '#/components/schemas/maxBW'
subif:
type: string
description: Sub-interface ID
vlan:
type: string
description: VLAN ID
wanNexthop:
type: string
description: Next hop IP address
wanSide:
type: boolean
description: Determines if this interface is on WAN side.
zone:
type: number
description: Zone id assigned to this interface. 0 if no zone assigned
portProfilesConfig:
title: portProfilesConfig
type: object
properties:
dhcpFailover:
type: array
items:
$ref: '#/components/schemas/portProfilesDhcpFailover'
description: ''
dpRoutes:
type: array
items:
$ref: '#/components/schemas/portProfilesDpRoute'
description: ''
modeIfs:
type: array
items:
$ref: '#/components/schemas/portProfilesModeIf'
description: ''
sysConfig:
allOf:
- $ref: '#/components/schemas/portProfilesSysConfig'
- description: Appliance's system configuration
portProfilesDhcpFailover:
title: portProfilesDhcpFailover
type: object
properties:
(ifname):
$ref: '#/components/schemas/portProfilesFailoverConfig'
description: List of dhcp failover settings configured on the interfaces
portProfilesDpRoute:
title: portProfilesDpRoute
required:
- intf
- metric
- nexthop
- prefix
- type
type: object
properties:
intf:
type: string
description: Interface name for this route entry, auto or bvi0/bvi1/VLAN for bridge mode
metric:
type: integer
description: Routing metric value, lower values have higher priority
format: int32
nexthop:
type: string
description: Next hop IP address for this route entry
prefix:
type: string
description: Subnetwork prefix, for example, 2.2.2.0/24
type:
type: string
description: Route entry type, gw is the only option for now
description: Datapath IP route entries
portProfilesEcLicense:
title: portProfilesEcLicense
type: object
properties:
(licenseType):
type: object
description: This key is dynamic based on the EC license type (fx, ecsp etc). Contains additional details based on license type.
ecBoost:
type: boolean
description: Is EC Boost license enabled
ecBoostBW:
type: integer
description: Boost bandwidth in Kbps
format: int32
ecMini:
type: boolean
description: Is EC Mini license enabled
ecPlus:
type: boolean
description: Is EC Plus license enabled
ecTier:
type: string
description: EC Tier license name
ecTierBW:
type: integer
description: EC Tier bandwidth in Kbps
format: int32
portProfilesFailoverConfig:
title: portProfilesFailoverConfig
required:
- my_ip
- peer_ip
- role
type: object
properties:
load_bal_max:
type: number
description: Defines a threshold to compare with the secs field of the client's DHCP packet in order to override load balancing.
max_resp_delay:
type: number
description: Tells the DHCP server how many seconds may pass without receiving a message from its failover peer before it assumes that connection has failed.
max_unack_updates:
type: number
description: Tells the remote DHCP server how many BNDUPD messages it can send before it receives a BNDACK from the local system.
mclt:
type: number
description: Define the Maximum Client Lead Time.
my_ip:
type: string
description: Define the address that the server should listen for connections from its failover peer
my_port:
type: number
description: Defines which TCP port the server should listen for connections from its failover peer.
peer_ip:
type: string
description: Define which server it should connect to reach its failover peer.
peer_port:
type: number
description: Define which TCP port to connect to its failover peer for failover messages.
role:
allOf:
- $ref: '#/components/schemas/Role2'
- description: Specify if the server is the primary or secondary.
split:
type: number
description: Specify the split between the primary and secondary
portProfilesGet:
title: portProfilesGet
required:
- id
- name
type: object
properties:
config:
$ref: '#/components/schemas/portProfilesConfig'
id:
type: string
description: System generated unique identifier for the Deployment Profile
name:
type: string
description: Deployment Profile template name
portProfilesLabelInUseGetResp:
title: portProfilesLabelInUseGetResp
required:
- inUse
type: object
properties:
inUse:
type: boolean
description: Boolean to donate if label is in use
portProfileIds:
type: array
items:
type: string
description: Array of unique profile ids which are using this label
description: If label is in use in a profile and list of profiles its in use.
portProfilesModeIf:
title: portProfilesModeIf
required:
- applianceIPs
- ifName
type: object
properties:
applianceIPs:
type: array
items:
$ref: '#/components/schemas/portProfilesApplianceIP'
description: Deployment interface IP addresses assignment
devNum:
type: string
description: Deployment interface type - rtr1/rtr2, bdg1/bdg2, for UI use, not needed in POST
ifName:
type: string
description: Deployment interface name - wan0/lan0 for router mode, bvi0/bvi1 for bridge mode
description: Deployment mode interface configuration
portProfilesPost:
title: portProfilesPost
required:
- id
- name
type: object
properties:
config:
$ref: '#/components/schemas/portProfilesConfig'
id:
type: string
description: System generated unique identifier for the Deployment Profile, leave empty or null when creating new Deployment Profile template
name:
type: string
description: Deployment Profile template name
portProfilesSysConfig:
title: portProfilesSysConfig
required:
- bonding
- inline
- maxBW
- mode
- propagateLinkDown
- singleBridge
- tenG
- useMgmt0
type: object
properties:
bonding:
type: boolean
description: Use interface bonding (only valid for models with 2 LAN interfaces and 2 WAN interfaces)
haIf:
type: string
description: Name of the interface used to build 'internal' High Availability (HA) VLAN interfaces using which two appliances in a HA configuration can communicate with each other
inline:
type: boolean
description: Inline router mode (only valid for router mode). This is the recommended mode.
licence:
$ref: '#/components/schemas/portProfilesEcLicense'
maxBW:
type: integer
description: System maximum bandwidth in Kbps
format: int32
maxInBW:
type: integer
description: System maximum inbound bandwidth in Kbps (to enable inbound shaping make sure maxInBWEnabled is set to true)
format: int32
maxInBWEnabled:
type: boolean
description: Enable inbound bandwidth shaping (if this is true, you must specify maxInBW)
mode:
allOf:
- $ref: '#/components/schemas/Mode'
- description: System deployment mode
propagateLinkDown:
type: boolean
description: 'Propagate link down state: this is valid in bridge mode only. If it is true, if either LAN or WAN side interface of the bridge is down, the system brings down the other interface automatically'
singleBridge:
type: boolean
description: Single 4-port flat bridge configuration (only valid for 4-port models)
tenG:
type: boolean
description: Use 10Gbps interfaces (only valid for models with 10Gbps interfaces)
useMgmt0:
type: boolean
description: Use mgmt0 interface as a datapath interface as well. (only valid under router mode)
zones:
type: array
items:
type: string
description: ''
description: Appliance's system configuration
portProtocol:
title: portProtocol
required:
- description
- disabled
- name
- port
- priority
- protocol
type: object
properties:
description:
type: string
disabled:
type: boolean
name:
type: string
description: application name
port:
type: number
description: Port number, user 0 for IP Protocol application
priority:
type: number
description: minimum 0, maximum 100
protocol:
type: number
description: Protocol number, user 6 for TCP Port application , 17 for UDP Port application
preconfigApplyStatus:
title: preconfigApplyStatus
type: object
properties:
completionStatus:
type: boolean
description: Whether the apply was successful or not, only look at this if taskStatus == 2
endtime:
type: integer
description: End time of last apply in epoch milliseconds
format: int64
guid:
type: string
description: ID of the log created in actionlog when the preconfiguration was applied
id:
type: integer
description: Id of the preconfiguration, used to reference this preconfiguration in the other APIs
format: int32
result:
type: array
items:
$ref: '#/components/schemas/resultItem'
description: ''
starttime:
type: integer
description: Start time of last apply in epoch milliseconds
format: int64
taskStatus:
type: integer
description: 'The current status of the preconfig apply. 0: Not Started, 1: In Progress, 2: Finished'
format: int64
replicationInfo:
title: replicationInfo
type: object
properties:
app_assure_replication:
type: string
app_assure_svr_backup:
type: string
netvault_replication:
type: string
vsphere_replication_ini:
type: string
vsphere_replication_ong:
type: string
zerto_mgmt:
type: string
zerto_replication:
type: string
restApiConfig:
title: restApiConfig
required:
- communicateWithApplianceViaPortal
type: object
properties:
communicateWithApplianceViaPortal:
type: boolean
description: the control value of connecting VXOA via portal web socket, true means allow connecting VXOA via portal web socket, false means disallow
resultItem:
title: resultItem
type: object
properties:
completionStatus:
type: boolean
description: Whether the apply was successful or not, only look at this if taskStatus == 2
data:
type: string
description: String or Json for the data that was used by this task
name:
type: string
description: Name of the task
nePk:
type: string
description: Appliance ID task is applying to
result:
type: string
description: Status/result string information of the task
taskStatus:
type: integer
description: 'The current status of the preconfig apply. 0: Not Started, 1: In Progress, 2: Finished'
format: int64
saMapObject:
title: saMapObject
type: object
properties:
entries:
type: array
items:
$ref: '#/components/schemas/MapEntryObject'
description: Data of may entries
mapName:
type: string
description: The name of map
numOfEntries:
type: string
description: Number of map entries in the current map
state:
type: string
description: Map state, sa map is always active
saas:
title: saas
type: object
properties:
addresses:
type: array
items:
$ref: '#/components/schemas/CloudAppSubnet'
description: Array of subnets associated with this cloud application.
application:
type: string
description: Name of cloud application
domains:
type: array
items:
type: string
description: Array of domain names associated with this cloud application.
enabled:
type: boolean
description: For internal use
ports:
type: array
items:
type: string
description: Array of ports associated with this cloud application
processedAt:
type: string
description: For internal use
saasId:
type: number
description: Unique identifier for cloud application
threshold:
type: number
description: Default RTT threshold value from portal
saasTmp:
title: saasTmp
required:
- id#
type: object
properties:
id#:
$ref: '#/components/schemas/CloudApp'
searchWildcard:
title: searchWildcard
required:
- pattern
type: object
properties:
limit:
type: number
description: default is 30
pattern:
type: string
serverMode:
title: serverMode
type: object
properties:
in_max_bw:
type: integer
description: Server inbound max bandwidth (kbps)
format: int32
out_max_bw:
type: integer
description: Server outbound max bandwidth (kbps)
format: int32
target_in_thres:
type: number
description: Interface max link threshold
target_out_thres:
type: number
description: Interface max link threshold
serviceIdToSaasIdSaasAppGet:
title: serviceIdToSaasIdSaasAppGet
type: object
properties:
saasAppName:
type: array
items:
type: string
description: Array representing saas applications
sessionDetail:
title: sessionDetail
required:
- autoLogout
type: object
properties:
autoLogout:
type: integer
format: int32
maxSession:
type: integer
format: int32
shaperInbound:
title: shaperInbound
type: object
properties:
wan:
$ref: '#/components/schemas/wan'
spPortalAccountKeyChangeCountResp:
title: spPortalAccountKeyChangeCountResp
required:
- count
type: object
properties:
count:
type: number
description: Number of times account key has been changed for this account. 0 if it's never been changed.
spPortalAccountKeyChangeStatusResp:
title: spPortalAccountKeyChangeStatusResp
required:
- committedToPortalTimestamp
- generateTimestamp
type: object
properties:
committedToPortalTimestamp:
type: number
description: Latest epoch time in milliseconds when old account key was delete from Portal. Null if current account key change has not been committed to Portal.
generateTimestamp:
type: number
description: Latest epoch time in milliseconds when new account key was generated. Null if account key has never been changed.
spPortalAccountKeyGeneratePutResp:
title: spPortalAccountKeyGeneratePutResp
required:
- accountKey
- oldAccountKey
type: object
properties:
accountKey:
type: string
description: Current account key
oldAccountKey:
type: string
description: Old account key
spPortalCreateCaseWithPortal:
title: spPortalCreateCaseWithPortal
required:
- caseDesc
- caseEmail
- caseName
- casePhone
- casePrio
- caseSubject
- orchSerialNum
type: object
properties:
caseDesc:
type: string
description: Description
caseEmail:
type: string
description: Contact email address. If Orchestrator is not registered to Portal, a valid Silver Peak support account email address is required in order to create a case.
caseName:
type: string
description: Contact name
casePhone:
type: string
description: Contact phone number
casePrio:
type: string
description: 'Priority. Accepted values: "P1 - Urgent", "P2 - High", "P3 - Normal", "P4 - Low"'
caseSubject:
type: string
description: Subject
orchSerialNum:
type: string
description: 'Serial number for Orchestrator or appliance. NOTE: For Orchestrators, leave this field empty (""). For appliances, enter the nePk (E.g. "0.NE"). The corresponding serial number will then be retrieved based on these inputs'
sslCACertId:
title: sslCACertId
type: object
properties:
builtin:
type: string
id:
type: string
description: Unique key that identify the cert
issuer:
type: string
description: Information regarding the CA that issued the certificate
key_type:
type: string
method:
type: string
pretty:
type: string
self:
type: string
serial:
type: string
description: The unique serial number that the issuing certification authority assigns to the certificate
subject:
type: string
description: The name of the individual, computer, device, to whom the certificate is issued
valid_from:
type: string
description: The beginning date for the period in which the certificate is valid
valid_to:
type: string
description: The final date for the period in which the certificate is valid
verified:
type: string
description: Whether certificate is verified or not
sslCACertValidation:
title: sslCACertValidation
required:
- certificateData
- isSslCACert
type: object
properties:
certificateData:
type: string
isPFX:
type: boolean
isSslCACert:
type: boolean
passPhrase:
type: string
password:
type: string
sslCACertsGet:
title: sslCACertsGet
type: object
properties:
auth:
$ref: '#/components/schemas/auth1'
sslCertGetInfoPost:
title: sslCertGetInfoPost
required:
- isPFX
- isSslCACert
type: object
properties:
certificateData:
type: string
isPFX:
type: boolean
isSslCACert:
type: boolean
keyData:
type: string
passPhrase:
type: string
password:
type: string
sslCertGetTextPost:
title: sslCertGetTextPost
required:
- certificateData
type: object
properties:
certificateData:
type: string
isPFX:
type: boolean
password:
type: string
sslCertId:
title: sslCertId
type: object
properties:
builtin:
type: string
id:
type: string
description: Unique key that identify the cert
issuer:
type: string
description: Information regarding the CA that issued the certificate
key_type:
type: string
method:
type: string
pretty:
type: string
self:
type: string
serial:
type: string
description: The unique serial number that the issuing certification authority assigns to the certificate
subject:
type: string
description: The name of the individual, computer, device, to whom the certificate is issued
valid_from:
type: string
description: The beginning date for the period in which the certificate is valid
valid_to:
type: string
description: The final date for the period in which the certificate is valid
verified:
type: string
description: Whether certificate is verified or not
sslCertSigningInfo:
title: sslCertSigningInfo
type: object
properties:
Unique key that identify the cert:
$ref: '#/components/schemas/sslCertId'
sslCertsGet:
title: sslCertsGet
type: object
properties:
config:
$ref: '#/components/schemas/configInfo'
state:
$ref: '#/components/schemas/stateInfo'
sslSubstituteCertConfig:
title: sslSubstituteCertConfig
type: object
properties:
builtin_signing:
type: boolean
cert-substitution:
type: boolean
sslSubstituteCertEnable:
title: sslSubstituteCertEnable
type: object
properties:
config:
$ref: '#/components/schemas/sslSubstituteCertConfig'
sslSubstituteCertGet:
title: sslSubstituteCertGet
type: object
properties:
enable:
$ref: '#/components/schemas/sslSubstituteCertEnable'
sslcert:
$ref: '#/components/schemas/sslSubstituteCertInfo'
sslSubstituteCertInfo:
title: sslSubstituteCertInfo
type: object
properties:
signing:
$ref: '#/components/schemas/sslCertSigningInfo'
sslSubstituteCertValidation:
title: sslSubstituteCertValidation
required:
- certificateData
- isPFX
- isSslCACert
type: object
properties:
certificateData:
type: string
description: Certificate data
isPFX:
type: boolean
description: To specify whether certificate containing the private key or not
isSslCACert:
type: boolean
passPhrase:
type: string
description: Passphrase for the certificate
password:
type: string
description: Password for the certificate
stateCertIdInfo:
title: stateCertIdInfo
type: object
properties:
builtin:
type: string
id:
type: string
description: Unique key that identify the cert
issuer:
type: string
description: Information regarding the CA that issued the certificate
key_type:
type: string
method:
type: string
pretty:
type: string
self:
type: string
serial:
type: string
description: The unique serial number that the issuing certification authority assigns to the certificate
subject:
type: string
description: The name of the individual, computer, device, or CA to whom the certificate is issued.
valid_from:
type: string
description: The beginning date for the period in which the certificate is valid
valid_to:
type: string
description: The final date for the period in which the certificate is valid
verified:
type: boolean
description: Whether certificate is verified or not
stateHostInfo:
title: stateHostInfo
type: object
properties:
Unique key that identify the cert:
$ref: '#/components/schemas/stateCertIdInfo'
stateInfo:
title: stateInfo
type: object
properties:
host:
$ref: '#/components/schemas/stateHostInfo'
statsCollection:
title: statsCollection
type: object
properties:
Application:
type: boolean
Dns:
type: boolean
Drc:
type: boolean
Drops:
type: boolean
Dscp:
type: boolean
Flow:
type: boolean
Interface:
type: boolean
Jitter:
type: boolean
Port:
type: boolean
Shaper:
type: boolean
TopTalkers:
type: boolean
Tunnel:
type: boolean
sysConfig:
title: sysConfig
required:
- bonding
- inline
- maxBW
- mode
- propagateLinkDown
- singleBridge
- tenG
- useMgmt0
type: object
properties:
bonding:
type: boolean
description: Use interface bonding (only valid for models with 2 LAN interfaces and 2 WAN interfaces)
haIf:
type: string
description: Name of the interface used to build 'internal' High Availability (HA) VLAN interfaces using which two appliances in a HA configuration can communicate with each other
ifLabels:
$ref: '#/components/schemas/ifLabels'
inline:
type: boolean
description: Inline router mode (only valid for router mode). This is the recommended mode.
licence:
$ref: '#/components/schemas/ecLicense'
maxBW:
type: integer
description: System maximum outbound bandwidth in Kbps
format: int32
maxInBW:
type: integer
description: System maximum inbound bandwidth in Kbps (to enable inbound shaping make sure maxInBWEnabled is set to true)
format: int32
maxInBWEnabled:
type: boolean
description: Enable inbound bandwidth shaping (if this is true, you must specify maxInBW)
mode:
allOf:
- $ref: '#/components/schemas/Mode'
- description: System deployment mode
propagateLinkDown:
type: boolean
description: 'Propagate link down state: this is valid in bridge mode only. If it is true, if either LAN or WAN side interface of the bridge is down, the system brings down the other interface automatically'
singleBridge:
type: boolean
description: Single 4-port flat bridge configuration (only valid for 4-port models)
tenG:
type: boolean
description: Use 10Gbps interfaces (only valid for models with 10Gbps interfaces)
useMgmt0:
type: boolean
description: Use mgmt0 interface as a datapath interface as well. (only valid under router mode)
zones:
type: array
items:
type: string
description: ''
description: Appliance's system configuration
sysConfigIfState:
title: sysConfigIfState
required:
- bonding
- mode
- submode
type: object
properties:
bonding:
type: boolean
description: Need description here.
mode:
type: string
description: The appliance's deployment mode.
submode:
type: string
description: The appliance's deployment submode.
targetAppliance:
title: targetAppliance
type: object
properties:
groupPks:
type: array
items:
type: string
description: comma separated list of groupPk (primary key of group). Job will be run on every appliance in the group
nePks:
type: array
items:
type: string
description: comma separated list of nepk (primary key of appliance)
textCustomizationItem:
title: textCustomizationItem
type: object
properties:
custom:
type: string
description: Text content
useDefault:
type: boolean
description: Use default brand
textCustomizationItems:
title: textCustomizationItems
type: object
properties:
footer:
$ref: '#/components/schemas/textCustomizationItem'
tmpHashCode:
title: tmpHashCode
type: object
properties:
hashVal:
type: string
tmpTimeStamp:
title: tmpTimeStamp
type: object
properties:
lastUpdateTime:
type: string
topTalkersAggregateStatsFields:
title: topTalkersAggregateStatsFields
type: object
properties:
CALC_DNS:
type: string
COUNT:
type: integer
format: int32
COUNTRY:
type: string
DNS:
type: string
FLOWS_CREATED:
type: integer
format: int32
FLOWS_DELETED:
type: integer
format: int32
FLOW_COUNT:
type: integer
format: int32
HOSTNAME:
type: string
IPADDR:
type: string
IS_SOURCE:
type: integer
format: int32
LANRX_BYTES:
type: integer
format: int32
LANRX_PKTS:
type: integer
format: int32
LANTX_BYTES:
type: integer
format: int32
LANTX_PKTS:
type: integer
format: int32
MAX_TIME:
type: integer
format: int32
MIN_TIME:
type: integer
format: int32
NEPK:
type: string
NE_IPADDR:
type: string
SERVICE_ID:
type: integer
format: int32
SPLIT_TYPE:
type: integer
format: int32
WANRX_BYTES:
type: integer
format: int32
WANRX_PKTS:
type: integer
format: int32
WANTX_BYTES:
type: integer
format: int32
WANTX_PKTS:
type: integer
format: int32
trafficBehaviorAggregateStatsFields:
title: trafficBehaviorAggregateStatsFields
required:
- BEHAVIORAL_CATEGORY
- HOSTNAME
- MAX_TIMESTAMP
- MIN_TIMESTAMP
- SUM_FLOWS_COUNT
- SUM_FLOWS_CREATED
- SUM_FLOWS_DELETED
- SUM_LRX_BYTES
- SUM_LRX_PKTS
- SUM_LTX_BYTES
- SUM_LTX_PKTS
- SUM_WRX_BYTES
- SUM_WRX_PKTS
- SUM_WTX_BYTES
- SUM_WTX_PKTS
- nePk
type: object
properties:
BEHAVIORAL_CATEGORY:
type: string
description: Applications are classified by the behavior of the traffic. This field indicates the behavior it was classified as
HOSTNAME:
type: string
description: Hostname of the appliance
MAX_TIMESTAMP:
type: integer
description: Start time ( epoch time in seconds ) of time range that stats are requested for
format: int32
MIN_TIMESTAMP:
type: integer
description: End time ( epoch time in seconds ) of time range that stats are requested for
format: int32
SUM_FLOWS_COUNT:
type: integer
description: Number of flows that were classified under this behavior during the time range specified
format: int32
SUM_FLOWS_CREATED:
type: integer
description: Number of flows created that were classified under this behavior during the time range specified
format: int32
SUM_FLOWS_DELETED:
type: integer
description: Number of flows deleted that were classified under this behavior during the time range specified
format: int32
SUM_LRX_BYTES:
type: integer
description: Total number of bytes received on the LAN side
format: int32
SUM_LRX_PKTS:
type: integer
description: Total number of packets received on the LAN side
format: int32
SUM_LTX_BYTES:
type: integer
description: Total number of bytes transmitted on the LAN side
format: int32
SUM_LTX_PKTS:
type: integer
description: Total number of packets transmitted on the LAN side
format: int32
SUM_WRX_BYTES:
type: integer
description: Total number of bytes received on the WAN side
format: int32
SUM_WRX_PKTS:
type: integer
description: Total number of packets received on the WAN side
format: int32
SUM_WTX_BYTES:
type: integer
description: Total number of bytes transmitted on the WAN side
format: int32
SUM_WTX_PKTS:
type: integer
description: Total number of packets transmitted on the WAN side
format: int32
nePk:
type: string
description: Internal ID of appliance
trafficBehaviorStatsFields:
title: trafficBehaviorStatsFields
required:
- APPNAME
- BEHAVIORAL_CATEGORY
- FLOWS_COUNT
- FLOWS_CREATED
- FLOWS_DELETED
- HOSTNAME
- LRX_BYTES
- LRX_PKTS
- LTX_BYTES
- LTX_PKTS
- MAX_TIMESTAMP
- MIN_TIMESTAMP
- WRX_BYTES
- WRX_PKTS
- WTX_BYTES
- WTX_PKTS
- nePk
type: object
properties:
APPNAME:
type: string
description: Application that was classified as of a particular behavior.
BEHAVIORAL_CATEGORY:
type: string
description: Applications are classified by the behavior of the traffic. This field indicates the behavior it was classified as.
FLOWS_COUNT:
type: integer
description: Number of flows that were classified under this behavior during the time range specified.
format: int32
FLOWS_CREATED:
type: integer
description: Number of flows created that were classified under this behavior during the time range specified.
format: int32
FLOWS_DELETED:
type: integer
description: Number of flows deleted that were classified under this behavior during the time range specified.
format: int32
HOSTNAME:
type: string
description: Hostname of the appliance.
LRX_BYTES:
type: integer
description: Number of bytes received on the LAN side.
format: int32
LRX_PKTS:
type: integer
description: Number of packets received on the LAN side.
format: int32
LTX_BYTES:
type: integer
description: Number of bytes transmitted on the LAN side.
format: int32
LTX_PKTS:
type: integer
description: Number of packets transmitted on the LAN side.
format: int32
MAX_TIMESTAMP:
type: integer
description: Start time ( epoch time in seconds ) of time range that stats are requested for.
format: int32
MIN_TIMESTAMP:
type: integer
description: End time ( epoch time in seconds ) of time range that stats are requested for.
format: int32
WRX_BYTES:
type: integer
description: Number of bytes received on the WAN side.
format: int32
WRX_PKTS:
type: integer
description: Number of packets received on the WAN side.
format: int32
WTX_BYTES:
type: integer
description: Number of bytes transmitted on the WAN side.
format: int32
WTX_PKTS:
type: integer
description: Number of packets transmitted on the WAN side.
format: int32
nePk:
type: string
description: Internal ID of appliance.
trafficBehaviorTmp:
title: trafficBehaviorTmp
required:
- TB_CONFIG
- TB_NAME
type: object
properties:
TB_CONFIG:
type: object
description: traffic behavior configuration key value pairs
TB_NAME:
type: object
description: an array of traffic behavior names, e.g Voice, Video conferencing, Video Streaming, Bulk Data, Interactive, Idle or Undetermined
trafficClass:
title: trafficClass
type: object
properties:
:
$ref: '#/components/schemas/trafficClassId'
trafficClassId:
title: trafficClassId
type: object
properties:
excess:
type: integer
description: Traffic class excess weight
format: int32
flow_limit:
type: integer
description: Traffic class flow rate limit
format: int32
max_bw:
type: number
description: Traffic class max bandwidth %
max_bw_abs:
type: integer
description: Traffic class max bandwidth (kbps)
format: int32
max_wait:
type: integer
description: Traffic class max wait
format: int32
min_bw:
type: number
description: Traffic class min bandwidth %
min_bw_abs:
type: integer
description: Traffic class min bandwidth (kbps)
format: int32
priority:
type: integer
description: Traffic class priority
format: int32
self:
type: integer
description: Traffic class ID. It is the same as the parent node key "trafficClassId"
format: int32
updateConfig:
title: updateConfig
required:
- defaultMenuType
- users
type: object
properties:
defaultMenuType:
type: boolean
description: Whether this is a default menu type
users:
type: array
items:
type: string
description: The user names configured for this menu type
updateMenuType:
title: updateMenuType
required:
- menuTypeName
type: object
properties:
menuTypeName:
$ref: '#/components/schemas/updateConfig'
userAccessCustomization:
title: userAccessCustomization
required:
- username
type: object
properties:
asset:
type: string
description: appliance access group / asset name. Required if roles value is not provided
roles:
type: string
description: Comma separated list of roles. Required if asset value is not provided
username:
type: string
description: username
userAuthType:
title: userAuthType
required:
- authType
- user
type: object
properties:
authType:
type: string
description: Current user's authentication type
user:
type: string
description: Current user
userDefinedConfig:
title: userDefinedConfig
type: object
properties:
:
$ref: '#/components/schemas/userDefinedConfigInfo'
userDefinedConfigInfo:
title: userDefinedConfigInfo
type: object
properties:
dscp:
type: string
description: Differentiated services code point
dst_ip_range:
type: string
description: Destination IP address
dst_port_range:
type: string
description: Destination port range
id:
type: integer
format: int32
ipver:
type: string
name:
type: string
proto:
type: string
description: Protocol
self:
type: integer
format: int32
src_ip_range:
type: string
description: Source ip range
src_port_range:
type: string
description: Source port range
vlan:
type: string
description: virtual local area network
versionName:
title: versionName
type: object
properties:
switchToVersion:
type: string
description: name of the version to be switched
vifs:
title: vifs
type: object
properties:
pppoe:
type: array
items:
type: string
description: List of PPPoE interface names configured on this appliance
description: List of virtual interface names configured on this appliance
vtiConfig:
title: vtiConfig
type: object
properties:
:
$ref: '#/components/schemas/vtiConfigDetail'
vtiConfigDetail:
title: vtiConfigDetail
required:
- admin
- ipaddr
- label
- nmask
- side
- tunnel
- zone
type: object
properties:
admin:
type: boolean
description: admin status
ipaddr:
type: string
description: Interface IP
label:
type: string
description: label id
nmask:
type: number
description: mask
side:
type: string
description: "'lan' or 'wan'"
tunnel:
type: string
description: Third party passthrough tunnel alias
zone:
type: number
description: zone id
vxoaObject:
title: vxoaObject
required:
- applianceName
- nePkId
type: object
properties:
applianceName:
type: string
description: application name
nePkId:
type: string
description: appliance ID
wan:
title: wan
type: object
properties:
accuracy:
type: integer
description: Shaper accuracy (usec)
format: int32
dyn_bw_enable:
type: boolean
description: Enable/disable dynamic bandwidth for inbound shaper
enable:
type: boolean
description: Enable/disable inbound shaper
max_bw:
type: integer
description: Shaper max bandwidth (kbps)
format: int32
self:
type: string
description: Shaper interface name. It is the same as the parent node key "wan"
traffic-class:
$ref: '#/components/schemas/trafficClass'
zscalerPauseOrchestration:
title: zscalerPauseOrchestration
required:
- paused
type: object
properties:
paused:
type: boolean
description: boolean flag to set pause zscaler orchestration
application:
title: application
enum:
- 3par
- aol
- aol_im
- app_assure_replication
- app_assure_svr_backup
- aspera
- avamar
- backweb
- bit_torrent
- bluearc
- celerra
- centera
- cifs_smb
- cisco_skinny
- citrix-bcast
- citrix-cgp
- citrix-ica
- citrix-ima
- commvault
- cuseeme
- cvs
- datadomain
- ddm
- ddm_ssl
- dns
- doom
- doubletake
- echo
- edonkey
- fcip
- filenet
- ftp
- ftps
- gnutella
- h_323
- hadoop
- hostname
- http
- https
- ibm_db2
- icmp
- ifcp
- imap
- imap4s
- ipsec
- irc
- irc_ssl
- isakmp
- iscsi
- isns
- ivisit
- kazaa
- kerberos
- l2tp
- ldap
- ldaps
- lotus_cc_mail
- lotus_notes
- matip
- ms_exchange
- ms_media
- ms_messenger
- ms_odbc
- ms_ole
- ms_rpc
- ms_sql
- ms_terminal_services
- ms_zone
- nameserver
- ndmp
- netbios
- netvault_replication
- nfs
- nntp
- nntps
- novell
- ntp
- openwindows
- oracle
- pcanywhere
- pcmail
- pcoip
- peoplesoft
- pop
- pop3s
- pptp
- printer
- printer_pdl
- quake
- recoverpoint
- rlogin
- routing
- rtcp
- rtsp
- sap
- sgcp
- sgmp
- shell
- silverpeak_comm
- silverpeak_gms
- silverpeak_internal
- silverpeak_iperf
- silverpeak_peer
- silverpeak_tcpperf
- sip
- sip_tls
- smtp
- smtps
- snapmirror
- snmp
- sql
- srdf
- ssh
- sshell
- sun_rpc
- sybase
- syslog
- t_120
- tacacs
- telnet
- telnets
- tftp
- timbuktu
- time
- unassigned
- uucp
- vnc
- vplex
- vsphere_replication_ini
- vsphere_replication_ong
- vvr
- xwindows
- yahoo_games
- yahoo_im
- zerto_mgmt
- zerto_replication
type: string
applicationGroup:
title: applicationGroup
enum:
- Accommodation_and_Hotels
- Accounting
- Ad_Network
- Addictions
- Adult
- Aerospace_and_Defence
- Agriculture
- Agriculture_and_Forestry
- Airlines_and_Airports
- Alternative_and_Natural_Medicine
- Amazon
- Animal_Products_and_Service
- Animation_and_Comics
- Antiques_and_Collectibles
- Apple
- Architecture
- Archives
- Arts_and_Entertainment
- Ask_an_Expert
- Associations
- Astronomy
- Auctions
- Automotive_Industry
- Automotive_News
- Autos_and_Vehicles
- Aviation
- Awards
- Banking
- Baseball
- Basketball
type: string
bound:
title: bound
enum:
- inbound
- outbound
type: string
bytes:
title: bytes
enum:
- total
- last5m
type: string
direction:
title: direction
enum:
- 0
- 1
type: integer
example: 0
FecEnableStr:
title: FecEnableStr
enum:
- enable
- disable
- auto
type: string
description: Enable Forward Error Correction(FEC)
FecResetIntvl:
title: FecResetIntvl
enum:
- 2
- 5
- 10
- 20
type: integer
description: Forward Error Correction Ratio
example: 2
Filter:
title: Filter
enum:
- 0
- 1
- 2
- 3
type: integer
description: 'For traffic Type : 0 - optimized traffic, 1 - passthrough-shaped, 2 - passthrough-unshaped, 3 - all traffic. Default is 0 - optimized traffic if omitted. For traffic direction: 1 - inbound, 0-outbound'
example: 0
filter1:
title: filter1
enum:
- all
- asymmetric
- stale
- passThrough
- boosted
- routeDropped
- firewallDropped
- directlyAttached
type: string
filter2:
title: filter2
enum:
- names
- metadata
type: string
flow:
title: flow
enum:
- TCP_ACCELERATED
- TCP_NOT_ACCELERATED
- NON_TCP
type: string
flowType:
title: flowType
enum:
- TCP_ACCELERATED
- TCP_NOT_ACCELERATED
- NON_TCP
type: string
format:
title: format
enum:
- CSV
type: string
format1:
title: format1
enum:
- csv
type: string
generatedObject:
title: generatedObject
type: object
properties:
ipaddr:
type: string
description: WCCP service group router IP address.
self:
type: integer
format: int32
granularity:
title: granularity
enum:
- minute
- hour
- day
type: string
HealthStatus:
title: HealthStatus
enum:
- HEALTHY
- WARNING
- MINOR
- MAJOR
- CRITICAL
type: string
description: health status
isKnown:
title: isKnown
enum:
- 0
- 1
type: integer
example: 0
isSource:
title: isSource
enum:
- 0
- 1
type: integer
example: 0
labelSide:
title: labelSide
enum:
- lan
- wan
type: string
method:
title: method
enum:
- GET
- POST
- PUT
- DELETE
type: string
metric:
title: metric
enum:
- throughput
- peakThroughput
- loss
- latency
- compression
- packets
- outOfOrder
- flows
- bandwidthUtilization
type: string
Mode:
title: Mode
enum:
- bridge
- router
type: string
description: System deployment mode
NetReadPrivilege:
title: NetReadPrivilege
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
type: integer
description: Need description here
example: 0
NetReadWritePrivilege:
title: NetReadWritePrivilege
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
type: integer
description: Need description here
example: 0
NetworkRole:
title: NetworkRole
enum:
- 0
- 1
- 2
type: integer
description: Need description here
example: 0
Protocol:
title: Protocol
enum:
- ip
- tcp
- udp
- or a number on the IP protocol header
type: string
description: Name of protocol or protocol number in the IP header
protocol1:
title: protocol1
enum:
- ip
- tcp
- udp
- ah
- egp
- eigrp
- encap
- esp
- etherip
- fc
- gre
- icmp
- idpr
- idpr-cmtp
- idrp
- igmp
- igp
- ip-comp
- ip-mobility
- ipip
- ipip4
- ipx-in-ip
- irtp
- iso-ip
- iso-tp4
- l2tp
- mhrp
- ospf
- pim
- rdp
- rsvp
- sctp
- tlsp
- vrrp
type: string
Rc:
title: Rc
enum:
- 0
- -1
type: integer
description: Indicates success or failure
example: 0
Role2:
title: Role2
enum:
- primary
- secondary
type: string
description: Specify if the server is the primary or secondary.
severity:
title: severity
enum:
- warning
- minor
- major
- critical
type: string
Status:
title: Status
enum:
- HEALTHY
- WARNING
- MINOR
- MAJOR
- CRITICAL
type: string
Status1:
title: Status1
enum:
- Normal
- BYPASS
type: string
description: Tells whether it is actually currently in bypass or normal mode by text.
traffic:
title: traffic
enum:
- optimized_traffic
- pass_through_shaped
- pass_through_unshaped
- all_traffic
type: string
trafficClass1:
title: trafficClass1
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
type: integer
example: 1
trafficType:
title: trafficType
enum:
- optimized_traffic
- pass_through_shaped
- pass_through_unshaped
- all_traffic
type: string
TunnelMode:
title: TunnelMode
enum:
- ipsec
- udp
- gre
type: string
description: The tunnel mode property
TunnelThreshold:
title: TunnelThreshold
type: object
properties:
fastfail:
type: integer
format: int32
Type:
title: Type
enum:
- tunnel
- trafficType
- app
- flow
- dscp
- trafficClass
- shaper
- drops
type: string
type1:
title: type1
enum:
- gms
- appliance
type: string
type2:
title: type2
enum:
- wan
- lan
type: string
uptime:
title: uptime
enum:
- anytime
- last5m
- term5m
- term
- last1hr
- term1hr
- last4hr
- term4hr
- last24hr
- term24hr
type: string
view:
title: view
enum:
- active
- closed
- all
type: string
tags: []