diff --git a/openapi-specs/sdwan/legacy/ADEM.yaml b/openapi-specs/sdwan/legacy/ADEM.yaml index 7ea9eac4f..aa53c5bf8 100644 --- a/openapi-specs/sdwan/legacy/ADEM.yaml +++ b/openapi-specs/sdwan/legacy/ADEM.yaml @@ -17,9 +17,7 @@ components: ' type: string tenant_id: - description: 'ID of the tenant. - - ' + description: "The tenant ID. \n" type: string required: - site_id @@ -43,7 +41,7 @@ components: ' type: string tenant_id: - description: The tenant ID. + description: "The tenant ID. \n" type: string required: - site_id @@ -63,19 +61,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -101,7 +99,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -110,18 +108,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -138,7 +136,7 @@ paths: description: Query the status of your ADEM instance. operationId: post-v2.0-api-tenants-tenant_id-demstatus-query parameters: - - description: Your SD-WAN instance's unique tenant ID. + - description: The unique tenant ID. in: path name: tenant_id required: true @@ -164,7 +162,7 @@ paths: type: array type: object description: Successful operation - summary: Query ADEM Status (v2.0) + summary: Query ADEM Status tags: - ADEM /v2.0/api/tenants/{tenant_id}/sites/{site_id}/demstatus: diff --git a/openapi-specs/sdwan/legacy/Applications.yaml b/openapi-specs/sdwan/legacy/Applications.yaml index ba94b0514..39f9f373d 100644 --- a/openapi-specs/sdwan/legacy/Applications.yaml +++ b/openapi-specs/sdwan/legacy/Applications.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view AppDefQuery: properties: aggregate: @@ -129,7 +123,9 @@ components: ' type: string aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -138,7 +134,9 @@ components: ' type: string app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -229,7 +227,7 @@ components: type: string ingress_traffic_pct: description: "The app def ingress traffic. Application ingress traffic percentage\ - \ should be in between 1-99. \n" + \ should be in between 1-99. \n" format: int32 type: integer ip_rules: @@ -253,8 +251,8 @@ components: ' type: boolean order_number: - description: 'Order Number: Range(max = 65535L, error = APPDEF_CONFIG_INVALID_ORDER_NUMBER: - Order number should be between 1-65535, min = 1L) ' + description: "The app config order number. Order number should be between\ + \ 1-65535. \n" format: int32 type: integer overrides_allowed: @@ -335,14 +333,12 @@ components: AppDefQueryFilterTransformedV2N4: properties: abbreviation: - description: 'Abbreviation of the application name. Must not exceed 5 characters. + description: 'Abbreviation of the application name. ' type: string aggregate_flows: - description: 'The aggregate flow. - - ' + description: "Aggregate flows enabled. True / False. \n" type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -351,7 +347,7 @@ components: ' type: string app_unreachability_detection: - description: 'Application unreachability detection. + description: 'Aggregate reachability detection. True / False. ' type: boolean @@ -443,8 +439,8 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. + description: 'Application ingress traffic percentage should be in between + 1-99. ' format: int32 @@ -470,9 +466,8 @@ components: ' type: boolean order_number: - description: 'The app def config order number. - - ' + description: "The order number. Order number should be between 1-65535L.\ + \ \n" format: int32 type: integer overrides_allowed: @@ -490,9 +485,7 @@ components: description: P Parent Id type: string p_sub_category: - description: 'Parent app sub-category. - - ' + description: "Parent app sub-category. \n" type: string parent_id: description: 'Parent app ID. @@ -517,9 +510,7 @@ components: format: int32 type: integer supported_engines: - description: 'The app config supported engines. - - ' + description: "Supported engines values. \n" enum: - ave - ave-all @@ -581,7 +572,9 @@ components: ' type: string aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -590,7 +583,9 @@ components: ' type: string app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -707,8 +702,8 @@ components: ' type: boolean order_number: - description: 'Order Number: Range(max = 65535L, error = APPDEF_CONFIG_INVALID_ORDER_NUMBER: - Order number should be between 1-65535, min = 1L) ' + description: "The app config order number. Order number should be between\ + \ 1-65535. \n" format: int32 type: integer overrides_allowed: @@ -753,9 +748,7 @@ components: format: int32 type: integer supported_engines: - description: 'Supported Engines: ValidateEnum(enumClass = classOf[SupportedEngines], - error = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., - nullAllowed = true) ' + description: "Supported engines. \n" enum: - ave - ave-all @@ -787,7 +780,7 @@ components: type: array transfer_type: description: "Application transfer type. Allowed values: transactional,\ - \ bulk, rt-audio, rt-video. \n" + \ bulk, rt-audio, rt-video. \n" type: string udp_rules: description: 'For UDP applications, this dictionary will include information @@ -812,12 +805,12 @@ components: AppDefScreenV2N5: properties: abbreviation: - description: 'Abbreviation of the application name. Must not exceed 5 characters. + description: 'Abbreviation of the application name. ' type: string aggregate_flows: - description: 'The aggregate flow. + description: 'Aggregate flows enabled. True / False. ' type: boolean @@ -828,7 +821,9 @@ components: ' type: string app_unreachability_detection: - description: App Unreachability Detection + description: 'Aggregate reachability detection. True / False. + + ' type: boolean category: description: 'The application category. @@ -918,8 +913,8 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. + description: 'Application ingress traffic percentage should be in between + 1-99. ' format: int32 @@ -945,9 +940,8 @@ components: ' type: boolean order_number: - description: 'The app def config order number. - - ' + description: "The order number. Order number should be between 1-65535L.\ + \ \n" format: int32 type: integer overrides_allowed: @@ -970,9 +964,7 @@ components: ' type: string parent_id: - description: 'Parent app ID. - - ' + description: "Parent app ID. \n" type: string path_affinity: description: "This parameter defines the path affinity characteristics to\ @@ -992,7 +984,7 @@ components: format: int32 type: integer supported_engines: - description: 'The app config supported engines. + description: 'Supported engines values. ' enum: @@ -1260,7 +1252,9 @@ components: ' type: string aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -1269,7 +1263,9 @@ components: ' type: string app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -1386,10 +1382,8 @@ components: ' type: boolean order_number: - description: 'The app config order number. Order number should be between - 1-65535. - - ' + description: 'Order Number: Range(max = 65535L, error = APPDEF_CONFIG_INVALID_ORDER_NUMBER: + Order number should be between 1-65535, min = 1L) ' format: int32 type: integer overrides_allowed: @@ -1434,7 +1428,9 @@ components: format: int32 type: integer supported_engines: - description: "Supported engines. \n" + description: 'Supported engines. + + ' enum: - ave - ave-all @@ -1491,12 +1487,12 @@ components: AppDefV2N5: properties: abbreviation: - description: 'Abbreviation of the application name. Must not exceed 5 characters. + description: 'Abbreviation of the application name. ' type: string aggregate_flows: - description: 'The aggregate flow. + description: 'The aggregate flows. ' type: boolean @@ -1507,7 +1503,9 @@ components: ' type: string app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -1597,10 +1595,8 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. - - ' + description: "The app def ingress traffic. Application ingress traffic percentage\ + \ should be in between 1-99. \n" format: int32 type: integer ip_rules: @@ -1624,7 +1620,8 @@ components: ' type: boolean order_number: - description: 'The app def config order number. + description: 'The app config order number. Order number should be between + 1-65535. ' format: int32 @@ -1671,9 +1668,7 @@ components: format: int32 type: integer supported_engines: - description: 'The app config supported engines. - - ' + description: "Supported engines. \n" enum: - ave - ave-all @@ -1704,8 +1699,10 @@ components: type: string type: array transfer_type: - description: "Application transfer type. Allowed values: transactional,\ - \ bulk, rt-audio, rt-video. \n" + description: 'Application transfer type. Allowed values: transactional, + bulk, rt-audio, rt-video. + + ' type: string udp_rules: description: 'For UDP applications, this dictionary will include information @@ -1819,8 +1816,8 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. + description: 'The app def config ingress traffic pct values. (Min value + = 1, Max value = 99). ' type: integer @@ -1912,10 +1909,14 @@ components: AppdefOverrideScreenV2N3: properties: aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -2037,7 +2038,7 @@ components: ' type: boolean p_category: - description: 'Parent App Category + description: 'Parent App Category. ' enum: @@ -2102,10 +2103,14 @@ components: AppdefOverrideV2N2: properties: aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -2280,10 +2285,14 @@ components: AppdefOverrideV2N3: properties: aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -2405,7 +2414,7 @@ components: ' type: boolean p_category: - description: 'Parent App Category + description: 'Parent App Category. ' enum: @@ -2470,18 +2479,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string DSCP: properties: @@ -2506,7 +2515,7 @@ components: Filter: properties: elements: - description: 'Filter by element. + description: 'Elements of the filter. ' items: @@ -2514,7 +2523,7 @@ components: type: string type: array path: - description: 'Filter by path. + description: 'Path of the filter. ' items: @@ -2522,19 +2531,15 @@ components: type: string type: array site: - description: 'Filter by site. + description: 'Site of the filter. ' type: object type: - description: 'Filter by type. + description: 'Type of the filter. ' type: string - required: - - path - - site - - elements GlobalPrefixFilter: properties: description: @@ -2705,11 +2710,8 @@ components: type: string type: array dest_prefixes: - description: 'Dest Prefixes: ListString(allowDuplicate = false, allowEmpty - = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_PREFIX: - Invalid prefix configured, noTrim = false, regex = , required = false) - ListIPAddress(bcast = DENY, listMaxSize = 0, error = APPDEF_CONFIG_INVALID_PREFIX: - Invalid prefix configured, required = false, type = APP_GATEWAYCIDR) ' + description: "The app def destination prefix filter list. Max size = 8.\ + \ \n" items: description: Dest Prefixes type: string @@ -2754,9 +2756,7 @@ components: - ipv6-frag type: string src_filters: - description: 'The app def src filters list. Max size = 8. - - ' + description: "The app def src filters list. Max size = 8. \n" items: description: Src Filters type: string @@ -2766,19 +2766,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -2804,7 +2804,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -2850,7 +2850,7 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queries that match the query parameters. + description: 'The aggregate number of app defs that match the query parameters. ' dest_page: @@ -2860,12 +2860,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number queries deleted for a time frame. + description: 'The number app definitions deleted for a time frame. ' type: boolean group_by: - description: 'Group the query. + description: 'Group the app definitions for the query. ' items: @@ -2873,7 +2873,7 @@ components: type: string type: array id: - description: "List the queries by ID. \n" + description: "List the app definitions by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -2989,11 +2989,9 @@ components: ' server_prefixes: - description: 'Server Prefixes: ListString(allowDuplicate = false, allowEmpty - = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_PREFIX: - Invalid prefix configured, noTrim = false, regex = , required = false) - ListIPAddress(bcast = DENY, listMaxSize = 0, error = APPDEF_CONFIG_INVALID_PREFIX: - Invalid prefix configured, required = false, type = APP_GATEWAYCIDR) ' + description: 'The server prefixes. + + ' items: description: Server Prefixes type: string @@ -3010,15 +3008,13 @@ components: type: array udp_port: $ref: '#/components/schemas/Port' - description: "The start and end UDP port ranges. \n" + description: "The start and end UDP port ranges. \n" UdpRuleV2: properties: dest_prefixes: - description: 'Dest Prefixes: ListString(allowDuplicate = false, allowEmpty - = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_PREFIX: - Invalid prefix configured, noTrim = false, regex = , required = false) - ListIPAddress(bcast = DENY, listMaxSize = 0, error = APPDEF_CONFIG_INVALID_PREFIX: - Invalid prefix configured, required = false, type = APP_GATEWAYCIDR) ' + description: 'The app def destination prefix filter list. Max size = 8. + + ' items: description: Dest Prefixes type: string @@ -3038,7 +3034,9 @@ components: type: array udp_port: $ref: '#/components/schemas/Port' - description: "The start and end UDP port ranges. \n" + description: 'The start and end UDP port ranges. + + ' info: contact: {} description: List of APIs used to manage an application definition specific query, @@ -3154,7 +3152,7 @@ paths: description: Get the global prefix filters. operationId: get-v2.0-api-tenants-tenant_id-globalprefixfilters parameters: - - description: Tenant Id + - description: The tenant ID. in: path name: tenant_id required: true @@ -3175,7 +3173,7 @@ paths: description: Create a new global prefix filter. operationId: post-v2.0-api-tenants-tenant_id-globalprefixfilters parameters: - - description: Tenant Id + - description: The tenant ID. in: path name: tenant_id required: true diff --git a/openapi-specs/sdwan/legacy/Auditlogs.yaml b/openapi-specs/sdwan/legacy/Auditlogs.yaml index 60b8610ae..e60195f35 100644 --- a/openapi-specs/sdwan/legacy/Auditlogs.yaml +++ b/openapi-specs/sdwan/legacy/Auditlogs.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view AuditLog: properties: esp_tenant_id: @@ -157,9 +151,7 @@ components: ' type: string tenant_id: - description: 'The tenant ID. - - ' + description: The tenant ID. type: string time_ms: description: Time Ms @@ -263,9 +255,7 @@ components: format: int64 type: integer sdwanapp_id: - description: 'The SD-WAN app ID. Max length = 128. - - ' + description: 'Sdwanapp Id: Length(max = 128, , min = 0) ' type: string session_key_c: description: 'The audit log session key C. Max length = 128. @@ -278,9 +268,7 @@ components: ' type: string tenant_id: - description: 'The tenant ID. - - ' + description: The tenant ID. type: string time_ms: description: Time Ms @@ -295,7 +283,7 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queries. + description: 'The aggregate number of queried elements. ' dest_page: @@ -305,12 +293,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of queried deleted for a time frame. + description: 'The number of queried elements deleted for a time frame. ' type: boolean group_by: - description: 'Group the queries. + description: 'Group the elements state for the query. ' items: @@ -318,7 +306,7 @@ components: type: string type: array id: - description: "List the query by ID. \n" + description: "List the element by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -375,19 +363,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -413,7 +401,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -422,25 +410,25 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string type: object info: contact: {} - description: List of APIs used to retrieve audit logs. + description: Query APIs used to retrieve audit logs. title: Auditlogs version: Latest openapi: 3.0.0 diff --git a/openapi-specs/sdwan/legacy/BulkOperations.yaml b/openapi-specs/sdwan/legacy/BulkOperations.yaml index a6b2040d6..267f8aeb7 100644 --- a/openapi-specs/sdwan/legacy/BulkOperations.yaml +++ b/openapi-specs/sdwan/legacy/BulkOperations.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,16 +44,15 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BaseQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queries. + description: 'The aggregate number of queried elements. ' dest_page: @@ -68,12 +62,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of queried deleted for a time frame. + description: 'The number of queried elements deleted for a time frame. ' type: boolean group_by: - description: 'Group the queries. + description: 'Group the elements state for the query. ' items: @@ -81,7 +75,7 @@ components: type: string type: array id: - description: "List the query by ID. \n" + description: "List the element by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -138,13 +132,13 @@ components: SetBulkResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -156,10 +150,12 @@ components: type: object type: array tenant_id: - description: Tenant Id + description: 'The tenant ID. + + ' type: string total_count: - description: 'The total number of responses. + description: 'Total number. ' format: int64 @@ -258,8 +254,7 @@ paths: - Bulk Operations /v2.0/api/tenants/{tenant_id}/policysets/bulk_config_state/query: post: - description: Get all the config/state information across all policy sets from - NB. + description: Get all config/state info across all policysets from NB. operationId: post-v2.0-api-tenants-tenant_id-policysets-bulk_config_state-query parameters: - description: The tenant ID. @@ -292,7 +287,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Config/State Info across Policy Sets (v2.0) + summary: Get Config/State across all Policysets from NB (v2.0) tags: - Bulk Operations /v2.0/api/tenants/{tenant_id}/sites/bulk_config_state/query: diff --git a/openapi-specs/sdwan/legacy/Cellular.yaml b/openapi-specs/sdwan/legacy/Cellular.yaml index 758b19e6f..ef1c91dd9 100644 --- a/openapi-specs/sdwan/legacy/Cellular.yaml +++ b/openapi-specs/sdwan/legacy/Cellular.yaml @@ -285,11 +285,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -298,26 +293,25 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string CellularModule: properties: @@ -1262,19 +1256,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -1300,7 +1294,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -1309,18 +1303,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -1422,7 +1416,7 @@ components: ' type: string tenant_id: - description: "The tenant ID. \n" + description: "The tenant ID. \n" type: string required: - tenant_id diff --git a/openapi-specs/sdwan/legacy/CloudBlades.yaml b/openapi-specs/sdwan/legacy/CloudBlades.yaml index 2b53ad257..b6ea8f841 100644 --- a/openapi-specs/sdwan/legacy/CloudBlades.yaml +++ b/openapi-specs/sdwan/legacy/CloudBlades.yaml @@ -18,18 +18,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string Error: properties: @@ -46,18 +46,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -410,7 +410,7 @@ components: type: string type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: "The tenant ID. \n" type: string version: description: 'The version of the SD-WAN app. @@ -680,7 +680,7 @@ components: - timestamp info: contact: {} - description: List of APIs used to retrieve cloudblade configurations and status. + description: List of APIs used to retrieve cloudblade configuration and status. title: CloudBlades version: Latest openapi: 3.0.0 diff --git a/openapi-specs/sdwan/legacy/DHCP.yaml b/openapi-specs/sdwan/legacy/DHCP.yaml index 07f958dd8..9b214d56b 100644 --- a/openapi-specs/sdwan/legacy/DHCP.yaml +++ b/openapi-specs/sdwan/legacy/DHCP.yaml @@ -18,8 +18,16 @@ components: required: - option_value - option_definition - DHCPServerScreenV2N1: + DHCPServerScreenV2N2: properties: + address_family: + description: 'The DHCP config address values. + + ' + enum: + - IPV4 + - IPV6 + type: string broadcast_address: description: 'The address of the site. @@ -94,7 +102,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMapping' + $ref: '#/components/schemas/StaticMappingV2' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -111,13 +119,15 @@ components: type: string type: array required: + - address_family - ip_ranges - subnet - DHCPServerScreenV2N2: + DHCPServerScreenV2N3: properties: address_family: - description: 'Address Family: ValidateEnum(enumClass = classOf[IPAddressFamily], - DHCP_CONFIG_ADDRESS_FAMILY_INVALID, nullAllowed = false) ' + description: 'The DHCP config address values. + + ' enum: - IPV4 - IPV6 @@ -212,12 +222,25 @@ components: description: Tags type: string type: array + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: - address_family - ip_ranges - subnet - DHCPServerV2N1: + DHCPServerV2N2: properties: + address_family: + description: 'The DHCP config address values. + + ' + enum: + - IPV4 + - IPV6 + type: string broadcast_address: description: 'The address of the site. @@ -292,7 +315,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMapping' + $ref: '#/components/schemas/StaticMappingV2' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -309,9 +332,10 @@ components: type: string type: array required: + - address_family - ip_ranges - subnet - DHCPServerV2N2: + DHCPServerV2N3: properties: address_family: description: 'The DHCP config address values. @@ -411,6 +435,11 @@ components: description: Tags type: string type: array + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: - address_family - ip_ranges @@ -443,24 +472,27 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string type: object - StaticMapping: + StaticMappingV2: properties: + client_duid: + description: "The DHCP server config duid provided for static mapping. \n" + type: string ip_address: description: 'IP addresses assigned mapped to MAC addresses of the clients. @@ -477,30 +509,6 @@ components: required: - ip_address - name - StaticMappingV2: - properties: - client_duid: - description: 'Client Duid: Pattern(error = DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID: - Invalid Client duid provided for static mapping., regexp = ([0-9a-fA-F]{1,2}:)*[0-9a-fA-F]{1,2}|([0-9a-fA-F]{1,2}:)*(:([0-9a-fA-F]{1,2}:)*)([0-9a-fA-F]{1,2})*) ' - type: string - ip_address: - description: 'Ip Address: NotNull(error = DHCPSERVER_CONFIG_STATIC_MAPPING_MISSING: - Provide all required attributes for static mappings.) ' - type: string - mac: - description: 'Mac: MACAddressFiveColons(error = DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_MAC_ADDR: - Invalid mac address provided for static mapping) ' - type: string - name: - description: 'Name: NotNull(error = DHCPSERVER_CONFIG_STATIC_MAPPING_MISSING: - Provide all required attributes for static mappings.) Size(max = 256, - error = DHCPSERVER_CONFIG_STATIC_MAPPING_NAME_EXCEEDS_LIMIT: Static Mapping - name execeeds the maximum limit, min = 0) Pattern(error = DHCPSERVER_CONFIG_STATIC_MAPPING_UNSUPPORTED_NAME: - Provide valid static mapping name, regexp = ^[a-zA-Z0-9]+(([a-zA-Z0-9\\-_])|(\\.?[a-zA-Z0-9\\-]))*\\.?$) ' - type: string - required: - - ip_address - - name info: contact: {} description: List of APIs used to manage the DHCP servers. @@ -508,10 +516,10 @@ info: version: Latest openapi: 3.0.0 paths: - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers: + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers: get: description: Get all the DHCP servers for a tenant on a site. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-dhcpservers + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-dhcpservers parameters: - description: ID of the tenant. in: path @@ -538,16 +546,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/DHCPServerV2N1' + $ref: '#/components/schemas/DHCPServerV2N2' type: array type: object description: Successful Operation - summary: Get DHCP Servers for Tenant on Site (v2.1) + summary: Get DHCP Servers for Tenant on Site (v2.2) tags: - DHCP post: description: Create a new DHCP server configuration for a subnet. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-dhcpservers + operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-dhcpservers parameters: - description: ID of the tenant. in: path @@ -568,14 +576,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N1' + $ref: '#/components/schemas/DHCPServerScreenV2N2' description: Details of dhcp server config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N1' + $ref: '#/components/schemas/DHCPServerV2N2' description: Successful Operation '400': content: @@ -595,16 +603,24 @@ paths: - code: DHCPSERVER_CONFIG_IP_RANGE_MISSING - code: DHCPSERVER_CONFIG_INVALID_TAGS - code: DHCPSERVER_CONFIG_DESCRIPTION_EXCEEDS_LIMIT + - code: DHCPSERVER_CONFIG_GATEWAY_NOT_SUPPORTED_FOR_IPV6_FAMILY + - code: DHCPSERVER_CONFIG_INVALID_IPV6_SUBNET_ADDR + - code: DHCPSERVER_CONFIG_BROADCAST_ADDRESS_NOT_SUPPORTED_FOR_IPV6_FAMILY + - code: DHCPSERVER_CONFIG_IP_RANGE_INVALID_IPV6 + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_IPV6 + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_MAC_NOT_SUPPORTED + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID_NOT_SUPPORTED + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create DHCP Server Configuration for Subnet (v2.1) + summary: Create DHCP Server Configuration for Subnet (v2.2) tags: - DHCP - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers/{dhcp_server_id}: + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers/{dhcp_server_id}: delete: description: Delete the DHCP Server for a tenant on a site. - operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id + operationId: delete-v2.2-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the tenant. in: path @@ -633,14 +649,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N1' + $ref: '#/components/schemas/DHCPServerV2N2' description: Successful Operation - summary: Delete DHCP Server for Tenant on Site (v2.1) + summary: Delete DHCP Server for Tenant on Site (v2.2) tags: - DHCP get: description: List the DHCP server for a tenant on a site. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the tenant. in: path @@ -669,14 +685,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N1' + $ref: '#/components/schemas/DHCPServerV2N2' description: Successful Operation - summary: Get DHCP Server for Tenant on Site (v2.1) + summary: Get DHCP Server for Tenant on Site (v2.2) tags: - DHCP put: description: Update an existing DHCP server configuration for a subnet. - operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id + operationId: put-v2.2-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the tenant. in: path @@ -704,14 +720,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N1' + $ref: '#/components/schemas/DHCPServerScreenV2N2' description: Details of dhcp server config to be Updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N1' + $ref: '#/components/schemas/DHCPServerV2N2' description: Successful Operation '400': content: @@ -731,16 +747,24 @@ paths: - code: DHCPSERVER_CONFIG_IP_RANGE_MISSING - code: DHCPSERVER_CONFIG_INVALID_TAGS - code: DHCPSERVER_CONFIG_DESCRIPTION_EXCEEDS_LIMIT + - code: DHCPSERVER_CONFIG_GATEWAY_NOT_SUPPORTED_FOR_IPV6_FAMILY + - code: DHCPSERVER_CONFIG_INVALID_IPV6_SUBNET_ADDR + - code: DHCPSERVER_CONFIG_BROADCAST_ADDRESS_NOT_SUPPORTED_FOR_IPV6_FAMILY + - code: DHCPSERVER_CONFIG_IP_RANGE_INVALID_IPV6 + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_IPV6 + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_MAC_NOT_SUPPORTED + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID_NOT_SUPPORTED + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update DHCP Server Configuration (v2.1) + summary: Update DHCP Server Configuration (v2.2) tags: - DHCP - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers: + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers: get: description: Get all the DHCP servers for a tenant on a site. - operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-dhcpservers + operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-dhcpservers parameters: - description: ID of the tenant. in: path @@ -767,16 +791,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServerV2N3' type: array type: object description: Successful Operation - summary: Get DHCP Servers for Tenant on Site (v2.2) + summary: Get DHCP Servers for Tenant on Site (v2.3) tags: - DHCP post: description: Create a new DHCP server configuration for a subnet. - operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-dhcpservers + operationId: post-v2.3-api-tenants-tenant_id-sites-site_id-dhcpservers parameters: - description: ID of the tenant. in: path @@ -797,14 +821,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N2' + $ref: '#/components/schemas/DHCPServerScreenV2N3' description: Details of dhcp server config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServerV2N3' description: Successful Operation '400': content: @@ -835,13 +859,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create DHCP Server Configuration for Subnet (v2.2) + summary: Create DHCP Server Configuration for Subnet (v2.3) tags: - DHCP - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers/{dhcp_server_id}: + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers/{dhcp_server_id}: delete: description: Delete the DHCP Server for a tenant on a site. - operationId: delete-v2.2-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id + operationId: delete-v2.3-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the tenant. in: path @@ -870,14 +894,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServerV2N3' description: Successful Operation - summary: Delete DHCP Server for Tenant on Site (v2.2) + summary: Delete DHCP Server for Tenant on Site (v2.3) tags: - DHCP get: description: List the DHCP server for a tenant on a site. - operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id + operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the tenant. in: path @@ -906,14 +930,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServerV2N3' description: Successful Operation - summary: Get DHCP Server for Tenant on Site (v2.2) + summary: Get DHCP Server for Tenant on Site (v2.3) tags: - DHCP put: description: Update an existing DHCP server configuration for a subnet. - operationId: put-v2.2-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id + operationId: put-v2.3-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the tenant. in: path @@ -941,14 +965,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N2' + $ref: '#/components/schemas/DHCPServerScreenV2N3' description: Details of dhcp server config to be Updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServerV2N3' description: Successful Operation '400': content: diff --git a/openapi-specs/sdwan/legacy/DNSServices.yaml b/openapi-specs/sdwan/legacy/DNSServices.yaml index d572f51ef..f3c7b738c 100644 --- a/openapi-specs/sdwan/legacy/DNSServices.yaml +++ b/openapi-specs/sdwan/legacy/DNSServices.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view Alias: properties: mask: @@ -329,23 +323,27 @@ components: DnsForwardConfigV2: properties: dns_servers: - description: 'Dns Servers: ListString(allowDuplicate = true, allowEmpty - = false, allowNull = false, length = 0, listMaxSize = 0, INVALID_STRING, - noTrim = false, regex = , required = false) ' + description: 'Details of the DNS severs. + + ' items: $ref: '#/components/schemas/DnsServersV2' type: array max_source_port: - description: 'Max Source Port: Range(max = 65535L, error = DNSSERVICE_CONFIG_INVALID_MAXSOURCEPORT_VALUE: - Invalid max source port, min = 1L) ' + description: 'The DNS service max source port. + + ' type: integer min_source_port: - description: 'Min Source Port: Range(max = 65535L, error = DNSSERVICE_CONFIG_INVALID_MINSOURCEPORT_VALUE: - Invalid min source port, min = 1L) ' + description: 'The DNS service min source port. + + ' format: int32 type: integer send_to_all_dns_servers: - description: Send To All Dns Servers + description: 'If the option es enabled to send to all DNS servers. + + ' type: boolean required: - dns_servers @@ -510,38 +508,44 @@ components: DnsServersV2: properties: address_family: - description: Address Family + description: 'The DNS server address values. + + ' enum: - ipv4 - ipv6 - ipv4v6 type: string dnsserver_ip: - description: 'Dnsserver Ip: NotEmpty(error = DNSSERVER_IP_CONFIG_MISSING: - Dns Server ip is missing) ' + description: 'The DNS server IP address. + + ' type: string dnsserver_port: - description: 'Dnsserver Port: Range(max = 65535L, error = INVALID_DNSSERVER_PORT_RANGE_CONFIG: - Dns Server port is not in the valid range ''1 - 65535'', min = 1L) ' + description: 'The DNS server port. + + ' type: integer domain_names: - description: 'Domain Names: UniqueHostNames(allowNull = true, max = 2147483647, - message = DNSSERVER_DOMAIN_NAMES_CONFIG_INVALID_HOST, min = 0) ' + description: 'The DNS server domain names. + + ' items: description: Domain Names type: string type: array forward_dnsservicerole_id: - description: 'Forward Dnsservicerole Id: Size(max = 20, error = VALUE_EXCEEDS_LIMIT: - value length exceeds maximum limit, min = 0) ' + description: 'The DNS forward service role ID. Max size = 20. + + ' type: string ip_prefix: - description: Ip Prefix + description: "The DNS server IP prefix. \n" type: string source_port: - description: 'Source Port: Range(max = 65535L, error = INVALID_DNSSERVER_SOURCE_PORT_RANGE_CONFIG: - Dns Server source port is not in the valid range ''1 - 65535'', min = - 1L) ' + description: 'The DNS server source port. + + ' type: integer required: - dnsserver_ip @@ -777,7 +781,7 @@ components: type: string type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: "The tenant ID. \n" type: string required: - dns_forward_config @@ -1279,19 +1283,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -1317,7 +1321,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -1326,18 +1330,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -2207,7 +2211,7 @@ paths: - DNS Services /v2.0/api/tenants/{tenant_id}/dnsservices/query: post: - description: Query DNS service configs based on parameters. + description: Query DNS service config based on parameters. operationId: post-v2.0-api-tenants-tenant_id-dnsservices-query parameters: - description: ID of the tenant. diff --git a/openapi-specs/sdwan/legacy/DeviceConfiguration.yaml b/openapi-specs/sdwan/legacy/DeviceConfiguration.yaml index c69e4bd1c..69e2fb693 100644 --- a/openapi-specs/sdwan/legacy/DeviceConfiguration.yaml +++ b/openapi-specs/sdwan/legacy/DeviceConfiguration.yaml @@ -87,11 +87,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -100,11 +95,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view ApplicationProbe: properties: description: @@ -203,7 +197,7 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queries. + description: 'The aggregate number of queried elements. ' dest_page: @@ -213,12 +207,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of queried deleted for a time frame. + description: 'The number of queried elements deleted for a time frame. ' type: boolean group_by: - description: 'Group the queries. + description: 'Group the elements state for the query. ' items: @@ -226,7 +220,7 @@ components: type: string type: array id: - description: "List the query by ID. \n" + description: "List the element by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -271,18 +265,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string BypassInfo: properties: @@ -339,6 +333,15 @@ components: enum: - UPDATE_CASTORE type: string + CDLConnectionState: + properties: + connected: + description: Connected + type: boolean + state_change_time: + description: State Change Time + format: int64 + type: integer CellularInterfaceConfig: properties: apn_config: @@ -810,9 +813,7 @@ components: ' type: string upgrade_interval: - description: 'The upgrade interval. - - ' + description: "The upgrade interval. \n" type: integer upgrade_state: description: 'The upgrade state of the element. @@ -874,12 +875,12 @@ components: ' type: integer download_percent: - description: 'The download percentage. + description: 'The download percent. ' type: integer failure_info: - description: 'The element image failure information. + description: 'Detials of the failure information. ' type: string @@ -919,7 +920,7 @@ components: ' type: integer upgrade_state: - description: 'The upgrade state of the element. + description: 'The upgrade state. ' enum: @@ -980,79 +981,55 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of elements that match the query parameters. + description: Aggregate + description: + description: 'The description of the element. ' dest_page: - description: 'The destination page. - - ' + description: Dest Page format: int32 type: integer getDeleted: - description: 'The number of elements deleted for a time frame. - - ' + description: GetDeleted type: boolean group_by: - description: 'Group the elements for the query. - - ' + description: Group By items: description: Group By type: string type: array id: - description: "List the element by ID. \n" + description: Id type: string last_query_ts: - description: 'Return the ID of a specified query in the current session. - - ' + description: Last Query Ts format: int64 type: integer limit: - description: 'The query limit. - - ' + description: Limit format: int32 type: integer next_query: - description: 'The limit. - - ' type: object query_params: - description: 'Query using query parameters. - - ' type: object retrieved_fields: - description: 'Retrieve information from a field. - - ' + description: Retrieved Fields items: description: Retrieved Fields type: string type: array retrieved_fields_mask: - description: 'List the fields to query. - - ' + description: Retrieved Fields Mask type: boolean sort_params: - description: 'Specify the order in which you want the search criteria to - display. - - ' type: object total_count: - description: 'The total number of query parameters. - - ' + description: Total Count format: int64 type: integer - ElementQueryFilterV2N7: + ElementQueryFilterV3: properties: admin_action: description: 'The values of admin actions that can be performed. @@ -1234,13 +1211,8 @@ components: - PA_CONN type: string type: array - cluster_insertion_mode: - description: "The cluster insertion mode. \n" - type: string - cluster_member_id: - description: 'The cluster member ID. - - ' + cluster_id: + description: "The spoke HA config cluster ID. \n" type: string connected: description: 'The element is connected. True or False. @@ -1425,7 +1397,9 @@ components: type: string type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string vpn_to_vpn_forwarding: description: 'VPN to VPN forwarding. True or False. @@ -1435,7 +1409,7 @@ components: required: - site_id - tenant_id - ElementQueryFilterV3: + ElementQueryFilterV3N1: properties: admin_action: description: 'The values of admin actions that can be performed. @@ -1651,6 +1625,26 @@ components: description: 'The description of the element. ' + device_change_mode_start_time: + description: Device Change Mode Start Time + format: int64 + type: integer + device_change_mode_state: + description: Device Change Mode State + enum: + - ELEMENT_CHANGE_MODE_INIT + - ELEMENT_CHANGE_MODE_IN_PROGRESS + - ELEMENT_CHANGE_MODE_FAILED + - ELEMENT_CHANGE_MODE_TIMEOUT + - ELEMENT_CHANGE_MODE + type: string + device_mode: + description: Device Mode + enum: + - none + - l3-mode + - l2-mode + type: string device_profile_id: description: 'The device profile ID. @@ -1803,85 +1797,98 @@ components: type: string type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' - type: string - vpn_to_vpn_forwarding: - description: 'VPN to VPN forwarding. True or False. + description: 'The tenant ID. ' + type: string + vpn_to_vpn_forwarding: + description: "VPN to VPN forwarding. True or False. \n" type: boolean required: - site_id - tenant_id - ElementScreenV2N7: + ElementScreenV3: properties: - cluster_insertion_mode: - description: Cluster Insertion Mode - type: string - cluster_member_id: - description: Cluster Member Id + cluster_id: + description: "The cluster ID. \n" type: string description: - description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: - Description length exceeds limit, min = 0) ' - type: string + description: 'The description of the element. + + ' device_profile_id: - description: Device Profile Id + description: "The device profile ID. \n" type: string id: - description: Id + description: "The element ID. \n" type: string l3_direct_private_wan_forwarding: - description: L3 Direct Private Wan Forwarding + description: 'The L3 direct private WAN is enabled. True or False. + + ' type: boolean l3_lan_forwarding: - description: L3 Lan Forwarding + description: 'The L3 LAN forwarding is enabled. Yes indicates that traffic + forwarding to and from LAN interface, when Enable L3 Direct Private WAN + Forwarding is enabled. + + ' type: boolean led_config: $ref: '#/components/schemas/LedConfig' - description: 'Led Config: Valid ' + description: 'Valid LED config. + + ' main_power_usage_threshold: - description: 'Main Power Usage Threshold: ValidateDecimal(allowZero = true, - increment = 0, max = 0, error = INVALID_MAIN_POWER_USAGE_THRESHOLD: Invalid - main power usage threshold. Allowed range is 50-100., min = 0) ' + description: "The main power usage threshold. Allowed range is 50-100. \ + \ \n" format: int32 type: integer name: - description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of - the resource exceeds limit., min = 0) ' + description: 'The name of the device. + + ' type: string nat_policysetstack_id: - description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, - error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. + + ' type: string network_policysetstack_id: - description: 'Network Policysetstack Id: Digits(fraction = 0, integer = - 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy - set stack id) ' + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. + + ' type: string priority_policysetstack_id: - description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = - 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy - set stack id) ' + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. + + ' type: string site_id: - description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) - NotNull ' + description: "The site ID. \n" type: string spoke_ha_config: $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'Spoke Ha Config: Valid ' + description: 'The details of the spoke HA configuration. + + ' sw_obj: $ref: '#/components/schemas/Software' - description: Sw Obj + description: 'The location and version of the software. + + ' switch_config: $ref: '#/components/schemas/SwitchConfig' - description: 'Switch Config: Valid ' + description: 'The details of the switch configuration. + + ' tags: - description: 'Tags: ListString(allowDuplicate = false, allowEmpty = true, - allowNull = true, length = 128, listMaxSize = 10, error = INVALID_TAG: - Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, - regex = [^,\\s]+, required = false) ' + description: 'A information field that can be added to identify the element. + + ' items: description: Tags type: string @@ -1890,77 +1897,95 @@ components: description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' type: string vpn_to_vpn_forwarding: - description: Vpn To Vpn Forwarding + description: 'VPN to VPN forwarding. True or False. + + ' type: boolean required: - site_id - tenant_id - ElementScreenV3: + ElementScreenV3N1: properties: cluster_id: - description: Cluster Id + description: "The cluster ID. \n" type: string description: - description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: - Description length exceeds limit, min = 0) ' - type: string + description: 'The description of the element. + + ' device_profile_id: - description: Device Profile Id + description: "The device profile ID. \n" type: string id: - description: Id + description: "The element ID. \n" type: string l3_direct_private_wan_forwarding: - description: L3 Direct Private Wan Forwarding + description: 'The L3 direct private WAN is enabled. True or False. + + ' type: boolean l3_lan_forwarding: - description: L3 Lan Forwarding + description: 'The L3 LAN forwarding is enabled. Yes indicates that traffic + forwarding to and from LAN interface, when Enable L3 Direct Private WAN + Forwarding is enabled. + + ' type: boolean led_config: $ref: '#/components/schemas/LedConfig' - description: 'Led Config: Valid ' + description: 'Valid LED config. + + ' main_power_usage_threshold: - description: 'Main Power Usage Threshold: ValidateDecimal(allowZero = true, - increment = 0, max = 0, error = INVALID_MAIN_POWER_USAGE_THRESHOLD: Invalid - main power usage threshold. Allowed range is 50-100., min = 0) ' + description: "The main power usage threshold. Allowed range is 50-100. \ + \ \n" format: int32 type: integer name: - description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of - the resource exceeds limit., min = 0) ' + description: 'The name of the device. + + ' type: string nat_policysetstack_id: - description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, - error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. + + ' type: string network_policysetstack_id: - description: 'Network Policysetstack Id: Digits(fraction = 0, integer = - 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy - set stack id) ' + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. + + ' type: string priority_policysetstack_id: - description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = - 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy - set stack id) ' + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. + + ' type: string site_id: - description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) - NotNull ' + description: "The site ID. \n" type: string spoke_ha_config: $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'Spoke Ha Config: Valid ' + description: 'The details of the spoke HA configuration. + + ' sw_obj: $ref: '#/components/schemas/Software' - description: Sw Obj + description: 'The location and version of the software. + + ' switch_config: $ref: '#/components/schemas/SwitchConfig' - description: 'Switch Config: Valid ' + description: 'The details of the switch configuration. + + ' tags: - description: 'Tags: ListString(allowDuplicate = false, allowEmpty = true, - allowNull = true, length = 128, listMaxSize = 10, error = INVALID_TAG: - Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, - regex = [^,\\s]+, required = false) ' + description: 'A information field that can be added to identify the element. + + ' items: description: Tags type: string @@ -1969,7 +1994,9 @@ components: description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' type: string vpn_to_vpn_forwarding: - description: Vpn To Vpn Forwarding + description: 'VPN to VPN forwarding. True or False. + + ' type: boolean required: - site_id @@ -2268,143 +2295,199 @@ components: ' format: int64 type: integer - ElementStatusV2N1: + ElementStatusV2N2: properties: analytics_backlog_connected: - description: Analytics Backlog Connected + description: 'The analytics backlog is connected. True or False. + + ' type: boolean analytics_backlog_connected_on_utc: - description: Analytics Backlog Connected On Utc + description: 'The analytics backlog is connected on utc. + + ' format: int64 type: integer analytics_backlog_disconnected_on_utc: - description: Analytics Backlog Disconnected On Utc + description: "The analytics backlog is disconnected on utc. \n" format: int64 type: integer analytics_backlog_from: - description: Analytics Backlog From + description: 'The IPv4 address of the analytics backlog. + + ' type: string analytics_live_connected: - description: Analytics Live Connected + description: "The live analytics is connected. True or False. \n" type: boolean analytics_live_connected_on_utc: - description: Analytics Live Connected On Utc + description: "The live analytics is connected on utc. \n" format: int64 type: integer analytics_live_disconnected_on_utc: - description: Analytics Live Disconnected On Utc + description: 'The live analytics is disconnected on utc. + + ' format: int64 type: integer analytics_live_from: - description: Analytics Live From + description: 'The IPv4 address of the live analytics. + + ' type: string config_and_events_connected: - description: Config And Events Connected + description: "The config and events are connected. True or False. \n" type: boolean config_and_events_connected_on_utc: - description: Config And Events Connected On Utc + description: 'The config and events are connected on utc. + + ' format: int64 type: integer config_and_events_disconnected_on_utc: - description: Config And Events Disconnected On Utc + description: "The config and events are disconnected on utc. \n" format: int64 type: integer config_and_events_from: - description: Config And Events From + description: 'The IPv4 address for config and events. + + ' type: string element_id: - description: Element Id + description: "The element ID. \n" type: string flows_backlog_connected: - description: Flows Backlog Connected + description: "The flows backlog is connected. True or False. \n" type: boolean flows_backlog_connected_on_utc: - description: Flows Backlog Connected On Utc + description: 'The flows backlog is connected on utc. + + ' format: int64 type: integer flows_backlog_disconnected_on_utc: - description: Flows Backlog Disconnected On Utc + description: "The flows backlog is disconnected on utc. \n" format: int64 type: integer flows_backlog_from: - description: Flows Backlog From + description: 'The IPv4 address of the flow backlog. + + ' type: string flows_live_connected: - description: Flows Live Connected + description: "The live flows is connected. True or False. \n" type: boolean flows_live_connected_on_utc: - description: Flows Live Connected On Utc + description: 'The live flows are connected on utc. + + ' format: int64 type: integer flows_live_disconnected_on_utc: - description: Flows Live Disconnected On Utc + description: "The live flows are disconnected on utc. \n" format: int64 type: integer flows_live_from: - description: Flows Live From + description: 'The IPV4 address of live flows. + + ' type: string id: - description: Id + description: 'The element ID. + + ' + type: string + last_disconnected_time: + description: 'The last disconnected time. + + ' + format: int64 + type: integer + last_rebooted_info: + description: "Information on the last reboot. \n" type: string + last_rebooted_time: + description: 'The last reboot time. + + ' + format: int64 + type: integer logs_backlog_connected: - description: Logs Backlog Connected + description: 'The backlog logs are connected. True or False. + + ' type: boolean logs_backlog_connected_on_utc: - description: Logs Backlog Connected On Utc + description: "The backlog logs are connected on utc. \n" format: int64 type: integer logs_backlog_disconnected_on_utc: - description: Logs Backlog Disconnected On Utc + description: 'The backlog logs disconnected on utc. + + ' format: int64 type: integer logs_backlog_from: - description: Logs Backlog From + description: 'The IPV4 address for logs backlog. + + ' type: string logs_live_connected: - description: Logs Live Connected - type: boolean - logs_live_connected_on_utc: - description: Logs Live Connected On Utc + description: 'The connected live logs. True or False. + + ' + type: boolean + logs_live_connected_on_utc: + description: "The live logs are connected on utc. \n" format: int64 type: integer logs_live_disconnected_on_utc: - description: Logs Live Disconnected On Utc + description: 'The live logs are disconnected on utc. + + ' format: int64 type: integer logs_live_from: - description: Logs Live From + description: "The IPv4 address from the live logs. \n" type: string main_max_power_supported: - description: Main Max Power Supported + description: 'The main max power supported. + + ' format: int32 type: integer main_power_allocated: - description: Main Power Allocated + description: 'The main power allocated. + + ' format: float type: number main_power_usage_threshold: - description: 'Main Power Usage Threshold: ValidateDecimal(allowZero = true, - increment = 0, max = 0, error = INVALID_MAIN_POWER_USAGE_THRESHOLD: Invalid - main power usage threshold. Allowed range is 50-100., min = 0) ' + description: "The main power usage threshold. \n" format: int32 type: integer poe_state: - description: Poe State + description: 'The poe_state. + + ' type: string site_id: - description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) - NotNull ' + description: "The site ID. \n" type: string switch_state: $ref: '#/components/schemas/SwitchState' - description: Switch State + description: 'The switch state. + + ' tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string required: - site_id - tenant_id - ElementStatusV2N2: + ElementStatusV2N3: properties: analytics_backlog_connected: description: 'The analytics backlog is connected. True or False. @@ -2444,6 +2527,9 @@ components: ' type: string + cdl_connection_state: + $ref: '#/components/schemas/CDLConnectionState' + description: Cdl Connection State config_and_events_connected: description: "The config and events are connected. True or False. \n" type: boolean @@ -2462,6 +2548,16 @@ components: ' type: string + controller_connection_intf: + description: Controller Connection Intf + type: string + device_mode: + description: Device Mode + enum: + - none + - l3-mode + - l2-mode + type: string element_id: description: "The element ID. \n" type: string @@ -2596,7 +2692,7 @@ components: required: - site_id - tenant_id - ElementV2N7: + ElementV3: properties: admin_action: description: 'The values of admin actions that can be performed. @@ -2778,11 +2874,8 @@ components: - PA_CONN type: string type: array - cluster_insertion_mode: - description: "The cluster insertion mode. \n" - type: string - cluster_member_id: - description: 'The cluster member ID. + cluster_id: + description: 'The spoke HA config cluster ID. ' type: string @@ -2969,7 +3062,9 @@ components: type: string type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string vpn_to_vpn_forwarding: description: 'VPN to VPN forwarding. True or False. @@ -2979,7 +3074,7 @@ components: required: - site_id - tenant_id - ElementV3: + ElementV3N1: properties: admin_action: description: 'The values of admin actions that can be performed. @@ -3162,7 +3257,7 @@ components: type: string type: array cluster_id: - description: Cluster Id + description: "The spoke HA config cluster ID. \n" type: string connected: description: 'The element is connected. True or False. @@ -3195,6 +3290,32 @@ components: description: 'The description of the element. ' + device_change_mode_start_time: + description: 'The device change mode start time. + + ' + format: int64 + type: integer + device_change_mode_state: + description: 'The device change mode state. + + ' + enum: + - ELEMENT_CHANGE_MODE_INIT + - ELEMENT_CHANGE_MODE_IN_PROGRESS + - ELEMENT_CHANGE_MODE_FAILED + - ELEMENT_CHANGE_MODE_TIMEOUT + - ELEMENT_CHANGE_MODE + type: string + device_mode: + description: 'The device mode values. + + ' + enum: + - none + - l3-mode + - l2-mode + type: string device_profile_id: description: 'The device profile ID. @@ -3347,7 +3468,9 @@ components: type: string type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string vpn_to_vpn_forwarding: description: 'VPN to VPN forwarding. True or False. @@ -3438,7 +3561,9 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string required: - site_id @@ -3571,9 +3696,7 @@ components: ' type: object total_count: - description: 'The total number of query parameters. - - ' + description: "The total number of query parameters. \n" format: int64 type: integer ExtensionQueryFilter: @@ -3599,7 +3722,7 @@ components: ' type: string tenant_id: - description: "The tenant ID. \n" + description: "The tenant ID. \n" type: string required: - conf @@ -3640,8 +3763,33 @@ components: GREConfig: properties: csum: - description: Csum + description: 'The CSUM. + + ' + type: boolean + keepalive_enable: + description: 'Is keepalive enabled. True or False. + + ' type: boolean + keepalive_fail_count: + description: 'Value between 3 and 10. Indicates the number of consecutive + missed keep-alive packets before a link is declared as down. The default + value is 3. + + ' + format: int32 + type: integer + keepalive_interval: + description: 'Value between 100 ms and 600000 ms. Indicates the time interval + in milliseconds between two VPN keepalive packets. The default value is + 1000 ms. + + ' + format: int32 + type: integer + GeneveConfig: + properties: keepalive_enable: description: 'Is keepalive enabled. True or False. @@ -3663,6 +3811,16 @@ components: ' format: int32 type: integer + keepalive_local_ipv4: + description: 'The keepalive local ipv4 address. + + ' + type: string + keepalive_remote_ipv4: + description: 'The keepalive remote ipv4 address. + + ' + type: string HardwareBypass: properties: element_bypass: @@ -3712,6 +3870,12 @@ components: ' type: string + certificate_profile_id: + description: Certificate Profile Id + type: string + comment: + description: Comment + type: string ikev1_params: $ref: '#/components/schemas/IKEV1Params' description: 'Ikev1 Params: Valid ' @@ -3728,18 +3892,34 @@ components: - DN - HOSTNAME - CUSTOM + - NONE type: string local_id_custom: description: 'The custom local ID. ' type: string + local_pa_certificate_id: + description: Local Pa Certificate Id + type: string + pa_master_key_id: + description: Pa Master Key Id + type: string passphrase: description: Passphrase type: string passphrase_encrypted: description: 'Passphrase Encrypted: JsonIgnore(value = true) ' type: string + peer_id_check: + description: Peer Id Check + enum: + - EXACT + - WILDCARD + type: string + permit_peer_id_mismatch: + description: Permit Peer Id Mismatch + type: boolean private_key: description: 'The private key file uploaded for certificate authentication. @@ -3765,6 +3945,9 @@ components: secret_hash: description: 'Secret Hash: JsonIgnore(value = true) ' type: string + strict_validation_peer_extended_key_use: + description: Strict Validation Peer Extended Key Use + type: boolean type: description: 'The authentication type = PSK or Certificates. @@ -3810,18 +3993,22 @@ components: IPv6DNS: properties: name_servers: - description: Name Servers + description: 'The IPv6 configured DNS name servers. + + ' items: description: Name Servers type: string type: array search: - description: Search + description: 'The search parameters. + + ' items: description: Search type: string type: array - InterfaceScreenV4N14: + InterfaceScreenV4N16: properties: admin_up: description: 'The interface admin state. @@ -3908,7 +4095,7 @@ components: ' ipv6_config: - $ref: '#/components/schemas/Ipv6Config' + $ref: '#/components/schemas/Ipv6ConfigV1' description: 'The ipv6 config information. ' @@ -3943,9 +4130,9 @@ components: ' type: string nat_address_v6: - description: 'Nat Address V6: IPAddress(allowEmpty = true, allowLinkLocal - = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck - = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IPV6) ' + description: 'The NAT IPV6 address. + + ' type: string nat_pools: description: 'The NAT pools information. @@ -3981,6 +4168,14 @@ components: ' type: string + peer_bypasspair_wan_port_type: + description: 'The peer bypass pair WAN port type. + + ' + enum: + - none + - cellular + type: string poe_enabled: description: 'PoE enabled = true/false. @@ -4069,11 +4264,17 @@ components: description: 'The VLAN config details. ' + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: + - peer_bypasspair_wan_port_type - scope - used_for - type - InterfaceScreenV4N15: + InterfaceScreenV4N17: properties: admin_up: description: 'The interface admin state. @@ -4329,12 +4530,17 @@ components: description: 'The VLAN config details. ' + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: - peer_bypasspair_wan_port_type - scope - used_for - type - InterfaceStateV3N4: + InterfaceStateV3N5: properties: cellular_state: $ref: '#/components/schemas/CellularState' @@ -4356,6 +4562,12 @@ components: description: 'The DNS v6 config details. ' + effective_vlans: + description: Effective Vlans + items: + description: Effective Vlans + type: integer + type: array element_id: description: 'The element ID. @@ -4392,6 +4604,9 @@ components: link_local_address: description: "The link local address. \n" type: string + lldp_enabled: + description: Lldp Enabled + type: boolean mac_address: description: 'The interface configuration MAC address. @@ -4413,6 +4628,9 @@ components: ' type: string + poe_state: + $ref: '#/components/schemas/PoeStateS' + description: Poe State port: $ref: '#/components/schemas/Port' description: 'The start and end port details. @@ -4453,7 +4671,17 @@ components: description: 'The service link details ServiceLink. ' - InterfaceStateV3N5: + stp_state: + $ref: '#/components/schemas/STPStateS' + description: 'The STP state details. + + ' + svi_state: + $ref: '#/components/schemas/SVIStateS' + description: 'The svi details. + + ' + InterfaceStateV3N6: properties: cellular_state: $ref: '#/components/schemas/CellularState' @@ -4594,7 +4822,10 @@ components: description: 'The svi details. ' - InterfaceV4N14: + vrf: + $ref: '#/components/schemas/VRF' + description: "The VRF details. \n" + InterfaceV4N16: properties: admin_up: description: 'The interface admin state. @@ -4681,7 +4912,7 @@ components: ' ipv6_config: - $ref: '#/components/schemas/Ipv6Config' + $ref: '#/components/schemas/Ipv6ConfigV1' description: 'The ipv6 config information. ' @@ -4716,9 +4947,9 @@ components: ' type: string nat_address_v6: - description: 'Nat Address V6: IPAddress(allowEmpty = true, allowLinkLocal - = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck - = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IPV6) ' + description: 'The NAT IPV6 address. + + ' type: string nat_pools: description: 'The NAT pools information. @@ -4754,6 +4985,14 @@ components: ' type: string + peer_bypasspair_wan_port_type: + description: 'The peer bypass pair WAN port type. + + ' + enum: + - none + - cellular + type: string poe_enabled: description: 'PoE enabled = true/false. @@ -4842,11 +5081,17 @@ components: description: 'The VLAN config details. ' + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: + - peer_bypasspair_wan_port_type - scope - used_for - type - InterfaceV4N15: + InterfaceV4N17: properties: admin_up: description: 'The interface admin state. @@ -5102,6 +5347,11 @@ components: description: 'The VLAN config details. ' + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: - peer_bypasspair_wan_port_type - scope @@ -5190,51 +5440,44 @@ components: address: description: Address type: string - Ipv6Config: - properties: - dhcp_config: - $ref: '#/components/schemas/Ipv6Dhcp' - description: Dhcp Config - dns_v6_config: - $ref: '#/components/schemas/DNS' - description: 'Dns V6 Config: Valid ' - routes: - description: Routes - items: - $ref: '#/components/schemas/Route' - type: array - static_config: - $ref: '#/components/schemas/Ipv6Static' - description: Static Config - type: - description: Type - type: string Ipv6ConfigV1: properties: dhcp_config: $ref: '#/components/schemas/Ipv6Dhcp' - description: Dhcp Config + description: "The DHCP config information. \n" dns_v6_config: $ref: '#/components/schemas/DNS' - description: 'Dns V6 Config: Valid ' + description: 'The DNS V6 configurations. + + ' routes: - description: Routes + description: 'The route details. + + ' items: $ref: '#/components/schemas/Route' type: array static_config: $ref: '#/components/schemas/Ipv6StaticV1' - description: Static Config + description: 'The IPv6 static address. + + ' type: - description: Type + description: 'The interface config type. Max = 12. + + ' type: string Ipv6Dhcp: properties: client_id: - description: Client Id + description: 'The client ID. + + ' type: string hostname: - description: Hostname + description: 'The IPv6 DHCP host name. + + ' type: string Ipv6Route: properties: @@ -5248,22 +5491,17 @@ components: ' type: string - Ipv6Static: - properties: - address: - description: Address - type: string - enable_prefix_distribution: - description: 'Enable Prefix Distribution: JsonIgnoreProperties(allowGetters - = false, allowSetters = false, ignoreUnknown = true) ' - type: boolean Ipv6StaticV1: properties: address: - description: Address + description: 'The IPv6 static address. + + ' type: string enable_prefix_distribution: - description: Enable Prefix Distribution + description: 'Is prefix distribution enabled. True or False. + + ' type: boolean LanNetworkVlanMapping: properties: @@ -5286,19 +5524,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -5324,7 +5562,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -5333,23 +5571,48 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string type: object - MachineInfoV2N2: + LivelinessProbe: + properties: + failure_count: + description: "The liveliness probe failure count interval. \n" + format: int32 + type: integer + interval: + description: 'The probe interval. Must be between 1 to 30 seconds. + + ' + format: int32 + type: integer + ip_address: + description: "The probe address. \n" + type: string + local_ip_address: + description: 'The local probe address. + + ' + type: string + proxy_id: + description: 'The proxy ID. + + ' + type: string + Machine: properties: connected: description: "The device is connected. True or False. \n" @@ -5360,15 +5623,13 @@ components: em_element_id: description: "The element ID. \n" type: string - esp_tenant_id: - description: "The MSP tenant ID. \n" - type: string hw_id: description: 'The hardware ID. ' type: string id: + description: Id type: string image_version: description: 'The image version. @@ -5376,15 +5637,90 @@ components: ' type: string inventory_op: - $ref: '#/components/schemas/InventoryOperation' - description: 'The details of the operation in the inventory. + description: 'The inventory lifecycle values. ' + enum: + - CLAIM + - RETURN + - REVOKE + - REUSE + - RETIRE + - RECOVER + - REMANUFACTURE + - DEFAULT + - INVALID + - ALLOCATE + - RECEIVED_STOCK + - ESP_ALLOCATE + - ESP_RECEIVED_STOCK + - ESP_RETURN + - ESP_REVOKE + - ESP_REUSE + type: string machine_state: - $ref: '#/components/schemas/MachineState' description: 'The various device states. ' + enum: + - MANUFACTURED + - MANUFACTURED_QA_PENDING + - MANUFACTURED_QA_OK + - MANUFACTURED_QA_NOK + - MANUFACTURED_BATTERY_TEST_PENDING + - MANUFACTURED_BATTERY_TEST_START + - MANUFACTURED_BATTERY_TEST_PASS + - MANUFACTURED_BATTERY_TEST_FAILED + - MANUFACTURED_MIC_ISSUE_PENDING + - MANUFACTURED_MIC_ISSUED + - MANUFACTURED_MIC_FAILED + - MANUFACTURED_MIC_OPERATIONAL + - MANUFACTURED_CIC_ISSUE_PENDING + - MANUFACTURED_CIC_ISSUED + - MANUFACTURED_CIC_REVOKED + - MANUFACTURED_CIC_OPERATIONAL + - MANUFACTURED_MIC_SIGNING_PENDING + - MANUFACTURED_CIC_SIGNING_PENDING + - MACHINE_ALLOCATED + - MACHINE_ALLOCATED_TO_ESP + - MACHINE_ELEMENT_ID_PENDING + - MACHINE_INIT + - MACHINE_INIT_FAILED + - MACHINE_ASSIGNED + - MACHINE_CLAIM_PENDING + - MACHINE_CLAIMED + - MACHINE_CLAIM_FAILED + - MACHINE_TO_BE_RETURNED + - MACHINE_RETURNED + - MACHINE_REVOKED + - MACHINE_ELEMENT_DELETE_PENDING + - MACHINE_RETURN_FAILED + - MACHINE_RECEIVED_STOCK + - REMANUFACTURED + - MACHINE_RETIRED + - MACHINE_RECOVER + - MACHINE_DECOMMISSIONED + - MACHINE_CLAIM_VALID + - MACHINE_CLAIM_INVALID + - MACHINE_CIC_RENEW_INITIAL + - MACHINE_CIC_RENEW_ISSUE_PENDING + - MACHINE_CIC_RENEW_ISSUED + - MACHINE_CIC_RENEW_SIGNING_PENDING + - MACHINE_CIC_RENEW_FAILED + - MACHINE_CIC_RENEWED + - MACHINE_SUSPEND_INIT + - MACHINE_SUSPEND_IN_PROGRESS + - MACHINE_SUSPENDED_MIC_OPERATIONAL + - MACHINE_SUSPENDED_CIC_OPERATIONAL + - MACHINE_SUSPEND_FAILED + - MACHINE_SUSPENDED_EMPTY_TOKEN + - MACHINE_SUSPENDED_INVALID_TOKEN + - MACHINE_SUSPENDED_TOKEN_EXPIRED + - MACHINE_SUSPENDED + - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL + type: string manufacture_id: description: 'The manufacture ID. @@ -5394,38 +5730,109 @@ components: description: "The model name of the device. \n" type: string ordering_info: - description: 'The order information. - - ' - type: string - owner_tenant_id: - description: "The owner tenant ID. \n" + description: "The order information. \n" type: string pki_op: $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op renew_state: - $ref: '#/components/schemas/MachineState' description: 'The device renew states. ' + enum: + - MANUFACTURED + - MANUFACTURED_QA_PENDING + - MANUFACTURED_QA_OK + - MANUFACTURED_QA_NOK + - MANUFACTURED_BATTERY_TEST_PENDING + - MANUFACTURED_BATTERY_TEST_START + - MANUFACTURED_BATTERY_TEST_PASS + - MANUFACTURED_BATTERY_TEST_FAILED + - MANUFACTURED_MIC_ISSUE_PENDING + - MANUFACTURED_MIC_ISSUED + - MANUFACTURED_MIC_FAILED + - MANUFACTURED_MIC_OPERATIONAL + - MANUFACTURED_CIC_ISSUE_PENDING + - MANUFACTURED_CIC_ISSUED + - MANUFACTURED_CIC_REVOKED + - MANUFACTURED_CIC_OPERATIONAL + - MANUFACTURED_MIC_SIGNING_PENDING + - MANUFACTURED_CIC_SIGNING_PENDING + - MACHINE_ALLOCATED + - MACHINE_ALLOCATED_TO_ESP + - MACHINE_ELEMENT_ID_PENDING + - MACHINE_INIT + - MACHINE_INIT_FAILED + - MACHINE_ASSIGNED + - MACHINE_CLAIM_PENDING + - MACHINE_CLAIMED + - MACHINE_CLAIM_FAILED + - MACHINE_TO_BE_RETURNED + - MACHINE_RETURNED + - MACHINE_REVOKED + - MACHINE_ELEMENT_DELETE_PENDING + - MACHINE_RETURN_FAILED + - MACHINE_RECEIVED_STOCK + - REMANUFACTURED + - MACHINE_RETIRED + - MACHINE_RECOVER + - MACHINE_DECOMMISSIONED + - MACHINE_CLAIM_VALID + - MACHINE_CLAIM_INVALID + - MACHINE_CIC_RENEW_INITIAL + - MACHINE_CIC_RENEW_ISSUE_PENDING + - MACHINE_CIC_RENEW_ISSUED + - MACHINE_CIC_RENEW_SIGNING_PENDING + - MACHINE_CIC_RENEW_FAILED + - MACHINE_CIC_RENEWED + - MACHINE_SUSPEND_INIT + - MACHINE_SUSPEND_IN_PROGRESS + - MACHINE_SUSPENDED_MIC_OPERATIONAL + - MACHINE_SUSPENDED_CIC_OPERATIONAL + - MACHINE_SUSPEND_FAILED + - MACHINE_SUSPENDED_EMPTY_TOKEN + - MACHINE_SUSPENDED_INVALID_TOKEN + - MACHINE_SUSPENDED_TOKEN_EXPIRED + - MACHINE_SUSPENDED + - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL + type: string ship_state: - $ref: '#/components/schemas/MachineShipState' description: 'The shipping status. ' + enum: + - MACHINE_SHIPPED + - MACHINE_SHIPPED_CORRECT_ADDRESS + - MACHINE_SHIPPED_WRONG_ADDRESS + - MACHINE_NOT_SHIPPED + type: string sl_no: description: 'The serial number. ' type: string tenant_id: + description: 'The tenant ID. + + ' type: string token: description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. ' type: string - type: object + required: + - ship_state + - manufacture_id + - renew_state + - machine_state + - image_version + - model_name + - sl_no + - hw_id + - tenant_id MachineInfoV2N3: properties: connected: @@ -5456,7 +5863,7 @@ components: type: string inventory_op: $ref: '#/components/schemas/InventoryOperation' - description: 'The details of the operation in the inventory. + description: 'The inventory lifecycle values. ' machine_state: @@ -5498,6 +5905,9 @@ components: sl_no: type: string tenant_id: + description: 'The tenant ID. + + ' type: string token: description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. @@ -5581,7 +5991,7 @@ components: ' format: int64 type: integer - MachineQueryFilterV2N2: + MachineQueryFilterV2N3: properties: connected: description: "The device is connected. True or False. \n" @@ -5611,7 +6021,7 @@ components: ' type: string inventory_op: - description: 'The details of the operation in the inventory. + description: 'The inventory lifecycle values. ' enum: @@ -5692,10 +6102,14 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string manufacture_id: description: 'The manufacture ID. + The manufacture ID. + ' type: string model_name: @@ -5770,6 +6184,13 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL + type: string + sales_order_number: + description: 'The sales order number. + + ' type: string ship_state: description: 'The shipping status. @@ -5782,9 +6203,7 @@ components: - MACHINE_NOT_SHIPPED type: string sl_no: - description: 'The serial number. - - ' + description: Sl No type: string suspend_state: description: 'The suspend state. @@ -5846,16 +6265,20 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string tenant_id: - description: Tenant Id + description: 'The tenant ID. + + ' type: string token: description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. ' type: string - MachineQueryFilterV2N3: + MachineQueryFilterV2N5: properties: connected: description: "The device is connected. True or False. \n" @@ -5863,8 +6286,13 @@ components: console_conf_passphrase: description: "The console password. \n" type: string + element_shell_id: + description: "The element shell ID. \n" + type: string em_element_id: - description: "The element ID. \n" + description: 'The element ID. + + ' type: string esp_tenant_id: description: 'The MSP tenant ID. @@ -5885,7 +6313,7 @@ components: ' type: string inventory_op: - description: 'The details of the operation in the inventory. + description: 'The inventory lifecycle values. ' enum: @@ -5906,6 +6334,10 @@ components: - ESP_REVOKE - ESP_REUSE type: string + is_eval: + description: 'Is Eval: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], + value = ALWAYS, valueFilter = classOf[Void]) ' + type: string machine_state: description: 'The various device states. @@ -5966,6 +6398,8 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string manufacture_id: description: 'The manufacture ID. @@ -6044,6 +6478,8 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string sales_order_number: description: 'The sales order number. @@ -6061,9 +6497,7 @@ components: - MACHINE_NOT_SHIPPED type: string sl_no: - description: 'The serial number. - - ' + description: Sl No type: string suspend_state: description: 'The suspend state. @@ -6125,9 +6559,13 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string tenant_id: - description: Tenant Id + description: 'The tenant ID. + + ' type: string token: description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. @@ -6224,14 +6662,16 @@ components: ' type: string trusted_boot: - description: "The possible values in trusted boot. \n" + description: 'The possible values in trusted boot. + + ' enum: - PASSED - FAILED type: string required: - hardware_id - MachineV2N2: + MachineV2N3: properties: connected: description: "The device is connected. True or False. \n" @@ -6261,7 +6701,7 @@ components: ' type: string inventory_op: - description: 'The details of the operation in the inventory. + description: 'The inventory lifecycle values. ' enum: @@ -6342,6 +6782,8 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string manufacture_id: description: 'The manufacture ID. @@ -6420,6 +6862,13 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL + type: string + sales_order_number: + description: 'The sales order number. + + ' type: string ship_state: description: 'The shipping status. @@ -6432,7 +6881,9 @@ components: - MACHINE_NOT_SHIPPED type: string sl_no: - description: Sl No + description: 'The serial number. + + ' type: string suspend_state: description: 'The suspend state. @@ -6494,16 +6945,31 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string tenant_id: - description: Tenant Id + description: 'The tenant ID. + + ' type: string token: description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. ' type: string - MachineV2N3: + required: + - suspend_state + - ship_state + - manufacture_id + - renew_state + - machine_state + - image_version + - model_name + - sl_no + - hw_id + - tenant_id + MachineV2N5: properties: connected: description: "The device is connected. True or False. \n" @@ -6511,8 +6977,13 @@ components: console_conf_passphrase: description: "The console password. \n" type: string + element_shell_id: + description: "The element shell ID. \n" + type: string em_element_id: - description: "The element ID. \n" + description: 'The element ID. + + ' type: string esp_tenant_id: description: 'The MSP tenant ID. @@ -6533,7 +7004,7 @@ components: ' type: string inventory_op: - description: 'The details of the operation in the inventory. + description: 'The inventory lifecycle values. ' enum: @@ -6554,6 +7025,10 @@ components: - ESP_REVOKE - ESP_REUSE type: string + is_eval: + description: 'Is Eval: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], + value = ALWAYS, valueFilter = classOf[Void]) ' + type: string machine_state: description: 'The various device states. @@ -6614,6 +7089,8 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string manufacture_id: description: 'The manufacture ID. @@ -6692,6 +7169,8 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string sales_order_number: description: 'The sales order number. @@ -6709,8 +7188,7 @@ components: - MACHINE_NOT_SHIPPED type: string sl_no: - description: 'Sl No: NotEmpty(message = Required sl_no) Readonly(message - = Readonly attribute., valid = true) ' + description: Sl No type: string suspend_state: description: 'The suspend state. @@ -6772,26 +7250,19 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string token: description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. ' type: string - required: - - suspend_state - - ship_state - - manufacture_id - - renew_state - - machine_state - - image_version - - model_name - - sl_no - - hw_id - - tenant_id MulticastInterfaceConfig: properties: igmp_version: @@ -6822,6 +7293,16 @@ components: ' type: string + PassiveMode: + properties: + enable: + description: "Passive mode enabled for the device. True or False. \n" + type: boolean + peer_ip_dynamic: + description: 'Peer IP dynamic enabled. True or False. + + ' + type: boolean PeerInfo: properties: hostname: @@ -6932,37 +7413,52 @@ components: ' type: string + Proxy: + properties: + local: + description: Local + type: string + local_port: + description: Local Port + type: integer + protocol: + description: Protocol + type: string + protocol_number: + description: Protocol Number + type: integer + proxy_id: + description: Proxy Id + type: string + remote: + description: Remote + type: string + remote_port: + description: Remote Port + type: integer RecoveryToken: properties: hardware_id: - description: "The machine hardware ID. \n" + description: Hardware Id type: string id: - description: 'The machine ID. - - ' + description: Id type: string ion_token: - description: 'The ION device token. - - ' + description: Ion Token type: string is_used: - description: "Values True or False. \n" + description: Is Used type: boolean secret_token: - description: 'The secret token. - - ' + description: Secret Token type: string token_validity_in_hour: - description: "The token validity in a hour. \n" + description: Token Validity In Hour format: int32 type: integer valid_till_secs: - description: 'The token validity in seconds. - - ' + description: Valid Till Secs format: int64 type: integer RecoveryTokenScreen: @@ -7052,6 +7548,35 @@ components: ' type: string + SaseIkeGWConfig: + properties: + ike_gw_name: + description: Ike Gw Name + type: string + ikev1_dpd_delay: + description: Ikev1 Dpd Delay + type: integer + ikev1_dpd_enable: + description: Ikev1 Dpd Enable + type: boolean + ikev1_dpd_timeout: + description: Ikev1 Dpd Timeout + type: integer + ikev1_enable_fragmentation: + description: Ikev1 Enable Fragmentation + type: boolean + ikev1_exchange_mode: + description: Ikev1 Exchange Mode + type: string + ikev2_liveness_check_enable: + description: Ikev2 Liveness Check Enable + type: boolean + ikev2_liveness_interval: + description: Ikev2 Liveness Interval + type: integer + ikev2_require_cookie: + description: Ikev2 Require Cookie + type: boolean SecondaryIPConfig: properties: ipv4_address: @@ -7062,6 +7587,34 @@ components: type: string ServiceLink: properties: + anti_replay: + description: 'The anti replay value. True or False. + + ' + type: boolean + anti_replay_window: + description: 'The anti replay window count. + + ' + type: integer + classic_site_id: + description: 'The site ID. + + ' + type: string + copy_tos: + description: Copy Tos + type: boolean + enable_gre_encapsulation: + description: 'Is GRE encapsulation enabled. True or False. + + ' + type: boolean + geneve_config: + $ref: '#/components/schemas/GeneveConfig' + description: 'Lists all the geneve configurations. + + ' gre_config: $ref: '#/components/schemas/GREConfig' description: 'The GRE config details. @@ -7077,15 +7630,48 @@ components: ' type: string + liveliness_probe: + $ref: '#/components/schemas/LivelinessProbe' + description: 'Lists the livliness probe details. + + ' + nat_traversal: + description: 'Nat traversal value. True or False. + + ' + type: boolean + pa_location_oid: + description: Pa Location Oid + type: string + pa_tunnel_oid: + description: Pa Tunnel Oid + type: string parent: description: 'The parent value = true. ' type: string + passive_mode: + $ref: '#/components/schemas/PassiveMode' + description: 'Passive mode enabled on the device. True or False + + ' peer: $ref: '#/components/schemas/PeerInfo' description: 'The peer information. + ' + proxy_ids: + description: 'The proxy details. + + ' + items: + $ref: '#/components/schemas/Proxy' + type: array + sase_ike_gw_config: + $ref: '#/components/schemas/SaseIkeGWConfig' + description: 'The SASE IKE GW configurations. + ' security_service_endpoint_id: description: 'The security service endpoint ID. @@ -7093,13 +7679,21 @@ components: ' type: string service_endpoint_id: - description: "The service endpoint ID. \n" + description: 'The service endpoint ID. + + ' + type: string + tunnel_role: + description: "The tunnel role. \n" type: string type: - description: "The service link type. \n" + description: 'The service link type. + + ' enum: - IPSEC - GRE + - GENEVE type: string required: - type @@ -7134,10 +7728,13 @@ components: description: "The service endpoint ID. \n" type: string type: - description: "The service link type. \n" + description: 'The service link type. + + ' enum: - IPSEC - GRE + - GENEVE type: string required: - type @@ -7346,24 +7943,32 @@ components: SwitchState: properties: bridge_id: - description: Bridge Id + description: 'The switch bridge ID + + ' type: string default_vlan_id: - description: Default Vlan Id + description: 'Default VLAN ID is 1. + + ' format: int32 type: integer designated_bridge_id: - description: Designated Bridge Id + description: "The designated bridge ID. \n" type: string last_topology_change: - description: Last Topology Change + description: 'Last topology change. + + ' type: string max_hops: description: Max Hops format: int32 type: integer mstp_enabled: - description: Mstp Enabled + description: 'The MSTP enabled. True or False. + + ' type: boolean root_bridge_id: description: Root Bridge Id @@ -7376,42 +7981,57 @@ components: description: Root Port type: string stp_aging_timer: - description: Stp Aging Timer + description: "The STP aging Timer between 10 - 1000000 seconds. \ + \ \n" format: int32 type: integer stp_forward_delay: - description: Stp Forward Delay + description: "Forward Delay is the length of time spent in listening state,\ + \ set the value between 4 - 30 seconds. \n" format: int32 type: integer stp_hello_time: - description: Stp Hello Time + description: "Hello Time is the time Interval between BPDU transmission,\ + \ set the value between 1-10 seconds. \n" format: int32 type: integer stp_max_age: - description: Stp Max Age + description: 'The length of Max Age time that the switch retains information + learned from BPDUs, set the value between 6 - 40 seconds. + + ' format: int32 type: integer stp_mode: - description: Stp Mode + description: 'The STP Mode is RSTP, default STP mode is RSTP + + ' type: string stp_priority: - description: Stp Priority + description: 'The Priority value is between 0 - 61440, in multiples of 4096. + + ' format: int32 type: integer TrackInterface: properties: interface_id: - description: Interface Id + description: 'The interface ID + + ' type: string reduce_priority: - description: 'Reduce Priority: Range(max = 254L, SPOKEHA_CONFIG_INVALID_REDUCE_PRIORITY, - min = 1L) ' + description: 'Reduce priority of the spoke HA config. + + ' format: int32 type: integer TrackV2: properties: interfaces: - description: "The details of the interfaces. \n" + description: 'The details of the interfaces. + + ' items: $ref: '#/components/schemas/TrackInterface' type: array @@ -7423,13 +8043,27 @@ components: TrackWANInterface: properties: reduce_priority: - description: 'The spoke HA config reduce priority. + description: 'Reduce priority of the spoke HA config. ' format: int32 type: integer wan_interface_id: - description: Wan Interface Id + description: 'The WAN interface ID + + ' + type: string + VRF: + properties: + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string + vrf_context_name: + description: 'The VFR context name. + + ' type: string VffInventoryOperation: enum: @@ -7696,6 +8330,9 @@ components: ' type: integer tenant_id: + description: 'The tenant ID. + + ' type: string type: object VffToken: @@ -8320,6 +8957,50 @@ paths: summary: Update Element State (v2.0) tags: - Device Configuration + /v2.0/api/tenants/{tenant_id}/machines/{machine_id}/allocate_to_shell: + post: + description: Allocate the element shell to the machine. + operationId: post-v2.0-api-tenants-tenant_id-machines-machine_id-allocate_to_shell + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The machine ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N5' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N5' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_SHELL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Allocate Element Shell to Machine (v2.0) + tags: + - Device Configuration /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/admin_state: put: description: Update admin state Northbound. @@ -9098,7 +9779,7 @@ paths: - Device Configuration /v2.0/api/tenants/{tenant_id}/vfflicenses/rquery: post: - description: Query all the Vff licenses for a tenant. + description: Query to get the virtual device(vff) license. operationId: post-v2.0-api-tenants-tenant_id-vfflicenses-rquery parameters: - description: The tenant ID. @@ -9131,7 +9812,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Vff Licenses for Tenant (v2.0) + summary: Query and Get Vff License (v2.0) tags: - Device Configuration /v2.0/api/tenants/{tenant_id}/vfflicenses/tokens/query: @@ -9199,17 +9880,19 @@ paths: - Device Configuration /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}/operations: post: - description: Get details of Vff operations for a tenant. + description: 'List the vff operations. + + ' operationId: post-v2.0-api-tenants-tenant_id-vfflicenses-license_id-operations parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The license ID. + - description: License Id in: path name: license_id required: true @@ -9239,7 +9922,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Details of Vff Operation (v2.0) + summary: Vff Operation (v2.0) tags: - Device Configuration /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}/status: @@ -9443,7 +10126,7 @@ paths: - Device Configuration /v2.0/api/tenants/{tenant_id}/vfflicensesstatus/rquery: post: - description: Query and get Vff license state. + description: Query to get the license state of the virtual device (vff). operationId: post-v2.0-api-tenants-tenant_id-vfflicensesstatus-rquery parameters: - description: The tenant ID. @@ -9476,7 +10159,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Vff License State (v2.0) + summary: Query to Get Vff License State (v2.0) tags: - Device Configuration /v2.0/api/tenants/{tenant_id}/ws/extensions: @@ -9734,49 +10417,6 @@ paths: summary: Update Extensions Configuration (v2.0) tags: - Device Configuration - /v2.1/api/tenants/{tenant_id}/elements/status/query: - post: - description: Query and get element status objects for a tenant - operationId: post-v2.1-api-tenants-tenant_id-elements-status-query - parameters: - - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementStatusQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementStatusQuery' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_STATUS_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query and get element status objects for a tenant (v2.1) - tags: - - Device Configuration /v2.1/api/tenants/{tenant_id}/elements/{element_id}/fips_mode_change_operations: post: description: Change the mode of an element from FIPS to Non-FIPS or vice-versa. @@ -9867,45 +10507,6 @@ paths: summary: Get Software Upgrade Status (v2.1) tags: - Device Configuration - /v2.1/api/tenants/{tenant_id}/elements/{element_id}/status: - get: - description: Get the specific element status for a tenant. - operationId: get-v2.1-api-tenants-tenant_id-elements-element_id-status - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The element ID. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ElementStatusV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_STATUS_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Element Status for Tenant (v2.1) - tags: - - Device Configuration /v2.1/api/tenants/{tenant_id}/machines/{machine_id}/machinesystemstatus: get: description: Get the machine system status for a tenant. @@ -10199,22 +10800,95 @@ paths: name: license_id required: true schema: - description: License Id + description: License Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffLicenseV2' + description: Successful Operation + summary: Get Vff License for Tenant (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/vfflicenses/{license_id}/status: + get: + description: List the status for the Vff license. + operationId: get-v2.1-api-tenants-tenant_id-vfflicenses-license_id-status + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The license ID. + in: path + name: license_id + required: true + schema: + description: License Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffLicenseStateV2' + description: Successful Operation + summary: Get Status for Vff License (v2.1) + tags: + - Device Configuration + /v2.2/api/tenants/{tenant_id}/elements/status/query: + post: + description: Query the element status objects for a tenant. + operationId: post-v2.2-api-tenants-tenant_id-elements-status-query + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementStatusQuery' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VffLicenseV2' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementStatusQuery' + type: array + type: object description: Successful Operation - summary: Get Vff License for Tenant (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_STATUS_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Element Status Objects for Tenant (v2.2) tags: - Device Configuration - /v2.1/api/tenants/{tenant_id}/vfflicenses/{license_id}/status: + /v2.2/api/tenants/{tenant_id}/elements/{element_id}/status: get: - description: List the status for the Vff license. - operationId: get-v2.1-api-tenants-tenant_id-vfflicenses-license_id-status + description: Get the specific element status for a tenant. + operationId: get-v2.2-api-tenants-tenant_id-elements-element_id-status parameters: - description: The tenant ID. in: path @@ -10223,27 +10897,37 @@ paths: schema: description: Tenant Id type: string - - description: The license ID. + - description: The element ID. in: path - name: license_id + name: element_id required: true schema: - description: License Id + description: Element Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VffLicenseStateV2' + $ref: '#/components/schemas/ElementStatusV2N2' description: Successful Operation - summary: Get Status for Vff License (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_STATUS_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Element Status for Tenant (v2.2) tags: - Device Configuration - /v2.2/api/tenants/{tenant_id}/clients/{client_id}/machines: + /v2.3/api/tenants/{tenant_id}/clients/{client_id}/machines: get: description: List all the machines of a tenant. - operationId: get-v2.2-api-tenants-tenant_id-clients-client_id-machines + operationId: get-v2.3-api-tenants-tenant_id-clients-client_id-machines parameters: - description: The tenant ID. in: path @@ -10284,13 +10968,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machines of Tenant (v2.2) + summary: Get Machines of Tenant (v2.3) tags: - Device Configuration - /v2.2/api/tenants/{tenant_id}/clients/{client_id}/machines/query: + /v2.3/api/tenants/{tenant_id}/clients/{client_id}/machines/query: post: description: Query the machines allocated by the MSP to a client tenant. - operationId: post-v2.2-api-tenants-tenant_id-clients-client_id-machines-query + operationId: post-v2.3-api-tenants-tenant_id-clients-client_id-machines-query parameters: - description: The tenant ID. in: path @@ -10336,13 +11020,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Tenant's Client (v2.2) + summary: Query Tenant's Client (v2.3) tags: - Device Configuration - /v2.2/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}: + /v2.3/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}: get: description: Get a specific machine allocated by the MSP to a client tenant. - operationId: get-v2.2-api-tenants-tenant_id-clients-client_id-machines-machine_id + operationId: get-v2.3-api-tenants-tenant_id-clients-client_id-machines-machine_id parameters: - description: The tenant ID. in: path @@ -10370,7 +11054,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N2' + $ref: '#/components/schemas/MachineV2N3' description: Successful Operation '400': content: @@ -10384,14 +11068,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machine of Tenant (v2.2) + summary: Get Machine of Tenant (v2.3) tags: - Device Configuration - /v2.2/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}/reallocate: + /v2.3/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}/reallocate: post: description: Reallocate a specific machine from one client tenant to another, where both client tenants are clients of the same MSP. - operationId: post-v2.2-api-tenants-tenant_id-clients-client_id-machines-machine_id-reallocate + operationId: post-v2.3-api-tenants-tenant_id-clients-client_id-machines-machine_id-reallocate parameters: - description: The tenant ID. in: path @@ -10418,13 +11102,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineInfoV2N2' + $ref: '#/components/schemas/MachineInfoV2N3' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N2' + $ref: '#/components/schemas/MachineV2N3' description: Successful Operation '400': content: @@ -10448,16 +11132,15 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.2) + summary: Update Tenant Machine (v2.3) tags: - Device Configuration - /v2.2/api/tenants/{tenant_id}/elements/status/query: + /v2.3/api/tenants/{tenant_id}/elements/status/query: post: - description: Query the element status objects for a tenant. - operationId: post-v2.2-api-tenants-tenant_id-elements-status-query + description: Query and get element the status objects for a tenant. + operationId: post-v2.3-api-tenants-tenant_id-elements-status-query parameters: - - description: The tenant ID. - in: path + - in: path name: tenant_id required: true schema: @@ -10492,13 +11175,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Element Status Objects for Tenant (v2.2) + summary: Query Element Status Objects for Tenant (v2.3) tags: - Device Configuration - /v2.2/api/tenants/{tenant_id}/elements/{element_id}/status: + /v2.3/api/tenants/{tenant_id}/elements/{element_id}/status: get: - description: Get the specific element status for a tenant. - operationId: get-v2.2-api-tenants-tenant_id-elements-element_id-status + description: Get a specific element status for a tenant. + operationId: get-v2.3-api-tenants-tenant_id-elements-element_id-status parameters: - description: The tenant ID. in: path @@ -10519,7 +11202,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementStatusV2N2' + $ref: '#/components/schemas/ElementStatusV2N3' description: Successful Operation '400': content: @@ -10531,16 +11214,15 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Element Status for Tenant (v2.2) + summary: Get Element Status for Tenant (v2.3) tags: - Device Configuration - /v2.2/api/tenants/{tenant_id}/machines: + /v2.3/api/tenants/{tenant_id}/machines: get: - description: Get all the machines of a tenant. - operationId: get-v2.2-api-tenants-tenant_id-machines + description: Get all machines of a tenant + operationId: get-v2.3-api-tenants-tenant_id-machines parameters: - - description: The tenant ID. - in: path + - in: path name: tenant_id required: true schema: @@ -10556,7 +11238,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/MachineV2N2' + $ref: '#/components/schemas/MachineV2N3' type: array type: object description: Successful Operation @@ -10572,13 +11254,13 @@ paths: description: Bad Request '404': description: Machines not found - summary: Get Machines of Tenant (v2.2) + summary: Get all machines of a tenant (v2.3) tags: - Device Configuration - /v2.2/api/tenants/{tenant_id}/machines/query: + /v2.3/api/tenants/{tenant_id}/machines/query: post: description: Query the machines of a tenant. - operationId: post-v2.2-api-tenants-tenant_id-machines-query + operationId: post-v2.3-api-tenants-tenant_id-machines-query parameters: - description: The tenant ID. in: path @@ -10602,7 +11284,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/MachineQueryFilterV2N2' + $ref: '#/components/schemas/MachineQueryFilterV2N3' type: array type: object description: Successful Operation @@ -10616,13 +11298,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad request - summary: Query Machine of Tenant (v2.2) + summary: Query Machine of Tenant (v2.3) tags: - Device Configuration - /v2.2/api/tenants/{tenant_id}/machines/{machine_id}: + /v2.3/api/tenants/{tenant_id}/machines/{machine_id}: get: description: Get a specific machine of a tenant. - operationId: get-v2.2-api-tenants-tenant_id-machines-machine_id + operationId: get-v2.3-api-tenants-tenant_id-machines-machine_id parameters: - description: The tenant ID. in: path @@ -10643,7 +11325,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N2' + $ref: '#/components/schemas/MachineV2N3' description: Successful Operation '400': content: @@ -10656,13 +11338,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Machine (v2.2) + summary: Get Tenant Machine (v2.3) tags: - Device Configuration - /v2.2/api/tenants/{tenant_id}/machines/{machine_id}/operations: + /v2.3/api/tenants/{tenant_id}/machines/{machine_id}/operations: post: description: Update a specific machine of a tenant using operations. - operationId: post-v2.2-api-tenants-tenant_id-machines-machine_id-operations + operationId: post-v2.3-api-tenants-tenant_id-machines-machine_id-operations parameters: - description: The tenant ID. in: path @@ -10682,13 +11364,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineInfoV2N2' + $ref: '#/components/schemas/MachineInfoV2N3' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N2' + $ref: '#/components/schemas/MachineV2N3' description: Successful Operation '400': content: @@ -10715,13 +11397,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.2) + summary: Update Tenant Machine (v2.3) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/clients/{client_id}/machines: + /v2.5/api/tenants/{tenant_id}/clients/{client_id}/machines: get: - description: List all the machines of a tenant. - operationId: get-v2.3-api-tenants-tenant_id-clients-client_id-machines + description: Get all machines allocated by ESP to a client tenant. + operationId: get-v2.5-api-tenants-tenant_id-clients-client_id-machines parameters: - description: The tenant ID. in: path @@ -10730,7 +11412,7 @@ paths: schema: description: Tenant Id type: string - - description: The client ID. + - description: Tenant ID of the client tenant of ESP. in: path name: client_id required: true @@ -10762,13 +11444,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machines of Tenant (v2.3) + summary: Get Machines Allocated by ESP to Client Tenant (v2.5) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/clients/{client_id}/machines/query: + /v2.5/api/tenants/{tenant_id}/clients/{client_id}/machines/query: post: - description: Query the machines allocated by the MSP to a client tenant. - operationId: post-v2.3-api-tenants-tenant_id-clients-client_id-machines-query + description: Query and get all machines allocated by ESP to a client tenant. + operationId: post-v2.5-api-tenants-tenant_id-clients-client_id-machines-query parameters: - description: The tenant ID. in: path @@ -10777,7 +11459,7 @@ paths: schema: description: Tenant Id type: string - - description: The client ID. + - description: Tenant ID of the client tenant of ESP. in: path name: client_id required: true @@ -10814,13 +11496,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Tenant's Client (v2.3) + summary: Query Machines Allocated by MSP to Client Tenant (v2.5) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}: + /v2.5/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}: get: - description: Get a specific machine allocated by the MSP to a client tenant. - operationId: get-v2.3-api-tenants-tenant_id-clients-client_id-machines-machine_id + description: Get a specific machine allocated by ESP to a client tenant. + operationId: get-v2.5-api-tenants-tenant_id-clients-client_id-machines-machine_id parameters: - description: The tenant ID. in: path @@ -10829,7 +11511,7 @@ paths: schema: description: Tenant Id type: string - - description: The client ID. + - description: Tenant ID of the client tenant of ESP. in: path name: client_id required: true @@ -10848,7 +11530,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/MachineV2N5' description: Successful Operation '400': content: @@ -10862,14 +11544,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machine of Tenant (v2.3) + summary: Get Machine allocated by MSP to a Client Tenant (v2.5) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}/reallocate: + /v2.5/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}/reallocate: post: description: Reallocate a specific machine from one client tenant to another, where both client tenants are clients of the same MSP. - operationId: post-v2.3-api-tenants-tenant_id-clients-client_id-machines-machine_id-reallocate + operationId: post-v2.5-api-tenants-tenant_id-clients-client_id-machines-machine_id-reallocate parameters: - description: The tenant ID. in: path @@ -10902,7 +11584,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/MachineV2N5' description: Successful Operation '400': content: @@ -10926,13 +11608,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.3) + summary: Update Machine from Client of same ESP (v2.5) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/machines: + /v2.5/api/tenants/{tenant_id}/machines: get: description: Get all the machines of a tenant. - operationId: get-v2.3-api-tenants-tenant_id-machines + operationId: get-v2.5-api-tenants-tenant_id-machines parameters: - description: The tenant ID. in: path @@ -10946,12 +11628,13 @@ paths: content: application/json: schema: + $ref: '#/components/schemas/MachineQuery' allOf: - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/MachineV2N5' type: array type: object description: Successful Operation @@ -10962,18 +11645,19 @@ paths: value: _error: - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN schema: $ref: '#/components/schemas/Error' description: Bad Request '404': description: Machines not found - summary: Get Machines of Tenant (v2.3) + summary: Get Machines of Tenant (v2.5) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/machines/query: + /v2.5/api/tenants/{tenant_id}/machines/query: post: description: Query the machines of a tenant. - operationId: post-v2.3-api-tenants-tenant_id-machines-query + operationId: post-v2.5-api-tenants-tenant_id-machines-query parameters: - description: The tenant ID. in: path @@ -10997,7 +11681,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/MachineQueryFilterV2N3' + $ref: '#/components/schemas/MachineQueryFilterV2N5' type: array type: object description: Successful Operation @@ -11011,13 +11695,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad request - summary: Query Machine of Tenant (v2.3) + summary: Query Machine of Tenant (v2.5) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/machines/{machine_id}: + /v2.5/api/tenants/{tenant_id}/machines/{machine_id}: get: description: Get a specific machine of a tenant. - operationId: get-v2.3-api-tenants-tenant_id-machines-machine_id + operationId: get-v2.5-api-tenants-tenant_id-machines-machine_id parameters: - description: The tenant ID. in: path @@ -11038,7 +11722,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/Machine' description: Successful Operation '400': content: @@ -11046,18 +11730,23 @@ paths: example: value: _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: MACHINE_UNKNOWN + - code: INVALID_OPERATION + - code: INVALID_STATE + - code: PLEASE_RETRY_LATER + - code: MACHINE_DISCONNECTED + - code: CLAIM_ALREADY_IN_PROGRESS + - code: NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Machine (v2.3) + summary: Get Tenant Machine (v2.5) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/machines/{machine_id}/operations: + /v2.5/api/tenants/{tenant_id}/machines/{machine_id}/operations: post: description: Update a specific machine of a tenant using operations. - operationId: post-v2.3-api-tenants-tenant_id-machines-machine_id-operations + operationId: post-v2.5-api-tenants-tenant_id-machines-machine_id-operations parameters: - description: The tenant ID. in: path @@ -11083,7 +11772,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/MachineV2N5' description: Successful Operation '400': content: @@ -11110,13 +11799,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.3) + summary: Update Tenant Machine (v2.5) tags: - Device Configuration - /v2.7/api/tenants/{tenant_id}/elements: + /v3.0/api/tenants/{tenant_id}/elements: get: description: Get the element of a tenant. - operationId: get-v2.7-api-tenants-tenant_id-elements + operationId: get-v3.0-api-tenants-tenant_id-elements parameters: - description: The tenant ID. in: path @@ -11135,27 +11824,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementV2N7' + $ref: '#/components/schemas/ElementV3' type: array type: object description: Successful Operation - '404': - content: - application/json: - example: - value: - _error: - - code: NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Not Found - summary: Get Element of Tenant (v2.7) + summary: Get Element of Tenant (v3.0) tags: - Device Configuration - /v2.7/api/tenants/{tenant_id}/elements/query: + /v3.0/api/tenants/{tenant_id}/elements/query: post: description: Query the DB for elements that match the query parameters. - operationId: post-v2.7-api-tenants-tenant_id-elements-query + operationId: post-v3.0-api-tenants-tenant_id-elements-query parameters: - description: The tenant ID. in: path @@ -11180,7 +11859,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementQueryFilterV2N7' + $ref: '#/components/schemas/ElementQueryFilterV3' type: array type: object description: Successful Operation @@ -11194,13 +11873,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Elements (v2.7) + summary: Query DB for Elements (v3.0) tags: - Device Configuration - /v2.7/api/tenants/{tenant_id}/elements/{element_id}: + /v3.0/api/tenants/{tenant_id}/elements/{element_id}: get: description: Get the element of a tenant. - operationId: get-v2.7-api-tenants-tenant_id-elements-element_id + operationId: get-v3.0-api-tenants-tenant_id-elements-element_id parameters: - description: The tenant ID. in: path @@ -11221,24 +11900,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementV2N7' + $ref: '#/components/schemas/ElementV3' description: Successful Operation '404': content: application/json: - example: - value: - _error: - - code: NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Not Found - summary: Get Element of Tenant (v2.7) + description: Element not found + summary: Get Element of Tenant (v3.0) tags: - Device Configuration put: description: Update element for associations. - operationId: put-v2.7-api-tenants-tenant_id-elements-element_id + operationId: put-v3.0-api-tenants-tenant_id-elements-element_id parameters: - description: The tenant ID. in: path @@ -11258,14 +11933,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV2N7' + $ref: '#/components/schemas/ElementScreenV3' description: Update to the element responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV2N7' + $ref: '#/components/schemas/ElementScreenV3' description: Successful Operation '400': content: @@ -11273,21 +11948,73 @@ paths: example: value: _error: - - code: BAD_JSON + - code: NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_NETWORK_POLICYSETSTACK_ID + - code: INVALID_PRIORITY_POLICYSETSTACK_ID + - code: INVALID_NAT_POLICYSETSTACK_ID + - code: INVALID_TAG - code: ELEMENT_NOT_FOUND - - code: ELEMENT_NOT_CLAIMED + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: GENERAL_CONFIG_ERROR + - code: ELEMENT_SITE_STACKED_SECURITY_POLICY_INCOMPATIBLE + - code: INVALID_OPERATION + - code: NO_DEFAULT_CLUSTER_DEFINED - code: SITE_NOT_FOUND + - code: L3_FORWARDING_SUPPORTED_BY_BRANCH_DEVICES + - code: POLICY_REQUIRED + - code: SPOKE_SITE_CLUSTER_ID_INVALID + - code: ELEMENT_CONFIG_INVALID_VALUES + - code: ELEMENT_CLUSTER_UPDATE_NOT_ALLOWED + - code: CLUSTER_ID_NOT_PRESENT + - code: CLUSTER_ID_INVALID + - code: CLUSTER_CAPACITY_FULL + - code: ELEMENT_SOFTWARE_NON_CG_SERVICE_LINK_NOT_SUPPORTED + - code: CLUSTER_ID_NOT_NULL + - code: ELEMENT_NOT_BOUND + - code: FIPS_MODE_PLEASE_RETRY_RECOVER_LATER + - code: ELEMENT_SPOKE_CLUSTER_MEMBER + - code: SITE_WAN_INTERFACE_ID_EXISTS - code: ELEMENT_BOUND_ERROR + - code: INVALID_CLUSTER_ID + - code: CLUSTER_ID_SHOULD_BE_NULL_FOR_SPOKE + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: ELEMENT_CONFIG_POLICY_FOR_HUB_NOT_ALLOWED + - code: ELEMENT_NAT_POLICY_SUPPORT_REQUIRED + - code: ELEMENT_CONFIG_NAT_POLICYSETSTACK_NOT_FOUND + - code: L3_FORWARDING_NOT_SUPPORTED_BY_ELEMENT + - code: ENABLE_L3_LAN_FORWARDING_NOT_ALLOWED + - code: DISABLE_L3_LAN_FORWARDING_NOT_ALLOWED_SECONDARY_IP_PRESENT + - code: DISABLE_L3_LAN_FORWARDING_NOT_ALLOWED_STATIC_ARP_PRESENT + - code: L3_LAN_FORWARDING_DISABLE_NOT_SUPPORTED_WHEN_MULTICAST_ENABLED_ON_INTERFACE + - code: ELEMENT_HA_CONFIG_NOT_SUPPORTED + - code: ELEMENT_INVALID_HA_CONFIG_SITE + - code: ELEMENT_HA_CONFIG_TRACK_WAN_INTERFACES_NOT_SUPPORTED + - code: ELEMENT_INVALID_HA_CONFIG_CLUSTER_ID + - code: ELEMENT_INVALID_HA_CONFIG_EXCEEDS_LIMIT + - code: ELEMENT_INVALID_HA_CONFIG_SOURCE_INTERFACE + - code: ELEMENT_INVALID_HA_CONFIG_SOURCE_INTERFACE_CELLULAR + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_INTERFACES + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_INTERFACE_BYPASSPAIR + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_INTERFACE_CELLULAR + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_WAN_INTERFACES + - code: DUPLICATE_HA_CONFIG_TRACK_WAN_INTERFACES + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_WAN_INTERFACES_BYPASSPAIR_PRIVATE_L2 + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_WAN_INTERFACES_WITHOUT_PORT + - code: ELEMENT_VPN_TO_VPN_FORWARDING_NOT_SUPPORTED + - code: ELEMENT_INVALID_VPN_TO_VPN_FORWARDING_SITE + - code: ADVERTISEMENT_INTERVAL_LOWER_THAN_ONE_SEC_ERR schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Element for Associations (v2.7) + summary: Update Element for Associations (v3.0) tags: - Device Configuration - /v3.0/api/tenants/{tenant_id}/elements: + /v3.1/api/tenants/{tenant_id}/elements: get: description: Get the element of a tenant. - operationId: get-v3.0-api-tenants-tenant_id-elements + operationId: get-v3.1-api-tenants-tenant_id-elements parameters: - description: The tenant ID. in: path @@ -11306,17 +12033,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementV3' + $ref: '#/components/schemas/ElementV3N1' type: array type: object description: Successful Operation - summary: Get Element of Tenant (v3.0) + summary: Get Element of Tenant (v3.1) tags: - Device Configuration - /v3.0/api/tenants/{tenant_id}/elements/query: + /v3.1/api/tenants/{tenant_id}/elements/query: post: description: Query the DB for elements that match the query parameters. - operationId: post-v3.0-api-tenants-tenant_id-elements-query + operationId: post-v3.1-api-tenants-tenant_id-elements-query parameters: - description: The tenant ID. in: path @@ -11341,7 +12068,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementQueryFilterV3' + $ref: '#/components/schemas/ElementQueryFilterV3N1' type: array type: object description: Successful Operation @@ -11355,13 +12082,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Elements (v3.0) + summary: Query DB for Elements (v3.1) tags: - Device Configuration - /v3.0/api/tenants/{tenant_id}/elements/{element_id}: + /v3.1/api/tenants/{tenant_id}/elements/{element_id}: get: description: Get the element of a tenant. - operationId: get-v3.0-api-tenants-tenant_id-elements-element_id + operationId: get-v3.1-api-tenants-tenant_id-elements-element_id parameters: - description: The tenant ID. in: path @@ -11382,7 +12109,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementV3' + $ref: '#/components/schemas/ElementV3N1' description: Successful Operation '404': content: @@ -11390,12 +12117,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Element not found - summary: Get Element of Tenant (v3.0) + summary: Get Element of Tenant (v3.1) tags: - Device Configuration put: description: Update element for associations. - operationId: put-v3.0-api-tenants-tenant_id-elements-element_id + operationId: put-v3.1-api-tenants-tenant_id-elements-element_id parameters: - description: The tenant ID. in: path @@ -11415,14 +12142,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV3' + $ref: '#/components/schemas/ElementScreenV3N1' description: Update to the element responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV3' + $ref: '#/components/schemas/ElementScreenV3N1' description: Successful Operation '400': content: @@ -11489,7 +12216,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Element for Associations (v3.0) + summary: Update Element for Associations (v3.1) tags: - Device Configuration /v3.1/api/tenants/{tenant_id}/machines/rquery: @@ -11562,10 +12289,10 @@ paths: summary: Query MSP Machines across Regions (v3.2) tags: - Device Configuration - /v3.4/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: + /v3.5/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: get: description: Get interface status. - operationId: get-v3.4-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-status + operationId: get-v3.5-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-status parameters: - description: The tenant ID. in: path @@ -11600,15 +12327,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceStateV3N4' + $ref: '#/components/schemas/InterfaceStateV3N5' description: Successful Operation - summary: Get Interface Status (v3.4) + summary: Get Interface Status (v3.5) tags: - Device Configuration - /v3.5/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: + /v3.6/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: get: description: Get interface status. - operationId: get-v3.5-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-status + operationId: get-v3.6-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-status parameters: - description: The tenant ID. in: path @@ -11643,15 +12370,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceStateV3N5' + $ref: '#/components/schemas/InterfaceStateV3N6' description: Successful Operation - summary: Get Interface Status (v3.5) + summary: Get Interface Status (v3.6) tags: - Device Configuration - /v4.14/api/tenants/{tenant_id}/interfaces/query: + /v4.16/api/tenants/{tenant_id}/interfaces/query: post: - description: Query the DB for limit number of interfaces that match query params. - operationId: post-v4.14-api-tenants-tenant_id-interfaces-query + description: Queries the DB for limit number of interfaces that match query + params. + operationId: post-v4.16-api-tenants-tenant_id-interfaces-query parameters: - description: The tenant ID. in: path @@ -11677,13 +12405,13 @@ paths: type: array type: object description: Successful Operation - summary: Query Interfaces (v4.14) + summary: Query all Interfaces (v4.16) tags: - Device Configuration - /v4.14/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: + /v4.16/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all cellular interfaces. - operationId: get-v4.14-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces + description: Get all interfaces. + operationId: get-v4.16-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - description: The tenant ID. in: path @@ -11716,16 +12444,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/InterfaceV4N14' + $ref: '#/components/schemas/InterfaceV4N16' type: array type: object description: Successful Operation - summary: Get Cellular Interfaces (v4.14) + summary: Get all Interfaces (v4.16) tags: - Device Configuration post: description: Create an interface. - operationId: post-v4.14-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces + operationId: post-v4.16-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - description: The tenant ID. in: path @@ -11752,13 +12480,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N14' + $ref: '#/components/schemas/InterfaceScreenV4N16' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N14' + $ref: '#/components/schemas/InterfaceV4N16' description: Successful Operation '400': content: @@ -11799,7 +12527,6 @@ paths: - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT @@ -11813,16 +12540,18 @@ paths: - code: INTERFACE_CONFIG_VLAN_INVALID_MAX_VLAN_COUNT_EXCEEDED - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_UNSUPPORTED_CHARACTERS - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_NOT_ACCESS_WHEN_AUTHMODE_PRESENT + - code: INTERFACE_CONFIG_IPV6_AUTOCONF_NOT_SUPPORTED_ON_DEVICE + - code: INTERFACE_CONFIG_IPV6_DHCP_NOT_SUPPORTED_ON_DEVICE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create an Interface (v4.14) + summary: Create Interface (v4.16) tags: - Device Configuration - /v4.14/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + /v4.16/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: delete: - description: Delete an cellular interface. - operationId: delete-v4.14-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + description: Delete an interface. + operationId: delete-v4.16-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The tenant ID. in: path @@ -11857,7 +12586,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N14' + $ref: '#/components/schemas/InterfaceV4N16' description: Successful Operation '400': content: @@ -11872,12 +12601,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Cellular Interface (v4.14) + summary: Delete Interface (v4.16) tags: - Device Configuration get: - description: Get cellular interface details. - operationId: get-v4.14-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + description: Get an interface. + operationId: get-v4.16-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The tenant ID. in: path @@ -11912,14 +12641,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N14' + $ref: '#/components/schemas/InterfaceV4N16' description: Successful Operation - summary: Get Cellular Interface (v4.14) + summary: Get Interface (v4.16) tags: - Device Configuration put: - description: Update an cellular interface. - operationId: put-v4.14-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + description: Update an interface. + operationId: put-v4.16-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The tenant ID. in: path @@ -11953,13 +12682,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N14' + $ref: '#/components/schemas/InterfaceScreenV4N16' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N14' + $ref: '#/components/schemas/InterfaceV4N16' description: Successful Operation '400': content: @@ -12019,7 +12748,6 @@ paths: - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT @@ -12057,16 +12785,19 @@ paths: - code: INTERFACE_CONFIG_VLAN_INVALID_MAX_VLAN_COUNT_EXCEEDED - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_UNSUPPORTED_CHARACTERS - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_NOT_ACCESS_WHEN_AUTHMODE_PRESENT + - code: INTERFACE_CONFIG_IPV6_AUTOCONF_NOT_SUPPORTED_ON_DEVICE + - code: INTERFACE_CONFIG_IPV6_DHCP_NOT_SUPPORTED_ON_DEVICE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Cellular Interface (v4.14) + summary: Update Interface (v4.16) tags: - Device Configuration - /v4.15/api/tenants/{tenant_id}/interfaces/query: + /v4.17/api/tenants/{tenant_id}/interfaces/query: post: - description: Query the DB for limit number of interfaces that match query params. - operationId: post-v4.15-api-tenants-tenant_id-interfaces-query + description: Queries the DB for limit number of interfaces that match query + params. + operationId: post-v4.17-api-tenants-tenant_id-interfaces-query parameters: - description: The tenant ID. in: path @@ -12092,13 +12823,13 @@ paths: type: array type: object description: Successful Operation - summary: Query Interfaces (v4.15) + summary: Query all Interfaces (v4.17) tags: - Device Configuration - /v4.15/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: + /v4.17/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all cellular interfaces. - operationId: get-v4.15-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces + description: Get all interfaces 4 + operationId: get-v4.17-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - description: The tenant ID. in: path @@ -12131,16 +12862,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/InterfaceV4N15' + $ref: '#/components/schemas/InterfaceV4N17' type: array type: object description: Successful Operation - summary: Get Cellular Interfaces (v4.15) + summary: Get all Interfaces (v4.17) tags: - Device Configuration post: description: Create an interface. - operationId: post-v4.15-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces + operationId: post-v4.17-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - description: The tenant ID. in: path @@ -12167,13 +12898,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N15' + $ref: '#/components/schemas/InterfaceScreenV4N17' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N15' + $ref: '#/components/schemas/InterfaceV4N17' description: Successful Operation '400': content: @@ -12214,7 +12945,6 @@ paths: - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT @@ -12230,16 +12960,18 @@ paths: - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_NOT_ACCESS_WHEN_AUTHMODE_PRESENT - code: INTERFACE_CONFIG_IPV6_AUTOCONF_NOT_SUPPORTED_ON_DEVICE - code: INTERFACE_CONFIG_IPV6_DHCP_NOT_SUPPORTED_ON_DEVICE + - code: INTERFACE_CONFIG_CONTROLLER_INTF_ALREADY_EXISTS + - code: INTERFACE_CONFIG_USED_FOR_CONTROLLER_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create an Interface (v4.15) + summary: Create Interface (v4.17) tags: - Device Configuration - /v4.15/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + /v4.17/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: delete: - description: Delete an cellular interface. - operationId: delete-v4.15-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + description: Delete an interface. + operationId: delete-v4.17-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The tenant ID. in: path @@ -12274,7 +13006,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N15' + $ref: '#/components/schemas/InterfaceV4N17' description: Successful Operation '400': content: @@ -12289,12 +13021,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Cellular Interface (v4.15) + summary: Delete Interface (v4.17) tags: - Device Configuration get: - description: Get cellular interface details. - operationId: get-v4.15-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + description: Get an interface. + operationId: get-v4.17-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The tenant ID. in: path @@ -12329,14 +13061,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N15' + $ref: '#/components/schemas/InterfaceV4N17' description: Successful Operation - summary: Get Cellular Interface (v4.15) + summary: Get Interface (v4.17) tags: - Device Configuration put: - description: Update an cellular interface. - operationId: put-v4.15-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + description: Update an interface. + operationId: put-v4.17-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The tenant ID. in: path @@ -12370,13 +13102,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N15' + $ref: '#/components/schemas/InterfaceScreenV4N17' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N15' + $ref: '#/components/schemas/InterfaceV4N17' description: Successful Operation '400': content: @@ -12436,7 +13168,6 @@ paths: - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT @@ -12476,10 +13207,12 @@ paths: - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_NOT_ACCESS_WHEN_AUTHMODE_PRESENT - code: INTERFACE_CONFIG_IPV6_AUTOCONF_NOT_SUPPORTED_ON_DEVICE - code: INTERFACE_CONFIG_IPV6_DHCP_NOT_SUPPORTED_ON_DEVICE + - code: INTERFACE_CONFIG_CONTROLLER_INTF_ALREADY_EXISTS + - code: INTERFACE_CONFIG_USED_FOR_CONTROLLER_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Cellular Interface (v4.15) + summary: Update Interface (v4.17) tags: - Device Configuration servers: diff --git a/openapi-specs/sdwan/legacy/DeviceSwitchConfiguration.yaml b/openapi-specs/sdwan/legacy/DeviceSwitchConfiguration.yaml index 8090d37c3..fb959720c 100644 --- a/openapi-specs/sdwan/legacy/DeviceSwitchConfiguration.yaml +++ b/openapi-specs/sdwan/legacy/DeviceSwitchConfiguration.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view ClientDetails: properties: aging_timeout: @@ -114,15 +108,6 @@ components: ' type: integer - required: - - stats_start_time_ms - - uptime - - reauth_timeout - - vlan_id - - username - - mac_address - - interface_id - - element_id ElementRadius: properties: description: @@ -306,8 +291,9 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) - NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string required: - tenant_id @@ -456,18 +442,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -754,8 +740,9 @@ components: description: "The STP Mode is RSTP (default). \n" type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) - NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string required: - site_id diff --git a/openapi-specs/sdwan/legacy/EventPolicy.yaml b/openapi-specs/sdwan/legacy/EventPolicy.yaml index 29677b7c7..cebfba6c7 100644 --- a/openapi-specs/sdwan/legacy/EventPolicy.yaml +++ b/openapi-specs/sdwan/legacy/EventPolicy.yaml @@ -1,37 +1,5 @@ components: schemas: - Address: - properties: - city: - description: 'The name of the city. Max size = 100. - - ' - type: string - country: - description: 'The name of the country. Max size = 100. - - ' - type: string - post_code: - description: 'The postal code. Max size = 100. - - ' - type: string - state: - description: 'The name of the state. Max size = 100. - - ' - type: string - street: - description: 'The name of the street. Max size = 100. - - ' - type: string - street2: - description: 'The name of the street. Max size = 100. - - ' - type: string Aggregate: properties: data: @@ -68,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -81,477 +44,289 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view - AnynetLinkQuery: + Error: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of anynet links that match the query - parameters. + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + type: string + message: + type: string + EscalationRule: + properties: + flap_rule: + $ref: '#/components/schemas/FlapRule' + description: 'Resource flaps more than the rate specified during the defined + interval, then a new flap rate exceeded alarm is generated. ' - dest_page: - description: 'The destination page. + standing_rule: + $ref: '#/components/schemas/StandingRule' + description: 'Alarms standing for more than the specified period. ' - format: int32 - type: integer - getDeleted: - description: 'The number anynet links deleted for a time frame. + EventCorrelationPolicyRule: + properties: + description: + description: 'Description of the event correlation policy rules. ' - type: boolean - group_by: - description: Group By - items: - description: Group By - type: string - type: array - id: - description: "List the anynet links by ID. \n" - type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + enabled: + description: 'The enabled event correlation policy rules. ' - format: int64 - type: integer - limit: - description: 'The query limit. + type: boolean + end_time: + description: 'The end date in MM/DD/YYYY HH: mm format of the applied event + policy rule. ' - format: int32 + format: int64 type: integer - next_query: - description: 'The limit. - - ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + escalation_rules: + $ref: '#/components/schemas/EscalationRule' + description: 'The alarms which have their priority escalated based on standing + rule and flap rule. ' + event_codes: + description: "List all the event codes. \n" items: - description: Retrieved Fields + description: Event Codes + enum: + - DEVICEHW_POWER_LOST + - DEVICEHW_INTERFACE_DOWN + - DEVICEHW_INTERFACE_HALFDUPLEX + - DEVICEHW_INTERFACE_ERRORS + - DEVICEHW_DISKUTIL_PARTITIONSPACE + - DEVICEHW_DISKENC_SYSTEM + - DEVICEHW_MEMUTIL_SWAPSPACE + - DEVICESW_GENERAL_PROCESSRESTART + - DEVICESW_GENERAL_PROCESSSTOP + - DEVICESW_CRITICAL_PROCESSRESTART + - DEVICESW_CRITICAL_PROCESSSTOP + - DEVICESW_LICENSE_VERIFICATION_FAILED + - DEVICESW_MONITOR_DISABLED + - DEVICESW_SYSTEM_BOOT + - DEVICESW_TOKEN_VERIFICATION_FAILED + - DEVICESW_IMAGE_UNSUPPORTED + - DEVICESW_DHCPSERVER_RESTART + - DEVICESW_DHCPRELAY_RESTART + - DEVICESW_DHCPSERVER_ERRORS + - DEVICESW_SNMP_AGENT_RESTART + - DEVICESW_SNMP_AGENT_FAILED_TO_START + - DEVICESW_SYSLOGSERVERS_DOWN + - DEVICESW_NTP_NO_SYNC + - DEVICEIF_ADDRESS_DUPLICATE + - DEVICEIF_IPV6_ADDRESS_DUPLICATE + - NETWORK_VPNLINK_DOWN + - NETWORK_VPNPEER_UNAVAILABLE + - NETWORK_VPNPEER_UNREACHABLE + - NETWORK_VPNSS_MISMATCH + - NETWORK_VPNSS_UNAVAILABLE + - NETWORK_VPNBFD_DOWN + - NETWORK_VPNLINKCIPHERS_INCOMPATIBLE + - NETWORK_DIRECTPRIVATE_DOWN + - NETWORK_DIRECTINTERNET_DOWN + - NETWORK_PRIVATEWAN_UNREACHABLE + - NETWORK_PRIVATEWAN_DEGRADED + - PEERING_EDGE_DOWN + - PEERING_CORE_DOWN + - PEERING_BGP_DOWN + - APPLICATION_APP_UNREACHABLE + - APPLICATION_IP_COLLISION + - APPLICATION_UNKNOWNS_HIGH + - APPLICATION_FLOWCTRL_APPUNREACHABLE + - APPLICATION_FLOWCTRL_APPREACHABLE + - APPLICATION_FLOWCTRL_APPWITHINSLA + - APPLICATION_FLOWCTRL_APPOUTSIDESLA + - OPERATOR_SIGNUP_TOKEN_DISABLED + - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED + - SITE_CIRCUIT_ABSENT_FOR_POLICY + - NETWORK_POLICY_RULE_CONFLICT + - PRIORITY_POLICY_RULE_CONFLICT + - APPLICATION_CUSTOM_RULE_CONFLICT + - NETWORK_POLICY_RULE_DROPPED + - PRIORITY_POLICY_RULE_DROPPED + - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN + - SPOKEHA_STATE_UPDATE + - SPOKEHA_MULTIPLE_ACTIVE_DEVICES + - SPOKEHA_CLUSTER_DEGRADED + - SPOKEHA_CLUSTER_DOWN + - NAT_POLICY_LEGACY_ALG_CONFIG_OVERRIDE + - NAT_POLICY_STATIC_NATPOOL_OVERRUN + - DEVICESW_CONNTRACK_FLOWLIMIT_EXCEEDED + - DEVICESW_INITIATED_CONNECTION_ON_EXCLUDED_PATH + - NETWORK_ANYNETLINK_DEGRADED + - NETWORK_ANYNETLINK_DOWN + - CLAIMCERT_RENEWAL_RETRY_LIMIT_EXCEEDED + - CLAIMCERT_RENEWAL_FAILED + - CLAIMCERT_AUTO_RENEWAL_DISABLED + - CLAIMCERT_RENEWALS_TOO_FREQUENT + - FLAP_RATE_EXCEEDED + - DEVICESW_ANALYTICS_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_FLOWS_DISCONNECTED_FROM_CONTROLLER + - APPLICATION_PROBE_DISABLED + - SITE_CONNECTIVITY_DOWN + - NETWORK_STANDARD_VPN_ENDPOINT_DOWN + - SECURITY_POLICY_RULE_INCOMPLETE + - SITE_NETWORK_SERVICE_ABSENT_FOR_POLICY + - DEVICESW_IPFIX_COLLECTORS_DOWN + - SITE_CONNECTIVITY_DEGRADED + - CLAIMCERT_EXPIRY_WARNING + - DEVICE_CELLULAR_ROAMING + - DEVICE_CELLULAR_SIM_REMOVAL + - DEVICE_CELLULAR_SIM_SWITCHOVER + - DEVICE_CELLULAR_SIGNAL_STRENGTH_THRESH + - DEVICE_CELLULAR_INTERNAL_MODEM_ERROR + - DEVICE_CELLULAR_TECH_CHANGE + - DEVICE_CELLULAR_SIM_PIN_ERROR + - DEVICE_CELLULAR_SIM_PUK_NEEDED + - DEVICE_CELLULAR_MODEM_TEMP_HIGH + - DEVICE_CELLULAR_MTU_MISMATCH + - DEVICE_CELLULAR_MODEM_DETECTION_ERROR + - DEVICE_CELLULAR_SIM_SECURITY_ERROR + - DEVICE_CELLULAR_FIRMWARE_NOT_AVAILABLE + - DEVICEHW_ION9000X722FW_OUTOFDATE + - DEVICESW_APPDEF_SIGFILE_MISMATCH + - SECURITY_POLICY_LIMITS_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_LIMIT_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - VION_BANDWIDTH_LIMIT_EXCEEDED + - VION_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - SPN_BANDWIDTH_LIMIT_EXCEEDED + - SPN_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - DEVICE_POE_PORT_POWER_STATUS + - DEVICE_POE_PORT_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_FAULT + - DOT1X_RADIUS_SERVER_UNREACHABLE + - DOT1X_DYNAMIC_VLAN_NOT_CONFIGURED + - DOT1X_CLIENT_AUTH_FAIL + - HUB_CLUSTER_SITE_COUNT_THRESHOLD_EXCEEDED + - DEVICEHW_DISKUTIL_FRUSSD + - DEVICEHW_TEMPERATURE_SENSOR + - USER_ID_DIRECTORY_SYNC_FAILED + - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. + id: + description: 'ID of the event policy set. ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + type: string + name: + description: 'Name of the event policy set. Max 25 characters. ' - format: int64 - type: integer - AnynetLinkQueryFilter: - properties: - admin_up: - description: Admin Up - type: boolean - ep1_site_id: - description: Ep1 Site Id type: string - ep1_site_role: - description: Ep1 Site Role + priority: + description: 'Priority level set for the event policy rule. + + ' enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep1_wan_interface_id: - description: Ep1 Wan Interface Id - type: string - ep2_site_id: - description: Ep2 Site Id + - p1 + - p2 + - p3 + - p4 + - p5 + - none type: string - ep2_site_role: - description: Ep2 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep2_wan_interface_id: - description: Ep2 Wan Interface Id - type: string - events: - description: Events + resource_ids: + description: 'The resource IDs configured for a rule. Max 128 resources + can be configured in a rule. + + ' items: - $ref: '#/components/schemas/AnynetlinkEventState' + description: Resource Ids + type: string type: array - id: - description: Id - type: string - type: - description: Type + resource_type: + description: "The resource on which the event policy rule is applied. \n" enum: - - AUTO - - MANUAL - - AUTO_PRIVATE - - MANUAL_PRIVATE - - AUTO_SASE - type: string - vpn_events: - description: Vpn Events - items: - $ref: '#/components/schemas/VPNEndpointEventState' - type: array - AnynetLinkQueryFilterV2N1: - properties: - admin_up: - description: Admin Up - type: boolean - ep1_site_id: - description: Ep1 Site Id - type: string - ep1_site_role: - description: Ep1 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep1_wan_interface_id: - description: Ep1 Wan Interface Id - type: string - ep2_site_id: - description: Ep2 Site Id - type: string - ep2_site_role: - description: Ep2 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep2_wan_interface_id: - description: Ep2 Wan Interface Id - type: string - events: - description: Events - items: - $ref: '#/components/schemas/AnynetlinkEventStateV2N1' - type: array - id: - description: Id - type: string - type: - description: Type - enum: - - AUTO - - MANUAL - - AUTO_PRIVATE - - MANUAL_PRIVATE - - AUTO_SASE - type: string - vpn_events: - description: Vpn Events - items: - $ref: '#/components/schemas/VPNEndpointEventState' - type: array - AnynetlinkEvent: - properties: - admin_up: - description: Admin Up - type: boolean - ep1_site_id: - description: Ep1 Site Id - type: string - ep1_site_role: - description: Ep1 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep1_wan_interface_id: - description: Ep1 Wan Interface Id - type: string - ep2_site_id: - description: Ep2 Site Id - type: string - ep2_site_role: - description: Ep2 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep2_wan_interface_id: - description: Ep2 Wan Interface Id - type: string - events: - description: Events - items: - $ref: '#/components/schemas/AnynetlinkEventState' - type: array - id: - description: Id - type: string - type: - description: Type - enum: - - AUTO - - MANUAL - - AUTO_PRIVATE - - MANUAL_PRIVATE - - AUTO_SASE - type: string - vpn_events: - description: Vpn Events - items: - $ref: '#/components/schemas/VPNEndpointEventState' - type: array - AnynetlinkEventState: - properties: - error_vpnlinks: - description: Error Vpnlinks - items: - description: Error Vpnlinks - type: string - type: array - event_code: - description: Event Code - type: string - event_id: - description: Event Id - type: string - id: - description: Id - type: string - priority: - description: Priority - format: int32 - type: integer - site_ids: - description: Site Ids - items: - description: Site Ids - type: string - type: array - standing: - description: Standing - type: boolean - suppressed: - description: Suppressed - type: boolean - suppressed_info: - $ref: '#/components/schemas/SuppressedInfo' - description: Suppressed Info - timestamp: - description: Timestamp - format: int64 - type: integer - AnynetlinkEventStateV2N1: - properties: - error_vpnlinks: - description: Error Vpnlinks - items: - description: Error Vpnlinks - type: string - type: array - event_code: - description: Event Code - type: string - event_id: - description: Event Id - type: string - id: - description: Id - type: string - priority: - description: Priority - format: int32 - type: integer - site_ids: - description: Site Ids - items: - description: Site Ids - type: string - type: array - standing: - description: Standing - type: boolean - suppressed: - description: Suppressed - type: boolean - suppressed_info: - $ref: '#/components/schemas/SuppressedInfo' - description: Suppressed Info - timestamp: - description: Timestamp - format: int64 - type: integer - AnynetlinkEventV2N1: - properties: - admin_up: - description: Admin Up - type: boolean - ep1_site_id: - description: Ep1 Site Id - type: string - ep1_site_role: - description: Ep1 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep1_wan_interface_id: - description: Ep1 Wan Interface Id - type: string - ep2_site_id: - description: Ep2 Site Id - type: string - ep2_site_role: - description: Ep2 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep2_wan_interface_id: - description: Ep2 Wan Interface Id - type: string - events: - description: Events - items: - $ref: '#/components/schemas/AnynetlinkEventStateV2N1' - type: array - id: - description: Id - type: string - type: - description: Type - enum: - - AUTO - - MANUAL - - AUTO_PRIVATE - - MANUAL_PRIVATE - - AUTO_SASE - type: string - vpn_events: - description: Vpn Events - items: - $ref: '#/components/schemas/VPNEndpointEventState' - type: array - BaseEventState: - properties: - event_code: - description: "The event code. \n" - type: string - event_id: - description: "The event ID. \n" - type: string - id: - description: Id + - site + - element + - anynetlink + - bgppeer + - interface + - waninterface + - wannetwork + - networkpolicyset + - prioritypolicyset + - natpolicyset + - securitypolicyset + - appdef + - serviceendpoint + - cellular_module + - user_id type: string - priority: - description: "The priority set for the event. \n" - format: int32 - type: integer - standing: - description: 'The standing event. True or False. - - ' - type: boolean - suppressed: - description: 'The events are suppressed. True or False. - - ' - type: boolean - suppressed_info: - $ref: '#/components/schemas/SuppressedInfo' - description: 'The information on the suppressed events. - - ' - timestamp: - description: 'The time stamp of the event. + start_time: + description: 'The start date in MM/DD/YYYY HH: mm format of the event policy + rule applied. ' format: int64 type: integer - ElementEvent: - properties: - events: - description: 'The details of the events occurred. - - ' - items: - $ref: '#/components/schemas/BaseEventState' - type: array - id: - description: 'The element ID. - - ' - type: string - name: - description: 'The name of the element. - - ' - type: string - role: - description: 'The element role. + sub_resource_type: + description: 'The sub-resource type to narrow down the match criteria to + more specific elements. ' enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN + - spoke + - hub + - public + - private type: string - spoke_cluster_status: - description: 'The spoke cluster status. - - ' + suppress: + description: "The sub-resource type to narrow down the match criteria to\ + \ more specific elements.The event policy rule which suppresses or unsuppress\ + \ the alarms on the resources identified by the resource type, sub-resource\ + \ type, or matched event codes during the specified schedule. \ + \ \n" enum: - - init - - active - - backup - - unknown + - 'yes' + - 'no' + - none type: string - ElementQuery: + tags: + description: "A information field that can be added to identify the event\ + \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ + \ are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - priority + - suppress + - name + EventCorrelationPolicyRuleQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of elements that match the query parameters. + description: 'The aggregate number of queried rules. ' dest_page: @@ -561,20 +336,18 @@ components: format: int32 type: integer getDeleted: - description: 'The number of elements deleted for a time frame. + description: 'The number of queried rules deleted for a time frame. ' type: boolean group_by: - description: 'Group the elements for the query. - - ' + description: Group By items: description: Group By type: string type: array id: - description: "List the element by ID. \n" + description: "List the event state by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -594,9 +367,6 @@ components: ' type: object query_params: - description: 'Query using query parameters. - - ' type: object retrieved_fields: description: 'Retrieve information from a field. @@ -612,10 +382,6 @@ components: ' type: boolean sort_params: - description: 'Specify the order in which you want the search criteria to - display. - - ' type: object total_count: description: 'The total number of query parameters. @@ -623,185 +389,7 @@ components: ' format: int64 type: integer - ElementQueryFilter: - properties: - admin_action: - description: "The values of admin actions that can be performed. \n" - enum: - - ALLOCATE - - CLAIM - - BOUND - - UNBOUND - - DECLAIM - - RETURN - - REVOKE - - RETIRE - - STOCK - - UPGRADE - - REMANUFACTURE - - DEFAULT - - INVALID - type: string - allowed_roles: - description: "The allowed roles. \n" - items: - description: Allowed Roles - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - type: array - cluster_insertion_mode: - description: "The cluster insertion mode. \n" - type: string - cluster_member_id: - description: 'The cluster member ID. - - ' - type: string - connected: - description: 'The device is connected. True or False. - - ' - type: boolean - deployment_op: - description: 'The deployment values. - - ' - enum: - - DECLAIM - - UPGRADE - - ABORT_UPGRADE - - DEFAULT - - INVALID - - REBIND - - READY - - IN_SERVICE - - REUNBIND - - RENEW_CIC - - ABORT_CELLULARMODULE_FIRMWARE_UPGRADE - - FIPS_AUTO - - NON_FIPS_AUTO - - FIPS_MANUAL - - NON_FIPS_MANUAL - - GET_MAC_ADDRESS_TABLE - type: string - description: - description: 'The description of the element filter. - - ' - events: - description: 'The details of the events occurred. - - ' - items: - $ref: '#/components/schemas/BaseEventState' - type: array - hw_id: - description: "The hardware ID. \n" - type: string - id: - description: Id - type: string - model_name: - description: "The model name of the device. \n" - type: string - name: - description: 'The name of the device. - - ' - type: string - role: - description: 'The element role. - - ' - enum: - - PA_WE_DC - - PA_WE_BR - - NONE - - PA_CONN - - SPOKE - - HUB - type: string - serial_number: - description: 'The serial number. - - ' - type: string - site_id: - description: 'The site ID. - - ' - type: string - software_version: - description: 'The software version. - - ' - type: string - spoke_cluster_status: - description: 'The spoke cluster status. - - ' - enum: - - init - - active - - backup - - unknown - type: string - state: - description: 'The element state. - - ' - enum: - - ACTIVE_INIT - - ACTIVE_INVENTORY_IN_PROGRESS - - ACTIVE_INVENTORY_OPERATION_FAILED - - ACTIVE_INVENTORY_GET_PENDING - - ACTIVE_INVENTORY_GET_COMPLETE - - ACTIVE_INVENTORY_POST_PENDING - - ACTIVE_INTF_CONFIG_GET_FAILED - - ACTIVE_INTF_STATE_GET_FAILED - - ACTIVE_READY - - ACTIVE_BOUND_IN_PROGRESS - - ACTIVE_UNBOUND_IN_PROGRESS - - ACTIVE_UNBOUND_FROM_SITE_FAILED - - ACTIVE_BOUND_TO_SITE - - ACTIVE_BOUND_TO_SITE_FAILED - - OOS - - ACTIVE_DECLAIM_IN_PROGRESS - type: string - required: - - site_id - Error: - properties: - _error: - items: - $ref: '#/components/schemas/ErrorResponse' - type: array - ErrorResponse: - properties: - code: - type: string - message: - type: string - EscalationRule: - properties: - flap_rule: - $ref: '#/components/schemas/FlapRule' - description: 'Resource flaps more than the rate specified during the defined - interval, then a new flap rate exceeded alarm is generated. - - ' - standing_rule: - $ref: '#/components/schemas/StandingRule' - description: 'Alarms standing for more than the specified period. - - ' - EventCorrelationPolicyRule: + EventCorrelationPolicyRuleQueryFilter: properties: description: description: 'Description of the event correlation policy rules. @@ -878,6 +466,7 @@ components: - APPLICATION_FLOWCTRL_APPOUTSIDESLA - OPERATOR_SIGNUP_TOKEN_DISABLED - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED - SITE_CIRCUIT_ABSENT_FOR_POLICY - NETWORK_POLICY_RULE_CONFLICT @@ -886,6 +475,7 @@ components: - NETWORK_POLICY_RULE_DROPPED - PRIORITY_POLICY_RULE_DROPPED - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN - SPOKEHA_STATE_UPDATE - SPOKEHA_MULTIPLE_ACTIVE_DEVICES - SPOKEHA_CLUSTER_DEGRADED @@ -945,6 +535,16 @@ components: - DEVICEHW_TEMPERATURE_SENSOR - USER_ID_DIRECTORY_SYNC_FAILED - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST type: string type: array id: @@ -955,6 +555,11 @@ components: name: description: 'Name of the event policy set. Max 25 characters. + ' + type: string + policyset_id: + description: 'The ID for the event policy set. + ' type: string priority: @@ -987,6 +592,7 @@ components: - bgppeer - interface - waninterface + - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -1028,7 +634,7 @@ components: tags: description: "A information field that can be added to identify the event\ \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ - \ are allowed. \n" + \ are allowed. \n" items: description: Tags type: string @@ -1037,75 +643,14 @@ components: - priority - suppress - name - EventCorrelationPolicyRuleQuery: + EventCorrelationPolicyRuleQueryFilterV2N1: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queried rules. + dampening_duration: + description: 'Dampening duration cannot be less than 5 minutes. Dampening + for duration cannot be more than 10080 minutes(a week). ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of queried rules deleted for a time frame. - - ' - type: boolean - group_by: - description: Group By - items: - description: Group By - type: string - type: array - id: - description: "List the event state by ID. \n" - type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. - - ' - format: int64 - type: integer - limit: - description: 'The query limit. - - ' - format: int32 - type: integer - next_query: - description: 'The limit. - - ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. - - ' - items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. - - ' - format: int64 type: integer - EventCorrelationPolicyRuleQueryFilter: - properties: description: description: 'Description of the event correlation policy rules. @@ -1181,6 +726,7 @@ components: - APPLICATION_FLOWCTRL_APPOUTSIDESLA - OPERATOR_SIGNUP_TOKEN_DISABLED - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED - SITE_CIRCUIT_ABSENT_FOR_POLICY - NETWORK_POLICY_RULE_CONFLICT @@ -1189,6 +735,7 @@ components: - NETWORK_POLICY_RULE_DROPPED - PRIORITY_POLICY_RULE_DROPPED - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN - SPOKEHA_STATE_UPDATE - SPOKEHA_MULTIPLE_ACTIVE_DEVICES - SPOKEHA_CLUSTER_DEGRADED @@ -1248,6 +795,16 @@ components: - DEVICEHW_TEMPERATURE_SENSOR - USER_ID_DIRECTORY_SYNC_FAILED - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST type: string type: array id: @@ -1295,6 +852,7 @@ components: - bgppeer - interface - waninterface + - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -1334,9 +892,11 @@ components: - none type: string tags: - description: "A information field that can be added to identify the event\ - \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ - \ are allowed. \n" + description: 'A information field that can be added to identify the event + correlation policy rule. Maximum 10 unique tags of length 1024 each are + allowed. + + ' items: description: Tags type: string @@ -1345,6 +905,73 @@ components: - priority - suppress - name + EventCorrelationPolicyRuleQueryV2N1: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of queried rules. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of queried rules deleted for a time frame. + + ' + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the event state by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer EventCorrelationPolicyRuleScreen: properties: description: @@ -1422,6 +1049,7 @@ components: - APPLICATION_FLOWCTRL_APPOUTSIDESLA - OPERATOR_SIGNUP_TOKEN_DISABLED - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED - SITE_CIRCUIT_ABSENT_FOR_POLICY - NETWORK_POLICY_RULE_CONFLICT @@ -1430,6 +1058,7 @@ components: - NETWORK_POLICY_RULE_DROPPED - PRIORITY_POLICY_RULE_DROPPED - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN - SPOKEHA_STATE_UPDATE - SPOKEHA_MULTIPLE_ACTIVE_DEVICES - SPOKEHA_CLUSTER_DEGRADED @@ -1489,6 +1118,16 @@ components: - DEVICEHW_TEMPERATURE_SENSOR - USER_ID_DIRECTORY_SYNC_FAILED - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST type: string type: array id: @@ -1531,6 +1170,7 @@ components: - bgppeer - interface - waninterface + - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -1581,556 +1221,439 @@ components: - priority - suppress - name - EventCorrelationPolicySet: + EventCorrelationPolicyRuleScreenV2N1: properties: - active_policyset: - description: 'Event policy sets set to active. - - ' - type: boolean - clone_from: - description: 'Policy sets cloned from existing policy sets. + dampening_duration: + description: 'Dampening duration cannot be less than 5 minutes. Dampening + for duration cannot be more than 10080 minutes(a week). ' - type: string + type: integer description: - description: 'Description of the event policy set. - - ' - id: - description: 'ID of the event policy set. - - ' - type: string - name: - description: "Name of the event policy set. Max 25 characters. \n" - type: string - policyrule_order: - description: 'The order for the execution of the policy rule. - - ' - items: - description: Policyrule Order - type: string - type: array - severity_priority_mapping: - description: 'Mapping of the priority and severity levels. - - ' - items: - $ref: '#/components/schemas/SeverityPriorityMapping' - type: array - tags: - description: "A information field that can be added to identify the event\ - \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ - \ are allowed. \n" - items: - description: Tags - type: string - type: array - required: - - name - EventCorrelationPolicySetQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queried rules. - - ' - dest_page: - description: 'The destination page. + description: 'Description of the event correlation policy rules. ' - format: int32 - type: integer - getDeleted: - description: 'The number of queried rules deleted for a time frame. + enabled: + description: 'The enabled event correlation policy rules. ' type: boolean - group_by: - description: Group By - items: - description: Group By - type: string - type: array - id: - description: "List the event state by ID. \n" - type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + end_time: + description: 'The end date in MM/DD/YYYY HH: mm format of the applied event + policy rule. ' format: int64 type: integer - limit: - description: 'The query limit. - - ' - format: int32 - type: integer - next_query: - description: 'The limit. - - ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + escalation_rules: + $ref: '#/components/schemas/EscalationRule' + description: 'The alarms which have their priority escalated based on standing + rule and flap rule. ' + event_codes: + description: "List all the event codes. \n" items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. - - ' - format: int64 - type: integer - EventCorrelationPolicySetQueryFilter: - properties: - active_policyset: - description: 'Event policy sets set to active. - - ' - type: boolean - clone_from: - description: 'Policy sets cloned from existing policy sets. - - ' - type: string - description: - description: 'Description of the event policy set. - - ' - id: - description: 'ID of the event policy set. - - ' - type: string - name: - description: "Name of the event policy set. Max 25 characters. \n" - type: string - policyrule_order: - description: 'The order for the execution of the policy rule. - - ' - items: - description: Policyrule Order - type: string - type: array - severity_priority_mapping: - description: 'Mapping of the priority and severity levels. - - ' - items: - $ref: '#/components/schemas/SeverityPriorityMapping' - type: array - tags: - description: "A information field that can be added to identify the event\ - \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ - \ are allowed. \n" - items: - description: Tags - type: string - type: array - required: - - name - EventCorrelationPolicySetScreen: - properties: - active_policyset: - description: 'Event policy sets set to active. - - ' - type: boolean - clone_from: - description: 'Policy sets cloned from existing policy sets. - - ' - type: string - description: - description: 'Description of the event policy set. - - ' - id: - description: 'ID of the event policy set. - - ' - type: string - name: - description: "Name of the event policy set. Max 25 characters. \n" - type: string - policyrule_order: - description: 'The order for the execution of the policy rule. - - ' - items: - description: Policyrule Order - type: string - type: array - severity_priority_mapping: - description: 'Mapping of the priority and severity levels. - - ' - items: - $ref: '#/components/schemas/SeverityPriorityMapping' - type: array - tags: - description: "A information field that can be added to identify the event\ - \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ - \ are allowed. \n" - items: - description: Tags - type: string - type: array - required: - - severity_priority_mapping - - name - FlapRule: - properties: - flap_duration: - description: 'Flap duration cannot be less than 5 minutes and more than - 10080 minutes (a week). - - ' - type: integer - flap_rate: - description: 'Flap count cannot be lower than 2 nor higher than 512. - - ' - type: integer - InterfaceEvent: - properties: - admin_up: - description: 'The interface admin state. - - ' - type: boolean - bound_interfaces: - description: 'The bound interfaces. - - ' - items: - description: Bound Interfaces - type: string - type: array - element_id: - description: 'The element ID. - - ' - type: string - events: - description: 'The details of the events occurred. - - ' - items: - $ref: '#/components/schemas/BaseEventState' - type: array - id: - description: "The interface ID. \n" - type: string - ipv4_addresses: - description: 'The IPv4 addresses configured for the interface. - - ' - items: - description: Ipv4 Addresses - type: string - type: array - name: - description: 'The name of the interface. - - ' - type: string - parent: - description: 'The parent interface. - - ' - type: string - site_wan_interface_ids: - description: 'The site WAN interface IDs. - - ' - items: - description: Site Wan Interface Ids - type: string - type: array - type: - description: 'The interface type. - - ' - enum: - - SERVICE_LINK - - LOOPBACK - - BYPASSPAIR - - SUBINTERFACE - - PPPOE - - PORTCHANNEL - - PORT - - VIRTUAL_INTERFACE - - CELLULAR - type: string - used_for: - description: 'The value of where the interface is used. - - ' - enum: - - NONE - - PUBLIC - - PRIVATE - - LAN - - PRIVATE_L2 - - PRIVATE_WAN - type: string - InterfaceQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of interfaces that match the query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number interfaces deleted for a time frame. - - ' - type: boolean - group_by: - description: Group By - items: - description: Group By - type: string - type: array - id: - description: "List the interfaces by ID. \n" - type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. - - ' - format: int64 - type: integer - limit: - description: 'The query limit. - - ' - format: int32 - type: integer - next_query: - description: 'The limit. - - ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. - - ' - items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. - - ' - format: int64 - type: integer - InterfaceQueryFilter: - properties: - admin_up: - description: 'The interface admin state. - - ' - type: boolean - bound_interfaces: - description: 'The bound interfaces. - - ' - items: - description: Bound Interfaces + description: Event Codes + enum: + - DEVICEHW_POWER_LOST + - DEVICEHW_INTERFACE_DOWN + - DEVICEHW_INTERFACE_HALFDUPLEX + - DEVICEHW_INTERFACE_ERRORS + - DEVICEHW_DISKUTIL_PARTITIONSPACE + - DEVICEHW_DISKENC_SYSTEM + - DEVICEHW_MEMUTIL_SWAPSPACE + - DEVICESW_GENERAL_PROCESSRESTART + - DEVICESW_GENERAL_PROCESSSTOP + - DEVICESW_CRITICAL_PROCESSRESTART + - DEVICESW_CRITICAL_PROCESSSTOP + - DEVICESW_LICENSE_VERIFICATION_FAILED + - DEVICESW_MONITOR_DISABLED + - DEVICESW_SYSTEM_BOOT + - DEVICESW_TOKEN_VERIFICATION_FAILED + - DEVICESW_IMAGE_UNSUPPORTED + - DEVICESW_DHCPSERVER_RESTART + - DEVICESW_DHCPRELAY_RESTART + - DEVICESW_DHCPSERVER_ERRORS + - DEVICESW_SNMP_AGENT_RESTART + - DEVICESW_SNMP_AGENT_FAILED_TO_START + - DEVICESW_SYSLOGSERVERS_DOWN + - DEVICESW_NTP_NO_SYNC + - DEVICEIF_ADDRESS_DUPLICATE + - DEVICEIF_IPV6_ADDRESS_DUPLICATE + - NETWORK_VPNLINK_DOWN + - NETWORK_VPNPEER_UNAVAILABLE + - NETWORK_VPNPEER_UNREACHABLE + - NETWORK_VPNSS_MISMATCH + - NETWORK_VPNSS_UNAVAILABLE + - NETWORK_VPNBFD_DOWN + - NETWORK_VPNLINKCIPHERS_INCOMPATIBLE + - NETWORK_DIRECTPRIVATE_DOWN + - NETWORK_DIRECTINTERNET_DOWN + - NETWORK_PRIVATEWAN_UNREACHABLE + - NETWORK_PRIVATEWAN_DEGRADED + - PEERING_EDGE_DOWN + - PEERING_CORE_DOWN + - PEERING_BGP_DOWN + - APPLICATION_APP_UNREACHABLE + - APPLICATION_IP_COLLISION + - APPLICATION_UNKNOWNS_HIGH + - APPLICATION_FLOWCTRL_APPUNREACHABLE + - APPLICATION_FLOWCTRL_APPREACHABLE + - APPLICATION_FLOWCTRL_APPWITHINSLA + - APPLICATION_FLOWCTRL_APPOUTSIDESLA + - OPERATOR_SIGNUP_TOKEN_DISABLED + - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED + - SITE_CIRCUIT_ABSENT_FOR_POLICY + - NETWORK_POLICY_RULE_CONFLICT + - PRIORITY_POLICY_RULE_CONFLICT + - APPLICATION_CUSTOM_RULE_CONFLICT + - NETWORK_POLICY_RULE_DROPPED + - PRIORITY_POLICY_RULE_DROPPED + - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN + - SPOKEHA_STATE_UPDATE + - SPOKEHA_MULTIPLE_ACTIVE_DEVICES + - SPOKEHA_CLUSTER_DEGRADED + - SPOKEHA_CLUSTER_DOWN + - NAT_POLICY_LEGACY_ALG_CONFIG_OVERRIDE + - NAT_POLICY_STATIC_NATPOOL_OVERRUN + - DEVICESW_CONNTRACK_FLOWLIMIT_EXCEEDED + - DEVICESW_INITIATED_CONNECTION_ON_EXCLUDED_PATH + - NETWORK_ANYNETLINK_DEGRADED + - NETWORK_ANYNETLINK_DOWN + - CLAIMCERT_RENEWAL_RETRY_LIMIT_EXCEEDED + - CLAIMCERT_RENEWAL_FAILED + - CLAIMCERT_AUTO_RENEWAL_DISABLED + - CLAIMCERT_RENEWALS_TOO_FREQUENT + - FLAP_RATE_EXCEEDED + - DEVICESW_ANALYTICS_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_FLOWS_DISCONNECTED_FROM_CONTROLLER + - APPLICATION_PROBE_DISABLED + - SITE_CONNECTIVITY_DOWN + - NETWORK_STANDARD_VPN_ENDPOINT_DOWN + - SECURITY_POLICY_RULE_INCOMPLETE + - SITE_NETWORK_SERVICE_ABSENT_FOR_POLICY + - DEVICESW_IPFIX_COLLECTORS_DOWN + - SITE_CONNECTIVITY_DEGRADED + - CLAIMCERT_EXPIRY_WARNING + - DEVICE_CELLULAR_ROAMING + - DEVICE_CELLULAR_SIM_REMOVAL + - DEVICE_CELLULAR_SIM_SWITCHOVER + - DEVICE_CELLULAR_SIGNAL_STRENGTH_THRESH + - DEVICE_CELLULAR_INTERNAL_MODEM_ERROR + - DEVICE_CELLULAR_TECH_CHANGE + - DEVICE_CELLULAR_SIM_PIN_ERROR + - DEVICE_CELLULAR_SIM_PUK_NEEDED + - DEVICE_CELLULAR_MODEM_TEMP_HIGH + - DEVICE_CELLULAR_MTU_MISMATCH + - DEVICE_CELLULAR_MODEM_DETECTION_ERROR + - DEVICE_CELLULAR_SIM_SECURITY_ERROR + - DEVICE_CELLULAR_FIRMWARE_NOT_AVAILABLE + - DEVICEHW_ION9000X722FW_OUTOFDATE + - DEVICESW_APPDEF_SIGFILE_MISMATCH + - SECURITY_POLICY_LIMITS_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_LIMIT_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - VION_BANDWIDTH_LIMIT_EXCEEDED + - VION_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - SPN_BANDWIDTH_LIMIT_EXCEEDED + - SPN_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - DEVICE_POE_PORT_POWER_STATUS + - DEVICE_POE_PORT_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_FAULT + - DOT1X_RADIUS_SERVER_UNREACHABLE + - DOT1X_DYNAMIC_VLAN_NOT_CONFIGURED + - DOT1X_CLIENT_AUTH_FAIL + - HUB_CLUSTER_SITE_COUNT_THRESHOLD_EXCEEDED + - DEVICEHW_DISKUTIL_FRUSSD + - DEVICEHW_TEMPERATURE_SENSOR + - USER_ID_DIRECTORY_SYNC_FAILED + - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST type: string type: array - element_id: - description: 'The element ID. - - ' - type: string - events: - description: 'The details of the events occurred. - - ' - items: - $ref: '#/components/schemas/BaseEventState' - type: array id: - description: "The interface ID. \n" - type: string - ipv4_addresses: - description: 'The IPv4 addresses configured for the interface. + description: 'ID of the event policy set. ' - items: - description: Ipv4 Addresses - type: string - type: array + type: string name: - description: 'The name of the interface. + description: 'Name of the event policy set. Max 25 characters. ' type: string - parent: - description: 'The parent interface. + priority: + description: 'Priority level set for the event policy rule. ' + enum: + - p1 + - p2 + - p3 + - p4 + - p5 + - none type: string - site_wan_interface_ids: - description: 'The site WAN interface IDs. + resource_ids: + description: 'The resource IDs configured for a rule. Max 128 resources + can be configured in a rule. ' items: - description: Site Wan Interface Ids + description: Resource Ids type: string type: array - type: - description: 'The interface type. - - ' - enum: - - SERVICE_LINK - - LOOPBACK - - BYPASSPAIR - - SUBINTERFACE - - PPPOE - - PORTCHANNEL - - PORT - - VIRTUAL_INTERFACE - - CELLULAR - type: string - used_for: - description: 'The value of where the interface is used. - - ' + resource_type: + description: "The resource on which the event policy rule is applied. \n" enum: - - NONE - - PUBLIC - - PRIVATE - - LAN - - PRIVATE_L2 - - PRIVATE_WAN + - site + - element + - anynetlink + - bgppeer + - interface + - waninterface + - wannetwork + - networkpolicyset + - prioritypolicyset + - natpolicyset + - securitypolicyset + - appdef + - serviceendpoint + - cellular_module + - user_id type: string - ListQueryResponse: - properties: - count: - description: 'The count of the query list. + start_time: + description: 'The start date in MM/DD/YYYY HH: mm format of the event policy + rule applied. ' - format: int32 + format: int64 type: integer - deleted_count: - description: 'The deleted number of queries. + sub_resource_type: + description: 'The sub-resource type to narrow down the match criteria to + more specific elements. ' - format: int64 - type: integer - deleted_ids: - description: 'The deleted query IDs. + enum: + - spoke + - hub + - public + - private + type: string + suppress: + description: "The sub-resource type to narrow down the match criteria to\ + \ more specific elements.The event policy rule which suppresses or unsuppress\ + \ the alarms on the resources identified by the resource type, sub-resource\ + \ type, or matched event codes during the specified schedule. \ + \ \n" + enum: + - 'yes' + - 'no' + - none + type: string + tags: + description: 'A information field that can be added to identify the event + correlation policy rule. Maximum 10 unique tags of length 1024 each are + allowed. ' items: + description: Tags type: string type: array - description: - description: 'Description of the query. Max size = 256. - - ' - id: - description: 'The ID. + required: + - priority + - suppress + - name + EventCorrelationPolicyRuleV2N1: + properties: + dampening_duration: + description: 'Dampening duration cannot be less than 5 minutes. Dampening + for duration cannot be more than 10080 minutes(a week). ' - type: string - next_query: - description: 'Details of the next query. + type: integer + description: + description: 'Description of the event correlation policy rules. ' - type: object - tenant_id: - description: 'The tenant ID. + enabled: + description: 'The enabled event correlation policy rules. ' - type: string - total_count: - description: 'Total number of queries. + type: boolean + end_time: + description: 'The end date in MM/DD/YYYY HH: mm format of the applied event + policy rule. ' format: int64 type: integer - type: object - ListResponse: - properties: - count: - description: 'The number of responses. + escalation_rules: + $ref: '#/components/schemas/EscalationRule' + description: 'The alarms which have their priority escalated based on standing + rule and flap rule. ' - format: int32 - type: integer + event_codes: + description: "List all the event codes. \n" + items: + description: Event Codes + enum: + - DEVICEHW_POWER_LOST + - DEVICEHW_INTERFACE_DOWN + - DEVICEHW_INTERFACE_HALFDUPLEX + - DEVICEHW_INTERFACE_ERRORS + - DEVICEHW_DISKUTIL_PARTITIONSPACE + - DEVICEHW_DISKENC_SYSTEM + - DEVICEHW_MEMUTIL_SWAPSPACE + - DEVICESW_GENERAL_PROCESSRESTART + - DEVICESW_GENERAL_PROCESSSTOP + - DEVICESW_CRITICAL_PROCESSRESTART + - DEVICESW_CRITICAL_PROCESSSTOP + - DEVICESW_LICENSE_VERIFICATION_FAILED + - DEVICESW_MONITOR_DISABLED + - DEVICESW_SYSTEM_BOOT + - DEVICESW_TOKEN_VERIFICATION_FAILED + - DEVICESW_IMAGE_UNSUPPORTED + - DEVICESW_DHCPSERVER_RESTART + - DEVICESW_DHCPRELAY_RESTART + - DEVICESW_DHCPSERVER_ERRORS + - DEVICESW_SNMP_AGENT_RESTART + - DEVICESW_SNMP_AGENT_FAILED_TO_START + - DEVICESW_SYSLOGSERVERS_DOWN + - DEVICESW_NTP_NO_SYNC + - DEVICEIF_ADDRESS_DUPLICATE + - DEVICEIF_IPV6_ADDRESS_DUPLICATE + - NETWORK_VPNLINK_DOWN + - NETWORK_VPNPEER_UNAVAILABLE + - NETWORK_VPNPEER_UNREACHABLE + - NETWORK_VPNSS_MISMATCH + - NETWORK_VPNSS_UNAVAILABLE + - NETWORK_VPNBFD_DOWN + - NETWORK_VPNLINKCIPHERS_INCOMPATIBLE + - NETWORK_DIRECTPRIVATE_DOWN + - NETWORK_DIRECTINTERNET_DOWN + - NETWORK_PRIVATEWAN_UNREACHABLE + - NETWORK_PRIVATEWAN_DEGRADED + - PEERING_EDGE_DOWN + - PEERING_CORE_DOWN + - PEERING_BGP_DOWN + - APPLICATION_APP_UNREACHABLE + - APPLICATION_IP_COLLISION + - APPLICATION_UNKNOWNS_HIGH + - APPLICATION_FLOWCTRL_APPUNREACHABLE + - APPLICATION_FLOWCTRL_APPREACHABLE + - APPLICATION_FLOWCTRL_APPWITHINSLA + - APPLICATION_FLOWCTRL_APPOUTSIDESLA + - OPERATOR_SIGNUP_TOKEN_DISABLED + - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED + - SITE_CIRCUIT_ABSENT_FOR_POLICY + - NETWORK_POLICY_RULE_CONFLICT + - PRIORITY_POLICY_RULE_CONFLICT + - APPLICATION_CUSTOM_RULE_CONFLICT + - NETWORK_POLICY_RULE_DROPPED + - PRIORITY_POLICY_RULE_DROPPED + - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN + - SPOKEHA_STATE_UPDATE + - SPOKEHA_MULTIPLE_ACTIVE_DEVICES + - SPOKEHA_CLUSTER_DEGRADED + - SPOKEHA_CLUSTER_DOWN + - NAT_POLICY_LEGACY_ALG_CONFIG_OVERRIDE + - NAT_POLICY_STATIC_NATPOOL_OVERRUN + - DEVICESW_CONNTRACK_FLOWLIMIT_EXCEEDED + - DEVICESW_INITIATED_CONNECTION_ON_EXCLUDED_PATH + - NETWORK_ANYNETLINK_DEGRADED + - NETWORK_ANYNETLINK_DOWN + - CLAIMCERT_RENEWAL_RETRY_LIMIT_EXCEEDED + - CLAIMCERT_RENEWAL_FAILED + - CLAIMCERT_AUTO_RENEWAL_DISABLED + - CLAIMCERT_RENEWALS_TOO_FREQUENT + - FLAP_RATE_EXCEEDED + - DEVICESW_ANALYTICS_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_FLOWS_DISCONNECTED_FROM_CONTROLLER + - APPLICATION_PROBE_DISABLED + - SITE_CONNECTIVITY_DOWN + - NETWORK_STANDARD_VPN_ENDPOINT_DOWN + - SECURITY_POLICY_RULE_INCOMPLETE + - SITE_NETWORK_SERVICE_ABSENT_FOR_POLICY + - DEVICESW_IPFIX_COLLECTORS_DOWN + - SITE_CONNECTIVITY_DEGRADED + - CLAIMCERT_EXPIRY_WARNING + - DEVICE_CELLULAR_ROAMING + - DEVICE_CELLULAR_SIM_REMOVAL + - DEVICE_CELLULAR_SIM_SWITCHOVER + - DEVICE_CELLULAR_SIGNAL_STRENGTH_THRESH + - DEVICE_CELLULAR_INTERNAL_MODEM_ERROR + - DEVICE_CELLULAR_TECH_CHANGE + - DEVICE_CELLULAR_SIM_PIN_ERROR + - DEVICE_CELLULAR_SIM_PUK_NEEDED + - DEVICE_CELLULAR_MODEM_TEMP_HIGH + - DEVICE_CELLULAR_MTU_MISMATCH + - DEVICE_CELLULAR_MODEM_DETECTION_ERROR + - DEVICE_CELLULAR_SIM_SECURITY_ERROR + - DEVICE_CELLULAR_FIRMWARE_NOT_AVAILABLE + - DEVICEHW_ION9000X722FW_OUTOFDATE + - DEVICESW_APPDEF_SIGFILE_MISMATCH + - SECURITY_POLICY_LIMITS_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_LIMIT_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - VION_BANDWIDTH_LIMIT_EXCEEDED + - VION_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - SPN_BANDWIDTH_LIMIT_EXCEEDED + - SPN_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - DEVICE_POE_PORT_POWER_STATUS + - DEVICE_POE_PORT_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_FAULT + - DOT1X_RADIUS_SERVER_UNREACHABLE + - DOT1X_DYNAMIC_VLAN_NOT_CONFIGURED + - DOT1X_CLIENT_AUTH_FAIL + - HUB_CLUSTER_SITE_COUNT_THRESHOLD_EXCEEDED + - DEVICEHW_DISKUTIL_FRUSSD + - DEVICEHW_TEMPERATURE_SENSOR + - USER_ID_DIRECTORY_SYNC_FAILED + - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST + type: string + type: array id: - description: 'The ID of the response. + description: 'ID of the event policy set. ' type: string - tenant_id: - description: 'The ID of the tenant. + name: + description: 'Name of the event policy set. Max 25 characters. ' type: string - type: object - Location: - properties: - description: - description: 'The decsription of the location. - - ' - latitude: - description: 'The latitude of the location. Max range = 90. - - ' - format: float - type: number - longitude: - description: 'The longitude of the location. Max range = 180. - - ' - format: float - type: number - SeverityPriorityMapping: - properties: priority: - description: 'Priority specified for the rule. Range from Priority 1 (P1), - through Priority 5 (P5). + description: 'Priority level set for the event policy rule. ' enum: @@ -2141,307 +1664,131 @@ components: - p5 - none type: string - severity: - description: 'Severity of the rule. - - ' - enum: - - major - - minor - - critical - type: string - required: - - priority - - severity - SiteEvent: - properties: - address: - $ref: '#/components/schemas/Address' - description: 'The address of the site where the event occurred. - - ' - admin_state: - description: 'The site mode of operation, can be in one of three states: - Active - the site is in Control mode and network policy is applied. Monitor - - the site is in Analytics mode, no network policy is applied. Disabled: - the site is disabled. - - ' - type: string - element_cluster_role: - description: 'This attribute describes the type i.e. SPOKE or HUB. - - ' - type: string - events: - description: 'The details of the events occurred. - - ' - items: - $ref: '#/components/schemas/BaseEventState' - type: array - id: - description: 'The site ID. - - ' - type: string - location: - $ref: '#/components/schemas/Location' - description: 'The geographical cordinates for the site address. - - ' - name: - description: 'The site name (Max size = 128). - - ' - type: string - SiteQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of sites that match the query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number sites deleted for a time frame. + resource_ids: + description: 'The resource IDs configured for a rule. Max 128 resources + can be configured in a rule. ' - type: boolean - group_by: - description: Group By items: - description: Group By + description: Resource Ids type: string type: array - id: - description: "List the sites by ID. \n" + resource_type: + description: "The resource on which the event policy rule is applied. \n" + enum: + - site + - element + - anynetlink + - bgppeer + - interface + - waninterface + - wannetwork + - networkpolicyset + - prioritypolicyset + - natpolicyset + - securitypolicyset + - appdef + - serviceendpoint + - cellular_module + - user_id type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + start_time: + description: 'The start date in MM/DD/YYYY HH: mm format of the event policy + rule applied. ' format: int64 type: integer - limit: - description: 'The query limit. - - ' - format: int32 - type: integer - next_query: - description: 'The limit. + sub_resource_type: + description: 'The sub-resource type to narrow down the match criteria to + more specific elements. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + enum: + - spoke + - hub + - public + - private + type: string + suppress: + description: "The sub-resource type to narrow down the match criteria to\ + \ more specific elements.The event policy rule which suppresses or unsuppress\ + \ the alarms on the resources identified by the resource type, sub-resource\ + \ type, or matched event codes during the specified schedule. \ + \ \n" + enum: + - 'yes' + - 'no' + - none + type: string + tags: + description: 'A information field that can be added to identify the event + correlation policy rule. Maximum 10 unique tags of length 1024 each are + allowed. ' items: - description: Retrieved Fields + description: Tags type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. - - ' - format: int64 - type: integer - SiteQueryFilter: + required: + - priority + - suppress + - name + EventCorrelationPolicySet: properties: - address: - $ref: '#/components/schemas/Address' - description: 'The address of the site. + active_policyset: + description: 'Event policy sets set to active. ' - admin_state: - description: 'The site mode of operation, can be in one of three states: - Active - the site is in Control mode and network policy is applied. Monitor - - the site is in Analytics mode, no network policy is applied. Disabled: - the site is disabled. + type: boolean + clone_from: + description: 'Policy sets cloned from existing policy sets. ' type: string description: - description: 'Description for the site (Max size = 1024). - - ' - element_cluster_role: - description: 'This attribute describes the type i.e. SPOKE or HUB. + description: 'Description of the event policy set. ' - type: string - events: - description: Events - items: - $ref: '#/components/schemas/BaseEventState' - type: array id: - description: 'The ID. + description: 'ID of the event policy set. ' type: string - location: - $ref: '#/components/schemas/Location' - description: 'The geographical cordinates for the site address. - - ' name: - description: 'The site name (Max size = 128). - - ' - type: string - policy_set_id: - description: 'The ID for the Original Network Policy Set. Can be retrieved - using policysets API. - - ' - type: string - security_policyset_id: - description: 'The ID for the Original Security Policy Set. Can be retrieved - using securitypolicysets API. - - ' - type: string - service_binding: - description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps - API. - - ' - type: string - StandingRule: - properties: - priority: - description: 'Priority specified for the standing rule. Range from Priority - 1 (P1), through Priority 5 (P5). - - ' - enum: - - p1 - - p2 - - p3 - - p4 - - p5 - - none + description: "Name of the event policy set. Max 25 characters. \n" type: string - standing_for: - description: 'Standing for duration cannot be less than 5 minutes and more - than 10080 minutes(a week). - - ' - type: integer - required: - - priority - SuppressedInfo: - properties: - root_cause_event_ids: - description: 'The event IDs of the root causes. + policyrule_order: + description: 'The order for the execution of the policy rule. ' items: - description: Root Cause Event Ids + description: Policyrule Order type: string type: array - suppressed_time: - description: 'The suppressed event time. - - ' - format: date - type: string - VPNEndpointEventState: - properties: - al_id: - description: Al Id - type: string - eid: - description: Eid - type: string - event_code: - description: Event Code - type: string - event_id: - description: Event Id - type: string - id: - description: Id - type: string - priority: - description: Priority - format: int32 - type: integer - site_id: - description: Site Id - type: string - standing: - description: Standing - type: boolean - suppressed: - description: Suppressed - type: boolean - suppressed_info: - $ref: '#/components/schemas/SuppressedInfo' - description: Suppressed Info - timestamp: - description: Timestamp - format: int64 - type: integer - vep_id: - description: Vep Id - type: string - vpnlink_id: - description: Vpnlink Id - type: string - WANInterfaceEvent: - properties: - events: - description: 'The details of the WAN events occurred. + severity_priority_mapping: + description: 'Mapping of the priority and severity levels. ' items: - $ref: '#/components/schemas/BaseEventState' + $ref: '#/components/schemas/SeverityPriorityMapping' type: array - id: - description: 'The WAN interface ID. - - ' - type: string - name: - description: 'The name of the WAN interface. - - ' - type: string - network_id: - description: 'The network ID. - - ' - type: string - type: - description: "The WAN interface type. \n" - enum: - - PUBLIC_WAN - - PRIVATE_WAN - type: string - WANInterfaceQuery: + tags: + description: "A information field that can be added to identify the event\ + \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ + \ are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + EventCorrelationPolicySetQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of WAN interfaces that match the query - parameters. + description: 'The aggregate number of queried rules. ' dest_page: @@ -2451,7 +1798,7 @@ components: format: int32 type: integer getDeleted: - description: 'The number WAN interfaces deleted for a time frame. + description: 'The number of queried rules deleted for a time frame. ' type: boolean @@ -2462,7 +1809,7 @@ components: type: string type: array id: - description: "List the WAN interfaces by ID. \n" + description: "List the event state by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -2504,161 +1851,242 @@ components: ' format: int64 type: integer - WANInterfaceQueryFilter: + EventCorrelationPolicySetQueryFilter: properties: - events: - description: 'The details of the WAN events occurred. + active_policyset: + description: 'Event policy sets set to active. + + ' + type: boolean + clone_from: + description: 'Policy sets cloned from existing policy sets. + + ' + type: string + description: + description: 'Description of the event policy set. + + ' + id: + description: 'ID of the event policy set. + + ' + type: string + name: + description: "Name of the event policy set. Max 25 characters. \n" + type: string + policyrule_order: + description: 'The order for the execution of the policy rule. + + ' + items: + description: Policyrule Order + type: string + type: array + severity_priority_mapping: + description: 'Mapping of the priority and severity levels. ' items: - $ref: '#/components/schemas/BaseEventState' + $ref: '#/components/schemas/SeverityPriorityMapping' + type: array + tags: + description: "A information field that can be added to identify the event\ + \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ + \ are allowed. \n" + items: + description: Tags + type: string type: array + required: + - name + EventCorrelationPolicySetScreen: + properties: + active_policyset: + description: 'Event policy sets set to active. + + ' + type: boolean + clone_from: + description: 'Policy sets cloned from existing policy sets. + + ' + type: string + description: + description: 'Description of the event policy set. + + ' id: - description: 'The WAN interface ID. + description: 'ID of the event policy set. ' type: string name: - description: 'The name of the WAN interface. + description: "Name of the event policy set. Max 25 characters. \n" + type: string + policyrule_order: + description: 'The order for the execution of the policy rule. ' - type: string - network_id: - description: 'The network ID. + items: + description: Policyrule Order + type: string + type: array + severity_priority_mapping: + description: 'Mapping of the priority and severity levels. + + ' + items: + $ref: '#/components/schemas/SeverityPriorityMapping' + type: array + tags: + description: "A information field that can be added to identify the event\ + \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ + \ are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - severity_priority_mapping + - name + FlapRule: + properties: + flap_duration: + description: 'Flap duration cannot be less than 5 minutes and more than + 10080 minutes (a week). + + ' + type: integer + flap_rate: + description: 'Flap count cannot be lower than 2 nor higher than 512. + + ' + type: integer + ListQueryResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + deleted_count: + description: 'The deleted number. + + ' + format: int64 + type: integer + deleted_ids: + description: 'The deleted IDs. + + ' + items: + type: string + type: array + description: + description: 'Description of the query. Max size = 256. + + ' + id: + description: 'The ID. ' type: string - type: - description: "The WAN interface type. \n" - enum: - - PUBLIC_WAN - - PRIVATE_WAN + next_query: + description: 'Details of the next query. + + ' + type: object + tenant_id: + description: 'The tenant ID. + + ' type: string -info: - contact: {} - description: List of APIs used to manage the event policy rules that inlcude managing - of event correlation policy rules and sets and querying of the rules and sets. - title: Event Policy - version: Latest -openapi: 3.0.0 -paths: - /v2.0/api/tenants/{tenant_id}/anynetlinks/correlationevents/query: - post: - description: Query all the anynet link correlation events. - operationId: post-v2.0-api-tenants-tenant_id-anynetlinks-correlationevents-query - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id + total_count: + description: 'Total number. + + ' + format: int64 + type: integer + type: object + ListResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + id: + description: 'The ID. + + ' type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AnynetLinkQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/AnynetLinkQueryFilter' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Anynet Link Correlation Events (v2.0) - tags: - - Event Policy - /v2.0/api/tenants/{tenant_id}/anynetlinks/{anynetlink_id}/correlationevents: - get: - description: List all the anynet link correlation events. - operationId: get-v2.0-api-tenants-tenant_id-anynetlinks-anynetlink_id-correlationevents - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id + tenant_id: + description: 'The tenant ID. + + ' type: string - - description: The anynetlink ID. - in: path - name: anynetlink_id - required: true - schema: - description: Anynetlink Id + type: object + SeverityPriorityMapping: + properties: + priority: + description: 'Priority specified for the rule. Range from Priority 1 (P1), + through Priority 5 (P5). + + ' + enum: + - p1 + - p2 + - p3 + - p4 + - p5 + - none type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AnynetlinkEvent' - description: Successful Operation - summary: Get Anynet Link Correlation Events (v2.0) - tags: - - Event Policy - /v2.0/api/tenants/{tenant_id}/elements/correlationevents/query: - post: - description: Query all the element correlation events. - operationId: post-v2.0-api-tenants-tenant_id-elements-correlationevents-query - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id + severity: + description: 'Severity of the rule. + + ' + enum: + - major + - minor + - critical type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementQueryFilter' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Element Correlation Events (v2.0) - tags: - - Event Policy + required: + - priority + - severity + StandingRule: + properties: + priority: + description: 'Priority specified for the standing rule. Range from Priority + 1 (P1), through Priority 5 (P5). + + ' + enum: + - p1 + - p2 + - p3 + - p4 + - p5 + - none + type: string + standing_for: + description: 'Standing for duration cannot be less than 5 minutes and more + than 10080 minutes(a week). + + ' + type: integer + required: + - priority +info: + contact: {} + description: List of APIs used to manage the event policy rules that inlcude managing + of event correlation policy rules and sets and querying of the rules and sets. + title: Event Policy + version: Latest +openapi: 3.0.0 +paths: /v2.0/api/tenants/{tenant_id}/eventcorrelationpolicyrules/query: post: description: Queries the DB for limit number of event correlation policy rules @@ -3161,12 +2589,13 @@ paths: summary: Update Event Correlation Policy Rule Configuration (v2.0) tags: - Event Policy - /v2.0/api/tenants/{tenant_id}/interfaces/correlationevents/query: + /v2.1/api/tenants/{tenant_id}/eventcorrelationpolicyrules/query: post: - description: Query all the interface correlation events. - operationId: post-v2.0-api-tenants-tenant_id-interfaces-correlationevents-query + description: Queries the DB for limit number of event correlation policy rules + that match query parameters. + operationId: post-v2.1-api-tenants-tenant_id-eventcorrelationpolicyrules-query parameters: - - description: The tenant ID. + - description: ID of the tenant. in: path name: tenant_id required: true @@ -3177,7 +2606,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceQuery' + $ref: '#/components/schemas/EventCorrelationPolicyRuleQueryV2N1' + description: Details for Event Correlation Policy Rule responses: '200': content: @@ -3188,7 +2618,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/InterfaceQueryFilter' + $ref: '#/components/schemas/EventCorrelationPolicyRuleQueryFilterV2N1' type: array type: object description: Successful Operation @@ -3202,272 +2632,218 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Interface Correlation Events (v2.0) + summary: Queries DB for Number of Event Correlation Policy Rules (v2.1) tags: - Event Policy - /v2.0/api/tenants/{tenant_id}/sites/correlationevents/query: - post: - description: Query all the site correlation events. - operationId: post-v2.0-api-tenants-tenant_id-sites-correlationevents-query + /v2.1/api/tenants/{tenant_id}/eventcorrelationpolicysets/{policy_set_id}/eventcorrelationpolicyrules: + get: + description: List all the event correlation policy rules. + operationId: get-v2.1-api-tenants-tenant_id-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules parameters: - - description: The tenant ID. + - description: ID of the tenant. in: path name: tenant_id required: true schema: description: Tenant Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteQuery' + - description: ID of the event policy set. + in: path + name: policy_set_id + required: true + schema: + description: Policy Set Id + type: string responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/SiteQueryFilter' + $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Site Correlation Events (v2.0) + summary: Get Event Correlation Policy Rules (v2.1) tags: - Event Policy - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/correlationevents: - get: - description: List all the site correlation events. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-correlationevents + post: + description: Create the event correlation policy rule configuration. + operationId: post-v2.1-api-tenants-tenant_id-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules parameters: - - description: The tenant ID. + - description: ID of the tenant. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: ID of the event policy set. in: path - name: site_id + name: policy_set_id required: true schema: - description: Site Id + description: Policy Set Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EventCorrelationPolicyRuleScreenV2N1' + description: Details of the vent correlation policyrule to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteEvent' + $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' description: Successful Operation - summary: Get Site Correlation Events (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: EVENT_POLICY_INVALID_RESOURCES + - code: EVENT_POLICY_INVALID_PRIORITY + - code: EVENT_POLICY_INVALID_SUPPRESS + - code: EVENT_POLICY_INVALID_RESOURCE_SUB_TYPE + - code: EVENT_POLICY_RULE_MAX_RESOURCE_IDS + - code: EVENT_POLICY_INVALID_RESOURCE_TYPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Event Correlation Policy Rule Configuration (v2.1) tags: - Event Policy - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/correlationevents: - get: - description: List all the events for an element at a site. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-correlationevents + /v2.1/api/tenants/{tenant_id}/eventcorrelationpolicysets/{policy_set_id}/eventcorrelationpolicyrules/{policy_rule_id}: + delete: + description: Delete a specific event correlation policy rule. + operationId: delete-v2.1-api-tenants-tenant_id-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules-policy_rule_id parameters: - - description: The tenant ID. + - description: ID of the tenant. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: ID of the event policy set. in: path - name: site_id + name: policy_set_id required: true schema: - description: Site Id + description: Policy Set Id type: string - - description: The element ID. + - description: ID of the event policy rule. in: path - name: element_id + name: policy_rule_id required: true schema: - description: Element Id + description: Policy Rule Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementEvent' + $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' description: Successful Operation - summary: Get Element Events (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: EVENT_POLICY_INVALID_RESOURCES + - code: EVENT_POLICY_INVALID_PRIORITY + - code: EVENT_POLICY_INVALID_SUPPRESS + - code: EVENT_POLICY_INVALID_RESOURCE_SUB_TYPE + - code: EVENT_POLICY_RULE_MAX_RESOURCE_IDS + - code: EVENT_POLICY_INVALID_RESOURCE_TYPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Specific Event Correlation Policy Rule (v2.1) tags: - Event Policy - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/correlationevents: get: - description: Get Interface correlation events. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-correlationevents + description: List the event correlation policy rule. + operationId: get-v2.1-api-tenants-tenant_id-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules-policy_rule_id parameters: - - description: Tenant Id + - description: ID of the tenant. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: Site Id - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: Element Id + - description: ID of the event policy set. in: path - name: element_id + name: policy_set_id required: true schema: - description: Element Id + description: Policy Set Id type: string - - description: Interface Id + - description: ID of the event policy rule. in: path - name: interface_id + name: policy_rule_id required: true schema: - description: Interface Id + description: Policy Rule Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceEvent' + $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' description: Successful Operation - summary: Get Interface correlation events. (v2.0) + summary: Get Event Correlation Policy Rule (v2.1) tags: - Event Policy - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}/correlationevents: - get: - description: List all the WAN interface correlation events for an element at - a site. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id-correlationevents + put: + description: Update the event correlation policy rule configuration. + operationId: put-v2.1-api-tenants-tenant_id-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules-policy_rule_id parameters: - - description: The tenant ID. + - description: ID of the tenant. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The WAN interface ID. - in: path - name: wan_interface_id - required: true - schema: - description: Wan Interface Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/WANInterfaceEvent' - description: Successful Operation - summary: Get WAN Interface Correlation Events (v2.0) - tags: - - Event Policy - /v2.0/api/tenants/{tenant_id}/waninterfaces/correlationevents/query: - post: - description: Query all the WAN interface correlation events. - operationId: post-v2.0-api-tenants-tenant_id-waninterfaces-correlationevents-query - parameters: - - description: The tenant ID. + - description: ID of the event policy set. in: path - name: tenant_id + name: policy_set_id required: true schema: - description: Tenant Id + description: Policy Set Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/WANInterfaceQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANInterfaceQueryFilter' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query WAN Interface Correlation Events (v2.0) - tags: - - Event Policy - /v2.1/api/tenants/{tenant_id}/anynetlinks/correlationevents/query: - post: - description: Query all the anynet link correlation events. - operationId: post-v2.1-api-tenants-tenant_id-anynetlinks-correlationevents-query - parameters: - - description: The tenant ID. + - description: ID of the event policy rule. in: path - name: tenant_id + name: policy_rule_id required: true schema: - description: Tenant Id + description: Policy Rule Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnynetLinkQuery' + $ref: '#/components/schemas/EventCorrelationPolicyRuleScreenV2N1' + description: Details of the event correlation policyrule to be updated responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/AnynetLinkQueryFilterV2N1' - type: array - type: object + $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' description: Successful Operation '400': content: @@ -3475,40 +2851,17 @@ paths: example: value: _error: - - code: BAD_QUERY_REQUEST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: EVENT_POLICY_INVALID_RESOURCES + - code: EVENT_POLICY_INVALID_PRIORITY + - code: EVENT_POLICY_INVALID_SUPPRESS + - code: EVENT_POLICY_INVALID_RESOURCE_SUB_TYPE + - code: EVENT_POLICY_RULE_MAX_RESOURCE_IDS + - code: EVENT_POLICY_INVALID_RESOURCE_TYPE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Anynet Link Correlation Events (v2.1) - tags: - - Event Policy - /v2.1/api/tenants/{tenant_id}/anynetlinks/{anynetlink_id}/correlationevents: - get: - description: List all the anynet link correlation events. - operationId: get-v2.1-api-tenants-tenant_id-anynetlinks-anynetlink_id-correlationevents - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The anynetlink ID. - in: path - name: anynetlink_id - required: true - schema: - description: Anynetlink Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AnynetlinkEventV2N1' - description: Successful Operation - summary: Get Anynet Link Correlation Events (v2.1) + summary: Update Event Correlation Policy Rule Configuration (v2.1) tags: - Event Policy servers: diff --git a/openapi-specs/sdwan/legacy/Events.yaml b/openapi-specs/sdwan/legacy/Events.yaml new file mode 100644 index 000000000..e7ee4048b --- /dev/null +++ b/openapi-specs/sdwan/legacy/Events.yaml @@ -0,0 +1,1880 @@ +components: + schemas: + Address: + properties: + city: + description: 'The name of the city. Max size = 100. + + ' + type: string + country: + description: 'The name of the country. Max size = 100. + + ' + type: string + post_code: + description: 'The postal code. Max size = 100. + + ' + type: string + state: + description: 'The name of the state. Max size = 100. + + ' + type: string + street: + description: 'The name of the street. Max size = 100. + + ' + type: string + street2: + description: 'The name of the street. Max size = 100. + + ' + type: string + Aggregate: + properties: + data: + description: 'The details of the aggregate data. + + ' + items: + $ref: '#/components/schemas/AggregateData' + type: array + field: + description: Field + type: string + name: + description: 'The name of the query response. + + ' + type: string + operator: + description: Operator + enum: + - max + - count + - min + - avg + - sum + type: string + statistic: + description: 'QoS application aggregate statistics. + + ' + type: string + unit: + description: 'The unit. + + ' + type: string + AggregateData: + properties: + value: + description: 'Value of the aggregate data. + + ' + type: number + view: + description: 'View the aggregate date. + + ' + type: object + AnynetLinkQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of anynet links that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number anynet links deleted for a time frame. + + ' + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the anynet links by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + AnynetLinkQueryFilter: + properties: + admin_up: + description: Admin Up + type: boolean + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_site_role: + description: Ep1 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep1_wan_interface_id: + description: Ep1 Wan Interface Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_site_role: + description: Ep2 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep2_wan_interface_id: + description: Ep2 Wan Interface Id + type: string + events: + description: Events + items: + $ref: '#/components/schemas/AnynetlinkEventState' + type: array + id: + description: Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpn_events: + description: Vpn Events + items: + $ref: '#/components/schemas/VPNEndpointEventState' + type: array + AnynetLinkQueryFilterV2N1: + properties: + admin_up: + description: Admin Up + type: boolean + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_site_role: + description: Ep1 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep1_wan_interface_id: + description: Ep1 Wan Interface Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_site_role: + description: Ep2 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep2_wan_interface_id: + description: Ep2 Wan Interface Id + type: string + events: + description: Events + items: + $ref: '#/components/schemas/AnynetlinkEventStateV2N1' + type: array + id: + description: Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpn_events: + description: Vpn Events + items: + $ref: '#/components/schemas/VPNEndpointEventState' + type: array + AnynetlinkEvent: + properties: + admin_up: + description: Admin Up + type: boolean + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_site_role: + description: Ep1 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep1_wan_interface_id: + description: Ep1 Wan Interface Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_site_role: + description: Ep2 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep2_wan_interface_id: + description: Ep2 Wan Interface Id + type: string + events: + description: Events + items: + $ref: '#/components/schemas/AnynetlinkEventState' + type: array + id: + description: Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpn_events: + description: Vpn Events + items: + $ref: '#/components/schemas/VPNEndpointEventState' + type: array + AnynetlinkEventState: + properties: + error_vpnlinks: + description: Error Vpnlinks + items: + description: Error Vpnlinks + type: string + type: array + event_code: + description: Event Code + type: string + event_id: + description: Event Id + type: string + id: + description: Id + type: string + priority: + description: Priority + format: int32 + type: integer + site_ids: + description: Site Ids + items: + description: Site Ids + type: string + type: array + standing: + description: Standing + type: boolean + suppressed: + description: Suppressed + type: boolean + suppressed_info: + $ref: '#/components/schemas/SuppressedInfo' + description: Suppressed Info + timestamp: + description: Timestamp + format: int64 + type: integer + AnynetlinkEventStateV2N1: + properties: + error_vpnlinks: + description: Error Vpnlinks + items: + description: Error Vpnlinks + type: string + type: array + event_code: + description: Event Code + type: string + event_id: + description: Event Id + type: string + id: + description: Id + type: string + priority: + description: Priority + format: int32 + type: integer + site_ids: + description: Site Ids + items: + description: Site Ids + type: string + type: array + standing: + description: Standing + type: boolean + suppressed: + description: Suppressed + type: boolean + suppressed_info: + $ref: '#/components/schemas/SuppressedInfo' + description: Suppressed Info + timestamp: + description: Timestamp + format: int64 + type: integer + AnynetlinkEventV2N1: + properties: + admin_up: + description: Admin Up + type: boolean + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_site_role: + description: Ep1 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep1_wan_interface_id: + description: Ep1 Wan Interface Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_site_role: + description: Ep2 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep2_wan_interface_id: + description: Ep2 Wan Interface Id + type: string + events: + description: Events + items: + $ref: '#/components/schemas/AnynetlinkEventStateV2N1' + type: array + id: + description: Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpn_events: + description: Vpn Events + items: + $ref: '#/components/schemas/VPNEndpointEventState' + type: array + BaseEventState: + properties: + event_code: + description: "The event code. \n" + type: string + event_id: + description: "The event ID. \n" + type: string + id: + description: Id + type: string + priority: + description: "The priority set for the event. \n" + format: int32 + type: integer + standing: + description: 'The standing event. True or False. + + ' + type: boolean + suppressed: + description: 'The events are suppressed. True or False. + + ' + type: boolean + suppressed_info: + $ref: '#/components/schemas/SuppressedInfo' + description: 'The information on the suppressed events. + + ' + timestamp: + description: 'The time stamp of the event. + + ' + format: int64 + type: integer + ElementEvent: + properties: + events: + description: 'The details of the events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: 'The element ID. + + ' + type: string + name: + description: 'The name of the element. + + ' + type: string + role: + description: 'The element role. + + ' + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + spoke_cluster_status: + description: 'The spoke cluster status. + + ' + enum: + - init + - active + - backup + - unknown + type: string + ElementQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: Aggregate + description: + description: 'The description of the element. + + ' + dest_page: + description: Dest Page + format: int32 + type: integer + getDeleted: + description: GetDeleted + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: Id + type: string + last_query_ts: + description: Last Query Ts + format: int64 + type: integer + limit: + description: Limit + format: int32 + type: integer + next_query: + type: object + query_params: + type: object + retrieved_fields: + description: Retrieved Fields + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: Retrieved Fields Mask + type: boolean + sort_params: + type: object + total_count: + description: Total Count + format: int64 + type: integer + ElementQueryFilter: + properties: + admin_action: + description: "The values of admin actions that can be performed. \n" + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID + type: string + allowed_roles: + description: "The allowed roles. \n" + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + type: array + cluster_insertion_mode: + description: "The element ID. \n" + type: string + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected + type: boolean + deployment_op: + description: Deployment Op + enum: + - DECLAIM + - UPGRADE + - ABORT_UPGRADE + - DEFAULT + - INVALID + - REBIND + - READY + - IN_SERVICE + - REUNBIND + - RENEW_CIC + - ABORT_CELLULARMODULE_FIRMWARE_UPGRADE + - FIPS_AUTO + - NON_FIPS_AUTO + - FIPS_MANUAL + - NON_FIPS_MANUAL + - GET_MAC_ADDRESS_TABLE + type: string + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + events: + description: Events + items: + $ref: '#/components/schemas/BaseEventState' + type: array + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + description: Id + type: string + model_name: + description: "The model name of the device. \n" + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + role: + description: Role + enum: + - PA_WE_DC + - PA_WE_BR + - NONE + - PA_CONN + - SPOKE + - HUB + type: string + serial_number: + description: Serial Number + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + software_version: + description: Software Version + type: string + spoke_cluster_status: + description: Spoke Cluster Status + enum: + - init + - active + - backup + - unknown + type: string + state: + description: State + enum: + - ACTIVE_INIT + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_READY + - ACTIVE_BOUND_IN_PROGRESS + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - OOS + - ACTIVE_DECLAIM_IN_PROGRESS + type: string + required: + - site_id + Error: + properties: + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + type: string + message: + type: string + InterfaceEvent: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + element_id: + description: 'The element ID. + + ' + type: string + events: + description: 'The details of the events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: "The interface ID. \n" + type: string + ipv4_addresses: + description: 'The IPv4 addresses configured for the interface. + + ' + items: + description: Ipv4 Addresses + type: string + type: array + name: + description: 'The name of the interface. + + ' + type: string + parent: + description: 'The parent interface. + + ' + type: string + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + type: + description: 'The interface type. + + ' + enum: + - SERVICE_LINK + - LOOPBACK + - BYPASSPAIR + - SUBINTERFACE + - PPPOE + - PORTCHANNEL + - PORT + - VIRTUAL_INTERFACE + - CELLULAR + type: string + used_for: + description: 'The value of where the interface is used. + + ' + enum: + - NONE + - PUBLIC + - PRIVATE + - LAN + - PRIVATE_L2 + - PRIVATE_WAN + type: string + InterfaceQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of interfaces that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number interfaces deleted for a time frame. + + ' + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the interfaces by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + InterfaceQueryFilter: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + element_id: + description: 'The element ID. + + ' + type: string + events: + description: 'The details of the events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: "The interface ID. \n" + type: string + ipv4_addresses: + description: 'The IPv4 addresses configured for the interface. + + ' + items: + description: Ipv4 Addresses + type: string + type: array + name: + description: 'The name of the interface. + + ' + type: string + parent: + description: 'The parent interface. + + ' + type: string + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + type: + description: 'The interface type. + + ' + enum: + - SERVICE_LINK + - LOOPBACK + - BYPASSPAIR + - SUBINTERFACE + - PPPOE + - PORTCHANNEL + - PORT + - VIRTUAL_INTERFACE + - CELLULAR + type: string + used_for: + description: 'The value of where the interface is used. + + ' + enum: + - NONE + - PUBLIC + - PRIVATE + - LAN + - PRIVATE_L2 + - PRIVATE_WAN + type: string + ListQueryResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + deleted_count: + description: 'The deleted number. + + ' + format: int64 + type: integer + deleted_ids: + description: 'The deleted IDs. + + ' + items: + type: string + type: array + description: + description: 'Description of the query. Max size = 256. + + ' + id: + description: 'The ID. + + ' + type: string + next_query: + description: 'Details of the next query. + + ' + type: object + tenant_id: + description: 'The tenant ID. + + ' + type: string + total_count: + description: 'Total number. + + ' + format: int64 + type: integer + type: object + Location: + properties: + description: + description: 'The decsription of the location. + + ' + latitude: + description: 'The latitude of the location. Max range = 90. + + ' + format: float + type: number + longitude: + description: 'The longitude of the location. Max range = 180. + + ' + format: float + type: number + SiteEvent: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site where the event occurred. + + ' + admin_state: + description: 'The site mode of operation, can be in one of three states: + Active - the site is in Control mode and network policy is applied. Monitor + - the site is in Analytics mode, no network policy is applied. Disabled: + the site is disabled. + + ' + type: string + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. + + ' + type: string + events: + description: 'The details of the events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: 'The site ID. + + ' + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' + name: + description: 'The site name (Max size = 128). + + ' + type: string + SiteQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of sites that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number sites deleted for a time frame. + + ' + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the sites by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + SiteQueryFilter: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. + + ' + admin_state: + description: 'The site mode of operation, can be in one of three states: + Active - the site is in Control mode and network policy is applied. Monitor + - the site is in Analytics mode, no network policy is applied. Disabled: + the site is disabled. + + ' + type: string + description: + description: 'Description for the site (Max size = 1024). + + ' + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. + + ' + type: string + events: + description: Events + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: 'The ID. + + ' + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' + name: + description: 'The site name (Max size = 128). + + ' + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. + + ' + type: string + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. + + ' + type: string + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. + + ' + type: string + SuppressedInfo: + properties: + root_cause_event_ids: + description: 'The event IDs of the root causes. + + ' + items: + description: Root Cause Event Ids + type: string + type: array + suppressed_time: + description: 'The suppressed event time. + + ' + format: date + type: string + VPNEndpointEventState: + properties: + al_id: + description: Al Id + type: string + eid: + description: Eid + type: string + event_code: + description: Event Code + type: string + event_id: + description: Event Id + type: string + id: + description: Id + type: string + priority: + description: Priority + format: int32 + type: integer + site_id: + description: Site Id + type: string + standing: + description: Standing + type: boolean + suppressed: + description: Suppressed + type: boolean + suppressed_info: + $ref: '#/components/schemas/SuppressedInfo' + description: Suppressed Info + timestamp: + description: Timestamp + format: int64 + type: integer + vep_id: + description: Vep Id + type: string + vpnlink_id: + description: Vpnlink Id + type: string + WANInterfaceEvent: + properties: + events: + description: 'The details of the WAN events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: 'The WAN interface ID. + + ' + type: string + name: + description: 'The name of the WAN interface. + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + type: + description: 'The WAN interface type. + + ' + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + WANInterfaceQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of app defs that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number app definitions deleted for a time frame. + + ' + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the app definitions by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + WANInterfaceQueryFilter: + properties: + events: + description: 'The details of the WAN events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: 'The WAN interface ID. + + ' + type: string + name: + description: 'The name of the WAN interface. + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + type: + description: 'The WAN interface type. + + ' + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string +info: + contact: {} + description: List of APIs used to retrieve events, manage the event policy rules + that include managing of event correlation policy rules and sets and querying + of the rules and sets. + title: Events + version: Latest +openapi: 3.0.0 +paths: + /v2.0/api/tenants/{tenant_id}/anynetlinks/correlationevents/query: + post: + description: Query AnynetLink correlation events. + operationId: post-v2.0-api-tenants-tenant_id-anynetlinks-correlationevents-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AnynetLinkQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query AnynetLink Correlation Events (v2.0) + tags: + - Events + /v2.0/api/tenants/{tenant_id}/anynetlinks/{anynetlink_id}/correlationevents: + get: + description: Get anynetlink correlation events. + operationId: get-v2.0-api-tenants-tenant_id-anynetlinks-anynetlink_id-correlationevents + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The anynet link ID. + in: path + name: anynetlink_id + required: true + schema: + description: Anynetlink Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetlinkEvent' + description: Successful Operation + summary: Get AnynetLink Correlation Events (v2.0) + tags: + - Events + /v2.0/api/tenants/{tenant_id}/elements/correlationevents/query: + post: + description: Query element correlation events. + operationId: post-v2.0-api-tenants-tenant_id-elements-correlationevents-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Element Correlation Events (v2.0) + tags: + - Events + /v2.0/api/tenants/{tenant_id}/interfaces/correlationevents/query: + post: + description: Query interface correlation events. + operationId: post-v2.0-api-tenants-tenant_id-interfaces-correlationevents-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Interface Correlation Events (v2.0) + tags: + - Events + /v2.0/api/tenants/{tenant_id}/sites/correlationevents/query: + post: + description: Query site correlation events. + operationId: post-v2.0-api-tenants-tenant_id-sites-correlationevents-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query SIte Correlation Events (v2.0) + tags: + - Events + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/correlationevents: + get: + description: Get site correlation events. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-correlationevents + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteEvent' + description: Successful Operation + summary: Get Site Correlation Events (v2.0) + tags: + - Events + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/correlationevents: + get: + description: Get element events. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-correlationevents + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementEvent' + description: Successful Operation + summary: Get Element Events (v2.0) + tags: + - Events + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/correlationevents: + get: + description: Get interface correlation events. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-correlationevents + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceEvent' + description: Successful Operation + summary: Get Interface Correlation Events (v2.0) + tags: + - Events + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}/correlationevents: + get: + description: Get wan interface correlation events. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id-correlationevents + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The wan interface ID. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceEvent' + description: Successful Operation + summary: Get WAN Interface Correlation Events (v2.0) + tags: + - Events + /v2.0/api/tenants/{tenant_id}/waninterfaces/correlationevents/query: + post: + description: Query WAN interface correlation events. + operationId: post-v2.0-api-tenants-tenant_id-waninterfaces-correlationevents-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query WAN Interface Correlation Events (v2.0) + tags: + - Events + /v2.1/api/tenants/{tenant_id}/anynetlinks/correlationevents/query: + post: + description: Query AnynetLink correlation events. + operationId: post-v2.1-api-tenants-tenant_id-anynetlinks-correlationevents-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AnynetLinkQueryFilterV2N1' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query AnynetLink Correlation Events (v2.1) + tags: + - Events + /v2.1/api/tenants/{tenant_id}/anynetlinks/{anynetlink_id}/correlationevents: + get: + description: Get anynetlink correlation events. + operationId: get-v2.1-api-tenants-tenant_id-anynetlinks-anynetlink_id-correlationevents + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The anynet link ID. + in: path + name: anynetlink_id + required: true + schema: + description: Anynetlink Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetlinkEventV2N1' + description: Successful Operation + summary: Get AnynetLink Correlation Events (v2.1) + tags: + - Events +servers: +- url: https://api.us.cloudgenix.com +tags: +- name: Events diff --git a/openapi-specs/sdwan/legacy/IPFIX.yaml b/openapi-specs/sdwan/legacy/IPFIX.yaml index 3adcf6434..9a5a9b331 100644 --- a/openapi-specs/sdwan/legacy/IPFIX.yaml +++ b/openapi-specs/sdwan/legacy/IPFIX.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,26 +44,25 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string CollectorConfig: properties: @@ -1202,19 +1196,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -1240,7 +1234,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 diff --git a/openapi-specs/sdwan/legacy/IoT.yaml b/openapi-specs/sdwan/legacy/IoT.yaml index 0d9330de7..8eaf72c59 100644 --- a/openapi-specs/sdwan/legacy/IoT.yaml +++ b/openapi-specs/sdwan/legacy/IoT.yaml @@ -1,5 +1,131 @@ components: schemas: + Aggregate: + properties: + data: + description: 'The details of the aggregate data. + + ' + items: + $ref: '#/components/schemas/AggregateData' + type: array + field: + description: Field + type: string + name: + description: 'The name of the query response. + + ' + type: string + operator: + description: Operator + enum: + - max + - count + - min + - avg + - sum + type: string + statistic: + description: 'QoS application aggregate statistics. + + ' + type: string + unit: + description: 'The unit. + + ' + type: string + AggregateData: + properties: + value: + description: 'Value of the aggregate data. + + ' + type: number + view: + description: 'View the aggregate date. + + ' + type: object + BulkDeleteStartNode: + properties: + description: + description: 'The start node description. + + ' + error_message: + description: 'Error message. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + ipv4_address: + description: 'The IPv4 address used as the starting point for network abd + device discovery. + + ' + type: string + name: + description: 'Start node name. + + ' + type: string + scope: + description: 'Subnet scopes. A maximum of eight subnets can be entered per + start node. This limits the discovery to a set of devices within the specified + scope. + + ' + items: + $ref: '#/components/schemas/StartNodeScopeConfig' + type: array + tags: + description: 'A information field that can be added to start nodes. Maximum + 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - ipv4_address + BulkDeviceIdDeleteStartNode: + properties: + id: + description: 'The ID. + + ' + type: string + start_nodes: + description: 'Details of the start nodes. This is the IP address that the + ION device uses as a starting point for network and device discovery. + + ' + items: + $ref: '#/components/schemas/BulkDeleteStartNode' + type: array + BulkResponse: + properties: + count: + description: 'The total number. + + ' + format: int32 + type: integer + id: + description: 'The ID. + + ' + type: string + type: + description: "The type. \n" + type: string DeviceIdConfig: properties: cfg_device_id_enabled: @@ -12,42 +138,983 @@ components: ' type: string - DeviceIdConfigScreen: - properties: - cfg_device_id_enabled: - description: 'The CFG device ID, if enabled. - - ' - type: boolean - id: - description: 'The ID. - - ' + DeviceIdConfigQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: Aggregate + dest_page: + description: Dest Page + format: int32 + type: integer + getDeleted: + description: GetDeleted + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: Id + type: string + last_query_ts: + description: Last Query Ts + format: int64 + type: integer + limit: + description: Limit + format: int32 + type: integer + next_query: + type: object + query_params: + type: object + retrieved_fields: + description: Retrieved Fields + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: Retrieved Fields Mask + type: boolean + sort_params: + type: object + total_count: + description: Total Count + format: int64 + type: integer + DeviceIdConfigScreen: + properties: + cfg_device_id_enabled: + description: 'The CFG device ID, if enabled. + + ' + type: boolean + id: + description: 'The ID. + + ' + type: string + DeviceIdConfigV2N1: + properties: + cfg_device_id_enabled: + description: 'The CFG device ID, if enabled. + + ' + type: boolean + deviceid_profile_id: + description: 'The deviceid profile ID. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + site_id: + description: 'The site ID. + + ' + type: string + required: + - site_id + DeviceIdElementConfig: + properties: + description: + description: "The device id element description. \n" + id: + description: 'The device ID. + + ' + type: string + name: + description: "Device ID element name. \n" + type: string + snmp_discovery_source_interface_id: + description: 'The snmp discovery source interface ID. + + ' + type: string + tags: + description: 'A information field that can be added to device id element. + Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + DeviceIdElementConfigScreen: + properties: + description: + description: "The device id element description. \n" + id: + description: 'The device ID. + + ' + type: string + name: + description: "Device ID element name. \n" + type: string + snmp_discovery_source_interface_id: + description: 'The snmp discovery source interface ID. + + ' + type: string + tags: + description: 'A information field that can be added to device id element. + Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + DeviceIdProfileOperations: + properties: + disabled: + description: 'Disable the device id profile. + + ' + type: boolean + disabled_reason: + description: 'Reason to disable the device id profile. + + ' + type: string + id: + description: 'Device ID. + + ' + type: string + inactive: + description: 'Device id profile (active or inactive). + + ' + type: boolean + inactive_reason: + description: 'Reason for profile to be inactive. + + ' + type: string + name: + description: 'Name of the device ID profile. + + ' + type: string + region: + description: 'Profile region. + + ' + type: string + sites: + description: 'The device ID site. + + ' + items: + $ref: '#/components/schemas/SiteDetails' + type: array + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + type: string + type: + description: 'The device ID profile type. + + ' + type: string + required: + - sites + - tenant_id + DeviceIdStartNode: + properties: + description: + description: 'The device id start node description. + + ' + id: + description: 'The device ID. + + ' + type: string + ipv4_address: + description: 'The IPv4 address used as the starting point for network and + device discovery. + + ' + type: string + name: + description: 'Device ID start node name. + + ' + type: string + scope: + description: 'Subnet scopes. A maximum of eight subnets can be entered per + start node. This limits the discovery to a set of devices within the specified + scope. + + ' + items: + $ref: '#/components/schemas/StartNodeScopeConfig' + type: array + tags: + description: 'A information field that can be added to start nodes. Maximum + 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - ipv4_address + - name + DeviceIdStartNodeQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of queries that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of queries deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the users for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the users by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + description: 'Query using query parameters. + + ' + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + DeviceIdStartNodeScreen: + properties: + description: + description: 'The device id start node description. + + ' + id: + description: 'The device ID. + + ' + type: string + ipv4_address: + description: 'The IPv4 address used as the starting point for network and + device discovery. + + ' + type: string + name: + description: 'Device ID start node name. + + ' + type: string + scope: + description: 'Subnet scopes. A maximum of eight subnets can be entered per + start node. This limits the discovery to a set of devices within the specified + scope. + + ' + items: + $ref: '#/components/schemas/StartNodeScopeConfig' + type: array + tags: + description: "A information field that can be added to start nodes. Maximum\ + \ 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - ipv4_address + - name + Error: + properties: + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + type: string + message: + type: string + ListQueryResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + deleted_count: + description: 'The deleted number. + + ' + format: int64 + type: integer + deleted_ids: + description: 'The deleted IDs. + + ' + items: + type: string + type: array + description: + description: 'Description of the query. Max size = 256. + + ' + id: + description: 'The ID. + + ' + type: string + next_query: + description: 'Details of the next query. + + ' + type: object + tenant_id: + description: 'The tenant ID. + + ' + type: string + total_count: + description: 'Total number. + + ' + format: int64 + type: integer + type: object + ListResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + id: + description: 'The ID. + + ' + type: string + tenant_id: + description: 'The tenant ID. + + ' + type: string + type: object + SiteDetails: + properties: + site_id: + description: 'The profile site ID. + + ' + type: string + StartNodeScopeConfig: + properties: + ipv4_prefix: + description: 'The prefix of the IPv4 address. + + ' + type: string +info: + contact: {} + description: List of APIs used to retrieve IoT specific configuration like device + IDs and more. + title: IoT + version: Latest +openapi: 3.0.0 +paths: + /v2.0/api/tenants/{tenant_id}/deviceidconfigs/query: + post: + description: List the device ID profiles. + operationId: post-v2.0-api-tenants-tenant_id-deviceidconfigs-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfigQuery' + description: Details of the Device ID profile to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfigV2N1' + description: Successful Operation + summary: Get Device ID Profiles (v2.0) + tags: + - IoT + /v2.0/api/tenants/{tenant_id}/deviceidprofiles/{deviceid_profile_id}/operations: + post: + description: Associate multiple sites to a profile. + operationId: post-v2.0-api-tenants-tenant_id-deviceidprofiles-deviceid_profile_id-operations + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Device ID of the profile ID. + in: path + name: deviceid_profile_id + required: true + schema: + description: Deviceid Profile Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdProfileOperations' + description: Details of the Device ID profile and sites to be associated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdProfileOperations' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICEID_INVALID_PROFILE_OPERATION + - code: DEVICEID_SITES_MISSING + - code: DEVICEID_DUPLICATE_SITE_DETECTED + - code: DEVICEID_INVALID_DEVICEID_PROFILE + - code: DEVICEID_INVALID_SITE_IDS + - code: DEVICEID_PROFILE_UPDATE_FAILED + - code: DEVICEID_LOCAL_SNMP_DISCOVERY_CANNOT_BE_ENABLE_FOR_DC_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Associate Device ID Profiles in Bulk (v2.0) + tags: + - IoT + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/deviceidconfigs: + get: + description: List all the device ID site configs. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfig' + description: Successful Operation + summary: Get Device ID Site Configs (v2.0) + tags: + - IoT + post: + description: Details of the device ID site config to be created. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfigScreen' + description: Details of the Device ID site config to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfig' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICE_ID_NOT_SUPPORTED_IN_HUB + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Device ID Site Config (v2.0) + tags: + - IoT + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/deviceidconfigs/{config_id}: + get: + description: Get the device ID site configs for a particular config entry. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs-config_id + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The source site config ID. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfig' + description: Successful Operation + summary: Get Device ID Site Config (v2.0) + tags: + - IoT + put: + description: Update the device ID site config. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs-config_id + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The source site config ID. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfigScreen' + description: Details of the Device ID site config to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfig' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICE_ID_NOT_SUPPORTED_IN_HUB + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Device ID Site Config (v2.0) + tags: + - IoT + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/deviceidconfigs/{deviceid_config_id}/bulkdelete_snmpdiscoverystartnodes: + post: + description: Bulk delete device ID of start network node config. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs-deviceid_config_id-bulkdelete_snmpdiscoverystartnodes + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkDeviceIdDeleteStartNode' + description: Details of the Device ID start network node config to be updated + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BulkDeleteStartNode' + type: array + type: object + description: Returns list of deleted start node ids based on query + summary: Bulk Delete Start Network Node Config (v2.0) + tags: + - IoT + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/deviceidconfigs/{deviceid_config_id}/snmpdiscoverystartnodes: + get: + description: Get all Start Network Node config. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs-deviceid_config_id-snmpdiscoverystartnodes + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNode' + description: Successful Operation + summary: Get Start Network Node Config (v2.0) + tags: + - IoT + post: + description: Create Start Network Node config. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs-deviceid_config_id-snmpdiscoverystartnodes + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNodeScreen' + description: Details of the Device ID start network node config to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNode' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICEID_START_NODE_MAX_LIMIT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Start Network Node Config (v2.0) + tags: + - IoT + ? /v2.0/api/tenants/{tenant_id}/sites/{site_id}/deviceidconfigs/{deviceid_config_id}/snmpdiscoverystartnodes/{deviceid_start_node_id} + : delete: + description: Delete Start Network Node config. + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs-deviceid_config_id-snmpdiscoverystartnodes-deviceid_start_node_id + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + - description: The deviceid start node ID. + in: path + name: deviceid_start_node_id + required: true + schema: + description: Deviceid Start Node Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNode' + description: Successful Operation + summary: Delete Start Network Node Config (v2.0) + tags: + - IoT + get: + description: Get Start Network Node config. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs-deviceid_config_id-snmpdiscoverystartnodes-deviceid_start_node_id + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + - description: The deviceid start node ID. + in: path + name: deviceid_start_node_id + required: true + schema: + description: Deviceid Start Node Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNode' + description: Successful Operation + summary: Get Start Network Node Config (v2.0) + tags: + - IoT + put: + description: Update Start Network Node config. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs-deviceid_config_id-snmpdiscoverystartnodes-deviceid_start_node_id + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id type: string - Error: - properties: - _error: - items: - $ref: '#/components/schemas/ErrorResponse' - type: array - ErrorResponse: - properties: - code: + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id type: string - message: + - description: The deviceid start node ID. + in: path + name: deviceid_start_node_id + required: true + schema: + description: Deviceid Start Node Id type: string -info: - contact: {} - description: List of APIs used to retrieve IoT specific configurations. Example; - Device IDs. - title: IoT - version: Latest -openapi: 3.0.0 -paths: - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/deviceidconfigs: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNodeScreen' + description: Details of the Device ID start network node config to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNode' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICEID_START_NODE_MAX_LIMIT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Start Network Node Config (v2.0) + tags: + - IoT + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/deviceidconfigs: get: - description: List all the device ID site configs. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs + description: Get device id element level configs. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-deviceidconfigs parameters: - description: The tenant ID in: path @@ -63,19 +1130,33 @@ paths: schema: description: Site Id type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeviceIdConfig' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/DeviceIdElementConfig' + type: array + type: object description: Successful Operation - summary: Get Device ID Site Configs (v2.0) + summary: Get Device ID Element Level Configs (v2.0) tags: - IoT post: - description: Details of the device ID site config to be created. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs + description: Create device id element level (source interface) config. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-deviceidconfigs parameters: - description: The tenant ID in: path @@ -91,18 +1172,25 @@ paths: schema: description: Site Id type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeviceIdConfigScreen' - description: Details of the Device ID site config to be created + $ref: '#/components/schemas/DeviceIdElementConfigScreen' + description: Details of the Device ID element level config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeviceIdConfig' + $ref: '#/components/schemas/DeviceIdElementConfig' description: Successful Operation '400': content: @@ -110,17 +1198,227 @@ paths: example: value: _error: - - code: DEVICE_ID_NOT_SUPPORTED_IN_HUB + - code: DEVICEID_INVALID_SOURCE_INTERFACE + - code: DEVICEID_INVALID_INTERFACE + - code: DEVICEID_INVALID_INTERFACE_TYPE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Device ID Site Config (v2.0) + summary: Create Device ID Element Level Config (v2.0) tags: - IoT - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/deviceidconfigs/{config_id}: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/deviceidconfigs/{config_id}: get: - description: Get the device ID site configs for a particular config entry. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs-config_id + description: Get element level configs. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-deviceidconfigs-config_id + parameters: + - in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - in: path + name: config_id + required: true + schema: + description: Config Id + type: string + summary: Get Element Config (v2.0) + tags: + - IoT + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/deviceidconfigs/{deviceid_config_id}: + delete: + description: Delete device id element level (source interface) config. + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-deviceidconfigs-deviceid_config_id + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdElementConfig' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICEID_INVALID_SOURCE_INTERFACE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Device ID Element Level Config (v2.0) + tags: + - IoT + put: + description: Update device id element level (source interface) config. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-deviceidconfigs-deviceid_config_id + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdElementConfigScreen' + description: Details of the Device ID element level config to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdElementConfig' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICEID_INVALID_SOURCE_INTERFACE + - code: DEVICEID_INVALID_INTERFACE + - code: DEVICEID_INVALID_INTERFACE_TYPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Device ID Element Level Config (v2.0) + tags: + - IoT + /v2.0/api/tenants/{tenant_id}/snmpdiscoverystartnodes/query: + post: + description: Query Start Network Node based on parameters. + operationId: post-v2.0-api-tenants-tenant_id-snmpdiscoverystartnodes-query + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNodeQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/DeviceIdStartNodeQuery' + type: array + type: object + description: Successful Operation + summary: Query Start Network Node (v2.0) + tags: + - IoT + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/deviceidconfigs: + get: + description: List all the device ID site configs. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-deviceidconfigs + parameters: + - description: The tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfigV2N1' + description: Successful Operation + summary: Get Device ID Site Configs (v2.0) + tags: + - IoT + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/deviceidconfigs/{config_id}: + get: + description: Get device ID for a site for a particular config entry. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-deviceidconfigs-config_id parameters: - description: The tenant ID in: path @@ -148,14 +1446,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeviceIdConfig' + $ref: '#/components/schemas/DeviceIdConfigV2N1' description: Successful Operation summary: Get Device ID Site Config (v2.0) tags: - IoT put: - description: Update the device ID site config. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-deviceidconfigs-config_id + description: Update device ID site config and associate deviceid profile. + operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-deviceidconfigs-config_id parameters: - description: The tenant ID in: path @@ -189,7 +1487,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeviceIdConfig' + $ref: '#/components/schemas/DeviceIdConfigV2N1' description: Successful Operation '400': content: @@ -197,7 +1495,7 @@ paths: example: value: _error: - - code: DEVICE_ID_NOT_SUPPORTED_IN_HUB + - code: DEVICEID_INVALID_PROFILE_ID schema: $ref: '#/components/schemas/Error' description: Bad Request diff --git a/openapi-specs/sdwan/legacy/Metrics.yaml b/openapi-specs/sdwan/legacy/Metrics.yaml index 950d94b43..6ba1d841f 100644 --- a/openapi-specs/sdwan/legacy/Metrics.yaml +++ b/openapi-specs/sdwan/legacy/Metrics.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view AggregateMetric: properties: name: @@ -102,12 +96,13 @@ components: type: string type: array required: - - path + - site + - app AggregateStatsQuery: properties: aggregates: - description: 'The aggregate number of supported app/site stats. Max number - = 10. + description: 'The aggregate number of supported app stats. Max number = + 10. ' items: @@ -115,7 +110,7 @@ components: type: map[string,aggregatestatstypeenum] type: array end_time: - description: 'The end time to get the app/site stats. + description: 'The end time to get the app stats. ' format: date @@ -124,46 +119,39 @@ components: $ref: '#/components/schemas/AggregateStatsFilter' description: "Filters according to the specifications. \n" name: - description: 'The description of the app/site. Maz size = 128. + description: 'The description of the app. Maz size = 128. ' type: string start_time: - description: "The start time to get the app/site statistics. \n" + description: "The start time to get the app statistics. \n" format: date type: string required: - filter - aggregates - - start_time - - name - - end_time AggregateStatsResponse: properties: aggregates: - description: 'The aggregate number of supported app/site stats. Max number - = 10. + description: 'The aggregate number of supported app stats. Max number = + 10. ' items: type: object type: array end_time: - description: 'The end time to get the app/site stats. + description: 'The end time to get the app stats. ' format: date type: string start_time: - description: 'The start time to get the app/site statistics. + description: 'The start time to get the app statistics. ' format: date type: string - required: - - aggregates - - end_time - - start_time AggregatesQueryResponse: properties: aggregates: @@ -173,30 +161,21 @@ components: items: $ref: '#/components/schemas/Aggregate' type: array - required: - - aggregates AppObjectStatsResponse: properties: data: - description: "The details of the app object stats. \n" + description: Data items: type: object type: array end_time: - description: 'The end time to get the app object stats. - - ' format: date type: string filter: $ref: '#/components/schemas/AppStatsFilter' - description: 'Filters according to the specifications. - - ' + description: Filter object_type: - description: 'The object type. - - ' + description: Object Type enum: - PeerStatistics - IntfStatistics @@ -214,17 +193,8 @@ components: - AppSummaryStats type: string start_time: - description: 'The start time to get the app object stats. - - ' format: date type: string - required: - - filter - - data - - object_type - - end_time - - start_time AppStatsAggregate: properties: name: @@ -242,7 +212,6 @@ components: description: Unit type: string required: - - unit - name AppStatsAggregateData: properties: @@ -273,12 +242,6 @@ components: unit: description: Unit type: string - required: - - unit - - name - - start_time - - end_time - - data AppStatsAggregateFilter: properties: app: @@ -340,10 +303,6 @@ components: start_time: description: "The start time to get the app statistics. \n" type: string - required: - - end_time - - start_time - - aggregates AppStatsAggregatesQuery: properties: aggregates: @@ -375,20 +334,12 @@ components: format: date type: string required: - - filter - aggregates - - start_time - - name - - end_time AppStatsFilter: properties: health_score: - description: 'Filter by health score. - - ' + description: Health Score type: map[appstatsoperatortype,string] - required: - - health_score AppStatsSupportedAggregate: properties: description: @@ -408,10 +359,6 @@ components: description: Units type: string type: array - required: - - units - - name - - description AppStatsSupportedAggregatesResponse: properties: aggregates: @@ -419,8 +366,6 @@ components: items: $ref: '#/components/schemas/AppStatsSupportedAggregate' type: array - required: - - aggregates AppStatsTopNFilter: properties: app: @@ -527,12 +472,8 @@ components: - egress_audio_mos type: string required: - - filter - topn_basis - top_n - - start_time - - name - - end_time AppStatsTopNResponse: properties: top_n: @@ -540,8 +481,6 @@ components: description: 'The details of the Top N reports. ' - required: - - top_n AppStatsTopNResponseData: properties: end_time: @@ -598,13 +537,6 @@ components: - app - site type: string - required: - - topn_basis - - type - - items - - start_time - - limit - - end_time AppStatsTopNView: properties: limit: @@ -620,7 +552,6 @@ components: type: string required: - type - - limit ApplicationQosAggregatesQuery: properties: aggregates: @@ -656,11 +587,7 @@ components: description: "View the QoS metric details. \n" required: - filter - - view - aggregates - - start_time - - name - - end_time ApplicationQosMetricsFilter: properties: application_name: @@ -693,18 +620,12 @@ components: type: string type: array user: - description: 'Filter by user. - - ' + description: "Filter by user. \n" items: description: User type: string type: array required: - - direction - - email - - site - - user - application_name ApplicationQosMetricsQuery: properties: @@ -724,11 +645,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max datapoints of the application QoS metrics. @@ -749,34 +670,26 @@ components: ' type: string start_time: - description: 'The start time to get the application QoS metrics. - - ' + description: "The start time to get the application QoS metrics. \ + \ \n" format: date type: string view: $ref: '#/components/schemas/View' - description: 'View the application QoS metrics. - - ' + description: View required: - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time ApplicationQosMetricsResponse: properties: metrics: - description: Metrics + description: 'Details of the application metrics. + + ' items: $ref: '#/components/schemas/Metrics' type: array - required: - - metrics ApplicationUserData: properties: client_ip: @@ -795,15 +708,8 @@ components: ' type: string user_name: - description: 'The user name of the application user. - - ' + description: "The user name of the application user. \n" type: string - required: - - client_ip - - site - - user_name - - email ApplicationUsersQuery: properties: application_name: @@ -830,9 +736,6 @@ components: type: string required: - application_name - - start_time - - name - - end_time ApplicationUsersResponse: properties: data: @@ -840,8 +743,6 @@ components: items: $ref: '#/components/schemas/ApplicationUserData' type: array - required: - - data BaseTopNQuery: properties: end_time: @@ -879,12 +780,8 @@ components: ' type: string required: - - filter - topn_basis - top_n - - start_time - - name - - end_time BaseTopNResponse: properties: top_n: @@ -892,8 +789,6 @@ components: description: 'The details of the Top N reports. ' - required: - - top_n BaseTopNResponseData: properties: end_time: @@ -931,13 +826,6 @@ components: ' type: string - required: - - topn_basis - - type - - items - - start_time - - limit - - end_time BaseTopNView: properties: limit: @@ -953,7 +841,6 @@ components: type: string required: - type - - limit CapacityPredictionFilter: properties: direction: @@ -980,12 +867,14 @@ components: description: Wn Path type: string type: array - required: - - direction - - wn_path - - site CapacityPredictionQuery: properties: + anomaly: + description: "The number of sites that will reach high capacity utilization\ + \ threshold within the next 28 days. \n" + items: + $ref: '#/components/schemas/Forecast' + type: array end_time: description: 'The end time of the capacity prediction query. End times need to be specified in ISO8601 UTC format. @@ -1016,6 +905,8 @@ components: - CAPACITY_EXCEED_THRESHOLD - ANOMALY - CIRCUIT_CAPACITY_FORECAST + - CIRCUIT_UTILIZATION + - ANOMALY_SITE_CIRCUIT_DETAILS type: string type: array forecast_date: @@ -1045,31 +936,31 @@ components: - SITE - CIRCUIT type: string - required: - - filter - - type - - forecast - - forecast_basis - - forecast_date - - start_time - - name - - end_time CapacityPredictionResponse: properties: + anomaly: + description: "The number of sites that will reach high capacity utilization\ + \ threshold within the next 28 days. \n" + type: object + end_time: + description: "The end time of the capacity prediction query. End times need\ + \ to be specified in ISO8601 UTC format. \n" + format: date + type: string forecast: - description: 'Capacity forecast. - - ' + description: "The details of the forecast. \n" type: object forecast_date: - description: 'Capacity forecast data. + description: "The forecast data. \n" + format: date + type: string + start_time: + description: 'The start time to get the capacity prediction query. Start + times need to be specified in ISO8601 UTC format. ' format: date type: string - required: - - forecast - - forecast_date CellularmetricsFilter: properties: apn: @@ -1121,13 +1012,6 @@ components: description: Site type: string type: array - required: - - carrier - - apn - - cellular_module - - direction - - site - - element CellularmetricsQuery: properties: end_time: @@ -1147,11 +1031,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max data points. @@ -1187,14 +1071,8 @@ components: ' required: - - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time CellularmetricsResponse: properties: metrics: @@ -1202,8 +1080,6 @@ components: items: $ref: '#/components/schemas/Metrics' type: array - required: - - metrics CellularmetricsSchemaResponse: properties: metrics: @@ -1213,8 +1089,6 @@ components: items: $ref: '#/components/schemas/MetricSchema' type: array - required: - - metrics ClientDetails: properties: aging_timeout: @@ -1275,15 +1149,6 @@ components: ' type: integer - required: - - stats_start_time_ms - - uptime - - reauth_timeout - - vlan_id - - username - - mac_address - - interface_id - - element_id Data: properties: datapoints: @@ -1294,9 +1159,6 @@ components: statistics: description: Statistics type: object - required: - - datapoints - - statistics Datapoints: properties: duration: @@ -1316,6 +1178,9 @@ components: description: Links type: string type: array + ninetieth_percentile: + description: Ninetieth Percentile + type: number sites: description: 'The sites. @@ -1329,12 +1194,6 @@ components: ' type: number - required: - - filter_property_id - - sites - - links - - value - - duration Error: properties: _error: @@ -1350,7 +1209,7 @@ components: Filter: properties: elements: - description: 'Filter by element. + description: 'Elements of the filter. ' items: @@ -1358,7 +1217,7 @@ components: type: string type: array path: - description: 'Filter by path. + description: 'Path of the filter. ' items: @@ -1366,152 +1225,20 @@ components: type: string type: array site: - description: 'Filter by site. + description: 'Site of the filter. ' type: object type: - description: 'Filter by type. + description: 'Type of the filter. ' type: string - required: - - path - - site - - elements - FlowDecisionMetadata: - properties: - available_wan_networks: - description: 'Available Wan Networks: JsonAlias(value = [bw_paths]) JsonInclude(content - = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = - classOf[Void]) ' - items: - description: Available Wan Networks - type: string - type: array - chosen_wan_path: - description: 'Chosen Wan Path: JsonAlias(value = [path_id]) ' - type: string - flow_decision_bitmap: - description: 'Flow Decision Bitmap: JsonAlias(value = [bitmap]) JsonInclude(content - = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = - classOf[Void]) ' - items: - description: Flow Decision Bitmap - format: int64 - type: integer - type: array - flow_decision_time: - description: 'Flow Decision Time: JsonAlias(value = [time]) ' - format: int64 - type: integer - policy_allowed_wan_paths: - description: 'Policy Allowed Wan Paths: JsonAlias(value = [policy_paths]) - JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, - valueFilter = classOf[Void]) ' - items: - description: Policy Allowed Wan Paths - type: string - type: array - predictive_wan_network_normalized_load: - description: 'Predictive Wan Network Normalized Load: JsonAlias(value = - [bw_values]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - items: - description: Predictive Wan Network Normalized Load - type: string - type: array - preferred_wan_path: - description: 'Preferred Wan Path: JsonAlias(value = [pref_wan_path]) JsonInclude(content - = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = - classOf[Void]) ' - type: string - sla_filtered_state_up_policy_allowed_wan_paths: - description: 'Sla Filtered State Up Policy Allowed Wan Paths: JsonAlias(value - = [policy_l2l3_sla_paths]) JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - items: - description: Sla Filtered State Up Policy Allowed Wan Paths - type: string - type: array - state_up_policy_allowed_wan_paths: - description: 'State Up Policy Allowed Wan Paths: JsonAlias(value = [policy_l2l3_paths]) - JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, - valueFilter = classOf[Void]) ' - items: - description: State Up Policy Allowed Wan Paths - type: string - type: array - required: - - flow_decision_time - - chosen_wan_path - - preferred_wan_path - - predictive_wan_network_normalized_load - - available_wan_networks - - sla_filtered_state_up_policy_allowed_wan_paths - - state_up_policy_allowed_wan_paths - - policy_allowed_wan_paths - - flow_decision_bitmap - FlowDetails: + FlowSummary: properties: app_id: description: App Id type: string - average_ntt: - description: 'Average Ntt: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - average_pg: - description: 'Average Pg: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - average_rtt: - description: 'Average Rtt: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - average_srt: - description: 'Average Srt: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - average_udp_trt: - description: 'Average Udp Trt: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_jitter_c2s: - description: 'Avg Jitter C2s: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_jitter_s2c: - description: 'Avg Jitter S2c: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_mos_c2s: - description: 'Avg Mos C2s: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_mos_s2c: - description: 'Avg Mos S2c: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_packet_loss_c2s: - description: 'Avg Packet Loss C2s: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_packet_loss_s2c: - description: 'Avg Packet Loss S2c: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number bytes_c2s: description: Bytes C2s format: int64 @@ -1520,56 +1247,18 @@ components: description: Bytes S2c format: int64 type: integer - codec_c2s: - description: 'Codec C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - items: - description: Codec C2s - format: int64 - type: integer - type: array - codec_s2c: - description: 'Codec S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - items: - description: Codec S2c - format: int64 - type: integer - type: array destination_ip: description: Destination Ip type: string - destination_lan_network_id: - description: Destination Lan Network Id - type: string - destination_lan_vlan_id: - description: Destination Lan Vlan Id - type: integer destination_port: description: Destination Port type: integer - element_id: - description: Element Id - type: string fc_app_id: description: Fc App Id type: string - fin_c2s: - description: Fin C2s - format: int64 - type: integer - fin_s2c: - description: Fin S2c - format: int64 - type: integer flow_action: description: Flow Action type: string - flow_decision_metadata_list: - description: Flow Decision Metadata List - items: - $ref: '#/components/schemas/FlowDecisionMetadata' - type: array flow_end_time_ms: description: Flow End Time Ms format: int64 @@ -1578,176 +1267,21 @@ components: description: Flow Start Time Ms format: int64 type: integer - incomplete_trans: - description: 'Incomplete Trans: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: int64 - type: integer - init_success: - description: 'Init Success: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - type: boolean is_local_traffic: description: Is Local Traffic type: boolean - is_sec_policy_present: - description: Is Sec Policy Present - type: boolean is_v6: description: Is V6 type: boolean - lan_dscp_lan_to_wan: - description: 'Lan Dscp Lan To Wan: JsonDeserialize(as = classOf[Void], builder - = classOf[Void], contentAs = classOf[Void], contentConverter = classOf[Converter$None], - contentUsing = classOf[JsonDeserializer$None], converter = classOf[Converter$None], - keyAs = classOf[Void], keyUsing = classOf[KeyDeserializer$None], using - = classOf[CustomGetSetPositionsDeserializer]) ' - items: - description: Lan Dscp Lan To Wan - type: integer - type: array - lan_dscp_wan_to_lan: - description: 'Lan Dscp Wan To Lan: JsonDeserialize(as = classOf[Void], builder - = classOf[Void], contentAs = classOf[Void], contentConverter = classOf[Converter$None], - contentUsing = classOf[JsonDeserializer$None], converter = classOf[Converter$None], - keyAs = classOf[Void], keyUsing = classOf[KeyDeserializer$None], using - = classOf[CustomGetSetPositionsDeserializer]) ' - items: - description: Lan Dscp Wan To Lan - type: integer - type: array - lan_origination_id: - description: Lan Origination Id - type: string - lan_termination_id: - description: Lan Termination Id - type: string lan_to_wan: description: Lan To Wan type: boolean - max_jitter_c2s: - description: 'Max Jitter C2s: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_jitter_s2c: - description: 'Max Jitter S2c: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_mos_c2s: - description: 'Max Mos C2s: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_mos_s2c: - description: 'Max Mos S2c: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_ntt: - description: 'Max Ntt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_packet_loss_c2s: - description: 'Max Packet Loss C2s: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_packet_loss_s2c: - description: 'Max Packet Loss S2c: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_pg: - description: 'Max Pg: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_rtt: - description: 'Max Rtt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_srt: - description: 'Max Srt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_udp_trt: - description: 'Max Udp Trt: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - media_type: - description: 'Media Type: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - type: string - min_mos_c2s: - description: 'Min Mos C2s: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_mos_s2c: - description: 'Min Mos S2c: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_ntt: - description: 'Min Ntt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_pg: - description: 'Min Pg: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_rtt: - description: 'Min Rtt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_srt: - description: 'Min Srt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_udp_trt: - description: 'Min Udp Trt: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - network_policy_dst_prefix_id: - description: Network Policy Dst Prefix Id - type: string network_policy_id: description: Network Policy Id type: string - network_policy_nctx_id: - description: Network Policy Nctx Id - type: string network_policy_set_id: description: Network Policy Set Id type: string - network_policy_src_prefix_id: - description: Network Policy Src Prefix Id - type: string - network_policy_stack_id: - description: Network Policy Stack Id - type: string - new_flow: - description: New Flow - type: boolean - ooo_pkts_c2s: - description: Ooo Pkts C2s - format: int64 - type: integer - ooo_pkts_s2c: - description: Ooo Pkts S2c - format: int64 - type: integer packets_c2s: description: Packets C2s format: int64 @@ -1765,262 +1299,39 @@ components: policy_id: description: Policy Id type: string - priority_class: - description: 'Priority Class: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - type: integer - priority_policy_default_rule_mapping_incoming_dscp: - description: Priority Policy Default Rule Mapping Incoming Dscp - format: int64 - type: integer - priority_policy_dst_prefix_id: - description: Priority Policy Dst Prefix Id - type: string priority_policy_id: description: Priority Policy Id type: string - priority_policy_nctx_id: - description: Priority Policy Nctx Id - type: string - priority_policy_remark_dscp: - description: Priority Policy Remark Dscp - format: int64 - type: integer priority_policy_set_id: description: Priority Policy Set Id type: string - priority_policy_src_prefix_id: - description: Priority Policy Src Prefix Id - type: string - priority_policy_stack_id: - description: Priority Policy Stack Id - type: string protocol: description: Protocol type: integer - reset_c2s: - description: Reset C2s - format: int64 - type: integer - reset_s2c: - description: Reset S2c - format: int64 - type: integer - retransmit_bytes_c2s: - description: Retransmit Bytes C2s - format: int64 - type: integer - retransmit_bytes_s2c: - description: Retransmit Bytes S2c - format: int64 - type: integer - retransmit_pkts_c2s: - description: Retransmit Pkts C2s - format: int64 - type: integer - retransmit_pkts_s2c: - description: Retransmit Pkts S2c - format: int64 - type: integer - sack_pkts_c2s: - description: Sack Pkts C2s - format: int64 - type: integer - sack_pkts_s2c: - description: Sack Pkts S2c - format: int64 - type: integer - sec_fc_app_id: - description: Sec Fc App Id + sec_policy_actions: + description: Sec Policy Actions items: - description: Sec Fc App Id + description: Sec Policy Actions type: string type: array - security_policy_rules: - description: 'Security Policy Rules: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = NON_EMPTY, valueFilter = classOf[Void]) ' - items: - $ref: '#/components/schemas/SecurityPolicyRules' - type: array service_endpoint_id: - description: 'Service Endpoint Id: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' + description: Service Endpoint Id type: string source_ip: description: Source Ip type: string - source_lan_network_id: - description: Source Lan Network Id - type: string - source_lan_vlan_id: - description: Source Lan Vlan Id - type: integer source_port: description: Source Port type: integer - success_transactions: - description: 'Success Transactions: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: int64 - type: integer - syn_c2s: - description: Syn C2s - format: int64 - type: integer - syn_s2c: - description: Syn S2c - format: int64 - type: integer - traffic_type: - description: 'Traffic Type: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - type: string unknown_domain: description: Unknown Domain type: string - unknown_reason: - description: Unknown Reason - type: string user_name: description: User Name type: string - vlan_id: - description: Vlan Id - type: integer - wan_path_change_reason: - description: 'Wan Path Change Reason: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' + vrf_id: + description: Vrf Id type: string - waninterface_id: - description: Waninterface Id - type: string - win_scaler_c2s: - description: Win Scaler C2s - format: int64 - type: integer - win_scaler_s2c: - description: Win Scaler S2c - format: int64 - type: integer - win_size_c2s: - description: Win Size C2s - format: int64 - type: integer - win_size_s2c: - description: Win Size S2c - format: int64 - type: integer - required: - - user_name - - is_v6 - - win_scaler_s2c - - win_scaler_c2s - - win_size_s2c - - win_size_c2s - - sack_pkts_s2c - - sack_pkts_c2s - - ooo_pkts_s2c - - ooo_pkts_c2s - - retransmit_pkts_s2c - - retransmit_pkts_c2s - - retransmit_bytes_s2c - - retransmit_bytes_c2s - - reset_s2c - - reset_c2s - - fin_s2c - - fin_c2s - - syn_s2c - - syn_c2s - - flow_decision_metadata_list - - security_policy_rules - - destination_lan_vlan_id - - source_lan_vlan_id - - destination_lan_network_id - - source_lan_network_id - - lan_termination_id - - lan_origination_id - - sec_fc_app_id - - is_sec_policy_present - - min_mos_s2c - - min_mos_c2s - - max_mos_s2c - - max_mos_c2s - - max_jitter_s2c - - max_jitter_c2s - - max_packet_loss_s2c - - max_packet_loss_c2s - - avg_mos_s2c - - avg_mos_c2s - - avg_jitter_s2c - - avg_jitter_c2s - - avg_packet_loss_s2c - - avg_packet_loss_c2s - - codec_s2c - - codec_c2s - - media_type - - min_udp_trt - - max_udp_trt - - average_udp_trt - - min_pg - - max_pg - - average_pg - - min_ntt - - max_ntt - - average_ntt - - min_srt - - max_srt - - average_srt - - min_rtt - - max_rtt - - average_rtt - - incomplete_trans - - success_transactions - - priority_policy_remark_dscp - - priority_policy_default_rule_mapping_incoming_dscp - - lan_dscp_wan_to_lan - - lan_dscp_lan_to_wan - - priority_class - - traffic_type - - packets_s2c - - packets_c2s - - bytes_s2c - - bytes_c2s - - unknown_domain - - unknown_reason - - flow_action - - priority_policy_stack_id - - priority_policy_set_id - - priority_policy_nctx_id - - priority_policy_dst_prefix_id - - priority_policy_src_prefix_id - - network_policy_stack_id - - network_policy_set_id - - network_policy_nctx_id - - network_policy_dst_prefix_id - - network_policy_src_prefix_id - - priority_policy_id - - network_policy_id - - policy_id - - service_endpoint_id - - vlan_id - - is_local_traffic - - flow_end_time_ms - - lan_to_wan - - path_type - - wan_path_change_reason - - waninterface_id - - path_id - - fc_app_id - - element_id - - app_id - - init_success - - new_flow - - flow_start_time_ms - - protocol - - destination_port - - destination_ip - - source_port - - source_ip FlowTupple: properties: destination_ip: @@ -2050,37 +1361,28 @@ components: description: Source Port type: integer type: array - required: - - source_port - - source_ip - - protocol - - destination_port - - destination_ip Flows: properties: debug_level: - description: Debug Level + description: "The values of the debug levels. \n" type: string end_time: - description: End Time + description: "The end time to get the flows information. \n" type: string items: - description: Items + description: "The flow summary information. \n" items: - $ref: '#/components/schemas/FlowDetails' + $ref: '#/components/schemas/FlowSummary' type: array start_time: - description: Start Time + description: 'The start time to get the flow information. + + ' type: string - required: - - start_time - - items - - end_time - - debug_level FlowsFilter: properties: app: - description: 'Filter flows by apps. + description: 'Filter by app. ' items: @@ -2088,7 +1390,7 @@ components: type: string type: array element: - description: 'Filter flows by element. + description: 'Filter by element. ' items: @@ -2097,11 +1399,11 @@ components: type: array flow: $ref: '#/components/schemas/FlowTupple' - description: 'Filter details of the flows. + description: 'Filter by flows information. ' flow_type: - description: 'Filter flows by flow type. + description: 'Filter by flows type. ' enum: @@ -2110,7 +1412,7 @@ components: - all type: string path: - description: 'Filter flows by path. + description: 'Filter by path. ' items: @@ -2118,7 +1420,7 @@ components: type: string type: array path_type: - description: 'Filter flows by path type. + description: 'Filter by path. ' items: @@ -2149,7 +1451,7 @@ components: type: string type: array security_policy_rule_action: - description: 'Filter by security policy rule action. + description: 'Filter by policy rule action. ' enum: @@ -2166,34 +1468,19 @@ components: type: string type: array site: - description: 'Filter flows by site. - - ' + description: "Filter by site. \n" items: description: Site type: string type: array waninterface: - description: 'Filter flows by WAN interface. + description: 'Filter by waninterface. ' items: description: Waninterface type: string type: array - required: - - site - - security_policy_source_zone - - security_policy_rule_action - - security_policy_rule - - security_policy_destination_zone - - path_type - - waninterface - - path - - flow_type - - flow - - element - - app FlowsQuery: properties: debug_level: @@ -2227,20 +1514,11 @@ components: description: "The start time to get the flow information. \n" format: date type: string - required: - - max_datapoints - - filter - - debug_level - - start_time - - name - - end_time FlowsQueryResponse: properties: flows: $ref: '#/components/schemas/Flows' description: Flows - required: - - flows Forecast: properties: actual_forecast_date: @@ -2249,6 +1527,12 @@ components: ' format: date-time type: string + bw_site_anomaly: + description: 'The bandwidth anomaly for the specified time range filter + for the site. + + ' + type: number forecast_status: description: 'The forecast status. True or False. @@ -2269,6 +1553,8 @@ components: - CAPACITY_EXCEED_THRESHOLD - ANOMALY - CIRCUIT_CAPACITY_FORECAST + - CIRCUIT_UTILIZATION + - ANOMALY_SITE_CIRCUIT_DETAILS type: string type: description: 'The type of forecast. @@ -2277,13 +1563,8 @@ components: enum: - FORECAST_28_DAYS - FORECAST_7_DAYS + - CIRCUIT_UTILIZATION_ANOMALY type: string - required: - - actual_forecast_date - - forecast_status - - items - - type - - name ForecastResult: properties: direction: @@ -2301,10 +1582,6 @@ components: ' type: string - required: - - direction - - wn_path - - site HealthData: properties: fair: @@ -2325,13 +1602,6 @@ components: type: description: Type type: string - required: - - others - - good - - fair - - poor - - total - - type HealthFilter: properties: application_health: @@ -2370,10 +1640,6 @@ components: - ALL type: string type: array - required: - - application_health - - link_health - - site_health HealthScoreQuery: properties: end_time: @@ -2392,11 +1658,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string name: description: 'The name of the healthscore filter. @@ -2417,13 +1683,6 @@ components: - SUMMARY - TIMESERIES type: string - required: - - view - - filter - - interval - - start_time - - name - - end_time HealthScoreResponse: properties: data: @@ -2442,11 +1701,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string start_time: description: 'The start time to get the health data. @@ -2459,12 +1718,6 @@ components: ' type: object - required: - - view - - data - - end_time - - start_time - - interval LqmStatsAggregateHealthScoreRequest: properties: aggregation: @@ -2502,9 +1755,6 @@ components: required: - healthscore_type - aggregation - - start_time - - name - - end_time LqmStatsAggregateHealthScoreResponse: properties: aggregation: @@ -2536,16 +1786,8 @@ components: $ref: '#/components/schemas/LqmStatsHealthScoreAggregateData' type: array start_time: - description: 'The start time to get the health score query. - - ' + description: "The start time to get the health score query. \n" type: string - required: - - items - - aggregation - - healthscore_type - - end_time - - start_time LqmStatsClientHealthScoreAggregateData: properties: tenant_id: @@ -2555,9 +1797,6 @@ components: description: Value format: int32 type: integer - required: - - value - - tenant_id LqmStatsHealthScoreAggregateData: properties: count: @@ -2577,10 +1816,6 @@ components: - fair - good type: string - required: - - count - - data - - health MetricSchema: properties: description: @@ -2608,11 +1843,6 @@ components: description: Units type: string type: array - required: - - description - - statistics - - units - - name MetricSchemaResponse: properties: metrics: @@ -2622,8 +1852,6 @@ components: items: $ref: '#/components/schemas/MetricSchema' type: array - required: - - metrics Metrics: properties: series: @@ -2633,8 +1861,6 @@ components: items: $ref: '#/components/schemas/Series' type: array - required: - - series MonitorMetricsFilter: properties: anynet_link: @@ -2711,17 +1937,6 @@ components: description: Waninterface type: string type: array - required: - - anynet_link - - waninterface - - remote_site - - path_type - - path - - app - - sprid - - direction - - site - - element MonitorMetricsQuery: properties: end_time: @@ -2740,11 +1955,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max data points. @@ -2774,14 +1989,8 @@ components: ' required: - - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time MonitorMetricsResponse: properties: metrics: @@ -2791,8 +2000,6 @@ components: items: $ref: '#/components/schemas/Metrics' type: array - required: - - metrics MulticastRouteIncomingInterface: properties: iif: @@ -2810,10 +2017,6 @@ components: ' type: string - required: - - is_site_interface - - wanpath - - iif MulticastRouteOutgoingInterface: properties: is_site_interface: @@ -2832,10 +2035,6 @@ components: description: Wanpaths type: string type: array - required: - - is_site_interface - - wanpaths - - oif MulticastRouteOutgoingInterfaceStatsData: properties: is_site_interface: @@ -2849,10 +2048,6 @@ components: items: $ref: '#/components/schemas/MulticastRouteWanpathStatsData' type: array - required: - - is_site_interface - - wanpaths - - oif MulticastRouteOutgoingInterfaceStatsResponse: properties: end_time: @@ -2866,10 +2061,6 @@ components: start_time: description: Start Time type: string - required: - - start_time - - end_time - - oif_list MulticastRouteSourceGroupStatsData: properties: flags: @@ -2913,14 +2104,6 @@ components: ' type: string - required: - - rx_packets - - rx_bytes - - flags - - outgoing_interfaces - - incoming_interface - - group - - source MulticastRouteSourceGroupStatsResponse: properties: end_time: @@ -2940,10 +2123,6 @@ components: ' type: string - required: - - source_group_list - - start_time - - end_time MulticastRouteStatsFilter: properties: element: @@ -2979,7 +2158,6 @@ components: type: string type: array required: - - group - source - site - element @@ -3024,9 +2202,6 @@ components: - is_active - type - filter - - start_time - - name - - end_time MulticastRouteWanpathStatsData: properties: last_active: @@ -3043,11 +2218,6 @@ components: wanpath: description: Wanpath type: string - required: - - last_active - - tx_packets - - tx_bytes - - wanpath MulticastWANNeighborStatsFilter: properties: element: @@ -3114,9 +2284,6 @@ components: required: - filter - object_type - - start_time - - name - - end_time MulticastWANPIMStatsData: properties: end_time: @@ -3204,22 +2371,6 @@ components: ' type: string - required: - - pim_bsm_tx_pkts - - pim_bsm_rx_pkts - - pim_assert_tx_pkts - - pim_assert_rx_pkts - - pim_join_prune_rx_pkts - - pim_join_prune_tx_pkts - - pim_register_rx_pkts - - pim_register_tx_pkts - - pim_register_stop_rx_pkts - - pim_register_stop_tx_pkts - - pim_hello_rx_pkts - - pim_hello_tx_pkts - - remote_site_id - - start_time - - end_time MulticastWANPIMStatsResponse: properties: data: @@ -3227,8 +2378,6 @@ components: description: 'The multicast WAN PIM statistics. ' - required: - - data MulticastWANPathStats: properties: rx_bytes: @@ -3264,12 +2413,6 @@ components: ' type: string - required: - - rx_bytes - - tx_bytes - - tx_packets - - rx_packets - - wanpath MulticastWANPathStatsData: properties: end_time: @@ -3292,11 +2435,6 @@ components: items: $ref: '#/components/schemas/MulticastWANPathStats' type: array - required: - - wanpath_list - - remote_site_id - - start_time - - end_time MulticastWANPathStatsResponse: properties: data: @@ -3304,8 +2442,6 @@ components: description: 'The multicast WAN path statistics. ' - required: - - data MulticastWANTrafficStatsData: properties: end_time: @@ -3347,14 +2483,6 @@ components: ' format: int64 type: integer - required: - - rx_bytes - - tx_bytes - - tx_packets - - rx_packets - - remote_site_id - - start_time - - end_time MulticastWANTrafficStatsResponse: properties: data: @@ -3362,8 +2490,6 @@ components: description: 'The multicast WAN traffic statistics. ' - required: - - data NetworkPointMetrics: properties: name: @@ -3381,10 +2507,6 @@ components: unit: description: Unit type: string - required: - - sites - - unit - - name NetworkPointMetricsFilter: properties: direction: @@ -3432,13 +2554,6 @@ components: description: Waninterface type: string type: array - required: - - direction - - waninterface - - interface - - site - - sites - - element NetworkPointMetricsQuery: properties: end_time: @@ -3458,11 +2573,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string metrics: description: 'The details of the network point metric. Metrics need to specified @@ -3489,9 +2604,6 @@ components: - filter - metrics - interval - - start_time - - name - - end_time NetworkPointMetricsResponse: properties: interval: @@ -3499,11 +2611,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string metrics: description: 'The details of the network point metric. Metrics need to specified @@ -3526,11 +2638,6 @@ components: description: 'The individual and summary views. ' - required: - - view - - interval - - start_time - - metrics ObjectStatsFilter: properties: element: @@ -3547,6 +2654,8 @@ components: description: Site type: string type: array + required: + - site ObjectStatsQuery: properties: end_time: @@ -3598,15 +2707,10 @@ components: - filter - object_id - object_type - - start_time - - name - - end_time ObjectStatsResponse: properties: data: type: object - required: - - data ObjectStatsType: properties: description: @@ -3618,9 +2722,6 @@ components: ' type: string - required: - - description - - name ObjectStatsTypeResponse: properties: object_statistics: @@ -3630,8 +2731,6 @@ components: items: $ref: '#/components/schemas/ObjectStatsType' type: array - required: - - object_statistics PointData: properties: avail_disk: @@ -3751,33 +2850,6 @@ components: ' type: number - required: - - link_healthy - - bad_link_health_reason_bitmap - - rtt_latency - - sample_completeness - - uplink_mos_max - - uplink_mos_min - - uplink_mos_avg - - downlink_mos_max - - downlink_mos_min - - downlink_mos_avg - - uplink_pkt_loss_avg - - downlink_pkt_loss_avg - - uplink_jitter_avg - - downlink_jitter_avg - - tunnel_healthscore - - egress - - ingress - - dskmx - - dskmn - - avail_disk - - memmx - - memmn - - avail_mem - - avidlemx - - avidlemn - - avidle PointMetricsAnynet: properties: anynet_link_id: @@ -3790,9 +2862,6 @@ components: description: 'The data of the point metric Anynet. ' - required: - - data - - anynet_link_id PointMetricsQuery: properties: end_time: @@ -3812,11 +2881,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string metrics: description: 'The details of the point metric. Metrics need to specified @@ -3842,14 +2911,6 @@ components: view: $ref: '#/components/schemas/View' description: View - required: - - view - - interval - - filter - - metrics - - start_time - - name - - end_time PointMetricsResponse: properties: interval: @@ -3876,11 +2937,6 @@ components: description: 'The individual and summary views. ' - required: - - start_time - - interval - - view - - metrics PointMetricsSites: properties: data: @@ -3901,10 +2957,6 @@ components: items: $ref: '#/components/schemas/PointMetricsWanPath' type: array - required: - - data - - waninterfaces - - site_id PointMetricsWanPath: properties: anynetlinks: @@ -3924,10 +2976,6 @@ components: ' type: string - required: - - data - - anynetlinks - - wn_path_id QosMetricsFilter: properties: direction: @@ -3981,10 +3029,6 @@ components: required: - traffic_type - priority - - waninterface - - direction - - site - - element QosMetricsQuery: properties: end_time: @@ -4003,11 +3047,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max data points. @@ -4038,13 +3082,8 @@ components: ' required: - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time QosMetricsResponse: properties: metrics: @@ -4054,8 +3093,6 @@ components: items: $ref: '#/components/schemas/Metrics' type: array - required: - - metrics RadiusClientMetricsFilter: properties: element: @@ -4076,10 +3113,6 @@ components: description: Site type: string type: array - required: - - site - - interface - - element RadiusClientsRequest: properties: end_time: @@ -4112,12 +3145,6 @@ components: ' format: date type: string - required: - - max_datapoints - - filter - - start_time - - name - - end_time RadiusClientsResponse: properties: end_time: @@ -4139,10 +3166,6 @@ components: ' type: string - required: - - start_time - - items - - end_time RadiusMetricsFilter: properties: client_mac_address: @@ -4185,12 +3208,6 @@ components: description: Site type: string type: array - required: - - client_mac_address - - interface - - direction - - site - - element RadiusMetricsQuery: properties: end_time: @@ -4209,11 +3226,11 @@ components: description: 'Interval: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max data points. @@ -4247,14 +3264,8 @@ components: ' required: - - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time RadiusMetricsResponse: properties: metrics: @@ -4264,48 +3275,6 @@ components: items: $ref: '#/components/schemas/Metrics' type: array - required: - - metrics - SecurityPolicyRules: - properties: - bytes_c2s: - format: int64 - type: integer - bytes_s2c: - format: int64 - type: integer - packets_c2s: - format: int64 - type: integer - packets_s2c: - format: int64 - type: integer - security_destination_zone_id: - description: 'Security Destination Zone Id: JsonAlias(value = [dst_zone_id]) ' - type: string - security_policy_rule_action: - description: 'Security Policy Rule Action: JsonAlias(value = [action]) ' - type: string - security_policy_rule_id: - description: 'Security Policy Rule Id: JsonAlias(value = [rule_id]) ' - type: string - security_source_zone_id: - description: 'Security Source Zone Id: JsonAlias(value = [src_zone_id]) ' - type: string - time: - description: Time - format: int64 - type: integer - required: - - packets_s2c - - packets_c2s - - bytes_s2c - - bytes_c2s - - time - - security_policy_rule_action - - security_destination_zone_id - - security_source_zone_id - - security_policy_rule_id Series: properties: data: @@ -4331,12 +3300,6 @@ components: ' type: object - required: - - view - - unit - - name - - interval - - data SysMetricsFilter: properties: direction: @@ -4369,17 +3332,10 @@ components: description: Site type: string type: array - required: - - interface - - direction - - site - - element SysMetricsQuery: properties: end_time: - description: 'The end time to get the system metrics. End time, if not specified, - default to now. Start and end times need to be specified in ISO8601 UTC - format. + description: 'The end time to get the system metrics. ' format: date @@ -4394,11 +3350,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max data points. @@ -4407,9 +3363,7 @@ components: format: int32 type: integer metrics: - description: 'The details of the metrics. Metrics need to specified according - to 2.3 specifications. Invalid metrics will be ignored and the result - will not include them. + description: 'The details of the metrics. ' items: @@ -4421,25 +3375,15 @@ components: ' type: string start_time: - description: 'The start time to get the system metrics. Start time, if not - specified, default to epoch. Start and end times need to be specified - in ISO8601 UTC format. - - ' + description: "The start time to get the system metrics. \n" format: date type: string view: $ref: '#/components/schemas/View' description: "View the system metric details. \n" required: - - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time SysMetricsResponse: properties: metrics: @@ -4449,8 +3393,6 @@ components: items: $ref: '#/components/schemas/Metrics' type: array - required: - - metrics TopNComparator: properties: end_time: @@ -4478,10 +3420,6 @@ components: ' format: date type: string - required: - - measurement - - end_time - - start_time TopNGrowth: properties: compare: @@ -4502,17 +3440,14 @@ components: ' type: - description: "The type of top n metrics. \n" + description: "The type of top n metrics. \n" enum: - app - site type: string required: - metrics - - filter - - compare - type - - limit TopNGrowthFilter: properties: app: @@ -4582,8 +3517,6 @@ components: description: Waninterface type: string type: array - required: - - direction TopNGrowthQuery: properties: end_time: @@ -4597,11 +3530,9 @@ components: description: "The name of the of the top n sites/apps. \n" type: string start_time: - description: 'The start time to get the top n sites/apps. If not specified, - it is default to epoch. Start times need to be specified in ISO8601 UTC - format. - - ' + description: "The start time to get the top n sites/apps. If not specified,\ + \ it is default to epoch. Start times need to be specified in ISO8601\ + \ UTC format. \n" format: date type: string top_n: @@ -4611,9 +3542,6 @@ components: ' required: - top_n - - start_time - - name - - end_time View: properties: individual: @@ -4644,25 +3572,21 @@ components: ' type: boolean - required: - - individual - - summary info: contact: {} description: List of APIs used to retrieve SDWAN metrics such as badnwidth utilization, TCP transaction, application health, application performance, LQM, flows, interface - & system metrics. + and system metrics. title: Metrics version: Latest openapi: 3.0.0 paths: /v2.0/api/tenants/{esp_tenant_id}/monitor/aggregates/healthscore: post: - description: The health score aggregate categorized as poor, fair and good for - MSP and its clients. + description: Query the aggregate health score for MSP and its clients. operationId: post-v2.0-api-tenants-esp_tenant_id-monitor-aggregates-healthscore parameters: - - description: MSP Tenant Id + - description: ID of the MSP tenant. in: path name: esp_tenant_id required: true @@ -4694,7 +3618,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Aggregate Healthscore (v2.0) + summary: Query Aggregate Health Score (v2.0) tags: - Metrics /v2.0/api/tenants/{tenant_id}/monitor/aaa_client_metrics: @@ -5023,13 +3947,89 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query WAN Neighbor Statistics (v2.0) + summary: Query WAN Neighbor Statistics (v2.0) + tags: + - Metrics + /v2.0/api/tenants/{tenant_id}/monitor/aiops/aggregates: + get: + description: Get the site or path level aggregated statistics. + operationId: get-v2.0-api-tenants-tenant_id-monitor-aiops-aggregates + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AggregateStatsResponse' + description: Successful Operation + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Get Site or Path Level Aggregated Statistics (2.0) + tags: + - Metrics + post: + description: Query the site or path level aggregated statistics. + operationId: post-v2.0-api-tenants-tenant_id-monitor-aiops-aggregates + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AggregateStatsQuery' + description: Details of app object stats query + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AggregateStatsResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: AGGREGATE_STATS_QUERY_AGGREGATES_REQUIRED + - code: AGGREGATE_STATS_APP_ID_REQUIRED + - code: AGGREGATE_STATS_APP_LENGTH_EXCEEDED + - code: AGGREGATE_STATS_QUERY_APP_INVALID_VALUE + - code: AGGREGATE_STATS_QUERY_FILTER_SITE_ID_REQUIRED + - code: AGGREGATE_STATS_QUERY_SITE_LIST_LENGTH_EXCEEDED + - code: AGGREGATE_STATS_QUERY_SITE_ID_INVALID_VALUE + - code: AGGREGATE_STATS_QUERY_PATH_ID_INVALID_VALUE + - code: AGGREGATE_STATS_QUERY_AGGREGATES_UNSUPPORTED + - code: AGGREGATE_STATS_QUERY_START_TIME_BEFORE_END_TIME + - code: AGGREGATE_STATS_QUERY_FILTER_UNSUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Site or Path Level Aggregated Statistics (2.0) tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/aiops/aggregates: + /v2.0/api/tenants/{tenant_id}/monitor/aiops/anomaly: get: - description: Get the site or path level aggregated statistics. - operationId: get-v2.0-api-tenants-tenant_id-monitor-aiops-aggregates + description: Get circuit bandwidth anomaly. + operationId: get-v2.0-api-tenants-tenant_id-monitor-aiops-anomaly parameters: - description: The tenant ID. in: path @@ -5043,7 +4043,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AggregateStatsResponse' + $ref: '#/components/schemas/CapacityPredictionResponse' description: Successful Operation '500': content: @@ -5051,12 +4051,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get Site or Path Level Aggregated Statistics (2.0) + summary: Get Circuit Bandwidth Anomaly (v2.0) tags: - Metrics post: - description: Query the site or path level aggregated statistics. - operationId: post-v2.0-api-tenants-tenant_id-monitor-aiops-aggregates + description: Get circuit bandwidth anomaly. Start and end time need to be specified + in ISO8601 UTC format. Forecast basis need be to specified according to 2.0 + specifications. + operationId: post-v2.0-api-tenants-tenant_id-monitor-aiops-anomaly parameters: - description: The tenant ID. in: path @@ -5069,14 +4071,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AggregateStatsQuery' - description: Details of app object stats query + $ref: '#/components/schemas/CapacityPredictionQuery' + description: Query request for getting circuit bandwidth anomaly based on + anomaly basis responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AggregateStatsResponse' + $ref: '#/components/schemas/CapacityPredictionQuery' description: Successful Operation '400': content: @@ -5085,21 +4088,13 @@ paths: value: _error: - code: INVALID_REQUEST_ERROR_0001 - - code: AGGREGATE_STATS_QUERY_AGGREGATES_REQUIRED - - code: AGGREGATE_STATS_APP_ID_REQUIRED - - code: AGGREGATE_STATS_APP_LENGTH_EXCEEDED - - code: AGGREGATE_STATS_QUERY_APP_INVALID_VALUE - - code: AGGREGATE_STATS_QUERY_FILTER_SITE_ID_REQUIRED - - code: AGGREGATE_STATS_QUERY_SITE_LIST_LENGTH_EXCEEDED - - code: AGGREGATE_STATS_QUERY_SITE_ID_INVALID_VALUE - - code: AGGREGATE_STATS_QUERY_PATH_ID_INVALID_VALUE - - code: AGGREGATE_STATS_QUERY_AGGREGATES_UNSUPPORTED - - code: AGGREGATE_STATS_QUERY_START_TIME_BEFORE_END_TIME - - code: AGGREGATE_STATS_QUERY_FILTER_UNSUPPORTED + - code: SCHEMA_MISMATCH + - code: START_TIME_GREATER_THAN_END_TIME + - code: MAX_DATAPOINTS_END_TIME schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Site or Path Level Aggregated Statistics (2.0) + summary: Get Circuit Bandwidth Anomaly for Site (v2.0) tags: - Metrics /v2.0/api/tenants/{tenant_id}/monitor/aiops/forecast: @@ -5366,7 +4361,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get TopN data with metrics output + summary: Get TopN data with metrics output (v2.0) tags: - Metrics /v2.0/api/tenants/{tenant_id}/monitor/application/qos_metrics: @@ -5848,7 +4843,7 @@ paths: schema: $ref: '#/components/schemas/MetricSchemaResponse' description: Successful Operation - summary: Get details of Qos metrics + summary: Get details of Qos metrics (v2.0) tags: - Metrics post: @@ -6135,7 +5130,7 @@ paths: - Metrics /v2.1/api/tenants/{tenant_id}/monitor/aiops/object_stats: get: - description: Get app object statistics. + description: Query and get the app object statistics. operationId: get-v2.1-api-tenants-tenant_id-monitor-aiops-object_stats parameters: - description: The tenant ID. @@ -6158,14 +5153,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get App Object Statistics (2.1) + summary: Get App Object Stats API (v2.1) tags: - Metrics post: - description: Query and list app object statistics. + description: Query and get app object stats API v2.1 operationId: post-v2.1-api-tenants-tenant_id-monitor-aiops-object_stats parameters: - - description: The tenant ID. + - description: Tenant ID in: path name: tenant_id required: true @@ -6208,7 +5203,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query App object Statistics (2.1) + summary: Query and get App object statistics (v2.1) tags: - Metrics /v2.1/api/tenants/{tenant_id}/monitor/sys_metrics/topn: @@ -6261,110 +5256,6 @@ paths: summary: Query System Metrics Top N (v2.1) tags: - Metrics - /v2.2/api/tenants/{tenant_id}/monitor/metrics: - post: - description: Query the monitor metrics. - operationId: post-v2.2-api-tenants-tenant_id-monitor-metrics - parameters: - - description: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MonitorMetricsQuery' - description: Details of monitor metrics query - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MonitorMetricsResponse' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_REQUEST_ERROR_0001 - - code: EMPTY_REQ_BODY - - code: SCHEMA_MISMATCH - - code: METRIC_NOT_SUPPORTED - - code: METRIC_UNIT_NOT_SUPPORTED - - code: UNSUPPORTED_INDIVIDUAL_DIMENSION - - code: VIEW_DIRECTION_AND_FILTER_DIRECTION_NOT_SUPPORTED - - code: UNSUPPORTED_DIRECTION_FILTER - - code: METRIC_AND_VIEW_NOT_SUPPORTED - - code: MISSING_DIRECTION - - code: MAX_DATAPOINTS_END_TIME - - code: START_TIME_GREATER_THAN_END_TIME - - code: METRIC_STATISTICS_NOT_SUPPORTED - - code: PATH_AND_PATH_TYPE_NOT_SUPPORTED - - code: SITE_WITH_PATH_MISSING - - code: SITE_WITH_WANINTERFACE_MISSING - - code: WANINTERFACE_WITH_ANYNETLINK_MISSING - - code: SITE_WITH_ELEMENT_MISSING - - code: METRIC_MISSING_SITE - - code: METRIC_MISSING_APP - - code: METRIC_SUPPORTS_SINGLE_SITE - - code: METRIC_SUPPORTS_SINGLE_REMOTE_SITE - - code: METRIC_SUPPORTS_SINGLE_APP - - code: METRIC_NOT_SUPPORTED_WITH_PATH_FILTER - - code: METRIC_NOT_SUPPORTED_WITH_WAN_INTERFACE - - code: METRIC_MISSING_PATH_ID - - code: METRIC_SUPPORTS_SINGLE_PATH_ID - - code: METRIC_SUPPORTS_SINGLE_FILTER_WITH_LIST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Monitor Metrics (v2.1) - tags: - - Metrics - /v2.2/api/tenants/{tenant_id}/monitor/metrics/{mtype}: - get: - description: List details of the monitor metrics. - operationId: get-v2.2-api-tenants-tenant_id-monitor-metrics-mtype - parameters: - - description: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The metric type. - in: path - name: mtype - required: true - schema: - description: Mtype - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MetricSchemaResponse' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: METRIC_NOT_SUPPORTED - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Monitor Metrics (v2.2) - tags: - - Metrics /v2.2/api/tenants/{tenant_id}/monitor/sys_metrics: get: description: List all the system metrics schema. @@ -6457,7 +5348,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: System metrics for Version 2.2 + summary: System metrics for Version 2.2 (v2.2) tags: - Metrics /v2.3/api/tenants/{tenant_id}/monitor/metrics: @@ -6592,7 +5483,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Returns sysmetrics schema for Version 2.3 + summary: Returns sysmetrics schema for Version 2.3 (v2.3) tags: - Metrics post: @@ -6649,6 +5540,112 @@ paths: summary: Get System Metrics Schema (v2.3) tags: - Metrics + /v2.4/api/tenants/{tenant_id}/monitor/metrics: + post: + description: Query all the monitor metrics. + operationId: post-v2.4-api-tenants-tenant_id-monitor-metrics + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorMetricsQuery' + description: Details of monitor metrics query + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorMetricsResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: EMPTY_REQ_BODY + - code: SCHEMA_MISMATCH + - code: METRIC_NOT_SUPPORTED + - code: METRIC_UNIT_NOT_SUPPORTED + - code: UNSUPPORTED_FILTER_FOR_VERSION + - code: UNSUPPORTED_INDIVIDUAL_DIMENSION + - code: VIEW_DIRECTION_AND_FILTER_DIRECTION_NOT_SUPPORTED + - code: UNSUPPORTED_DIRECTION_FILTER + - code: METRIC_AND_VIEW_NOT_SUPPORTED + - code: MISSING_DIRECTION + - code: MAX_DATAPOINTS_END_TIME + - code: START_TIME_GREATER_THAN_END_TIME + - code: METRIC_STATISTICS_NOT_SUPPORTED + - code: PATH_AND_PATH_TYPE_NOT_SUPPORTED + - code: SITE_WITH_PATH_MISSING + - code: SITE_WITH_WANINTERFACE_MISSING + - code: WANINTERFACE_WITH_ANYNETLINK_MISSING + - code: SITE_WITH_ELEMENT_MISSING + - code: METRIC_MISSING_SITE + - code: METRIC_MISSING_APP + - code: METRIC_SUPPORTS_SINGLE_SITE + - code: METRIC_SUPPORTS_SINGLE_REMOTE_SITE + - code: METRIC_SUPPORTS_SINGLE_APP + - code: METRIC_NOT_SUPPORTED_WITH_PATH_FILTER + - code: METRIC_NOT_SUPPORTED_WITH_WAN_INTERFACE + - code: METRIC_MISSING_PATH_ID + - code: METRIC_SUPPORTS_SINGLE_PATH_ID + - code: METRIC_SUPPORTS_SINGLE_FILTER_WITH_LIST + - code: FILTER_NOT_SUPPORTED_FOR_METRIC + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Monitor Metrics (v2.4) + tags: + - Metrics + /v2.4/api/tenants/{tenant_id}/monitor/metrics/{mtype}: + get: + description: List details of the monitor metrics. + operationId: get-v2.4-api-tenants-tenant_id-monitor-metrics-mtype + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The metric type. + in: path + name: mtype + required: true + schema: + description: Mtype + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MetricSchemaResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: METRIC_NOT_SUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Monitor Metrics (v2.4) + tags: + - Metrics /v2.4/api/tenants/{tenant_id}/monitor/object_stats: get: description: List the object statistics. @@ -6672,10 +5669,10 @@ paths: tags: - Metrics post: - description: Query and get object stats API v2.4 + description: Query and get object statistics. operationId: post-v2.4-api-tenants-tenant_id-monitor-object_stats parameters: - - description: Tenant ID + - description: ID of the tenant. in: path name: tenant_id required: true @@ -6718,15 +5715,15 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query and get object statistics + summary: Query Object Stats (v2.4) tags: - Metrics /v2.5/api/tenants/{tenant_id}/monitor/object_stats: get: - description: Get object stats API v2.5 + description: List the object statistics. operationId: get-v2.5-api-tenants-tenant_id-monitor-object_stats parameters: - - description: Tenant ID + - description: ID of the tenant. in: path name: tenant_id required: true @@ -6740,11 +5737,11 @@ paths: schema: $ref: '#/components/schemas/ObjectStatsTypeResponse' description: Successful Operation - summary: Get name and description of all object statistics + summary: Get Object Stats (v2.5) tags: - Metrics post: - description: List the object statistics. + description: Query and get object statistics. operationId: post-v2.5-api-tenants-tenant_id-monitor-object_stats parameters: - description: ID of the tenant. @@ -6790,15 +5787,15 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Object Stats (v2.5) + summary: Query Object Stats (v2.5) tags: - Metrics /v3.0/api/tenants/{tenant_id}/monitor/aggregates: get: - description: Summary of supported aggregates + description: List all the supported app stats aggregates. operationId: get-v3.0-api-tenants-tenant_id-monitor-aggregates parameters: - - description: Tenant Id + - description: ID of the tenant. in: path name: tenant_id required: true @@ -6812,7 +5809,7 @@ paths: schema: $ref: '#/components/schemas/AppStatsSupportedAggregatesResponse' description: Successful Operation - summary: Supported App stats Aggregates + summary: Get App Stats Aggregates (v3.0) tags: - Metrics post: @@ -6961,10 +5958,10 @@ paths: summary: Get Top N Data (v3.1) tags: - Metrics - /v3.6/api/tenants/{tenant_id}/monitor/flows: + /v3.7/api/tenants/{tenant_id}/monitor/flows: post: - description: List all the flow information. - operationId: post-v3.6-api-tenants-tenant_id-monitor-flows + description: List all the flows information. + operationId: post-v3.7-api-tenants-tenant_id-monitor-flows parameters: - description: ID of the tenant. in: path @@ -7013,13 +6010,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get Flow Information (v3.6) + summary: Get Flows Information (v3.7) tags: - Metrics - /v3.7/api/tenants/{tenant_id}/monitor/flows: + /v3.8/api/tenants/{tenant_id}/monitor/flows: post: description: List all the flows information. - operationId: post-v3.7-api-tenants-tenant_id-monitor-flows + operationId: post-v3.8-api-tenants-tenant_id-monitor-flows parameters: - description: ID of the tenant. in: path @@ -7068,7 +6065,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get Flows Information (v3.7) + summary: Get Flows Information (v3.8) tags: - Metrics servers: diff --git a/openapi-specs/sdwan/legacy/Multicast.yaml b/openapi-specs/sdwan/legacy/Multicast.yaml index 3abd486dd..8072b0786 100644 --- a/openapi-specs/sdwan/legacy/Multicast.yaml +++ b/openapi-specs/sdwan/legacy/Multicast.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view DynamicRp: properties: groups: @@ -70,7 +64,7 @@ components: type: string type: description: "The type of dynamic RP. BSR\u2014Indicates that the RP is\ - \ learnt dynamically via BSM.\n" + \ learnt dynamically via BSM. \n" type: string Error: properties: @@ -99,19 +93,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -137,7 +131,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -146,18 +140,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -560,7 +554,9 @@ components: MulticastPeerSite: properties: peer_site_id: - description: Peer Site Id + description: 'The peer site ID. + + ' type: string MulticastPimProtocolConfig: properties: @@ -2408,24 +2404,24 @@ paths: tags: - Multicast post: - description: API to create multicast rp config + description: Create multicast RP config. operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-multicastrps parameters: - - description: Tenant Id + - description: ID of the tenant. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: Site Id + - description: ID of the site. in: path name: site_id required: true schema: description: Site Id type: string - - description: Element Id + - description: ID of the element. in: path name: element_id required: true @@ -2457,7 +2453,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Creates Multicast RP config (v2.0) + summary: Create Multicast RP Config (v2.0) tags: - Multicast /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/multicastrps/{config_id}: @@ -2700,7 +2696,7 @@ paths: - Multicast /v2.0/api/tenants/{tenant_id}/sites/{site_id}/multicastsourcesiderps: get: - description: List the multicast source side RPs. + description: Get multicast source side RPs API. operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-multicastsourcesiderps parameters: - description: The tenant ID. @@ -2710,7 +2706,7 @@ paths: schema: description: Tenant Id type: string - - description: The site ID for which you wish to query the source side RPs. + - description: Site ID in: path name: site_id required: true diff --git a/openapi-specs/sdwan/legacy/NATPolicy.yaml b/openapi-specs/sdwan/legacy/NATPolicy.yaml index eb5d155eb..1f63ea626 100644 --- a/openapi-specs/sdwan/legacy/NATPolicy.yaml +++ b/openapi-specs/sdwan/legacy/NATPolicy.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BasePolicyPrefixS: properties: description: @@ -120,7 +114,7 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queries. + description: 'The aggregate number of queried elements. ' dest_page: @@ -130,12 +124,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of queried deleted for a time frame. + description: 'The number of queried elements deleted for a time frame. ' type: boolean group_by: - description: 'Group the queries. + description: 'Group the elements state for the query. ' items: @@ -143,7 +137,7 @@ components: type: string type: array id: - description: "List the query by ID. \n" + description: "List the element by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -188,18 +182,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string Error: properties: @@ -323,19 +317,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -361,7 +355,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -370,18 +364,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -660,7 +654,9 @@ components: type: string type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string required: - actions @@ -895,7 +891,9 @@ components: type: string type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string update_order: description: Update Order @@ -935,10 +933,9 @@ components: type: string type: array tags: - description: 'A information field that can be added to identify the NAT - policy set. Maximum 10 unique tags of length 1024 each are allowed. - - ' + description: "A information field that can be added to identify the NAT\ + \ policy set. Maximum 10 unique tags of length 1024 each are allowed.\ + \ \n" items: description: Tags type: string @@ -1122,7 +1119,9 @@ components: type: string type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string required: - name @@ -2310,7 +2309,7 @@ paths: schema: description: Tenant Id type: string - - description: ID of the NAT policy set + - description: ID of the NAT policy set. in: path name: nat_policy_set_id required: true diff --git a/openapi-specs/sdwan/legacy/NTP.yaml b/openapi-specs/sdwan/legacy/NTP.yaml index 79a86b291..0284a9e16 100644 --- a/openapi-specs/sdwan/legacy/NTP.yaml +++ b/openapi-specs/sdwan/legacy/NTP.yaml @@ -3,18 +3,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string ElementNTP: properties: diff --git a/openapi-specs/sdwan/legacy/NetworkConstructs.yaml b/openapi-specs/sdwan/legacy/NetworkConstructs.yaml index 50a854682..779bee1f9 100644 --- a/openapi-specs/sdwan/legacy/NetworkConstructs.yaml +++ b/openapi-specs/sdwan/legacy/NetworkConstructs.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BaseCustomDHCPOptions: properties: option_definition: @@ -72,18 +66,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string DHCPRelay: properties: @@ -239,6 +233,9 @@ components: ' type: boolean + lifesize: + $ref: '#/components/schemas/Lifesize' + description: Lifesize lifetime: description: 'The life time for the ESP Group. The default lifetime of an ESP Group is 24 hours. @@ -246,6 +243,9 @@ components: ' format: int32 type: integer + lifetime_units: + description: Lifetime Units + type: string mode: description: 'The IPsec config ESP tunnel mode. @@ -261,8 +261,10 @@ components: items: $ref: '#/components/schemas/Proposals' type: array + responder_sase_proposals: + $ref: '#/components/schemas/ResponderSaseProposals' + description: Responder Sase Proposals required: - - proposals - mode Error: properties: @@ -284,6 +286,9 @@ components: ' type: boolean + authentication_multiple: + description: Authentication Multiple + type: integer key_exchange: description: 'The key exchange for the IKE group = IKEv1 or IKEv2. @@ -299,6 +304,9 @@ components: ' format: int32 type: integer + lifetime_units: + description: Lifetime Units + type: string port: description: 'The port number of the communication port. The default port is 500. The port number configured in the IKE group has to be the same @@ -323,7 +331,6 @@ components: ' type: boolean required: - - proposals - key_exchange IKEV1Params: properties: @@ -375,6 +382,12 @@ components: ' type: string + certificate_profile_id: + description: Certificate Profile Id + type: string + comment: + description: Comment + type: string ikev1_params: $ref: '#/components/schemas/IKEV1Params' description: 'Ikev1 Params: Valid ' @@ -391,18 +404,34 @@ components: - DN - HOSTNAME - CUSTOM + - NONE type: string local_id_custom: description: 'The custom local ID. ' type: string + local_pa_certificate_id: + description: Local Pa Certificate Id + type: string + pa_master_key_id: + description: Pa Master Key Id + type: string passphrase: description: Passphrase type: string passphrase_encrypted: description: 'Passphrase Encrypted: JsonIgnore(value = true) ' type: string + peer_id_check: + description: Peer Id Check + enum: + - EXACT + - WILDCARD + type: string + permit_peer_id_mismatch: + description: Permit Peer Id Mismatch + type: boolean private_key: description: 'The private key file uploaded for certificate authentication. @@ -428,6 +457,9 @@ components: secret_hash: description: 'Secret Hash: JsonIgnore(value = true) ' type: string + strict_validation_peer_extended_key_use: + description: Strict Validation Peer Extended Key Use + type: boolean type: description: 'The authentication type = PSK or Certificates. @@ -792,7 +824,7 @@ components: - site_id - scope - name - LANNetworkQueryFilterV3N1: + LANNetworkQueryFilterV3N2: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -805,6 +837,11 @@ components: $ref: '#/components/schemas/LanNetworkIPv4Config' description: 'The Ipv4 config of the LAN network. Maz size = 256. + ' + ipv6_config: + $ref: '#/components/schemas/LanNetworkIPv6Config' + description: 'The Ipv6 config of the LAN network. Maz size = 256. + ' name: description: 'The name of the LAN network. Max size = 128. @@ -836,7 +873,7 @@ components: required: - scope - name - LANNetworkQueryFilterV3N2: + LANNetworkQueryFilterV3N3: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -882,10 +919,13 @@ components: description: Tags type: string type: array + vrf_context_id: + description: "The vrf context id. \n" + type: string required: - scope - name - LANNetworkScreenV3N1: + LANNetworkScreenV3N2: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -898,6 +938,11 @@ components: $ref: '#/components/schemas/LanNetworkIPv4Config' description: 'The Ipv4 config of the LAN network. Maz size = 256. + ' + ipv6_config: + $ref: '#/components/schemas/LanNetworkIPv6Config' + description: 'The Ipv6 config of the LAN network. Maz size = 256. + ' name: description: 'The name of the LAN network. Max size = 128. @@ -918,8 +963,10 @@ components: - LOCAL type: string tags: - description: "An information field that can be added to identify the LAN\ - \ network. Maximum 10 unique tags of length 1024 each are allowed. \n" + description: 'An information field that can be added to identify the LAN + network. Maximum 10 unique tags of length 1024 each are allowed. + + ' items: description: Tags type: string @@ -927,7 +974,7 @@ components: required: - scope - name - LANNetworkScreenV3N2: + LANNetworkScreenV3N3: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -973,10 +1020,14 @@ components: description: Tags type: string type: array + vrf_context_id: + description: "The VRF (Virtual Routing and Forwarding) ID. \ + \ \n" + type: string required: - scope - name - LANNetworkV3N1: + LANNetworkV3N2: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -989,6 +1040,11 @@ components: $ref: '#/components/schemas/LanNetworkIPv4Config' description: 'The Ipv4 config of the LAN network. Maz size = 256. + ' + ipv6_config: + $ref: '#/components/schemas/LanNetworkIPv6Config' + description: 'The Ipv6 config of the LAN network. Maz size = 256. + ' name: description: 'The name of the LAN network. Max size = 128. @@ -1020,7 +1076,7 @@ components: required: - scope - name - LANNetworkV3N2: + LANNetworkV3N3: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -1066,6 +1122,11 @@ components: description: Tags type: string type: array + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: - scope - name @@ -1136,22 +1197,31 @@ components: description: Prefixes type: string type: array + Lifesize: + properties: + units: + description: Units + type: string + value: + description: Value + format: int32 + type: integer ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -1177,7 +1247,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -1186,18 +1256,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -1292,6 +1362,7 @@ components: - AES128CTR - AES192CTR - AES256CTR + - AES128CCM16 - AES128CCM64 - AES192CCM64 - AES256CCM64 @@ -1301,8 +1372,10 @@ components: - AES128CCM128 - AES192CCM128 - AES256CCM128 + - AES128GCM16 - AES128GCM64 - AES192GCM64 + - AES256GCM16 - AES256GCM64 - AES128GCM96 - AES192GCM96 @@ -1342,11 +1415,116 @@ components: - AES128GMAC - AES192GMAC - AES256GMAC + - NONE type: string required: - hash - encryption - dh_groups + ResponderSaseProposals: + properties: + dh_group: + description: Dh Group + items: + description: Dh Group + enum: + - NONE + - MODP768 + - MODP1024 + - MODP1536 + - MODP2048 + - MODP3072 + - MODP4096 + - MODP6144 + - MODP8192 + - MODP1024S160 + - MODP2048S224 + - MODP2048S256 + - ECP192 + - ECP224 + - ECP256 + - ECP384 + - ECP521 + - ECP224BP + - ECP256BP + - ECP384BP + - ECP512BP + - CURVE25519 + type: string + type: array + encryption: + description: 'The encryption values. + + ' + items: + description: Encryption + enum: + - NONE + - AES128 + - AES192 + - AES256 + - AES128CTR + - AES192CTR + - AES256CTR + - AES128CCM16 + - AES128CCM64 + - AES192CCM64 + - AES256CCM64 + - AES128CCM96 + - AES192CCM96 + - AES256CCM96 + - AES128CCM128 + - AES192CCM128 + - AES256CCM128 + - AES128GCM16 + - AES128GCM64 + - AES192GCM64 + - AES256GCM16 + - AES256GCM64 + - AES128GCM96 + - AES192GCM96 + - AES256GCM96 + - AES128GCM128 + - AES192GCM128 + - AES256GCM128 + - AES128GMAC + - AES192GMAC + - AES256GMAC + - TRIPLEDES + - BLOWFISH128 + - BLOWFISH192 + - BLOWFISH256 + - CAMELLIA128 + - CAMELLIA192 + - CAMELLIA256 + - SERPENT128 + - SERPENT192 + - SERPENT256 + - TWOFISH128 + - TWOFISH192 + - TWOFISH256 + type: string + type: array + hash: + description: 'The hash values. + + ' + items: + description: Hash + enum: + - MD5 + - SHA1 + - SHA256 + - SHA384 + - SHA512 + - SHA256_96 + - AESXCBC + - AES128GMAC + - AES192GMAC + - AES256GMAC + - NONE + type: string + type: array SiteIPFixPrefixAssociation: properties: id: @@ -3575,12 +3753,12 @@ paths: summary: Update WAN Interface Label (v2.4) tags: - Network Constructs - /v3.1/api/tenants/{tenant_id}/lannetworks/query: + /v3.2/api/tenants/{tenant_id}/lannetworks/query: post: - description: Query the DB for site LAN networks that match query parameters. - operationId: post-v3.1-api-tenants-tenant_id-lannetworks-query + description: Query db for Site LAN networks that match query parameters + operationId: post-v3.2-api-tenants-tenant_id-lannetworks-query parameters: - - description: The ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true @@ -3616,13 +3794,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Site LAN Networks (v3.1) + summary: Query db for Site LAN networks that match query parameters (v3.2) tags: - Network Constructs - /v3.1/api/tenants/{tenant_id}/sites/{site_id}/lannetworks: + /v3.2/api/tenants/{tenant_id}/sites/{site_id}/lannetworks: get: description: Get LAN networks - operationId: get-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks + operationId: get-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks parameters: - description: tenant ID in: path @@ -3648,16 +3826,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkV3N1' + $ref: '#/components/schemas/LANNetworkV3N2' type: array type: object description: Successful Operation - summary: Get LAN networks (v3.1) + summary: Get LAN networks (v3.2) tags: - Network Constructs post: description: Create a new LAN - operationId: post-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks + operationId: post-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks parameters: - description: tenant ID in: path @@ -3677,14 +3855,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N1' + $ref: '#/components/schemas/LANNetworkScreenV3N2' description: Details of the network to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N1' + $ref: '#/components/schemas/LANNetworkV3N2' description: Successful Operation '400': content: @@ -3704,16 +3882,20 @@ paths: - code: DEFAULT_ROUTER_PREFIX_MISMATCH - code: SAME_IPV4_DEFAULT_ROUTER_ADDRESS - code: LAN_NETWORK_ADD_FAILURE + - code: INVALID_IPV6_PREFIX + - code: NO_LAN_NET_V6_PREFIX + - code: DEFAULT_ROUTER_V6_EXCEEDS_LIMIT + - code: SAME_IPV6_PREFIX schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create a new LAN (v3.1) + summary: Create a new LAN (v3.2) tags: - Network Constructs - /v3.1/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/query: + /v3.2/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/query: post: description: Query LAN networks that match query parameters. - operationId: post-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks-query + operationId: post-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks-query parameters: - description: The ID of the tenant. in: path @@ -3744,17 +3926,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkQueryFilterV3N1' + $ref: '#/components/schemas/LANNetworkQueryFilterV3N2' type: array type: object description: Successful Operation - summary: Query LAN Networks (v3.1) + summary: Query LAN Networks (v3.2) tags: - Network Constructs - /v3.1/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/{lannetwork_id}: + /v3.2/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/{lannetwork_id}: delete: description: Delete an existing LAN network. - operationId: delete-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + operationId: delete-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the tenant. in: path @@ -3782,7 +3964,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N1' + $ref: '#/components/schemas/LANNetworkV3N2' description: Successful Operation '400': content: @@ -3795,12 +3977,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete LAN Network (v3.1) + summary: Delete LAN Network (v3.2) tags: - Network Constructs get: description: List a LAN network. - operationId: get-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + operationId: get-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the tenant. in: path @@ -3828,14 +4010,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N1' + $ref: '#/components/schemas/LANNetworkV3N2' description: Successful Operation - summary: Get LAN Network (v3.1) + summary: Get LAN Network (v3.2) tags: - Network Constructs put: description: Update an existing LAN network. - operationId: put-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + operationId: put-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the tenant. in: path @@ -3862,14 +4044,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N1' + $ref: '#/components/schemas/LANNetworkScreenV3N2' description: Details of the network to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N1' + $ref: '#/components/schemas/LANNetworkV3N2' description: Successful Operation '400': content: @@ -3890,16 +4072,20 @@ paths: - code: SAME_IPV4_DEFAULT_ROUTER_ADDRESS - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE - code: OVERLAPPING_LAN_NET_PREFIXES + - code: INVALID_IPV6_PREFIX + - code: NO_LAN_NET_V6_PREFIX + - code: DEFAULT_ROUTER_V6_EXCEEDS_LIMIT + - code: SAME_IPV6_PREFIX schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update LAN Network (v3.1) + summary: Update LAN Network (v3.2) tags: - Network Constructs - /v3.2/api/tenants/{tenant_id}/lannetworks/query: + /v3.3/api/tenants/{tenant_id}/lannetworks/query: post: description: Query db for Site LAN networks that match query parameters - operationId: post-v3.2-api-tenants-tenant_id-lannetworks-query + operationId: post-v3.3-api-tenants-tenant_id-lannetworks-query parameters: - description: Tenant Id in: path @@ -3937,13 +4123,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query db for Site LAN networks that match query parameters (v3.2) + summary: Query db for Site LAN networks that match query parameters (v3.3) tags: - Network Constructs - /v3.2/api/tenants/{tenant_id}/sites/{site_id}/lannetworks: + /v3.3/api/tenants/{tenant_id}/sites/{site_id}/lannetworks: get: description: Get LAN networks - operationId: get-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks + operationId: get-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks parameters: - description: tenant ID in: path @@ -3969,16 +4155,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3N3' type: array type: object description: Successful Operation - summary: Get LAN networks (v3.2) + summary: Get LAN networks (v3.3) tags: - Network Constructs post: description: Create a new LAN - operationId: post-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks + operationId: post-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks parameters: - description: tenant ID in: path @@ -3998,14 +4184,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N2' + $ref: '#/components/schemas/LANNetworkScreenV3N3' description: Details of the network to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3N3' description: Successful Operation '400': content: @@ -4032,13 +4218,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create a new LAN (v3.2) + summary: Create a new LAN (v3.3) tags: - Network Constructs - /v3.2/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/query: + /v3.3/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/query: post: description: Query LAN networks that match query parameters. - operationId: post-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks-query + operationId: post-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks-query parameters: - description: The ID of the tenant. in: path @@ -4069,17 +4255,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkQueryFilterV3N2' + $ref: '#/components/schemas/LANNetworkQueryFilterV3N3' type: array type: object description: Successful Operation - summary: Query LAN Networks (v3.2) + summary: Query LAN Networks (v3.3) tags: - Network Constructs - /v3.2/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/{lannetwork_id}: + /v3.3/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/{lannetwork_id}: delete: description: Delete an existing LAN network. - operationId: delete-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + operationId: delete-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the tenant. in: path @@ -4107,7 +4293,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3N3' description: Successful Operation '400': content: @@ -4120,12 +4306,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete LAN Network (v3.2) + summary: Delete LAN Network (v3.3) tags: - Network Constructs get: description: List a LAN network. - operationId: get-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + operationId: get-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the tenant. in: path @@ -4153,14 +4339,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3N3' description: Successful Operation - summary: Get LAN Network (v3.2) + summary: Get LAN Network (v3.3) tags: - Network Constructs put: description: Update an existing LAN network. - operationId: put-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + operationId: put-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the tenant. in: path @@ -4187,14 +4373,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N2' + $ref: '#/components/schemas/LANNetworkScreenV3N3' description: Details of the network to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3N3' description: Successful Operation '400': content: @@ -4222,7 +4408,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update LAN Network (v3.2) + summary: Update LAN Network (v3.3) tags: - Network Constructs servers: diff --git a/openapi-specs/sdwan/legacy/PathPolicy.yaml b/openapi-specs/sdwan/legacy/PathPolicy.yaml index 1b39356a6..67b42c541 100644 --- a/openapi-specs/sdwan/legacy/PathPolicy.yaml +++ b/openapi-specs/sdwan/legacy/PathPolicy.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,47 +44,46 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BasePolicyRule: properties: description: - description: 'The description of the network policy rule. Max size = 256. + description: 'The description of the policy rule. Max size = 256. ' disabled: - description: "Lists if the network policy rules are disabled. \n" + description: "Lists if the policy rules are disabled. \n" type: boolean disabled_reason: - description: 'Reason the network policy rule is disabled. + description: 'Reason the policy rule is disabled. ' type: string id: - description: 'The network policy rule ID. + description: 'The policy rule ID. ' type: string inactive: - description: 'Lists if the network policy rule is inactive. + description: 'Lists if the policy rule is inactive. ' type: boolean inactive_reason: - description: 'Reason the network policy rule is inactive. + description: 'Reason the policy rule is inactive. ' type: string name: - description: 'The name of the network policy rule. + description: 'The name of the policy rule. ' type: string policyset_id: - description: 'The ID of the network policy set. + description: 'The ID of the policy set. ' type: string @@ -99,8 +93,8 @@ components: ' type: string tags: - description: 'A information field that can be added to identify the network - policy rule. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the policy + rule. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -305,19 +299,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -343,7 +337,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -352,18 +346,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -1059,7 +1053,9 @@ components: type: string type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string required: - name @@ -1183,7 +1179,9 @@ components: type: string type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string required: - defaultrule_policyset_id @@ -1270,9 +1268,7 @@ components: $ref: '#/components/schemas/WANPath' type: array l3_failure_paths: - description: 'The configured l3 failure path for the rule. - - ' + description: "The configured l3 failure path for the rule. \n" items: $ref: '#/components/schemas/WANPath' type: array @@ -1295,8 +1291,9 @@ components: $ref: '#/components/schemas/WANPath' type: array l3_failure_paths: - description: "The configured l3 failure path for the rule. \ - \ \n" + description: 'The configured l3 failure path for the rule. + + ' items: $ref: '#/components/schemas/WANPath' type: array @@ -1600,7 +1597,9 @@ components: description: "The IP Prefix ID that associates with a site. \n" type: string site_id: - description: "The site ID binding the prefix. \n" + description: 'The site ID binding the prefix. + + ' type: string tags: description: 'A information field that can be added to identify the site @@ -3184,7 +3183,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Network Policy Rules (v2.2) + summary: Query Network Policy Rules (v2.1) tags: - Path Policy /v2.1/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/networkpolicyrules: @@ -3215,7 +3214,7 @@ paths: $ref: '#/components/schemas/NetworkPolicyRuleV2N1' type: array description: Successful Operation - summary: Get Network Policy Rules (v2.2) + summary: Get Network Policy Rules (v2.1) tags: - Path Policy post: @@ -3283,7 +3282,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Network Policy Rule (v2.2) + summary: Create Network Policy Rule (v2.1) tags: - Path Policy /v2.1/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/networkpolicyrules/{policy_rule_id}: @@ -3930,7 +3929,7 @@ paths: schema: description: Policy Set Id type: string - - description: ID of the network policy rule. + - description: Policy rule Id in: path name: policy_rule_id required: true diff --git a/openapi-specs/sdwan/legacy/PathPolicyOriginal.yaml b/openapi-specs/sdwan/legacy/PathPolicyOriginal.yaml index 335df96e9..4b9e8a2a2 100644 --- a/openapi-specs/sdwan/legacy/PathPolicyOriginal.yaml +++ b/openapi-specs/sdwan/legacy/PathPolicyOriginal.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BandwidthAllocationScheme: properties: bandwidth_range: @@ -147,19 +141,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -185,7 +179,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -194,18 +188,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -227,9 +221,7 @@ components: $ref: '#/components/schemas/WANPath' type: array l3_failure_paths: - description: 'The configured l3 failure path for the rule. - - ' + description: "The configured l3 failure path for the rule. \n" items: $ref: '#/components/schemas/WANPath' type: array @@ -334,7 +326,9 @@ components: $ref: '#/components/schemas/SiteWanPath' type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string required: - paths_allowed diff --git a/openapi-specs/sdwan/legacy/PerformancePolicy.yaml b/openapi-specs/sdwan/legacy/PerformancePolicy.yaml new file mode 100644 index 000000000..f2a72de19 --- /dev/null +++ b/openapi-specs/sdwan/legacy/PerformancePolicy.yaml @@ -0,0 +1,1920 @@ +components: + schemas: + Aggregate: + properties: + data: + description: 'The details of the aggregate data. + + ' + items: + $ref: '#/components/schemas/AggregateData' + type: array + field: + description: Field + type: string + name: + description: 'The name of the query response. + + ' + type: string + operator: + description: Operator + enum: + - max + - count + - min + - avg + - sum + type: string + statistic: + description: 'QoS application aggregate statistics. + + ' + type: string + unit: + description: 'The unit. + + ' + type: string + AggregateData: + properties: + value: + description: 'Value of the aggregate data. + + ' + type: number + view: + description: 'View the aggregate date. + + ' + type: object + ApplicationFilter: + properties: + app_transfer_types: + description: 'Lists the app transfer types. Maximum 4 app transfer types + are supported. + + ' + items: + description: App Transfer Types + enum: + - RT_AUDIO + - RT_VIDEO + - TRANSACTIONAL + - BULK + type: string + type: array + application_ids: + description: 'Lists the application IDs in a rule. Maximum 64 applications + can be specified in a rule. + + ' + items: + description: Application Ids + type: string + type: array + BasePolicyRule: + properties: + description: + description: 'The description of the policy rule. Max size = 256. + + ' + disabled: + description: "Lists if the policy rules are disabled. \n" + type: boolean + disabled_reason: + description: 'Reason the policy rule is disabled. + + ' + type: string + id: + description: 'The policy rule ID. + + ' + type: string + inactive: + description: 'Lists if the policy rule is inactive. + + ' + type: boolean + inactive_reason: + description: 'Reason the policy rule is inactive. + + ' + type: string + name: + description: 'The name of the policy rule. + + ' + type: string + policyset_id: + description: 'The ID of the policy set. + + ' + type: string + region: + description: 'The region of the site. + + ' + type: string + tags: + description: 'A information field that can be added to identify the policy + rule. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + type: string + required: + - name + - tenant_id + Error: + properties: + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + type: string + message: + type: string + LQMThresholdConfig: + properties: + max_jitter: + description: 'The max jitter threshold range. Max = 100L. + + ' + type: integer + max_latency: + description: 'The max latency threshold range. Max = 500L. + + ' + type: integer + max_packet_loss: + description: 'The max packet loss threshold range. Max = 20L. + + ' + type: integer + ListQueryResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + deleted_count: + description: 'The deleted number. + + ' + format: int64 + type: integer + deleted_ids: + description: 'The deleted IDs. + + ' + items: + type: string + type: array + description: + description: 'Description of the query. Max size = 256. + + ' + id: + description: 'The ID. + + ' + type: string + next_query: + description: 'Details of the next query. + + ' + type: object + tenant_id: + description: 'The tenant ID. + + ' + type: string + total_count: + description: 'Total number. + + ' + format: int64 + type: integer + type: object + ListResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + id: + description: 'The ID. + + ' + type: string + tenant_id: + description: 'The tenant ID. + + ' + type: string + type: object + PathFilter: + properties: + label: + description: 'The policy rule path label. + + ' + type: string + path_type: + description: 'The path type specified in the path filter. + + ' + enum: + - vpn + - direct + - servicelink + - all + type: string + required: + - path_type + PerfMgmtAction: + properties: + action_type: + description: 'The values of the action type for the performance policy rule. + + ' + enum: + - RAISE_ALARM + - MOVE_FLOWS + - FEC + - VISIBILITY + type: string + app_perf: + $ref: '#/components/schemas/PerfMgmtActionParameters' + description: 'The details of the application performance parameters. + + ' + lqm_perf: + $ref: '#/components/schemas/PerfMgmtActionParameters' + description: 'The details of the LQM performance parameters. + + ' + required: + - action_type + PerfMgmtActionParameters: + properties: + bad_health_thresholds: + $ref: '#/components/schemas/PerfMgmtHealthThresholds' + description: 'Lists the valid / invalid performance policy rules thresholds. + + ' + monitoring_approach: + description: 'The monitoring approach for the rule. + + ' + enum: + - AGGRESSIVE + - MODERATE + - CONSERVATIVE + type: string + required: + - monitoring_approach + PerfMgmtHealthThresholds: + properties: + clear_below: + description: 'The clear_below value should be between 1-80L. + + ' + format: int32 + type: integer + raise_above: + description: 'The raise_above value should be between 10-100L. + + ' + format: int32 + type: integer + PerfMgmtPolicyRule: + properties: + actions: + description: 'The valid actions configured for the performance policy rule. + + ' + items: + $ref: '#/components/schemas/PerfMgmtAction' + type: array + app_filters: + $ref: '#/components/schemas/ApplicationFilter' + description: 'The details of the app filters used for the performance policy + rule. + + ' + description: + description: 'The description of the performance policy rule. Max characters + = 256. + + ' + enabled: + description: 'Lists if the performance policy rule is enabled. + + ' + type: boolean + id: + description: 'Lists the performance policy rules by ID. + + ' + type: string + name: + description: 'The name of the performance policy rule. + + ' + type: string + path_filters: + description: 'Lists the path filters applied. Maximum 32 path filters are + supported. + + ' + items: + $ref: '#/components/schemas/PathFilter' + type: array + service_label_ids: + description: 'Lists the service label IDs. Maximum 32 service labels are + supported. + + ' + items: + description: Service Label Ids + type: string + type: array + tags: + description: 'A information field that can be added to identify the performance + policy rule. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + thresholdprofile_id: + description: 'Lists the threshold profile IDs. + + ' + type: string + type: + description: 'The type of performance policy rule. + + ' + enum: + - APP_CIRCUIT_HEALTH + type: string + required: + - type + - name + PerfMgmtPolicyRuleQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of performance policy rules that match + the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number performance policy rules deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the performance policy rules for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the performance policy rules by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + description: 'Query using query parameters. + + ' + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + PerfMgmtPolicyRuleQueryFilter: + properties: + actions: + description: 'The valid actions configured for the performance policy rule. + + ' + items: + $ref: '#/components/schemas/PerfMgmtAction' + type: array + app_filters: + $ref: '#/components/schemas/ApplicationFilter' + description: 'The details of the app filters used for the performance policy + rule. + + ' + description: + description: 'The description of the performance policy rule. Max characters + = 256. + + ' + enabled: + description: 'Lists if the performance policy rule is enabled. + + ' + type: boolean + id: + description: 'Lists the performance policy rules by ID. + + ' + type: string + name: + description: 'The name of the performance policy rule. + + ' + type: string + path_filters: + description: 'Lists the path filters applied. Maximum 32 path filters are + supported. + + ' + items: + $ref: '#/components/schemas/PathFilter' + type: array + service_label_ids: + description: 'Lists the service label IDs. Maximum 32 service labels are + supported. + + ' + items: + description: Service Label Ids + type: string + type: array + tags: + description: 'A information field that can be added to identify the performance + policy rule. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + thresholdprofile_id: + description: 'Lists the threshold profile IDs. + + ' + type: string + type: + description: 'The type of performance policy rule. + + ' + enum: + - APP_CIRCUIT_HEALTH + type: string + required: + - type + - name + PerfMgmtPolicySet: + properties: + clone_from: + description: 'The performance policy set that has been cloned from. + + ' + type: string + defaultrule_policyset: + description: "The default rule of the policy set. \n" + type: boolean + description: + description: 'The description of the performance policy set. Max size = + 256. + + ' + disabled: + description: "Lists if the performance policy sets are disabled. \n" + type: boolean + disabled_reason: + description: 'Reason the performance policy set is disabled. + + ' + type: string + id: + description: 'The ID of the policy set. + + ' + type: string + inactive: + description: 'Lists if the performance policy set is inactive. + + ' + type: boolean + inactive_reason: + description: "Reason the performance policy set is inactive. \n" + type: string + link_health_policyrule_order: + description: "The order of the policy rule. \n" + items: + description: Link Health Policyrule Order + type: string + type: array + link_health_rules: + description: 'The details of the policy rule. + + ' + items: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + type: array + name: + description: 'The name of the performance policy set. Max size = 128. + + ' + type: string + policy_rules: + description: 'Lists the details of the policy rules. + + ' + items: + $ref: '#/components/schemas/BasePolicyRule' + type: array + region: + description: 'The region of the site. + + ID of the DEM status. + + ' + type: string + send_to_element: + description: Send To Element + type: boolean + tags: + description: 'A information field that can be added to identify the policy + set. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tenant_id: + description: 'The tenant ID. + + ' + type: string + required: + - name + - tenant_id + PerfMgmtPolicySetStack: + properties: + default_policysetstack: + description: "The default policy set stack. \n" + type: boolean + defaultrule_policyset_id: + description: 'The ID of the default rule policy set. + + ' + type: string + description: + description: 'The description of the policy set stack. Max size = 256. + + ' + id: + description: 'The policy set stack ID. + + ' + type: string + name: + description: 'The name of the performance policy set stack. Max size = 128. + + ' + type: string + policyset_ids: + description: 'The policy set IDs.Should be between 1-4. + + ' + items: + description: Policyset Ids + type: string + type: array + tags: + description: 'A information field that can be added to identify the policy + set stack. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - defaultrule_policyset_id + - name + PerfMgmtPolicySetState: + properties: + id: + description: 'The ID of the performance policy set. + + ' + type: string + policy_req_state: + description: 'The policy required state. + + ' + enum: + - POLICY_REQ_PENDING + - POLICY_CREATE_INPROGRESS + - POLICY_CREATE_COMPLETE + - POLICY_REPLICATE + - POLICY_CREATE_FAILED + - POLICY_REQ_COMPLETE + type: string + policyset_id: + description: 'The ID of the policy set. + + ' + type: string + PerfMgmtThresholdProfile: + properties: + description: + description: 'The description of the threshold profile. Max size = 256. + + ' + disabled: + description: "Lists if the threshold profiles are disabled. \n" + type: boolean + disabled_reason: + description: 'Reason the threshold profile is disabled. + + ' + type: string + hard_limit_app_metrics: + $ref: '#/components/schemas/StaticAppMetricConfig' + description: 'The hard limits set for the app metrics. + + ' + id: + description: 'The ID of the threshold profile. + + ' + type: string + inactive: + description: 'Lists if the threshold profile is inactive. + + ' + type: boolean + inactive_reason: + description: "Reason the threshold profile is inactive. \n" + type: string + is_default: + description: 'The default threshold. + + ' + type: boolean + lqm_thresholds: + $ref: '#/components/schemas/LQMThresholdConfig' + description: 'Details of the LQM threshold configurations. + + ' + name: + description: 'The name of the profile. Max size = 128. + + ' + type: string + region: + description: 'The region of the site. + + ' + type: string + soft_limit_app_metrics: + $ref: '#/components/schemas/StaticAppMetricConfig' + description: 'The soft limits set for the app metrics. + + ' + tags: + description: 'A information field that can be added to identify the profile. + Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + type: string + required: + - name + - tenant_id + PerfMgmtThresholdProfileScreen: + properties: + description: + description: 'The description of the threshold profile. Max size = 256. + + ' + hard_limit_app_metrics: + $ref: '#/components/schemas/StaticAppMetricConfig' + description: 'The hard limits set for the app metrics. + + ' + id: + description: 'The ID of the threshold profile. + + ' + type: string + lqm_thresholds: + $ref: '#/components/schemas/LQMThresholdConfig' + description: 'Details of the LQM threshold configurations. + + ' + name: + description: 'The name of the profile. Max size = 128. + + ' + type: string + soft_limit_app_metrics: + $ref: '#/components/schemas/StaticAppMetricConfig' + description: 'The soft limits set for the app metrics. + + ' + tags: + description: 'A information field that can be added to identify the profile. + Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - hard_limit_app_metrics + - name + StaticAppMetricConfig: + properties: + max_init_failure_rate: + description: 'The max init failure rate threshold. Max = 100L. + + ' + type: integer + max_rtt: + description: 'The max rtt threshold range. Max = 500L. + + ' + type: integer +info: + contact: {} + description: List of APIs used to manage performance policy. + title: Performance Policy + version: Latest +openapi: 3.0.0 +paths: + /v2.0/api/tenants/{tenant_id}/perfmgmtpolicyrules/query: + post: + description: Query details for the performance policy rules. + operationId: post-v2.0-api-tenants-tenant_id-perfmgmtpolicyrules-query + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRuleQuery' + description: Details of the query for PERFMGMT Policy Rule + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PerfMgmtPolicyRuleQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Performance Policy Rules (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtpolicysets: + get: + description: Get details of the performance policy sets. + operationId: get-v2.0-api-tenants-tenant_id-perfmgmtpolicysets + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PerfMgmtPolicySet' + type: array + type: object + description: Successful Operation + summary: Get Performance Policy Sets (v2.0) + tags: + - Performance Policy + post: + description: Create a new performance policy set. + operationId: post-v2.0-api-tenants-tenant_id-perfmgmtpolicysets + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Details of PERFMGMT Policy Set to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: POLICY_SET_CONFIG_CREATION_FAILED + - code: PERFMGMT_SET_CONFIG_INVALID_CLONE_FROM + - code: PERFMGMT_DUPLICATE_RULES_IN_RULES_ORDER + - code: PERFMGMT_INVALID_POLICY_SET_ORDER + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Performance Policy Set (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtpolicysets/query: + post: + description: Query details for the performance policy set. + operationId: post-v2.0-api-tenants-tenant_id-perfmgmtpolicysets-query + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Details of query for PERFMGMT Policy Set + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Performance Policy Set (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtpolicysets/{id}/status: + get: + description: Get the status of the performance policy sets. + operationId: get-v2.0-api-tenants-tenant_id-perfmgmtpolicysets-id-status + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: id + required: true + schema: + description: Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetState' + description: Successful Operation + summary: Get Performance Policy Set Status (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtpolicysets/{perfmgmtpolicyset_id}: + delete: + description: Delete a performance policy set. + operationId: delete-v2.0-api-tenants-tenant_id-perfmgmtpolicysets-perfmgmtpolicyset_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: PERFMGMT_SET_IN_USE + - code: DEFAULT_POLICY_SET_CANNOT_BE_DELETED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Performance Policy Set (v2.0) + tags: + - Performance Policy + get: + description: Get a performance policy set. + operationId: get-v2.0-api-tenants-tenant_id-perfmgmtpolicysets-perfmgmtpolicyset_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Successful Operation + summary: Get Performance Policy Set (v2.0) + tags: + - Performance Policy + put: + description: Update a performance policy set. + operationId: put-v2.0-api-tenants-tenant_id-perfmgmtpolicysets-perfmgmtpolicyset_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Details of PERFMGMT Policy Set to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: POLICY_SET_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: READONLY_CLONE_FROM + - code: DEFAULT_RULES_CANNOT_BE_REMOVED_FROM_SET + - code: PERFMGMT_DEFAULT_RESOURCE_NAME_CHANGE_NOT_ALLOWED + - code: PERFMGMT_DUPLICATE_RULES_IN_RULES_ORDER + - code: PERFMGMT_INVALID_POLICY_SET_ORDER + - code: PERFMGMT_POLICY_DEFAULT_SET_UPDATE_NOT_ALLOWED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Performance Policy Set (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtpolicysets/{perfmgmtpolicyset_id}/perfmgmtpolicyrules: + get: + description: Get details of the performance policy rules of a policy set. + operationId: get-v2.0-api-tenants-tenant_id-perfmgmtpolicysets-perfmgmtpolicyset_id-perfmgmtpolicyrules + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + type: array + type: object + description: Successful Operation + summary: Get Policy Rules of Performance Policy Set (v2.0) + tags: + - Performance Policy + post: + description: Create a new performance policy rule. + operationId: post-v2.0-api-tenants-tenant_id-perfmgmtpolicysets-perfmgmtpolicyset_id-perfmgmtpolicyrules + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Details of PERFMGMT Policy Rule to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: PERFMGMT_INVALID_PATH_TYPE + - code: PERFMGMT_INVALID_APP_TRANSFER_TYPE + - code: PERFMGMT_INVALID_ACTION_TYPE + - code: PERFMGMT_INVALID_MONITORING_APPROACH + - code: PERFMGMT_INVALID_RAISE_ABOVE + - code: PERFMGMT_INVALID_CLEAR_BELOW + - code: PERFMGMT_RULE_THRESHOLD_CLEAR_BELOW_INVALID + - code: PERFMGMT_INVALID_SERVICE_LABEL_IDS + - code: PERFMGMT_INVALID_THRESHOLD_PROFILE_ID + - code: PERFMGMT_POLICY_RULE_NOT_PRESENT + - code: PERFMGMT_MISSING_THRESHOLD_PROFILE_ID + - code: PERFMGMT_RULE_MISSING_ACTIONS + - code: PERFMGMT_RULE_LQM_THRESHOLD_MISSING + - code: PERFMGMT_RULE_APP_THRESHOLD_MISSING + - code: PERFMGMT_RULE_APP_PERF_BAD_HEALTH_THRESHOLD_MISSING + - code: PERFMGMT_RULE_MISSING_ACTION_TYPE + - code: PERFMGMT_RULE_APP_FILTER_AND_APP_THRESHOLDS_NOT_ALLOWED + - code: PERFMGMT_RULE_THRESHOLDS_MISSING + - code: PERFMGMT_RULE_APP_FILTER_MISSING + - code: PERFMGMT_RULE_INVALID_APP_FILTER + - code: PERFMGMT_INVALID_APPLICATION_IDS + - code: PERFMGMT_RULE_DUPLICATE_APPLICATION_IDS + - code: PERFMGMT_RULE_DUPLICATE_SERVICE_LABEL_IDS + - code: PERFMGMT_RULE_DUPLICATE_APP_TRANSFER_TYPES + - code: PERFMGMT_RULE_DUPLICATE_PATH_TYPE_IN_PATH_FILTERS + - code: PERFMGMT_RULE_DUPLICATE_LABEL_IN_PATH_FILTERS + - code: PERFMGMT_RULE_DUPLICATE_ACTION_TYPE + - code: PERFMGMT_INVALID_RULE_TYPE + - code: PERFMGMT_APP_TRANSFER_TYPE_LIST_SIZE_EXCEEDED + - code: PERFMGMT_PATH_FILTERS_LIST_SIZE_EXCEEDED + - code: PERFMGMT_APP_FILTER_MANDATORY_FOR_APP_THRESHOLDS + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY + - code: PERFMGMT_RULE_EXCEEDS_MAX_LIMIT + - code: PERFMGMT_RULE_DUPLICATE_PATH_LABEL_PATH_TYPE_IN_PATH_FILTERS + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY_FOR_ACTION_FEC + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY_FOR_ACTION_MOVE_FLOWS + - code: PERFMGMT_RULE_LQM_THRESHOLDS_REQUIRED_FOR_VISIBILITY + - code: PERFMGMT_RULE_VISIBILITY_APP_FILTERS_PROHIBITED + - code: PERFMGMT_RULE_FEC_APP_THRESHOLDS_PROHIBITED + - code: PERFMGMT_RULE_THRESHOLDS_MISSING_FOR_APP_PERF + - code: PERFMGMT_RULE_APP_FILTER_MISSING_FOR_APP_PERF + - code: PERFMGMT_RULE_LQM_THRESHOLD_MISSING_FOR_LQM_PERF + - code: PERFMGMT_RULE_LQM_PERF_APP_PERF_NOT_ALLOWED + - code: PERFMGMT_SERVICE_LABELS_NOT_ALLOWED_FOR_DIRECT_PATHS + - code: PERFMGMT_RULE_CANNOT_BE_CREATED_FOR_DEFAULT_SET + - code: APP_DEF_ID_LIST_SIZE_EXCEEDED_64 + - code: SERVICE_LABEL_ID_LIST_SIZE_EXCEEDED + - code: PERFMGMT_RULE_OVERLAPPING_PATH_FILTERS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Performance Policy Rule (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtpolicysets/{perfmgmtpolicyset_id}/perfmgmtpolicyrules/{perfmgmtpolicyrule_id}: + delete: + description: Delete a performance policy rule of the tenant. + operationId: delete-v2.0-api-tenants-tenant_id-perfmgmtpolicysets-perfmgmtpolicyset_id-perfmgmtpolicyrules-perfmgmtpolicyrule_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + - description: The performance policy rule ID. + in: path + name: perfmgmtpolicyrule_id + required: true + schema: + description: Perfmgmtpolicyrule Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: PERFMGMT_SET_NOT_FOUND + - code: PERFMGMT_POLICY_RULE_IN_USE + - code: DEFAULT_POLICY_RULE_CANNOT_BE_DELETED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Performance Policy Rule (v2.0) + tags: + - Performance Policy + get: + description: Get a specific performance policy rule of the tenant. + operationId: get-v2.0-api-tenants-tenant_id-perfmgmtpolicysets-perfmgmtpolicyset_id-perfmgmtpolicyrules-perfmgmtpolicyrule_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + - description: The performance policy rule ID. + in: path + name: perfmgmtpolicyrule_id + required: true + schema: + description: Perfmgmtpolicyrule Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Successful Operation + summary: Get Performance Policy Rule (v2.0) + tags: + - Performance Policy + put: + description: Update a performance policy rule of the tenant. + operationId: put-v2.0-api-tenants-tenant_id-perfmgmtpolicysets-perfmgmtpolicyset_id-perfmgmtpolicyrules-perfmgmtpolicyrule_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + - description: The performance policy rule ID. + in: path + name: perfmgmtpolicyrule_id + required: true + schema: + description: Perfmgmtpolicyrule Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Details of PERFMGMT Policy Rule to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: PERFMGMT_INVALID_PATH_TYPE + - code: PERFMGMT_INVALID_APP_TRANSFER_TYPE + - code: PERFMGMT_INVALID_ACTION_TYPE + - code: PERFMGMT_INVALID_MONITORING_APPROACH + - code: PERFMGMT_INVALID_RAISE_ABOVE + - code: PERFMGMT_INVALID_CLEAR_BELOW + - code: PERFMGMT_RULE_THRESHOLD_CLEAR_BELOW_INVALID + - code: PERFMGMT_INVALID_SERVICE_LABEL_IDS + - code: PERFMGMT_INVALID_THRESHOLD_PROFILE_ID + - code: PERFMGMT_POLICY_RULE_NOT_PRESENT + - code: PERFMGMT_MISSING_THRESHOLD_PROFILE_ID + - code: PERFMGMT_RULE_MISSING_ACTIONS + - code: PERFMGMT_RULE_LQM_THRESHOLD_MISSING + - code: PERFMGMT_RULE_APP_THRESHOLD_MISSING + - code: PERFMGMT_RULE_APP_PERF_BAD_HEALTH_THRESHOLD_MISSING + - code: PERFMGMT_RULE_MISSING_ACTION_TYPE + - code: PERFMGMT_RULE_APP_FILTER_AND_APP_THRESHOLDS_NOT_ALLOWED + - code: PERFMGMT_RULE_THRESHOLDS_MISSING + - code: PERFMGMT_RULE_APP_FILTER_MISSING + - code: PERFMGMT_RULE_INVALID_APP_FILTER + - code: PERFMGMT_INVALID_APPLICATION_IDS + - code: PERFMGMT_RULE_DUPLICATE_APPLICATION_IDS + - code: PERFMGMT_RULE_DUPLICATE_SERVICE_LABEL_IDS + - code: PERFMGMT_RULE_DUPLICATE_APP_TRANSFER_TYPES + - code: PERFMGMT_RULE_DUPLICATE_PATH_TYPE_IN_PATH_FILTERS + - code: PERFMGMT_RULE_DUPLICATE_LABEL_IN_PATH_FILTERS + - code: PERFMGMT_RULE_DUPLICATE_ACTION_TYPE + - code: PERFMGMT_DEFAULT_RESOURCE_NAME_CHANGE_NOT_ALLOWED + - code: PERFMGMT_DEFAULT_RULE_MATCH_CRITERIA_CHANGE_NOT_ALLOWED + - code: PERFMGMT_ACTION_CANNOT_BE_REMOVED_FROM_DEFAULT_RULE + - code: PERFMGMT_INVALID_RULE_TYPE + - code: PERFMGMT_APP_TRANSFER_TYPE_LIST_SIZE_EXCEEDED + - code: PERFMGMT_PATH_FILTERS_LIST_SIZE_EXCEEDED + - code: PERFMGMT_APP_FILTER_MANDATORY_FOR_APP_THRESHOLDS + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY + - code: PERFMGMT_RULE_EXCEEDS_MAX_LIMIT + - code: PERFMGMT_RULE_DUPLICATE_PATH_LABEL_PATH_TYPE_IN_PATH_FILTERS + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY_FOR_ACTION_FEC + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY_FOR_ACTION_MOVE_FLOWS + - code: PERFMGMT_RULE_LQM_THRESHOLDS_REQUIRED_FOR_VISIBILITY + - code: PERFMGMT_RULE_VISIBILITY_APP_FILTERS_PROHIBITED + - code: PERFMGMT_RULE_FEC_APP_THRESHOLDS_PROHIBITED + - code: PERFMGMT_RULE_THRESHOLDS_MISSING_FOR_APP_PERF + - code: PERFMGMT_RULE_APP_FILTER_MISSING_FOR_APP_PERF + - code: PERFMGMT_RULE_LQM_THRESHOLD_MISSING_FOR_LQM_PERF + - code: PERFMGMT_RULE_TYPE_CHANGE_NOT_ALLOWED + - code: PERFMGMT_RULE_LQM_PERF_APP_PERF_NOT_ALLOWED + - code: PERFMGMT_CANNOT_SET_APP_METRICS_APP_FILTER_MISSING + - code: PERFMGMT_SERVICE_LABELS_NOT_ALLOWED_FOR_DIRECT_PATHS + - code: PERFMGMT_DEFAULT_RULE_CANNOT_BE_DISABLED + - code: APP_DEF_ID_LIST_SIZE_EXCEEDED_64 + - code: SERVICE_LABEL_ID_LIST_SIZE_EXCEEDED + - code: PERFMGMT_RULE_OVERLAPPING_PATH_FILTERS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Performance Policy Rule (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtpolicysetstacks: + get: + description: Get all the performance policy set stacks. + operationId: get-v2.0-api-tenants-tenant_id-perfmgmtpolicysetstacks + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + type: array + type: object + description: Successful Operation + summary: Get Performance Policy Set Stacks (v2.0) + tags: + - Performance Policy + post: + description: Create a new performance policy set stack. + operationId: post-v2.0-api-tenants-tenant_id-perfmgmtpolicysetstacks + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Details of PERFMGMT Policy Set Stack to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: POLICYSETSTACK_CONFIG_DUPLICATE_POLICYSETID + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_IDS + - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_STATE + - code: PERFMGMT_STACKS_EXCEEDS_MAX_LIMIT_FOR_SETS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Performance Policy Set Stack (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtpolicysetstacks/query: + post: + description: Query details for the performance policy set stack. + operationId: post-v2.0-api-tenants-tenant_id-perfmgmtpolicysetstacks-query + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Details of query for PERFMGMT Policy Set Stack + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Performance Policy Set Stack (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtpolicysetstacks/{id}: + delete: + description: Delete a performance policy set stack. + operationId: delete-v2.0-api-tenants-tenant_id-perfmgmtpolicysetstacks-id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: id + required: true + schema: + description: Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEFAULT_POLICYSETSTACK_CAN_NOT_BE_DELETED + - code: POLICYSETSTACK_IN_USE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Performance Policy Set Stack (v2.0) + tags: + - Performance Policy + get: + description: Get a performance set stack. + operationId: get-v2.0-api-tenants-tenant_id-perfmgmtpolicysetstacks-id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: id + required: true + schema: + description: Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Successful Operation + summary: Get Performance Policy Set Stack (v2.0) + tags: + - Performance Policy + put: + description: Update a performance policy set stack. + operationId: put-v2.0-api-tenants-tenant_id-perfmgmtpolicysetstacks-id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The performance policy set ID. + in: path + name: id + required: true + schema: + description: Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Details of PERFMGMT Policy Set Stack to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: POLICYSETSTACK_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: DEFAULT_POLICY_SET_CANNOT_BE_REMOVED_FROM_DEFAULT_STACK + - code: PERFMGMT_DEFAULT_RESOURCE_NAME_CHANGE_NOT_ALLOWED + - code: DEFAULT_POLICYSET_STACK_EXISTS + - code: POLICYSETSTACK_CONFIG_DUPLICATE_POLICYSETID + - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_IDS + - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_STATE + - code: PERFMGMT_STACKS_EXCEEDS_MAX_LIMIT_FOR_SETS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Performance Policy Set Stack (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtthresholdprofiles: + get: + description: Get details of the threshold profile list. + operationId: get-v2.0-api-tenants-tenant_id-perfmgmtthresholdprofiles + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + type: array + type: object + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Successful Operation + summary: Get Threshold Profile List (v2.0) + tags: + - Performance Policy + post: + description: Create a new threshold profile. + operationId: post-v2.0-api-tenants-tenant_id-perfmgmtthresholdprofiles + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfileScreen' + description: Details of the Threshold profile to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_VALUE + - code: PERFMGMT_HARD_LIMIT_APP_METRICS_REQUIRED + - code: PERFMGMT_MAX_INIT_FAILURE_RATE_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_LATENCY_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_JITTER_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_PACKET_LOSS_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_RTT_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_LQM + - code: PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_APP_METRICS + - code: PERFMGMT_LQM_OR_APP_THREHOLDS_EXPECTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Threshold Profile (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtthresholdprofiles/query: + post: + description: Query the DB for limit number of tenant level threshold profiles + that match the query params. + operationId: post-v2.0-api-tenants-tenant_id-perfmgmtthresholdprofiles-query + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Query Details for Threshold profile + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Tenant Level Threshold Profiles (v2.0) + tags: + - Performance Policy + /v2.0/api/tenants/{tenant_id}/perfmgmtthresholdprofiles/{profile_id}: + delete: + description: Delete a threshold profile. + operationId: delete-v2.0-api-tenants-tenant_id-perfmgmtthresholdprofiles-profile_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The threshold ID. + in: path + name: profile_id + required: true + schema: + description: Profile Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: PERFMGMT_THRESHOLD_PROFILE_IN_USE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Threshold Profile (v2.0) + tags: + - Performance Policy + get: + description: Get a threshold profile. + operationId: get-v2.0-api-tenants-tenant_id-perfmgmtthresholdprofiles-profile_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The threshold ID. + in: path + name: profile_id + required: true + schema: + description: Profile Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Successful Operation + summary: Get Threshold Profile (v2.0) + tags: + - Performance Policy + put: + description: Update a threshold profile. + operationId: put-v2.0-api-tenants-tenant_id-perfmgmtthresholdprofiles-profile_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The threshold ID. + in: path + name: profile_id + required: true + schema: + description: Profile Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfileScreen' + description: Details of the Threshold profile to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_VALUE + - code: PERFMGMT_HARD_LIMIT_APP_METRICS_REQUIRED + - code: PERFMGMT_MAX_INIT_FAILURE_RATE_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_LATENCY_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_JITTER_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_PACKET_LOSS_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_RTT_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_LQM + - code: PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_APP_METRICS + - code: PERFMGMT_CANNOT_UNSET_LQM_THRESHOLD_PROFILE_IN_USE + - code: PERFMGMT_CANNOT_SET_APP_METRICS_APP_FILTER_MISSING + - code: PERFMGMT_DEFAULT_RESOURCE_NAME_CHANGE_NOT_ALLOWED + - code: PERFMGMT_DEFAULT_THRESHOLD_PROFILE_LQM_UNSET_NOT_ALLOWED + - code: PERFMGMT_LQM_OR_APP_THREHOLDS_EXPECTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Threshold Profile (v2.0) + tags: + - Performance Policy +servers: +- url: https://api.us.cloudgenix.com +tags: +- name: Performance Policy diff --git a/openapi-specs/sdwan/legacy/PrismaAccessConfigs.yaml b/openapi-specs/sdwan/legacy/PrismaAccessConfigs.yaml index de70240f7..20e07e055 100644 --- a/openapi-specs/sdwan/legacy/PrismaAccessConfigs.yaml +++ b/openapi-specs/sdwan/legacy/PrismaAccessConfigs.yaml @@ -15,19 +15,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -53,7 +53,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -79,7 +79,7 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: "The tenant ID. \n" type: string required: - site_id @@ -104,13 +104,19 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: "The tenant ID. \n" type: string required: - site_id - tenant_id RemoteNetwork: properties: + edge_location_display: + description: Edge Location Display + type: string + edge_location_value: + description: Edge Location Value + type: string remote_network_names: description: 'The names of the remote networks. @@ -119,6 +125,12 @@ components: description: Remote Network Names type: string type: array + service_link_ids: + description: Service Link Ids + items: + description: Service Link Ids + type: string + type: array spn_name: description: 'The SPN (Security Processing Name) of the prisma access config. @@ -128,7 +140,7 @@ components: - spn_name info: contact: {} - description: No description available. + description: List of APIs that are used for Prisma Access configuration. title: Prisma Access Configs version: Latest openapi: 3.0.0 diff --git a/openapi-specs/sdwan/legacy/QOSPolicy.yaml b/openapi-specs/sdwan/legacy/QOSPolicy.yaml index 1ec896289..be141ba95 100644 --- a/openapi-specs/sdwan/legacy/QOSPolicy.yaml +++ b/openapi-specs/sdwan/legacy/QOSPolicy.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BandwidthAllocationSchemeV2: properties: bandwidth_range: @@ -318,10 +312,9 @@ components: ' type: string tags: - description: 'A information field that can be added to identify the priority - policy global prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' + description: "A information field that can be added to identify the priority\ + \ policy global prefix. Maximum 10 unique tags of length 1024 each are\ + \ allowed. \n" items: description: Tags type: string @@ -331,19 +324,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -369,7 +362,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -378,18 +371,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -634,9 +627,10 @@ components: ' type: string tags: - description: "A information field that can be added to identify the priority\ - \ policy rule. Maximum 10 unique tags of length 1024 each are allowed.\ - \ \n" + description: 'A information field that can be added to identify the priority + policy rule. Maximum 10 unique tags of length 1024 each are allowed. + + ' items: description: Tags type: string @@ -1550,7 +1544,7 @@ paths: type: array type: object description: Successful Operation - summary: Get Priority Policy GLobal Prefixes (v2.0) + summary: Get Priority Policy Global Prefixes (v2.0) tags: - QOS Policy post: @@ -3018,7 +3012,7 @@ paths: schema: description: Site Id type: string - - description: The priority policy local prefix ID. + - description: The prefix ID. in: path name: prefix_id required: true diff --git a/openapi-specs/sdwan/legacy/Routing.yaml b/openapi-specs/sdwan/legacy/Routing.yaml index 46782626c..209ee0ed2 100644 --- a/openapi-specs/sdwan/legacy/Routing.yaml +++ b/openapi-specs/sdwan/legacy/Routing.yaml @@ -58,11 +58,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -71,11 +66,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BGPConfig: properties: adv_interval: @@ -127,7 +121,7 @@ components: \ default is 120 seconds. \n" format: int32 type: integer - BGPGlobalConfigScreenV2N1: + BGPGlobalConfigScreenV2N2: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -195,6 +189,12 @@ components: ' format: int32 type: integer + peer_auth_type: + description: "The authentication type of the BGP peer. \n" + enum: + - md5 + - none + type: string peer_retry_time: description: 'The peer retry time should be between 0 - 65535 seconds. The default is 120 seconds. @@ -209,7 +209,9 @@ components: ' type: string prefix_adv_type_to_lan: - description: Prefix Adv Type To Lan + description: 'The prefix advertises to LAN. + + ' type: string prefixes_to_adv_to_wan: description: 'The prefix advertises to WAN. @@ -231,7 +233,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigScreenV2N2: + BGPGlobalConfigScreenV2N3: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -262,6 +264,14 @@ components: id: description: "The BGP configuration ID. \n" type: string + ipv6_prefixes_to_adv_to_wan: + description: 'Ipv6 Prefixes To Adv To Wan: ListIPv6Address(bcast = DENY, + listMaxSize = 0, error = BGP_CONFIG_INVALID_PREFIX: IP prefix is not valid + OR is not within the valid prefix range, required = false, type = GATEWAYCIDRV6) ' + items: + description: Ipv6 Prefixes To Adv To Wan + type: string + type: array keepalive_time: description: 'The keep-alive time of the BGP config. The keep-alive time should be between 3 - 200 seconds. @@ -300,7 +310,9 @@ components: format: int32 type: integer peer_auth_type: - description: "The authentication type of the BGP peer. \n" + description: 'The authentication type of the BGP peer. + + ' enum: - md5 - none @@ -343,7 +355,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigV2N1: + BGPGlobalConfigV2N2: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -411,6 +423,14 @@ components: ' format: int32 type: integer + peer_auth_type: + description: 'The authentication type of the BGP peer. + + ' + enum: + - md5 + - none + type: string peer_retry_time: description: 'The peer retry time should be between 0 - 65535 seconds. The default is 120 seconds. @@ -425,7 +445,9 @@ components: ' type: string prefix_adv_type_to_lan: - description: Prefix Adv Type To Lan + description: 'The prefix advertises to LAN. + + ' type: string prefixes_to_adv_to_wan: description: 'The prefix advertises to WAN. @@ -447,7 +469,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigV2N2: + BGPGlobalConfigV2N3: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -478,6 +500,14 @@ components: id: description: "The BGP configuration ID. \n" type: string + ipv6_prefixes_to_adv_to_wan: + description: 'List of IPv6 prefixes advertised to WAN. + + ' + items: + description: Ipv6 Prefixes To Adv To Wan + type: string + type: array keepalive_time: description: 'The keep-alive time of the BGP config. The keep-alive time should be between 3 - 200 seconds. @@ -516,9 +546,7 @@ components: format: int32 type: integer peer_auth_type: - description: 'The authentication type of the BGP peer. - - ' + description: "The authentication type of the BGP peer. \n" enum: - md5 - none @@ -579,19 +607,27 @@ components: ' type: string - BGPPeerConfigEtag: + BGPPeerAdvertisedPrefixesV2N1: properties: - id: - description: 'The BGP peer config etag ID. + advertised_ipv6_prefix_count: + description: Advertised Ipv6 Prefix Count + format: int32 + type: integer + advertised_prefix_count: + description: Advertised Prefix Count + format: int32 + type: integer + advertised_prefixes: + $ref: '#/components/schemas/PrefixSet' + description: 'Advertised Prefixes: Valid ' + description: + description: 'The description of the prefix filter list. Max size = 1024. ' + id: + description: "The ID of the prefix filter list. \n" type: string - tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' - type: string - required: - - tenant_id - BGPPeerConfigV2N1: + BGPPeerConfigScreenV2N3: properties: bgp_config: $ref: '#/components/schemas/BGPConfig' @@ -611,7 +647,7 @@ components: ' type: string peer_ip: - description: "The peer IP address. \n" + description: "The peer IP address. \n" type: string peer_type: description: 'The peer type = Classic. The Peer Type option is available @@ -634,11 +670,15 @@ components: ' type: string + router_id: + description: "The IP address of the ION device. \n" + type: string scope: - description: "The scope of the static route = Local or Global. If scope\ - \ is local, the device does not advertise the route to other sites and\ - \ if scope is global, the device advertises the route to other sites.\ - \ \n" + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' enum: - GLOBAL - LOCAL @@ -658,14 +698,26 @@ components: update_source: description: 'The Update Source IP address. + ' + type: string + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + ' type: string required: - remote_as_num - - peer_ip - name - BGPPeerConfigV2N2: + BGPPeerConfigScreenV2N4: properties: + allow_v4_prefixes: + description: 'Allow v4 prefixes. + + ' + type: boolean + allow_v6_prefixes: + description: "Allow v6 prefixes. \n" + type: boolean bgp_config: $ref: '#/components/schemas/BGPConfig' description: 'The details of the BGP config. @@ -684,7 +736,12 @@ components: ' type: string peer_ip: - description: "The peer IP address. \n" + description: 'The peer IP address. + + ' + type: string + peer_ip_v6: + description: "The peer IPv6 address. \n" type: string peer_type: description: 'The peer type = Classic. The Peer Type option is available @@ -707,11 +764,18 @@ components: ' type: string + router_id: + description: 'Router Id: Size(max = 256, ROUTER_ID_EXCEEDS_LIMIT, min = + 0) IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, + bcast = DENY, defaultRoute = false, dnsCheck = false, BGP_CONFIG_INVALID_ROUTER_ID, + type = IP) ' + type: string scope: - description: "The scope of the static route = Local or Global. If scope\ - \ is local, the device does not advertise the route to other sites and\ - \ if scope is global, the device advertises the route to other sites.\ - \ \n" + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' enum: - GLOBAL - LOCAL @@ -733,116 +797,22 @@ components: ' type: string - required: - - remote_as_num - - peer_ip - - name - BGPPeerDiscoveredPrefixes: - properties: - discovered_ipv4_prefixes: - description: 'The discovered IPv4 prefixes for the BGP peer. - - ' - items: - $ref: '#/components/schemas/PrefixInfo' - type: array - discovered_ipv4_prefixes_count: - description: 'The discovered IPv4 prefixes count for the BGP peer. - - ' - format: int32 - type: integer - id: - description: 'The ID of the BGP peer. + update_source_v6: + description: 'The Update Source IPv6 address. ' type: string - BGPPeerOperations: - properties: - action: - description: 'Action: ValidateEnum(enumClass = classOf[BGPPeerOperations], - error = INVALID_OPERATION: Invalid Operation, nullAllowed = false) ' - enum: - - HARD_RESET - - SOFT_RESET - - REVERT_AUTOGENERATED - - REFRESH_STATUS - type: string - id: - description: Id - type: string - required: - - action - BGPPeerQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of BGP peers that match the query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of BGP peers deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the BGP peers for the query. + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' - items: - description: Group By - type: string - type: array - id: - description: "Lists the BGP peers by ID. \n" type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. - - ' - format: int64 - type: integer - limit: - description: 'The query limit. - - ' - format: int32 - type: integer - next_query: - description: 'The limit. - - ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. - - ' - items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. - - ' - format: int64 - type: integer - BGPPeerQueryFilterV2N1: + required: + - allow_v6_prefixes + - allow_v4_prefixes + - remote_as_num + - name + BGPPeerConfigV2N3: properties: bgp_config: $ref: '#/components/schemas/BGPConfig' @@ -883,13 +853,18 @@ components: route_map_out_id: description: 'The ID of the Route Map Out to filter outgoing routes. + ' + type: string + router_id: + description: 'The IP address of the ION device. + ' type: string scope: description: "The scope of the static route = Local or Global. If scope\ \ is local, the device does not advertise the route to other sites and\ \ if scope is global, the device advertises the route to other sites.\ - \ \n" + \ \n" enum: - GLOBAL - LOCAL @@ -909,14 +884,26 @@ components: update_source: description: 'The Update Source IP address. + ' + type: string + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + ' type: string required: - remote_as_num - - peer_ip - name - BGPPeerQueryFilterV2N2: + BGPPeerConfigV2N4: properties: + allow_v4_prefixes: + description: 'Allow v4 prefixes. + + ' + type: boolean + allow_v6_prefixes: + description: "Allow v6 prefixes. \n" + type: boolean bgp_config: $ref: '#/components/schemas/BGPConfig' description: 'The details of the BGP config. @@ -935,7 +922,12 @@ components: ' type: string peer_ip: - description: "The peer IP address. \n" + description: 'The peer IP address. + + ' + type: string + peer_ip_v6: + description: "The peer IPv6 address. \n" type: string peer_type: description: 'The peer type = Classic. The Peer Type option is available @@ -958,11 +950,18 @@ components: ' type: string + router_id: + description: 'Router Id: Size(max = 256, ROUTER_ID_EXCEEDS_LIMIT, min = + 0) IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, + bcast = DENY, defaultRoute = false, dnsCheck = false, BGP_CONFIG_INVALID_ROUTER_ID, + type = IP) ' + type: string scope: - description: "The scope of the static route = Local or Global. If scope\ - \ is local, the device does not advertise the route to other sites and\ - \ if scope is global, the device advertises the route to other sites.\ - \ \n" + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' enum: - GLOBAL - LOCAL @@ -982,23 +981,34 @@ components: update_source: description: 'The Update Source IP address. + ' + type: string + update_source_v6: + description: 'The Update Source IPv6 address. + + ' + type: string + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + ' type: string required: + - allow_v6_prefixes + - allow_v4_prefixes - remote_as_num - - peer_ip - name - BGPPeerReachablePrefixes: + BGPPeerDiscoveredPrefixes: properties: - filtered_ipv4_prefixes: - description: 'The filtered IPv4 prefixes for the BGP peer. + discovered_ipv4_prefixes: + description: 'The discovered IPv4 prefixes for the BGP peer. ' items: $ref: '#/components/schemas/PrefixInfo' type: array - filtered_ipv4_prefixes_count: - description: 'The filtered IPv4 prefixes count for the BGP peer. + discovered_ipv4_prefixes_count: + description: 'The discovered IPv4 prefixes count for the BGP peer. ' format: int32 @@ -1008,769 +1018,915 @@ components: ' type: string - reachable_ipv4_prefixes: - description: 'The reachable IPv4 prefixes for the BGP peer. + BGPPeerDiscoveredPrefixesV2N1: + properties: + discovered_ipv4_prefixes: + description: 'The discovered IPv4 prefixes for the BGP peer. ' items: $ref: '#/components/schemas/PrefixInfo' type: array - reachable_ipv4_prefixes_count: - description: 'The reachable IPv4 prefixes count for the BGP peer. + discovered_ipv4_prefixes_count: + description: 'The discovered IPv4 prefixes count for the BGP peer. ' format: int32 type: integer - BGPPeerStatus: - properties: - downtime: - description: 'The downtime configured for the BGP peer. - - ' - type: string id: description: 'The ID of the BGP peer. ' type: string - state: - description: 'The state of the BGP peer. + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' type: string - uptime: - description: 'The uptime configured for the BGP peer. - - ' - type: string - BGPPeerStatusV2N1: + BGPPeerDiscoveredPrefixesV2N2: properties: - direction: - description: "The direction for the BGP peer. \n" - type: string - downtime: - description: 'The downtime configured for the BGP peer. + discovered_ipv4_prefixes: + description: 'The discovered IPv4 prefixes for the BGP peer. ' - type: string - id: - description: 'The ID of the BGP peer. + items: + $ref: '#/components/schemas/PrefixInfo' + type: array + discovered_ipv4_prefixes_count: + description: 'The discovered IPv4 prefixes count for the BGP peer. ' - type: string - state: - description: 'The state of the BGP peer. + format: int32 + type: integer + discovered_ipv6_prefixes: + description: 'The discovered IPv6 prefixes for the BGP peer. ' - type: string - uptime: - description: 'The uptime configured for the BGP peer. + items: + $ref: '#/components/schemas/PrefixInfo' + type: array + discovered_ipv6_prefixes_count: + description: 'The discovered IPv6 prefixes count for the BGP peer. ' - type: string - Direction: - properties: {} - EnterprisePrefixSetN: - properties: + format: int32 + type: integer id: - description: 'The ID of the tenant enterprise prefix set. + description: 'The ID of the BGP peer. ' type: string - ipv4_enterprise_prefixes: - description: 'The IPv4 configuration of the tenant enterprise prefix. + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' - items: - description: Ipv4 Enterprise Prefixes - type: string - type: array - tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' type: string - required: - - tenant_id - EnterprisePrefixSetNV2N1: + BGPPeerOperations: properties: - id: - description: Id + action: + description: 'The BGP peer actions. + + ' + enum: + - HARD_RESET + - SOFT_RESET + - REVERT_AUTOGENERATED + - REFRESH_STATUS type: string - ipv4_enterprise_prefixes: - description: 'Ipv4 Enterprise Prefixes: ListIPAddress(bcast = DENY, listMaxSize - = 0, EPS_CONFIG_INVALID_PREFIX, required = false, type = PREFIXCIDR_32) ' - items: - description: Ipv4 Enterprise Prefixes - type: string - type: array - ipv6_enterprise_prefixes: - description: 'Ipv6 Enterprise Prefixes: ListIPv6Address(bcast = DENY, listMaxSize - = 0, message = EPS_CONFIG_INVALID_IPV6_PREFIX, required = false, type - = GATEWAYCIDRV6) ' - items: - description: Ipv6 Enterprise Prefixes - type: string - type: array - tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + id: + description: 'The ID of the BGP peer. + + ' type: string required: - - tenant_id - Error: - properties: - _error: - items: - $ref: '#/components/schemas/ErrorResponse' - type: array - ErrorResponse: - properties: - code: - type: string - message: - type: string - ListQueryResponse: + - action + BGPPeerQuery: properties: - count: - description: 'The count of the query list. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of BGP peers that match the query parameters. + + ' + dest_page: + description: 'The destination page. ' format: int32 type: integer - deleted_count: - description: 'The deleted number of queries. + getDeleted: + description: 'The number of BGP peers deleted for a time frame. ' - format: int64 - type: integer - deleted_ids: - description: 'The deleted query IDs. + type: boolean + group_by: + description: 'Group the BGP peers for the query. ' items: + description: Group By type: string type: array - description: - description: 'Description of the query. Max size = 256. + id: + description: "Lists the BGP peers by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. ' - id: - description: 'The ID. + format: int64 + type: integer + limit: + description: 'The query limit. ' - type: string + format: int32 + type: integer next_query: - description: 'Details of the next query. + description: 'The limit. ' type: object - tenant_id: - description: 'The tenant ID. + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' - type: string + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object total_count: - description: 'Total number of queries. + description: 'The total number of query parameters. ' format: int64 type: integer - type: object - ListResponse: + BGPPeerQueryFilterV2N2: properties: - count: - description: 'The number of responses. + bgp_config: + $ref: '#/components/schemas/BGPConfig' + description: 'The details of the BGP config. ' - format: int32 - type: integer + description: + description: "The description of the BGP peer config. Max size = 1024. \n" id: - description: 'The ID of the response. + description: 'The ID of the BGP peer config. ' type: string - tenant_id: - description: 'The ID of the tenant. + name: + description: 'The name of the BGP peer config. Max size = 128. ' type: string - type: object - LocalNetwork: - properties: - prefix_set: - description: 'Prefix Set: Valid ' - items: - $ref: '#/components/schemas/Network' - type: array - prefix_set_v6: - description: 'Prefix Set V6: Valid ' - items: - $ref: '#/components/schemas/NetworkV6' - type: array - security_policies: - description: 'Security Policies: Valid ' - items: - $ref: '#/components/schemas/SecurityPolicy' - type: array - vlan_id: - description: 'Vlan Id: Min(message = min, value = 0L) Max(message = max, - value = 4095L) ' - format: int32 - type: integer - LocalPrefixSet: - properties: - local_networks: - description: 'Local Networks: Valid ' - items: - $ref: '#/components/schemas/LocalNetwork' - type: array - MatchClauses: - properties: - as_path_id: - description: 'The AS path ID. + peer_ip: + description: "The peer IP address. \n" + type: string + peer_type: + description: 'The peer type = Classic. The Peer Type option is available + only for data center ION devices. ' type: string - community_list_id: - description: "The community list ID. \n" - type: string - ip_next_hop_id: - description: 'The IP next-hop ID. + remote_as_num: + description: 'The remote AS number. ' type: string - ip_prefix_list_id: - description: 'The IP prefix list ID. + route_map_in_id: + description: 'The ID of the Route Map In to filter incoming routes. ' type: string - tag: - description: 'A information field that can be added to identify the match - clause. + route_map_out_id: + description: 'The ID of the Route Map Out to filter outgoing routes. ' - format: int32 - type: integer - Network: - properties: - gateway: - description: 'The network gateway. + type: string + scope: + description: "The scope of the static route = Local or Global. If scope\ + \ is local, the device does not advertise the route to other sites and\ + \ if scope is global, the device advertises the route to other sites.\ + \ \n" + enum: + - GLOBAL + - LOCAL + type: string + shutdown: + description: Shutdown + type: boolean + tags: + description: 'A information field that can be added to identify the BGP + peer. Maximum 10 unique tags of length 1024 each are allowed. ' - type: string - ipv4_prefix: - description: 'The IPv4 address prefix. + items: + description: Tags + type: string + type: array + update_source: + description: 'The Update Source IP address. ' type: string - NetworkV6: + required: + - remote_as_num + - name + BGPPeerQueryFilterV2N3: properties: - gateway: - description: 'The network gateway. + bgp_config: + $ref: '#/components/schemas/BGPConfig' + description: 'The details of the BGP config. + + ' + description: + description: "The description of the BGP peer config. Max size = 1024. \n" + id: + description: 'The ID of the BGP peer config. ' type: string - ipv6_prefix: - description: 'The IPv6 address prefix. + name: + description: 'The name of the BGP peer config. Max size = 128. ' type: string - NextHop: - properties: - admin_distance: - description: 'The admin distance for a specific route. The default value - for admin distance is 1. + peer_ip: + description: "The peer IP address. \n" + type: string + peer_type: + description: 'The peer type = Classic. The Peer Type option is available + only for data center ION devices. ' - type: integer - nexthop_interface_id: - description: 'The next hop interface ID. + type: string + remote_as_num: + description: 'The remote AS number. ' type: string - nexthop_ip: - description: "The next hop IPv4 address. \n" + route_map_in_id: + description: 'The ID of the Route Map In to filter incoming routes. + + ' type: string - self: - description: "Set to True to indicate that traffic is destined for the ION\ - \ device. By default, Self is set to False. \n" + route_map_out_id: + description: 'The ID of the Route Map Out to filter outgoing routes. + + ' + type: string + router_id: + description: 'Router Id: Size(max = 256, ROUTER_ID_EXCEEDS_LIMIT, min = + 0) IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, + bcast = DENY, defaultRoute = false, dnsCheck = false, BGP_CONFIG_INVALID_ROUTER_ID, + type = IP) ' + type: string + scope: + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' + enum: + - GLOBAL + - LOCAL + type: string + shutdown: + description: Shutdown type: boolean - PrefixInfo: - properties: - as_path: - description: 'The AS path of the IPv4 prefix. + tags: + description: 'A information field that can be added to identify the BGP + peer. Maximum 10 unique tags of length 1024 each are allowed. ' items: - description: As Path - format: int64 - type: integer + description: Tags + type: string type: array - network: - description: 'The network of the IPv4 prefix. + update_source: + description: 'The Update Source IP address. ' type: string - nexthop: - description: 'The next-hop of the IPv4 prefix. + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' type: string - PrefixQueryFilterV3: + required: + - remote_as_num + - name + BGPPeerQueryFilterV2N4: properties: - element_id: - description: 'The element ID. + allow_v4_prefixes: + description: 'Allow v4 prefixes. + + ' + type: boolean + allow_v6_prefixes: + description: "Allow v6 prefixes. \n" + type: boolean + bgp_config: + $ref: '#/components/schemas/BGPConfig' + description: 'The details of the BGP config. + + ' + description: + description: "The description of the BGP peer config. Max size = 1024. \n" + id: + description: 'The ID of the BGP peer config. ' type: string - ipv4_prefix: - description: 'The IPv4 address prefix. + name: + description: 'The name of the BGP peer config. Max size = 128. ' type: string - resource_id: - description: 'The resource ID. + peer_ip: + description: 'The peer IP address. ' type: string - resource_type: - description: 'The resource type. + peer_ip_v6: + description: "The peer IPv6 address. \n" + type: string + peer_type: + description: 'The peer type = Classic. The Peer Type option is available + only for data center ION devices. ' - enum: - - static_route - - interface - - lan_network - - BGP type: string - scope: - description: "The prefix scope. \n" - enum: - - GLOBAL - - LOCAL + remote_as_num: + description: 'The remote AS number. + + ' type: string - site_id: - description: 'The site ID. + route_map_in_id: + description: 'The ID of the Route Map In to filter incoming routes. ' type: string - required: - - site_id - PrefixQueryV3: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of prefix sets that match the query parameters. + route_map_out_id: + description: 'The ID of the Route Map Out to filter outgoing routes. ' - dest_page: - description: 'The destination page. + type: string + router_id: + description: 'The IP address of the ION device. Max size = 256. ' - format: int32 - type: integer - ge: - type: integer - getDeleted: - description: 'The number prefix sets deleted for a time frame. + type: string + scope: + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. ' + enum: + - GLOBAL + - LOCAL + type: string + shutdown: + description: Shutdown type: boolean - group_by: - description: 'Group the prefix sets for the query. + tags: + description: 'A information field that can be added to identify the BGP + peer. Maximum 10 unique tags of length 1024 each are allowed. ' items: - description: Group By + description: Tags type: string type: array - id: - description: "List the prefix sets by ID. \n" + update_source: + description: 'The Update Source IP address. + + ' type: string - ipv4_prefix: - description: Ipv4 Prefix + update_source_v6: + description: 'The Update Source IPv6 address. + + ' type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' - format: int64 - type: integer - le: - type: integer - limit: - description: 'The query limit. + type: string + required: + - allow_v6_prefixes + - allow_v4_prefixes + - remote_as_num + - name + BGPPeerReachablePrefixes: + properties: + filtered_ipv4_prefixes: + description: 'The filtered IPv4 prefixes for the BGP peer. ' - format: int32 - type: integer - next_query: - description: 'The limit. + items: + $ref: '#/components/schemas/PrefixInfo' + type: array + filtered_ipv4_prefixes_count: + description: 'The filtered IPv4 prefixes count for the BGP peer. ' - type: object - query_params: - description: 'Query using query parameters. + format: int32 + type: integer + id: + description: 'The ID of the BGP peer. ' - type: object - retrieved_fields: - description: 'Retrieve information from a field. + type: string + reachable_ipv4_prefixes: + description: 'The reachable IPv4 prefixes for the BGP peer. ' items: - description: Retrieved Fields - type: string + $ref: '#/components/schemas/PrefixInfo' type: array - retrieved_fields_mask: - description: 'List the fields to query. + reachable_ipv4_prefixes_count: + description: 'The reachable IPv4 prefixes count for the BGP peer. ' - type: boolean - sort_params: - description: 'Specify the order in which you want the search criteria to - display. + format: int32 + type: integer + BGPPeerReachablePrefixesV2N1: + properties: + filtered_ipv4_prefixes: + description: 'The filtered IPv4 prefixes for the BGP peer. ' - type: object - total_count: - description: 'The total number of query parameters. + items: + $ref: '#/components/schemas/PrefixInfo' + type: array + filtered_ipv4_prefixes_count: + description: 'The filtered IPv4 prefixes count for the BGP peer. ' - format: int64 + format: int32 type: integer - PrefixSet: - properties: - ipv4_set: - description: 'The set of The IPv4 addresses. + filtered_ipv6_prefixes: + description: 'The filtered IPv6 prefixes for the BGP peer. ' items: - description: Ipv4 Set - type: string + $ref: '#/components/schemas/PrefixInfo' type: array - ipv6_set: - description: 'The set of The IPv4 addresses. + filtered_ipv6_prefixes_count: + description: "The filtered IPv6 prefixes count for the BGP peer. \n" + format: int32 + type: integer + id: + description: 'The ID of the BGP peer. + + ' + type: string + reachable_ipv4_prefixes: + description: 'The reachable IPv4 prefixes for the BGP peer. ' items: - description: Ipv6 Set - type: string + $ref: '#/components/schemas/PrefixInfo' type: array - RoutingAccessList: - properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + reachable_ipv4_prefixes_count: + description: "The reachable IPv4 prefixes count for the BGP peer. \n" + format: int32 + type: integer + reachable_ipv6_prefixes: + description: 'The reachable IPv6 prefixes for the BGP peer. ' items: - $ref: '#/components/schemas/ASPathRegex' + $ref: '#/components/schemas/PrefixInfo' type: array - auto_generated: - description: "The value true or false for auto-generated access lists. \n" - type: boolean - description: - description: 'The description of the access list. Max size = 1024. + reachable_ipv6_prefixes_count: + description: 'The reachable IPv6 prefixes count for the BGP peer. + + ' + format: int32 + type: integer + BGPPeerStatusV2N1: + properties: + direction: + description: "The direction for the BGP peer. \n" + type: string + downtime: + description: 'The downtime configured for the BGP peer. ' + type: string id: - description: "The ID of the access list. \n" + description: 'The ID of the BGP peer. + + ' type: string - name: - description: 'The name of the access list. Max size = 128. + state: + description: 'The state of the BGP peer. ' type: string - tags: - description: 'A information field that can be added to identify the access - list. Maximum 10 unique tags of length 1024 each are allowed. + uptime: + description: 'The uptime configured for the BGP peer. ' - items: - description: Tags - type: string - type: array - required: - - name - RoutingAccessListQuery: + type: string + BGPPeerStatusV2N2: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of access/prefix lists that match the - query parameters. + direction: + description: 'The direction for the BGP peer. ' - dest_page: - description: 'The destination page. + type: string + downtime: + description: 'The downtime configured for the BGP peer. ' - format: int32 - type: integer - getDeleted: - description: 'The number of access/prefix lists deleted for a time frame. + type: string + id: + description: 'The ID of the BGP peer. + + ' + type: string + state: + description: 'The state of the BGP peer. + + ' + type: string + uptime: + description: 'The uptime configured for the BGP peer. ' + type: string + v4_capability_negotiated: + description: "The v4 negotiated capability. \n" type: boolean - group_by: - description: 'Group the access/prefix lists for the query. + v6_capability_negotiated: + description: 'The v6 negotiated capability. + + ' + type: boolean + Direction: + properties: {} + EnterprisePrefixSetN: + properties: + id: + description: 'The ID of the tenant enterprise prefix set. + + ' + type: string + ipv4_enterprise_prefixes: + description: 'The IPv4 configuration of the tenant enterprise prefix. ' items: - description: Group By + description: Ipv4 Enterprise Prefixes type: string type: array - id: - description: "Lists the access/prefix lists by ID. \n" + tenant_id: + description: "The tenant ID. \n" type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + required: + - tenant_id + EnterprisePrefixSetNV2N1: + properties: + id: + description: 'The ID of the tenant enterprise prefix set. ' - format: int64 - type: integer - limit: - description: 'The query limit. + type: string + ipv4_enterprise_prefixes: + description: 'The IPv4 configuration of the tenant enterprise prefix. ' - format: int32 - type: integer - next_query: - description: 'The limit. + items: + description: Ipv4 Enterprise Prefixes + type: string + type: array + ipv6_enterprise_prefixes: + description: 'The IPv6 configuration of the tenant enterprise prefix. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + items: + description: Ipv6 Enterprise Prefixes + type: string + type: array + tenant_id: + description: 'The tenant ID. ' + type: string + required: + - tenant_id + Error: + properties: + _error: items: - description: Retrieved Fields - type: string + $ref: '#/components/schemas/ErrorResponse' type: array - retrieved_fields_mask: - description: 'List the fields to query. + ErrorResponse: + properties: + code: + type: string + message: + type: string + ListQueryResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + deleted_count: + description: 'The deleted number. ' - type: boolean - sort_params: - type: object - total_count: - description: "The total number of query parameters. \n" format: int64 type: integer - RoutingAccessListQueryFilter: - properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + deleted_ids: + description: 'The deleted IDs. ' items: - $ref: '#/components/schemas/ASPathRegex' + type: string type: array - auto_generated: - description: "The value true or false for auto-generated access lists. \n" - type: boolean description: - description: 'The description of the access list. Max size = 1024. + description: 'Description of the query. Max size = 256. ' id: - description: "The peer IP address. \n" + description: 'The ID. + + ' type: string - name: - description: 'The name of the access list. Max size = 128. + next_query: + description: 'Details of the next query. + + ' + type: object + tenant_id: + description: 'The tenant ID. ' type: string - tags: - description: 'A information field that can be added to identify the access - list. Maximum 10 unique tags of length 1024 each are allowed. + total_count: + description: 'Total number. ' - items: - description: Tags - type: string - type: array - required: - - name - RoutingAccessListQueryFilterV2N1: + format: int64 + type: integer + type: object + ListResponse: properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + count: + description: 'The actual count. ' - items: - $ref: '#/components/schemas/ASPathRegex' - type: array - auto_generated: - description: "The value true or false for auto-generated access lists. \n" - type: boolean - description: - description: 'The description of the access list. Max size = 1024. + format: int32 + type: integer + id: + description: 'The ID. ' - id: - description: "The ID of the access list. \n" type: string - name: - description: 'The name of the access list. Max size = 128. + tenant_id: + description: 'The tenant ID. ' type: string - tags: - description: 'A information field that can be added to identify the access - list. Maximum 10 unique tags of length 1024 each are allowed. + type: object + LocalNetwork: + properties: + prefix_set: + description: 'The valid local prefix set for the site. ' items: - description: Tags - type: string + $ref: '#/components/schemas/Network' type: array - required: - - name - RoutingAccessListScreen: - properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + prefix_set_v6: + description: 'The v6 prefix set for the site. ' items: - $ref: '#/components/schemas/ASPathRegex' + $ref: '#/components/schemas/NetworkV6' type: array - auto_generated: - description: "The value true or false for auto-generated access/community\ - \ lists. \n" - type: boolean - description: - description: 'The description of the access/community list. Max size = 1024. + security_policies: + description: 'The details of the security policy. ' - id: - description: "The ID of the access/community list. \n" - type: string - name: - description: 'The name of the access/community list. Max size = 128. + items: + $ref: '#/components/schemas/SecurityPolicy' + type: array + vlan_id: + description: "The vlan ID. \n" + format: int32 + type: integer + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' type: string - tags: - description: 'A information field that can be added to identify the access/community - list. Maximum 10 unique tags of length 1024 each are allowed. + LocalPrefixSet: + properties: + local_networks: + description: 'The details of the local networks prefix sets. ' items: - description: Tags - type: string + $ref: '#/components/schemas/LocalNetwork' type: array - required: - - name - RoutingAccessListScreenV2N1: + MatchClauses: properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + as_path_id: + description: 'The AS path ID. ' - items: - $ref: '#/components/schemas/ASPathRegex' - type: array - auto_generated: - description: "The value true or false for auto-generated access lists. \n" - type: boolean - description: - description: 'The description of the access list. Max size = 1024. + type: string + community_list_id: + description: "The community list ID. \n" + type: string + ip_next_hop_id: + description: 'The IP next-hop ID. ' - id: - description: "The ID of the access list. \n" type: string - name: - description: 'The name of the access list. Max size = 128. + ip_prefix_list_id: + description: 'The IP prefix list ID. ' type: string - tags: - description: "A information field that can be added to identify the access\ - \ list. Maximum 10 unique tags of length 1024 each are allowed. \n" - items: - description: Tags - type: string - type: array - required: - - name - RoutingAccessListV2N1: + tag: + description: 'A information field that can be added to identify the match + clause. + + ' + format: int32 + type: integer + Network: properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + gateway: + description: 'The network gateway. ' - items: - $ref: '#/components/schemas/ASPathRegex' - type: array - auto_generated: - description: "The value true or false for auto-generated access lists. \n" - type: boolean - description: - description: 'The description of the access list. Max size = 1024. + type: string + ipv4_prefix: + description: 'The IPv4 address prefix. ' - id: - description: "The ID of the access list. \n" type: string - name: - description: 'The name of the access list. Max size = 128. + NetworkV6: + properties: + gateway: + description: 'The network gateway. ' type: string - tags: - description: 'A information field that can be added to identify the access - list. Maximum 10 unique tags of length 1024 each are allowed. + ipv6_prefix: + description: 'The IPv6 address prefix. ' - items: - description: Tags - type: string - type: array - required: - - name - RoutingCommunityList: + type: string + NextHop: properties: - auto_generated: - description: 'The value true or false for auto-generated IP community lists. + admin_distance: + description: 'The admin distance for a specific route. The default value + for admin distance is 1. + + ' + type: integer + nexthop_interface_id: + description: 'The next hop interface ID. ' + type: string + nexthop_ip: + description: "The next hop IPv4 address. \n" + type: string + self: + description: "Set to True to indicate that traffic is destined for the ION\ + \ device. By default, Self is set to False. \n" type: boolean - community_list: - description: "The details of the IP community lists. \n" + PrefixInfo: + properties: + as_path: + description: 'The AS path of the IPv4/IPv6 prefix. + + ' items: - $ref: '#/components/schemas/RoutingIPCommunity' + description: As Path + format: int64 + type: integer type: array - description: - description: 'The description of the IP community list. Max size = 1024. + network: + description: 'The network of the IPv4/IPv6 prefix. ' - id: - description: "The ID of the IP community list. \n" type: string - name: - description: 'The name of the IP community list. Max size = 128. + nexthop: + description: 'The next-hop of the IPv4/IPv6 prefix. + + ' + type: string + PrefixQueryFilterV3: + properties: + element_id: + description: 'The element ID. + + ' + type: string + ipv4_prefix: + description: 'The IPv4 address prefix. + + ' + type: string + resource_id: + description: 'The resource ID. + + ' + type: string + resource_type: + description: 'The resource type. + + ' + enum: + - static_route + - interface + - lan_network + - BGP + type: string + scope: + description: "The prefix scope. \n" + enum: + - GLOBAL + - LOCAL + type: string + site_id: + description: 'The site ID. ' type: string - tags: - description: "A information field that can be added to identify the IP community\ - \ list. Maximum 10 unique tags of length 1024 each are allowed. \n" - items: - description: Tags - type: string - type: array required: - - name - RoutingCommunityListQuery: + - site_id + PrefixQueryFilterV3N1: + properties: + element_id: + description: 'The element ID. + + ' + type: string + ipv4_prefix: + description: 'The IPv4 address prefix. + + ' + type: string + ipv6_prefix: + description: 'The IPv6 address prefix. + + ' + type: string + resource_id: + description: 'The resource ID. + + ' + type: string + resource_type: + description: 'The resource type. + + ' + enum: + - static_route + - interface + - lan_network + - BGP + type: string + scope: + description: "The prefix scope. \n" + enum: + - GLOBAL + - LOCAL + type: string + site_id: + description: "The site ID. \n" + type: string + required: + - site_id + PrefixQueryV3: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of community lists that match the query - parameters. + description: 'The aggregate number of prefix sets that match the query parameters. ' dest_page: @@ -1779,13 +1935,15 @@ components: ' format: int32 type: integer + ge: + type: integer getDeleted: - description: 'The number of community lists deleted for a time frame. + description: 'The number prefix sets deleted for a time frame. ' type: boolean group_by: - description: 'Group the community lists for the query. + description: 'Group the prefix sets for the query. ' items: @@ -1793,7 +1951,10 @@ components: type: string type: array id: - description: "Lists the community lists by ID. \n" + description: "List the prefix sets by ID. \n" + type: string + ipv4_prefix: + description: Ipv4 Prefix type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -1801,6 +1962,8 @@ components: ' format: int64 type: integer + le: + type: integer limit: description: 'The query limit. @@ -1813,6 +1976,9 @@ components: ' type: object query_params: + description: 'Query using query parameters. + + ' type: object retrieved_fields: description: 'Retrieve information from a field. @@ -1828,6 +1994,10 @@ components: ' type: boolean sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' type: object total_count: description: 'The total number of query parameters. @@ -1835,67 +2005,134 @@ components: ' format: int64 type: integer - RoutingCommunityListQueryFilter: + PrefixQueryV3N1: properties: - auto_generated: - description: 'The value true or false for auto-generated IP community lists. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of prefix sets that match the query parameters. ' - type: boolean - community_list: - description: "The details of the IP community lists. \n" - items: - $ref: '#/components/schemas/RoutingIPCommunity' - type: array - description: - description: 'The description of the IP community list. Max size = 1024. + dest_page: + description: 'The destination page. ' - id: - description: "The ID of the IP community list. \n" - type: string - name: - description: 'The name of the IP community list. Max size = 128. + format: int32 + type: integer + ge: + type: integer + getDeleted: + description: 'The number prefix sets deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the prefix sets for the query. ' + items: + description: Group By + type: string + type: array + id: + description: "List the prefix sets by ID. \n" type: string - tags: - description: 'A information field that can be added to identify the IP community - list. Maximum 10 unique tags of length 1024 each are allowed. + ipv4_prefix: + description: Ipv4 Prefix + type: string + ipv6_prefix: + description: Ipv6 Prefix + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + le: + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + description: 'Query using query parameters. + + ' + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' items: - description: Tags + description: Retrieved Fields type: string type: array - required: - - name - RoutingCommunityListScreen: - properties: - auto_generated: - description: 'The value true or false for auto-generated IP community lists. + retrieved_fields_mask: + description: 'List the fields to query. ' type: boolean - community_list: - description: "The details of the IP community lists. \n" + sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' + type: object + total_count: + description: "The total number of query parameters. \n" + format: int64 + type: integer + PrefixSet: + properties: + ipv4_set: + description: 'The set of The IPv4 addresses. + + ' items: - $ref: '#/components/schemas/RoutingIPCommunity' + description: Ipv4 Set + type: string + type: array + ipv6_set: + description: 'The set of The IPv6 addresses. + + ' + items: + description: Ipv6 Set + type: string + type: array + RoutingAccessList: + properties: + as_path_regex_list: + description: 'The AS Path Regex expression list. + + ' + items: + $ref: '#/components/schemas/ASPathRegex' type: array + auto_generated: + description: "The value true or false for auto-generated access lists. \n" + type: boolean description: - description: 'The description of the IP community list. Max size = 1024. + description: 'The description of the access list. Max size = 1024. ' id: - description: "The ID of the IP community list. \n" + description: "The ID of the access list. \n" type: string name: - description: 'The name of the IP community list. Max size = 128. + description: 'The name of the access list. Max size = 128. ' type: string tags: - description: 'A information field that can be added to identify the IP community + description: 'A information field that can be added to identify the access list. Maximum 10 unique tags of length 1024 each are allowed. ' @@ -1905,79 +2142,101 @@ components: type: array required: - name - RoutingIPCommunity: + RoutingAccessListQuery: properties: - community_str: - description: 'The community string. Max size = 256. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of access/prefix lists that match the + query parameters. ' - type: string - permit: - description: "The permit of the IP community sctring = Permit or Deny. \n" - type: boolean - required: - - community_str - RoutingPrefixFilter: - properties: - ge: - description: 'The prefix filter value for ge operator should be within the - range 1-32. + dest_page: + description: 'The destination page. ' format: int32 type: integer - le: - description: "The prefix filter value for le operator should be within the\ - \ range 1-32. \n" - format: int32 + getDeleted: + description: 'The number of access/prefix lists deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the access/prefix lists for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "Lists the access/prefix lists by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 type: integer - order: - description: 'The order of the prefix filter. + limit: + description: 'The query limit. ' format: int32 type: integer - permit: - description: 'The permit of the IP community sctring = Permit or Deny. + next_query: + description: 'The limit. ' - type: boolean - prefix: - description: 'The valid prefix filters. + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' - type: string - required: - - prefix - RoutingPrefixList: + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: "The total number of query parameters. \n" + format: int64 + type: integer + RoutingAccessListQueryFilter: properties: - auto_generated: - description: 'The value true or false for auto-generated prefix list for - an element. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' + items: + $ref: '#/components/schemas/ASPathRegex' + type: array + auto_generated: + description: "The value true or false for auto-generated access lists. \n" type: boolean description: - description: 'The description of the prefix filter list. Max size = 1024. + description: 'The description of the access list. Max size = 1024. ' id: - description: "The ID of the prefix filter list. \n" + description: "The peer IP address. \n" type: string name: - description: 'The name of the prefix filter list. Max size = 128. + description: 'The name of the access list. Max size = 128. ' type: string - prefix_filter_list: - description: "The details of the prefix filter list used to filter routes.\ - \ \n" - items: - $ref: '#/components/schemas/RoutingPrefixFilter' - type: array tags: - description: 'A information field that can be added to identify the prefix - filter list. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the access + list. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -1986,35 +2245,33 @@ components: type: array required: - name - RoutingPrefixListQueryFilter: + RoutingAccessListQueryFilterV2N1: properties: - auto_generated: - description: 'The value true or false for auto-generated prefix list for - an element. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' + items: + $ref: '#/components/schemas/ASPathRegex' + type: array + auto_generated: + description: "The value true or false for auto-generated access lists. \n" type: boolean description: - description: 'The description of the prefix filter list. Max size = 1024. + description: 'The description of the access list. Max size = 1024. ' id: - description: "The ID of the prefix list. \n" + description: "The ID of the access list. \n" type: string name: - description: 'The name of the prefix filter list. Max size = 128. + description: 'The name of the access list. Max size = 128. ' type: string - prefix_filter_list: - description: "The details of the prefix filter list used to filter routes.\ - \ \n" - items: - $ref: '#/components/schemas/RoutingPrefixFilter' - type: array tags: - description: 'A information field that can be added to identify the prefix - filter list. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the access + list. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -2023,35 +2280,34 @@ components: type: array required: - name - RoutingPrefixListScreen: + RoutingAccessListScreen: properties: - auto_generated: - description: 'The value true or false for auto-generated prefix list for - an element. - - ' - type: boolean - description: - description: 'The description of the prefix filter list. Max size = 1024. + as_path_regex_list: + description: 'The AS Path Regex expression list. + + ' + items: + $ref: '#/components/schemas/ASPathRegex' + type: array + auto_generated: + description: "The value true or false for auto-generated access/community\ + \ lists. \n" + type: boolean + description: + description: 'The description of the access/community list. Max size = 1024. ' id: - description: "The ID of the prefix filter list. \n" + description: "The ID of the access/community list. \n" type: string name: - description: 'The name of the prefix filter list. Max size = 128. + description: 'The name of the access/community list. Max size = 128. ' type: string - prefix_filter_list: - description: "The details of the prefix filter list used to filter routes.\ - \ \n" - items: - $ref: '#/components/schemas/RoutingPrefixFilter' - type: array tags: - description: 'A information field that can be added to identify the prefix - filter list. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the access/community + list. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -2060,101 +2316,113 @@ components: type: array required: - name - RoutingRouteMap: + RoutingAccessListScreenV2N1: properties: - auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' + items: + $ref: '#/components/schemas/ASPathRegex' + type: array + auto_generated: + description: "The value true or false for auto-generated access lists. \n" type: boolean description: - description: 'The description of the route map. Max size = 1024. + description: 'The description of the access list. Max size = 1024. ' id: - description: "The ID of the route map. \n" + description: "The ID of the access list. \n" type: string name: - description: 'The name of the route map. Max size = 128. + description: 'The name of the access list. Max size = 128. ' type: string - route_map_entries: - description: "The details of the route map entries. \n" - items: - $ref: '#/components/schemas/RoutingRouteMapEntry' - type: array tags: - description: 'A information field that can be added to identify the route - map. Maximum 10 unique tags of length 1024 each are allowed. - - ' + description: "A information field that can be added to identify the access\ + \ list. Maximum 10 unique tags of length 1024 each are allowed. \n" items: description: Tags type: string type: array required: - name - RoutingRouteMapEntry: + RoutingAccessListV2N1: properties: - continue_entry: - description: 'To continue to use the rule that the route matches. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' - type: string - match: - $ref: '#/components/schemas/MatchClauses' - description: "The details of route match. \n" - order: - description: 'Enter an order number from 1 to 65535 to define the order - in which this route map will be used. + items: + $ref: '#/components/schemas/ASPathRegex' + type: array + auto_generated: + description: "The value true or false for auto-generated access lists. \n" + type: boolean + description: + description: 'The description of the access list. Max size = 1024. ' - format: int32 - type: integer - permit: - description: 'It allow routes to be advertised or Deny to block the routes - from being advertised. + id: + description: "The ID of the access list. \n" + type: string + name: + description: 'The name of the access list. Max size = 128. ' - type: boolean - set: - $ref: '#/components/schemas/SetClauses' - description: 'The details of the route map set. + type: string + tags: + description: 'A information field that can be added to identify the access + list. Maximum 10 unique tags of length 1024 each are allowed. ' - RoutingRouteMapEntryV2N1: + items: + description: Tags + type: string + type: array + required: + - name + RoutingCommunityList: properties: - continue_entry: - description: 'To continue to use the rule that the route matches. + auto_generated: + description: 'The value true or false for auto-generated IP community lists. ' - type: string - match: - $ref: '#/components/schemas/MatchClauses' - description: "The details of route match. \n" - order: - description: 'Enter an order number from 1 to 65535 to define the order - in which this route map will be used. + type: boolean + community_list: + description: "The details of the IP community lists. \n" + items: + $ref: '#/components/schemas/RoutingIPCommunity' + type: array + description: + description: 'The description of the IP community list. Max size = 1024. ' - format: int32 - type: integer - permit: - description: 'It allow routes to be advertised or Deny to block the routes - from being advertised. + id: + description: "The ID of the IP community list. \n" + type: string + name: + description: 'The name of the IP community list. Max size = 128. ' - type: boolean - set: - $ref: '#/components/schemas/SetClauses' - description: "The details of the route map set. \n" - RoutingRouteMapQuery: + type: string + tags: + description: "A information field that can be added to identify the IP community\ + \ list. Maximum 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + RoutingCommunityListQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of route maps that match the query parameters. + description: 'The aggregate number of community lists that match the query + parameters. ' dest_page: @@ -2164,12 +2432,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of route maps deleted for a time frame. + description: 'The number of community lists deleted for a time frame. ' type: boolean group_by: - description: 'Group the route maps for the query. + description: 'Group the community lists for the query. ' items: @@ -2177,7 +2445,7 @@ components: type: string type: array id: - description: "Lists the route maps by ID. \n" + description: "Lists the community lists by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -2219,34 +2487,33 @@ components: ' format: int64 type: integer - RoutingRouteMapQueryFilter: + RoutingCommunityListQueryFilter: properties: auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + description: 'The value true or false for auto-generated IP community lists. ' type: boolean + community_list: + description: "The details of the IP community lists. \n" + items: + $ref: '#/components/schemas/RoutingIPCommunity' + type: array description: - description: 'The description of the route map. Max size = 1024. + description: 'The description of the IP community list. Max size = 1024. ' id: - description: "The ID of the route map. \n" + description: "The ID of the IP community list. \n" type: string name: - description: 'The name of the route map. Max size = 128. + description: 'The name of the IP community list. Max size = 128. ' type: string - route_map_entries: - description: "The details of the route map entries. \n" - items: - $ref: '#/components/schemas/RoutingRouteMapEntry' - type: array tags: - description: 'A information field that can be added to identify the route - map. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the IP community + list. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -2255,34 +2522,33 @@ components: type: array required: - name - RoutingRouteMapQueryFilterV2N1: + RoutingCommunityListScreen: properties: auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + description: 'The value true or false for auto-generated IP community lists. ' type: boolean + community_list: + description: "The details of the IP community lists. \n" + items: + $ref: '#/components/schemas/RoutingIPCommunity' + type: array description: - description: 'The description of the route map. Max size = 1024. + description: 'The description of the IP community list. Max size = 1024. ' id: - description: "The ID of the route map. \n" + description: "The ID of the IP community list. \n" type: string name: - description: 'The name of the route map. Max size = 128. + description: 'The name of the IP community list. Max size = 128. ' type: string - route_map_entries: - description: "The details of the route map entries. \n" - items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' - type: array tags: - description: 'A information field that can be added to identify the route - map. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the IP community + list. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -2291,340 +2557,2285 @@ components: type: array required: - name - RoutingRouteMapScreen: + RoutingIPCommunity: properties: - auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + community_str: + description: 'The community string. Max size = 256. ' + type: string + permit: + description: "The permit of the IP community sctring = Permit or Deny. \n" type: boolean - description: - description: 'The description of the route map. Max size = 1024. + required: + - community_str + RoutingPrefixFilter: + properties: + ge: + description: 'The prefix filter value for ge operator should be within the + range 1-32. ' - id: - description: "The ID of the route map. \n" - type: string - name: - description: 'The name of the route map. Max size = 128. + format: int32 + type: integer + ipv6_prefix: + description: 'The IPv6 address prefix. ' type: string - route_map_entries: - description: "The details of the route map entries. \n" - items: - $ref: '#/components/schemas/RoutingRouteMapEntry' - type: array - tags: - description: 'A information field that can be added to identify the route - map. Maximum 10 unique tags of length 1024 each are allowed. + le: + description: "The prefix filter value for le operator should be within the\ + \ range 1-32. \n" + format: int32 + type: integer + order: + description: 'The order of the prefix filter. ' - items: - description: Tags - type: string - type: array - required: - - name - RoutingRouteMapScreenV2N1: - properties: - auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + format: int32 + type: integer + permit: + description: 'The permit of the IP community sctring = Permit or Deny. ' type: boolean - description: - description: 'The description of the route map. Max size = 1024. + prefix: + description: 'The valid prefix filters. + + ' + type: string + RoutingPrefixFilterV2N1: + properties: + ge: + description: 'The prefix filter value for ge operator should be within the + range 1-32. + + ' + format: int32 + type: integer + ipv6_prefix: + description: "The IPv4 prefixes. \n" + type: string + le: + description: "The prefix filter value for le operator should be within the\ + \ range 1-32. \n" + format: int32 + type: integer + order: + description: 'The order of the prefix filter. + + ' + format: int32 + type: integer + permit: + description: 'The permit of the IP community string = Permit or Deny. + + ' + type: boolean + prefix: + description: 'The valid prefix filters. + + ' + type: string + RoutingPrefixList: + properties: + auto_generated: + description: 'The value true or false for auto-generated prefix list for + an element. + + ' + type: boolean + description: + description: 'The description of the prefix filter list. Max size = 1024. ' id: - description: "The ID of the route map. \n" + description: "The ID of the prefix filter list. \n" type: string name: - description: 'The name of the route map. Max size = 128. + description: 'The name of the prefix filter list. Max size = 128. ' type: string - route_map_entries: - description: "The details of the route map entries. \n" + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + $ref: '#/components/schemas/RoutingPrefixFilter' type: array tags: - description: "A information field that can be added to identify the route\ - \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. + + ' items: description: Tags type: string type: array required: - name - RoutingRouteMapV2N1: + RoutingPrefixListQueryFilter: properties: auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + description: 'The value true or false for auto-generated prefix list for + an element. ' type: boolean description: - description: 'The description of the route map. Max size = 1024. + description: 'The description of the prefix filter list. Max size = 1024. ' id: - description: "The ID of the route map. \n" + description: "The ID of the prefix list. \n" type: string name: - description: 'The name of the route map. Max size = 128. + description: 'The name of the prefix filter list. Max size = 128. ' type: string - route_map_entries: - description: "The details of the route map entries. \n" + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + $ref: '#/components/schemas/RoutingPrefixFilter' type: array tags: - description: "A information field that can be added to identify the route\ - \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. + + ' items: description: Tags type: string type: array required: - name - SecurityPolicy: + RoutingPrefixListQueryFilterV2N1: properties: - action: - $ref: '#/components/schemas/Action' - description: 'The action to allow, deny, or reject traffic based on the - security intent of the enterprise. - - ' - app_ids: - description: 'The App IDs. - - ' - items: - description: App Ids - type: string - type: array - direction: - $ref: '#/components/schemas/Direction' - description: 'The direction of the traffic. + auto_generated: + description: 'The value true or false for auto-generated prefix list for + an element. ' - SetClauses: - properties: - as_path_prepend: - description: 'The AS path prepend. + type: boolean + description: + description: 'The description of the prefix filter list. Max size = 1024. ' + id: + description: "The ID of the prefix list. \n" type: string - community: - description: "The community. \n" - type: string - ip_next_hop: - description: Ip Next Hop - type: string - local_preference: - description: 'The local preference. - - ' - format: int64 - type: integer - tag: - description: 'A information field that can be added to identify the set - clause. + name: + description: 'The name of the prefix filter list. Max size = 128. ' - format: int32 - type: integer - weight: - description: 'The weight of the set clause. + type: string + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" + items: + $ref: '#/components/schemas/RoutingPrefixFilterV2N1' + type: array + tags: + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. ' - format: int64 - type: integer - StateNextHop: + items: + description: Tags + type: string + type: array + required: + - name + RoutingPrefixListScreen: properties: - nexthop_ip: - description: 'The IP address of the next hop. + auto_generated: + description: 'The value true or false for auto-generated prefix list for + an element. ' - type: string - reachability_status: - description: 'The reachability status. + type: boolean + description: + description: 'The description of the prefix filter list. Max size = 1024. ' - type: boolean - StaticRouteStatus: - properties: id: - description: 'The ID of the static route. + description: "The ID of the prefix filter list. \n" + type: string + name: + description: 'The name of the prefix filter list. Max size = 128. ' type: string - nexthops: - description: 'The details of the next hop. + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" + items: + $ref: '#/components/schemas/RoutingPrefixFilter' + type: array + tags: + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. ' items: - $ref: '#/components/schemas/StateNextHop' + description: Tags + type: string type: array required: - - nexthops - StaticRouteStatusV2N2: + - name + RoutingPrefixListScreenV2N1: properties: + auto_generated: + description: 'The value true or false for auto-generated prefix list for + an element. + + ' + type: boolean + description: + description: 'The description of the prefix filter list. Max size = 1024. + + ' id: - description: 'The ID of the static route. + description: "The ID of the prefix filter list. \n" + type: string + name: + description: 'The name of the prefix filter list. Max size = 128. ' type: string - nexthops: - description: 'The details of the next hop. + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" + items: + $ref: '#/components/schemas/RoutingPrefixFilterV2N1' + type: array + tags: + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. ' items: - $ref: '#/components/schemas/StateNextHop' + description: Tags + type: string type: array - StaticRouteV2N1: + required: + - name + RoutingPrefixListV2N1: properties: - description: - description: 'The description of the static route. Max size = 256. + auto_generated: + description: 'The value true or false for auto-generated prefix list for + an element. ' - destination_prefix: - description: 'The IPv4 or IPv6 address mask for next hop Destination Prefix - (IPv4 or IPv6). + type: boolean + description: + description: 'The description of the prefix filter list. Max size = 1024. ' - type: string id: - description: 'The ID of the static route. - - ' + description: "The ID of the prefix filter list. \n" type: string name: - description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of - the resource exceeds limit., min = 0) ' - type: string - network_context_id: - description: 'The ID of the network context. + description: 'The name of the prefix filter list. Max size = 128. ' type: string - nexthop_reachability_probe: - description: Nexthop Reachability Probe - type: boolean - nexthops: - description: 'The details of the next hops configured on the static route. + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" + items: + $ref: '#/components/schemas/RoutingPrefixFilterV2N1' + type: array + tags: + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. ' - items: - $ref: '#/components/schemas/NextHop' - type: array - scope: - description: 'The scope of the static route = Local or Global. If scope - is local, the device does not advertise the route to other sites and if - scope is global, the device advertises the route to other sites. - - ' - enum: - - GLOBAL - - LOCAL - type: string - tags: - description: "A information field that can be added to identify the static\ - \ route. Maximum 10 unique tags of length 1024 each are allowed. \n" items: description: Tags type: string type: array required: - - scope - - nexthops - - destination_prefix - StaticRouteV2N2: + - name + RoutingRouteMapEntryV2N1: properties: - address_family: - description: "The static route address family. \n" + continue_entry: + description: 'To continue to use the rule that the route matches. + + ' type: string - description: - description: 'The description of the static route. Max size = 256. + match: + $ref: '#/components/schemas/MatchClauses' + description: "The details of route match. \n" + order: + description: 'Enter an order number from 1 to 65535 to define the order + in which this route map will be used. ' - destination_prefix: - description: 'The IPv4 or IPv6 address mask for next hop Destination Prefix - (IPv4 or IPv6). + format: int32 + type: integer + permit: + description: 'It allow routes to be advertised or Deny to block the routes + from being advertised. + + ' + type: boolean + set: + $ref: '#/components/schemas/SetClauses' + description: 'The details of the route map set. + + ' + RoutingRouteMapEntryV2N2: + properties: + continue_entry: + description: 'To continue to use the rule that the route matches. ' type: string + match: + $ref: '#/components/schemas/MatchClauses' + description: "The details of route match. \n" + order: + description: 'Enter an order number from 1 to 65535 to define the order + in which this route map will be used. + + ' + format: int32 + type: integer + permit: + description: 'It allow routes to be advertised or Deny to block the routes + from being advertised. + + ' + type: boolean + set: + $ref: '#/components/schemas/SetClauses' + description: 'The details of the route map set. + + ' + RoutingRouteMapQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of route maps that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of route maps deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the route maps for the query. + + ' + items: + description: Group By + type: string + type: array id: - description: 'The ID of the static route. + description: "Lists the route maps by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + RoutingRouteMapQueryFilterV2N1: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. + + ' + type: boolean + description: + description: 'The description of the route map. Max size = 1024. ' + id: + description: "The ID of the route map. \n" type: string name: - description: 'The name of the static route. + description: 'The name of the route map. Max size = 128. ' type: string - network_context_id: - description: 'The ID of the network context. + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + type: array + tags: + description: 'A information field that can be added to identify the route + map. Maximum 10 unique tags of length 1024 each are allowed. ' - type: string - nexthop_reachability_probe: - description: 'The Next Hop Reachability Probe is enabled. + items: + description: Tags + type: string + type: array + required: + - name + RoutingRouteMapQueryFilterV2N2: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. ' type: boolean - nexthops: - description: 'The details of the next hops configured on the static route. + description: + description: 'The description of the route map. Max size = 1024. + + ' + id: + description: "The ID of the route map. \n" + type: string + name: + description: 'The name of the route map. Max size = 128. + + ' + type: string + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N2' + type: array + tags: + description: 'A information field that can be added to identify the route + map. Maximum 10 unique tags of length 1024 each are allowed. ' items: - $ref: '#/components/schemas/NextHop' + description: Tags + type: string type: array - scope: - description: 'The scope of the static route = Local or Global. If scope - is local, the device does not advertise the route to other sites and if - scope is global, the device advertises the route to other sites. + required: + - name + RoutingRouteMapScreenV2N1: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. ' - enum: - - GLOBAL - - LOCAL + type: boolean + description: + description: 'The description of the route map. Max size = 1024. + + ' + id: + description: "The ID of the route map. \n" type: string - tags: - description: 'A information field that can be added to identify the static - route. Maximum 10 unique tags of length 1024 each are allowed. + name: + description: 'The name of the route map. Max size = 128. ' + type: string + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + type: array + tags: + description: "A information field that can be added to identify the route\ + \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" items: description: Tags type: string type: array required: - - address_family - - scope - - nexthops - - destination_prefix -info: - contact: {} - description: List of APIs used to configure all routing contructs like, BGP configs, - static routes, AS paths, and community lists. - title: Routing - version: Latest -openapi: 3.0.0 -paths: - /v2.0/api/tenants/{tenant_id}/enterpriseprefixset: - get: - description: List the prefix set of a tenant enterprise. - operationId: get-v2.0-api-tenants-tenant_id-enterpriseprefixset + - name + RoutingRouteMapScreenV2N2: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. + + ' + type: boolean + description: + description: 'The description of the route map. Max size = 1024. + + ' + id: + description: "The ID of the route map. \n" + type: string + name: + description: 'The name of the route map. Max size = 128. + + ' + type: string + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N2' + type: array + tags: + description: "A information field that can be added to identify the route\ + \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + RoutingRouteMapV2N1: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. + + ' + type: boolean + description: + description: 'The description of the route map. Max size = 1024. + + ' + id: + description: "The ID of the route map. \n" + type: string + name: + description: 'The name of the route map. Max size = 128. + + ' + type: string + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + type: array + tags: + description: "A information field that can be added to identify the route\ + \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + RoutingRouteMapV2N2: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. + + ' + type: boolean + description: + description: 'The description of the route map. Max size = 1024. + + ' + id: + description: "The ID of the route map. \n" + type: string + name: + description: 'The name of the route map. Max size = 128. + + ' + type: string + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N2' + type: array + tags: + description: "A information field that can be added to identify the route\ + \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + SecurityPolicy: + properties: + action: + $ref: '#/components/schemas/Action' + description: 'The action to allow, deny, or reject traffic based on the + security intent of the enterprise. + + ' + app_ids: + description: 'The App IDs. + + ' + items: + description: App Ids + type: string + type: array + direction: + $ref: '#/components/schemas/Direction' + description: 'The direction of the traffic. + + ' + SetClauses: + properties: + as_path_prepend: + description: 'The AS path prepend. + + ' + type: string + community: + description: "The community. \n" + type: string + ip_next_hop: + description: Ip Next Hop + type: string + local_preference: + description: 'The local preference. + + ' + format: int64 + type: integer + tag: + description: 'A information field that can be added to identify the set + clause. + + ' + format: int32 + type: integer + weight: + description: 'The weight of the set clause. + + ' + format: int64 + type: integer + StateNextHop: + properties: + nexthop_ip: + description: 'The IP address of the next hop. + + ' + type: string + reachability_status: + description: 'The reachability status. + + ' + type: boolean + StaticRouteStatus: + properties: + id: + description: 'The ID of the static route. + + ' + type: string + nexthops: + description: 'The details of the next hop. + + ' + items: + $ref: '#/components/schemas/StateNextHop' + type: array + required: + - nexthops + StaticRouteStatusV2N2: + properties: + id: + description: 'The ID of the static route. + + ' + type: string + nexthops: + description: 'The details of the next hop. + + ' + items: + $ref: '#/components/schemas/StateNextHop' + type: array + StaticRouteV2N2: + properties: + address_family: + description: "The static route address family. \n" + type: string + description: + description: 'The description of the static route. Max size = 256. + + ' + destination_prefix: + description: 'The IPv4 or IPv6 address mask for next hop Destination Prefix + (IPv4 or IPv6). + + ' + type: string + id: + description: 'The ID of the static route. + + ' + type: string + name: + description: 'The name of the static route. + + ' + type: string + network_context_id: + description: 'The ID of the network context. + + ' + type: string + nexthop_reachability_probe: + description: 'The Next Hop Reachability Probe is enabled. + + ' + type: boolean + nexthops: + description: 'The details of the next hops configured on the static route. + + ' + items: + $ref: '#/components/schemas/NextHop' + type: array + scope: + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' + enum: + - GLOBAL + - LOCAL + type: string + tags: + description: 'A information field that can be added to identify the static + route. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - address_family + - scope + - nexthops + - destination_prefix + StaticRouteV2N3: + properties: + address_family: + description: "The static route address family. \n" + type: string + description: + description: 'The description of the static route. Max size = 256. + + ' + destination_prefix: + description: 'The IPv4 or IPv6 address mask for next hop Destination Prefix + (IPv4 or IPv6). + + ' + type: string + id: + description: 'The ID of the static route. + + ' + type: string + name: + description: 'The name of the static route. + + ' + type: string + network_context_id: + description: 'The ID of the network context. + + ' + type: string + nexthop_reachability_probe: + description: 'The Next Hop Reachability Probe is enabled. + + ' + type: boolean + nexthops: + description: 'The details of the next hops configured on the static route. + + ' + items: + $ref: '#/components/schemas/NextHop' + type: array + scope: + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' + enum: + - GLOBAL + - LOCAL + type: string + tags: + description: 'A information field that can be added to identify the static + route. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string + required: + - address_family + - scope + - nexthops + - destination_prefix + VRFContext: + properties: + default_vrf_context: + description: "VRF context is enabled by default. True / False. \n" + type: boolean + description: + description: 'Description of the VRF context config. Max size = 256. + + ' + id: + description: 'The VRF context ID. + + ' + type: string + name: + description: 'The name of the VRF context. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + context. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + VRFContextProfile: + properties: + default_vrf_context_profile: + description: "VRF profile is enabled by default. True / False. \n" + type: boolean + description: + description: 'Description of the VRF profile. Max size = 256. + + ' + id: + description: 'The VRF profile ID. + + ' + type: string + name: + description: 'The name of the VRF profile. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + profile. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + vrf_context_ids: + description: 'The VRF context IDs. + + ' + items: + description: Vrf Context Ids + type: string + type: array + vrf_context_route_leak_rules: + description: 'The valid VRF context leak rules. + + ' + items: + $ref: '#/components/schemas/VRFContextRouteLeakRule' + type: array + required: + - name + VRFContextProfileQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of VRF profiles that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number VRF profiles deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the VRF profiles for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the VRF profiles by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + description: 'Query using query parameters. + + ' + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + VRFContextProfileQueryFilter: + properties: + default_vrf_context_profile: + description: "VRF profile is enabled by default. True / False. \n" + type: boolean + description: + description: 'Description of the VRF profile. Max size = 256. + + ' + id: + description: 'The VRF profile ID. + + ' + type: string + name: + description: 'The name of the VRF profile. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + profile. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + vrf_context_ids: + description: 'The VRF context IDs. + + ' + items: + description: Vrf Context Ids + type: string + type: array + vrf_context_route_leak_rules: + description: 'The valid VRF context leak rules. + + ' + items: + $ref: '#/components/schemas/VRFContextRouteLeakRule' + type: array + required: + - name + VRFContextProfileScreen: + properties: + description: + description: 'Description of the VRF profile. Max size = 256. + + ' + id: + description: 'The VRF profile ID. + + ' + type: string + name: + description: 'The name of the VRF profile. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + profile. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + vrf_context_ids: + description: 'The VRF context IDs. + + ' + items: + description: Vrf Context Ids + type: string + type: array + vrf_context_route_leak_rules: + description: 'The valid VRF context leak rules. + + ' + items: + $ref: '#/components/schemas/VRFContextRouteLeakRule' + type: array + required: + - name + VRFContextQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of VRF contexts that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number VRF contexts deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the VRF contexts for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the VRF contexts by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + description: 'Query using query parameters. + + ' + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + VRFContextQueryFilter: + properties: + default_vrf_context: + description: "VRF context is enabled by default. True / False. \n" + type: boolean + description: + description: 'Description of the VRF context config. Max size = 256. + + ' + id: + description: 'The VRF context ID. + + ' + type: string + name: + description: 'The name of the VRF context. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + context. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + VRFContextRouteLeakRule: + properties: + description: + description: 'Description of the Route Leak Rule. Max size = 256. + + ' + dest_vrf_context_id: + description: "The destination VRF ID for the Route Leak Rule. \n" + type: string + ipv4_prefixes: + description: 'The leaked IPv4 prefixes of the Route Leak Rule. The leaked + IPv4 prefix in the route leak rule must match the prefix configured on + the interface. + + ' + items: + description: Ipv4 Prefixes + type: string + type: array + name: + description: 'The name of the Route Leak Rule. Max size = 128. + + ' + type: string + src_vrf_context_id: + description: 'The SRC VRF ID. + + ' + type: string + VRFContextScreen: + properties: + description: + description: 'Description of the VRF context config. Max size = 256. + + ' + id: + description: 'The VRF context ID. + + ' + type: string + name: + description: 'The name of the VRF context. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + context. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name +info: + contact: {} + description: List of APIs used to configure all routing contructs like, BGP configs, + static routes, AS paths, and community lists. + title: Routing + version: Latest +openapi: 3.0.0 +paths: + /v2.0/api/tenants/{tenant_id}/enterpriseprefixset: + get: + description: List the prefix set of a tenant enterprise. + operationId: get-v2.0-api-tenants-tenant_id-enterpriseprefixset + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EnterprisePrefixSetN' + description: Successful Operation + summary: Get Tenant Enterprise Prefix Set (v2.0) + tags: + - Routing + put: + description: Update the prefix set of a tenant enterprise. + operationId: put-v2.0-api-tenants-tenant_id-enterpriseprefixset + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnterprisePrefixSetN' + description: Enterprise prefix Set + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EnterprisePrefixSetN' + description: Successful Operation + summary: Update Tenant Enterprise Prefix Set (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}/operations: + post: + description: Reset the BGP peer configuration. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id-operations + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the BGP peer. + in: path + name: bgp_peer_id + required: true + schema: + description: Bgp Peer Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerOperations' + description: Details of the BGP peer config to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerOperations' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BGP_PEER_CONFIG_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Reset BGP Peer Config (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/advertisedprefixes: + get: + description: List all the BGP peer advertised prefixes. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-advertisedprefixes + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the BGP peer config. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerAdvertisedPrefixes' + description: Successful Operation + summary: Get BGP Peer Advertised Prefixes (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/discoveredprefixes: + get: + description: List all the BGP discovered prefix information. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-discoveredprefixes + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the BGP peer config. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerDiscoveredPrefixes' + description: Successful Operation + summary: Get BGP Discovered Prefixes (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/reachableprefixes: + get: + description: List all the BGP reachable prefix information. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-reachableprefixes + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the BGP peer config. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerReachablePrefixes' + description: Successful Operation + summary: Get BGP Reachable Prefix (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: + get: + description: List all the access lists for the element. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingAccessList' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Access List for Element (v2.0) + tags: + - Routing + post: + description: Create a AS-Path access list. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessListScreen' + description: Details of the as-path access list to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: NOT_SUPPORTED_BY_ELEMENT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create AS-Path Access List (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: + post: + description: Queries the DB for limit number of access lists that match query + parameters. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessListQuery' + description: Query details for access lists + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingAccessListQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Access Lists (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: + delete: + description: Delete the access list. + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the access list. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ACCESS_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Access List (v2.0) + tags: + - Routing + get: + description: Get a specific access list. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The BGP peer config ID. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessList' + description: Successful Operation + summary: Get Access List (v2.0) + tags: + - Routing + put: + description: Updates the access list. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the access list. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessListScreen' + description: Details of the as-path access list to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Access List (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists: + get: + description: Get all the community lists for an element. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingCommunityList' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Community List for Element (v2.0) + tags: + - Routing + post: + description: Create an IP community list. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessListScreen' + description: Details of the community list to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingCommunityList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: NOT_SUPPORTED_BY_ELEMENT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_COMMUNITY_LIST_NAME + - code: MAX_LIMIT_FOR_COMMUNITY_LIST_EXCEEDS + - code: COMMUNITY_LIST_ALREADY_DEFINED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create IP Community List (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists/query: + post: + description: Queries the DB for limit number of community lists that match the + query parameters. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingCommunityListQuery' + description: Query details for Routing Community + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingCommunityListQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Community Lists (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists/{config_id}: + delete: + description: Deletes the community list. + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the IP community list. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingCommunityList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: COMMUNITY_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_COMMUNITY_LIST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Community List (v2.0) + tags: + - Routing + get: + description: Lists a specific community list. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The BGP peer config ID. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingCommunityList' + description: Successful Operation + summary: Get Community List (v2.0) + tags: + - Routing + put: + description: Updates the community list. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the IP community list. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingCommunityListScreen' + description: Details of the community list to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingCommunityList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: CANNOT_UPDATE_AUTOGENERATED_COMMUNITY_LIST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_COMMUNITY_LIST_NAME + - code: MAX_LIMIT_FOR_COMMUNITY_LIST_EXCEEDS + - code: COMMUNITY_LIST_ALREADY_DEFINED + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Community List (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists: + get: + description: Get all the prefix lists for an element. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingPrefixList' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Prefix List for Element (v2.0) + tags: + - Routing + post: + description: Create an IP Prefix List. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingPrefixListScreen' + description: Details of the prefix list to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingPrefixList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: NOT_SUPPORTED_BY_ELEMENT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create IP Prefix List (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists/query: + post: + description: Queries the DB for limit number of prefix lists that match the + query parameters. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-query parameters: - description: ID of the tenant. in: path @@ -2633,19 +4844,58 @@ paths: schema: description: Tenant Id type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessListQuery' + description: Query details for access lists responses: '200': content: application/json: schema: - $ref: '#/components/schemas/EnterprisePrefixSetN' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingPrefixListQueryFilter' + type: array + type: object description: Successful Operation - summary: Get Tenant Enterprise Prefix Set (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Prefix Lists (v2.0) tags: - Routing - put: - description: Update the prefix set of a tenant enterprise. - operationId: put-v2.0-api-tenants-tenant_id-enterpriseprefixset + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists/{config_id}: + delete: + description: Delete a prefix list. + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-config_id parameters: - description: ID of the tenant. in: path @@ -2654,26 +4904,51 @@ paths: schema: description: Tenant Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EnterprisePrefixSetN' - description: Enterprise prefix Set + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the prefix list. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/EnterprisePrefixSetN' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation - summary: Update Tenant Enterprise Prefix Set (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: PREFIX_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_PREFIX_LIST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Prefix List (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/status: get: - description: List all the BGP peer statuses from NB. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-status + description: Get a specific prefix list. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-config_id parameters: - description: ID of the tenant. in: path @@ -2696,27 +4971,26 @@ paths: schema: description: Element Id type: string + - description: The BGP peer config ID. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPPeerStatus' - type: array - type: object + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation - summary: Get BGP Peer Status from NB (v2.0) + summary: Get Prefix List (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}/operations: - post: - description: Reset the BGP peer configuration. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id-operations + put: + description: Update a prefix list. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-config_id parameters: - description: ID of the tenant. in: path @@ -2739,25 +5013,25 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. + - description: The ID of the prefix list. in: path - name: bgp_peer_id + name: config_id required: true schema: - description: Bgp Peer Id + description: Config Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerOperations' - description: Details of the BGP peer config to be created + $ref: '#/components/schemas/RoutingPrefixListScreen' + description: Details of the prefix list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerOperations' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation '400': content: @@ -2765,17 +5039,19 @@ paths: example: value: _error: - - code: BGP_PEER_CONFIG_NOT_FOUND + - code: CANNOT_UPDATE_AUTOGENERATED_PREFIX_LIST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Reset BGP Peer Config (v2.0) + summary: Update Prefix List (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/advertisedprefixes: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/localprefixset: get: - description: List all the BGP peer advertised prefixes. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-advertisedprefixes + description: List the site local prefix set. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-localprefixset parameters: - description: ID of the tenant. in: path @@ -2791,34 +5067,130 @@ paths: schema: description: Site Id type: string - - description: The ID of the element. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixSet' + description: Successful Operation + summary: Get Site Local Prefix Set (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/vrfcontextprofiles: + get: + description: List all the VRF context profiles. + operationId: get-v2.0-api-tenants-tenant_id-vrfcontextprofiles + parameters: + - description: ID of the tenant. in: path - name: element_id + name: tenant_id required: true schema: - description: Element Id + description: Tenant Id type: string - - description: The ID of the BGP peer config. + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/VRFContextProfile' + type: array + type: object + description: Successful Operation + summary: Get VRF Context Profiles (v2.0) + tags: + - Routing + post: + description: Create a new VRF context profile. + operationId: post-v2.0-api-tenants-tenant_id-vrfcontextprofiles + parameters: + - description: ID of the tenant. in: path - name: config_id + name: tenant_id required: true schema: - description: Config Id + description: Tenant Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VRFContextProfileScreen' + description: VRF Context Profile Request responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerAdvertisedPrefixes' + $ref: '#/components/schemas/VRFContextProfile' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: VRF_CONTEXT_PROFILE_NAME_INVALID + - code: VRF_CONTEXT_PROFILE_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_PROFILE_DESCRIPTION_INVALID + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_NAME_INVALID + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_DESCRIPTION_INVALID + - code: SOURCE_VRF_CONTEXT_INVALID + - code: DESTINATION_VRF_CONTEXT_INVALID + - code: INVALID_PREFIX + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create VRF Context Profile (v2.0) + tags: + - Routing + /v2.0/api/tenants/{tenant_id}/vrfcontextprofiles/query: + post: + description: Query VRF context profiles. + operationId: post-v2.0-api-tenants-tenant_id-vrfcontextprofiles-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VRFContextProfileQuery' + description: Query Details for the Vrf Context Profile + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/VRFContextProfileQueryFilter' + type: array + type: object description: Successful Operation - summary: Get BGP Peer Advertised Prefixes (v2.0) + summary: Query VRF Context Profiles (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/discoveredprefixes: - get: - description: List all the BGP discovered prefix information. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-discoveredprefixes + /v2.0/api/tenants/{tenant_id}/vrfcontextprofiles/{vrf_context_profile_id}: + delete: + description: Delete a VRF context profile. + operationId: delete-v2.0-api-tenants-tenant_id-vrfcontextprofiles-vrf_context_profile_id parameters: - description: ID of the tenant. in: path @@ -2827,41 +5199,36 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The ID of the BGP peer config. + - description: The ID of the VRF context profile. in: path - name: config_id + name: vrf_context_profile_id required: true schema: - description: Config Id + description: Vrf Context Profile Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerDiscoveredPrefixes' + $ref: '#/components/schemas/VRFContextProfile' description: Successful Operation - summary: Get BGP Discovered Prefixes (v2.0) + '404': + content: + application/json: + example: + value: + _error: + - code: VRF_CONTEXT_PROFILE_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: NOT FOUND + summary: Delete VRF Context Profile (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/reachableprefixes: get: - description: List all the BGP reachable prefix information. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-reachableprefixes + description: Get a VRF context profile. + operationId: get-v2.0-api-tenants-tenant_id-vrfcontextprofiles-vrf_context_profile_id parameters: - description: ID of the tenant. in: path @@ -2870,41 +5237,36 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The ID of the BGP peer config. + - description: The ID of the VRF context profile. in: path - name: config_id + name: vrf_context_profile_id required: true schema: - description: Config Id + description: Vrf Context Profile Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerReachablePrefixes' + $ref: '#/components/schemas/VRFContextProfile' description: Successful Operation - summary: Get BGP Reachable Prefix (v2.0) + '404': + content: + application/json: + example: + value: + _error: + - code: VRF_CONTEXT_PROFILE_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: NOT FOUND + summary: Get VRF Context Profile (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/status: - get: - description: List the BGP peer status information from NB. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-status + put: + description: Update a VRF context profile. + operationId: put-v2.0-api-tenants-tenant_id-vrfcontextprofiles-vrf_context_profile_id parameters: - description: ID of the tenant. in: path @@ -2913,41 +5275,52 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The ID of the BGP peer config. + - description: The ID of the VRF context profile. in: path - name: config_id + name: vrf_context_profile_id required: true schema: - description: Config Id + description: Vrf Context Profile Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VRFContextProfileScreen' + description: Details of vrf context profile to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerStatus' + $ref: '#/components/schemas/VRFContextProfile' description: Successful Operation - summary: Get BGP Peer Status from NB (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: VRF_CONTEXT_PROFILE_NAME_INVALID + - code: VRF_CONTEXT_PROFILE_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_PROFILE_DESCRIPTION_INVALID + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_NAME_INVALID + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_DESCRIPTION_INVALID + - code: SOURCE_VRF_CONTEXT_INVALID + - code: DESTINATION_VRF_CONTEXT_INVALID + - code: INVALID_PREFIX + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update VRF Context Profile (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: + /v2.0/api/tenants/{tenant_id}/vrfcontexts: get: - description: List all the access lists for the element. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists + description: Get a VRF segments. + operationId: get-v2.0-api-tenants-tenant_id-vrfcontexts parameters: - description: ID of the tenant. in: path @@ -2956,20 +5329,6 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string responses: '200': content: @@ -2980,26 +5339,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/VRFContext' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Access List for Element (v2.0) + summary: Get VRF Segments (v2.0) tags: - Routing post: - description: Create a AS-Path access list. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists + description: Create a VRF segment. + operationId: post-v2.0-api-tenants-tenant_id-vrfcontexts parameters: - description: ID of the tenant. in: path @@ -3008,32 +5357,18 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListScreen' - description: Details of the as-path access list to be created + $ref: '#/components/schemas/VRFContextScreen' + description: VRF Context Request responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/VRFContext' description: Successful Operation '400': content: @@ -3041,21 +5376,20 @@ paths: example: value: _error: - - code: ELEMENT_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: NOT_SUPPORTED_BY_ELEMENT + - code: VRF_CONTEXT_CONFIG_DESCRIPTION_INVALID + - code: VRF_CONTEXT_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_NAME_INVALID - code: INVALID_JSON_EXTRA_ATTRIBUTE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create AS-Path Access List (v2.0) + summary: Create VRF Segment (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: + /v2.0/api/tenants/{tenant_id}/vrfcontexts/query: post: - description: Queries the DB for limit number of access lists that match query - parameters. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-query + description: Query VRF contexts. + operationId: post-v2.0-api-tenants-tenant_id-vrfcontexts-query parameters: - description: ID of the tenant. in: path @@ -3064,26 +5398,12 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListQuery' - description: Query details for access lists + $ref: '#/components/schemas/VRFContextQuery' + description: Query Details for the Vrf Context responses: '200': content: @@ -3094,27 +5414,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessListQueryFilter' + $ref: '#/components/schemas/VRFContextQueryFilter' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for Access Lists (v2.0) + summary: Query VRF Contexts (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: + /v2.0/api/tenants/{tenant_id}/vrfcontexts/{vrf_context_id}: delete: - description: Delete the access list. - operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + description: Delete a VRF segment. + operationId: delete-v2.0-api-tenants-tenant_id-vrfcontexts-vrf_context_id parameters: - description: ID of the tenant. in: path @@ -3123,51 +5433,36 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The ID of the access list. + - description: The ID of the VRF context. in: path - name: config_id + name: vrf_context_id required: true schema: - description: Config Id + description: Vrf Context Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/VRFContext' description: Successful Operation - '400': + '404': content: application/json: example: value: _error: - - code: ACCESS_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST + - code: VRF_CONTEXT_NAME_INVALID schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Access List (v2.0) + description: NOT FOUND + summary: Delete VRF Segment (v2.0) tags: - Routing get: - description: Get a specific access list. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + description: Get a VRF segment. + operationId: get-v2.0-api-tenants-tenant_id-vrfcontexts-vrf_context_id parameters: - description: ID of the tenant. in: path @@ -3176,81 +5471,63 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The BGP peer config ID. + - description: The ID of the VRF context. in: path - name: config_id + name: vrf_context_id required: true schema: - description: Config Id + description: Vrf Context Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/VRFContext' description: Successful Operation - summary: Get Access List (v2.0) - tags: - - Routing - put: - description: Updates the access list. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id - parameters: - - description: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. + '404': + content: + application/json: + example: + value: + _error: + - code: INVALID_VRF_CONTEXT_ID + schema: + $ref: '#/components/schemas/Error' + description: Not Found + summary: Get VRF Segment (v2.0) + tags: + - Routing + put: + description: Update a VRF context. + operationId: put-v2.0-api-tenants-tenant_id-vrfcontexts-vrf_context_id + parameters: + - description: ID of the tenant. in: path - name: element_id + name: tenant_id required: true schema: - description: Element Id + description: Tenant Id type: string - - description: The ID of the access list. + - description: The ID of the VRF context. in: path - name: config_id + name: vrf_context_id required: true schema: - description: Config Id + description: Vrf Context Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListScreen' - description: Details of the as-path access list to be updated + $ref: '#/components/schemas/VRFContextScreen' + description: Details of vrf segment to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/VRFContext' description: Successful Operation '400': content: @@ -3258,19 +5535,19 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: VRF_CONTEXT_CONFIG_DESCRIPTION_INVALID + - code: VRF_CONTEXT_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_NAME_INVALID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Access List (v2.0) + summary: Update VRF Context (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists: + /v2.1/api/tenants/{tenant_id}/enterpriseprefixset: get: - description: Get all the community lists for an element. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists + description: List the prefix set of a tenant enterprise. + operationId: get-v2.1-api-tenants-tenant_id-enterpriseprefixset parameters: - description: ID of the tenant. in: path @@ -3279,50 +5556,47 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' + description: Successful Operation + summary: Get Tenant Enterprise Prefix Set (v2.1) + tags: + - Routing + put: + description: Update the prefix set of a tenant enterprise. + operationId: put-v2.1-api-tenants-tenant_id-enterpriseprefixset + parameters: + - description: ID of the tenant. in: path - name: element_id + name: tenant_id required: true schema: - description: Element Id + description: Tenant Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' + description: Enterprise prefix Set responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/RoutingCommunityList' - type: array - type: object + $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Community List for Element (v2.0) + summary: Update Tenant Enterprise Prefix Set (v2.1) tags: - Routing - post: - description: Create an IP community list. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/status: + get: + description: List all the BGP peer statuses from NB. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-status parameters: - description: ID of the tenant. in: path @@ -3345,43 +5619,27 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoutingAccessListScreen' - description: Details of the community list to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerStatusV2N1' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: NOT_SUPPORTED_BY_ELEMENT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_COMMUNITY_LIST_NAME - - code: MAX_LIMIT_FOR_COMMUNITY_LIST_EXCEEDS - - code: COMMUNITY_LIST_ALREADY_DEFINED - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create IP Community List (v2.0) + summary: Get BGP Peer Status from NB (v2.1) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists/query: - post: - description: Queries the DB for limit number of community lists that match the - query parameters. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists-query + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_config_id}/advertisedprefixes: + get: + description: Get BGP peer advertised prefixes. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_config_id-advertisedprefixes parameters: - description: ID of the tenant. in: path @@ -3404,44 +5662,27 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoutingCommunityListQuery' - description: Query details for Routing Community + - description: The BGP peer config ID. + in: path + name: bgp_peer_config_id + required: true + schema: + description: Bgp Peer Config Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/RoutingCommunityListQueryFilter' - type: array - type: object + $ref: '#/components/schemas/BGPPeerAdvertisedPrefixesV2N1' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_REQUEST - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for Community Lists (v2.0) + summary: Get BGP Peer Advertised Prefixes (v2.1) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists/{config_id}: - delete: - description: Deletes the community list. - operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_config_id}/reachableprefixes: + get: + description: Get BGP reachable prefix information. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_config_id-reachableprefixes parameters: - description: ID of the tenant. in: path @@ -3464,37 +5705,27 @@ paths: schema: description: Element Id type: string - - description: The ID of the IP community list. + - description: The BGP peer config ID. in: path - name: config_id + name: bgp_peer_config_id required: true schema: - description: Config Id + description: Bgp Peer Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + $ref: '#/components/schemas/BGPPeerReachablePrefixesV2N1' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: COMMUNITY_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_COMMUNITY_LIST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Community List (v2.0) + summary: Get BGP Reachable Prefix Information (v2.1) tags: - Routing + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/discoveredprefixes: get: - description: Lists a specific community list. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + description: Get BGP discovered prefix information. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-discoveredprefixes parameters: - description: ID of the tenant. in: path @@ -3529,14 +5760,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + $ref: '#/components/schemas/BGPPeerDiscoveredPrefixesV2N1' description: Successful Operation - summary: Get Community List (v2.0) + summary: Get BGP Discovered Prefix Information (v2.1) tags: - Routing - put: - description: Updates the community list. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/status: + get: + description: List the BGP peer status information from NB. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-status parameters: - description: ID of the tenant. in: path @@ -3559,48 +5791,27 @@ paths: schema: description: Element Id type: string - - description: The ID of the IP community list. + - description: The ID of the BGP peer config. in: path name: config_id required: true schema: description: Config Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoutingCommunityListScreen' - description: Details of the community list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + $ref: '#/components/schemas/BGPPeerStatusV2N1' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: CANNOT_UPDATE_AUTOGENERATED_COMMUNITY_LIST - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_COMMUNITY_LIST_NAME - - code: MAX_LIMIT_FOR_COMMUNITY_LIST_EXCEEDS - - code: COMMUNITY_LIST_ALREADY_DEFINED - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Community List (v2.0) + summary: Get BGP Peer Status from NB (v2.1) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: get: - description: Get all the prefix lists for an element. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists + description: List all the access lists for the element. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists parameters: - description: ID of the tenant. in: path @@ -3633,9 +5844,12 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/RoutingAccessListV2N1' type: array type: object + items: + $ref: '#/components/schemas/RoutingAccessListV2N1' + type: array description: Successful Operation '400': content: @@ -3647,12 +5861,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Prefix List for Element (v2.0) + summary: Get Access List for Element (v2.1) tags: - Routing post: - description: Create an IP Prefix List. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists + description: Create a AS-Path access list. + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists parameters: - description: ID of the tenant. in: path @@ -3679,14 +5893,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListScreen' - description: Details of the prefix list to be created + $ref: '#/components/schemas/RoutingAccessListScreenV2N1' + description: Details of the as-path access list to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation '400': content: @@ -3701,14 +5915,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create IP Prefix List (v2.0) + summary: Create AS-Path Access List (v2.1) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists/query: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: post: - description: Queries the DB for limit number of prefix lists that match the - query parameters. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-query + description: Queries the DB for limit number of access lists that match query + parameters. + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-query parameters: - description: ID of the tenant. in: path @@ -3747,7 +5961,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingPrefixListQueryFilter' + $ref: '#/components/schemas/RoutingAccessListQueryFilterV2N1' type: array type: object description: Successful Operation @@ -3762,13 +5976,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Prefix Lists (v2.0) + summary: Query DB for Access Lists (v2.1) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists/{config_id}: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: delete: - description: Delete a prefix list. - operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-config_id + description: Delete the access list. + operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id parameters: - description: ID of the tenant. in: path @@ -3791,7 +6005,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the prefix list. + - description: The ID of the access list. in: path name: config_id required: true @@ -3803,7 +6017,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation '400': content: @@ -3811,17 +6025,17 @@ paths: example: value: _error: - - code: PREFIX_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_PREFIX_LIST + - code: ACCESS_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Prefix List (v2.0) + summary: Delete Access List (v2.1) tags: - Routing get: - description: Get a specific prefix list. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-config_id + description: Get a specific access list. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id parameters: - description: ID of the tenant. in: path @@ -3856,14 +6070,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation - summary: Get Prefix List (v2.0) + summary: Get Access List (v2.1) tags: - Routing put: - description: Update a prefix list. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-config_id + description: Updates the access list. + operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id parameters: - description: ID of the tenant. in: path @@ -3886,7 +6100,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the prefix list. + - description: The ID of the access list. in: path name: config_id required: true @@ -3897,14 +6111,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListScreen' - description: Details of the prefix list to be updated + $ref: '#/components/schemas/RoutingAccessListV2N1' + description: Details of the access list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation '400': content: @@ -3912,19 +6126,19 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_PREFIX_LIST + - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Prefix List (v2.0) + summary: Update Access List (v2.1) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists: get: - description: List all the route maps for an element. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps + description: Get all the prefix lists for an element. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists parameters: - description: ID of the tenant. in: path @@ -3957,7 +6171,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingRouteMap' + $ref: '#/components/schemas/RoutingPrefixListV2N1' type: array type: object description: Successful Operation @@ -3971,12 +6185,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Route Map for Element (v2.0) + summary: Get Prefix List for Element (v2.1) tags: - Routing post: - description: Create a route map. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps + description: Create an IP Prefix List. + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists parameters: - description: ID of the tenant. in: path @@ -4003,14 +6217,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreen' - description: Details of route map to be created + $ref: '#/components/schemas/RoutingPrefixListScreenV2N1' + description: Details of the prefix list to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMap' + $ref: '#/components/schemas/RoutingPrefixListV2N1' description: Successful Operation '400': content: @@ -4022,26 +6236,18 @@ paths: - code: ELEMENT_NOT_ASSIGNED_TO_SITE - code: NOT_SUPPORTED_BY_ELEMENT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_ROUTE_MAP_NAME - - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS - - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER - - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER - - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND - - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND - - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND - - code: BGP_CONFIG_INVALID_AS_NUMBER - - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: PREFIX_LIST_PREFIX_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Route Map (v2.0) + summary: Create IP Prefix List (v2.1) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/query: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists/query: post: - description: Queries the DB for limit number of route maps that match the query - parameters. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-query + description: Queries the DB for limit number of prefix lists that match the + query parameters. + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-query parameters: - description: ID of the tenant. in: path @@ -4068,8 +6274,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapQuery' - description: Query details for route maps + $ref: '#/components/schemas/RoutingAccessListQuery' + description: Query details for access lists responses: '200': content: @@ -4080,7 +6286,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingRouteMapQueryFilter' + $ref: '#/components/schemas/RoutingPrefixListQueryFilterV2N1' type: array type: object description: Successful Operation @@ -4091,16 +6297,17 @@ paths: value: _error: - code: BAD_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Route Maps (v2.0) + summary: Query DB for Prefix Lists (v2.1) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists/{routing_prefixlist_id}: delete: - description: Delete a route map. - operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id + description: Delete a prefix list. + operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id parameters: - description: ID of the tenant. in: path @@ -4123,19 +6330,19 @@ paths: schema: description: Element Id type: string - - description: The ID of the route map. + - description: The routing prefix list ID. in: path - name: config_id + name: routing_prefixlist_id required: true schema: - description: Config Id + description: Routing Prefixlist Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMap' + $ref: '#/components/schemas/RoutingPrefixListV2N1' description: Successful Operation '400': content: @@ -4143,17 +6350,17 @@ paths: example: value: _error: - - code: ROUTE_MAP_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP + - code: PREFIX_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_PREFIX_LIST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Route Map (v2.0) + summary: Delete Prefix List (v2.1) tags: - Routing get: - description: Get a specific route map. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id + description: Get a prefix list. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id parameters: - description: ID of the tenant. in: path @@ -4176,26 +6383,26 @@ paths: schema: description: Element Id type: string - - description: The BGP peer config ID. + - description: The routing prefix list ID. in: path - name: config_id + name: routing_prefixlist_id required: true schema: - description: Config Id + description: Routing Prefixlist Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMap' + $ref: '#/components/schemas/RoutingPrefixListV2N1' description: Successful Operation - summary: Get Route Map (v2.0) + summary: Get Prefix List (v2.1) tags: - Routing put: - description: Update a route map. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id + description: Update a prefix list. + operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id parameters: - description: ID of the tenant. in: path @@ -4218,25 +6425,25 @@ paths: schema: description: Element Id type: string - - description: The ID of the route map. + - description: The routing prefix list ID. in: path - name: config_id + name: routing_prefixlist_id required: true schema: - description: Config Id + description: Routing Prefixlist Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreen' - description: Details of route map to be created + $ref: '#/components/schemas/RoutingPrefixListScreenV2N1' + description: Details of the prefix list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMap' + $ref: '#/components/schemas/RoutingPrefixListV2N1' description: Successful Operation '400': content: @@ -4244,28 +6451,20 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP + - code: CANNOT_UPDATE_AUTOGENERATED_PREFIX_LIST - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_ROUTE_MAP_NAME - - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS - - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER - - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER - - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND - - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND - - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND - - code: BGP_CONFIG_INVALID_AS_NUMBER - - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: PREFIX_LIST_PREFIX_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Route Map (v2.0) + summary: Update Prefix List (v2.1) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/localprefixset: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps: get: - description: List the site local prefix set. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-localprefixset + description: List all the route maps for an element. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps parameters: - description: ID of the tenant. in: path @@ -4281,69 +6480,43 @@ paths: schema: description: Site Id type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LocalPrefixSet' - description: Successful Operation - summary: Get Site Local Prefix Set (v2.0) - tags: - - Routing - /v2.1/api/tenants/{tenant_id}/enterpriseprefixset: - get: - description: GET the tenant enterprise prefix set - operationId: get-v2.1-api-tenants-tenant_id-enterpriseprefixset - parameters: - - description: Tenant Id + - description: The ID of the element. in: path - name: tenant_id + name: element_id required: true schema: - description: Tenant Id + description: Element Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + type: array + type: object description: Successful Operation - summary: GET the tenant enterprise prefix set (v2.1) - tags: - - Routing - put: - description: Update the tenant enterprise prefix set - operationId: put-v2.1-api-tenants-tenant_id-enterpriseprefixset - parameters: - - description: Tenant Id - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' - description: Enterprise prefix Set - responses: - '200': + '400': content: application/json: + example: + value: + _error: + - code: ELEMENT_NOT_ASSIGNED_TO_SITE schema: - $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' - description: Successful Operation - summary: Update the tenant enterprise prefix set (v2.1) + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Route Map for Element (v2.1) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs: - get: - description: List all the BGP configurations from NB. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs + post: + description: Create a route map. + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps parameters: - description: ID of the tenant. in: path @@ -4366,27 +6539,52 @@ paths: schema: description: Element Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingRouteMapV2N1' + description: Details of the route map to be created responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPGlobalConfigV2N1' - type: array - type: object + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation - summary: Get BGP Configs from NB (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: NOT_SUPPORTED_BY_ELEMENT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY + - code: INVALID_ROUTE_MAP_NAME + - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS + - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER + - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER + - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND + - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND + - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND + - code: BGP_CONFIG_INVALID_AS_NUMBER + - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Route Map (v2.1) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: - get: - description: List a specific BGP configuration from NB. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/query: + post: + description: Queries the DB for limit number of route maps that match the query + parameters. + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-query parameters: - description: ID of the tenant. in: path @@ -4409,26 +6607,44 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP config. - in: path - name: bgp_config_id - required: true - schema: - description: Bgp Config Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingRouteMapQuery' + description: Query details for route maps responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigV2N1' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingRouteMapQueryFilterV2N1' + type: array + type: object description: Successful Operation - summary: Get BGP Config from NB (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Route Maps (v2.1) tags: - Routing - put: - description: Updates the BGP configuration from NB. - operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: + delete: + description: Delete a route map. + operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: ID of the tenant. in: path @@ -4451,25 +6667,19 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP config. + - description: The ID of the route map. in: path - name: bgp_config_id - required: true - schema: - description: Bgp Config Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N1' - description: Details of the bgp config to be updated + name: config_id + required: true + schema: + description: Config Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation '400': content: @@ -4477,26 +6687,17 @@ paths: example: value: _error: - - code: BGP_CONFIG_INVALID_LOCAL_AS_NUM - - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_HOLD_TIME - - code: BGP_CONFIG_INVALID_ADV_INTERVAL - - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME - - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS - - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT - - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ROUTE_MAP_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update BGP Config from NB (v2.1) + summary: Delete Route Map (v2.1) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers: get: - description: List all the BGP peer configurations from NB. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers + description: Get a specific route map. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: ID of the tenant. in: path @@ -4519,26 +6720,26 @@ paths: schema: description: Element Id type: string + - description: The BGP peer config ID. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPPeerConfigEtag' - type: array - type: object + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation - summary: Get BGP Peer Configs from NB (v2.1) + summary: Get Route Map (v2.1) tags: - Routing - post: - description: Create a BGP peer configuration. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers + put: + description: Update a route map. + operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: ID of the tenant. in: path @@ -4561,18 +6762,25 @@ paths: schema: description: Element Id type: string + - description: The ID of the route map. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N1' - description: Details of the BGP peer config to be created + $ref: '#/components/schemas/RoutingRouteMapV2N1' + description: Details of the route map to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation '400': content: @@ -4580,36 +6788,30 @@ paths: example: value: _error: - - code: PEER_CONFIG_INVALID_PEER_IP - - code: BGP_CONFIG_INVALID_REMOTE_AS_NUM - - code: BGP_CONFIG_INVALID_LOCAL_AS_NUM - - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_HOLD_TIME - - code: BGP_CONFIG_INVALID_ADV_INTERVAL - - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME - - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS - - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT - - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE - - code: BGP_CONFIG_INVALID_PREFIX + - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: INVALID_PEER_CONFIG_FOR_SPOKE - - code: PEER_TYPE_NOT_SUPPORTED - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW - - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY + - code: INVALID_ROUTE_MAP_NAME + - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS + - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER + - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER + - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND + - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND + - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND + - code: BGP_CONFIG_INVALID_AS_NUMBER + - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create BGP Peer Config (v2.1) + summary: Update Route Map (v2.1) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/query: - post: - description: Queries the DB for limit number of BGP peers that match query parameters. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-query + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}/status: + get: + description: Get the status of the static route. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id-status parameters: - description: ID of the tenant. in: path @@ -4632,43 +6834,27 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BGPPeerQuery' - description: Query Details for BGP Peers + - description: The ID of the static route. + in: path + name: static_route_id + required: true + schema: + description: Static Route Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPPeerQueryFilterV2N1' - type: array - type: object + $ref: '#/components/schemas/StaticRouteStatus' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for BGP Peers (v2.1) + summary: Get Static Route Status (v2.1) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/status: + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs: get: - description: List all the BGP peer statuses from NB. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-status + description: List all the BGP configurations from NB. + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs parameters: - description: ID of the tenant. in: path @@ -4701,17 +6887,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/BGPPeerStatusV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N2' type: array type: object description: Successful Operation - summary: Get BGP Peer Status from NB (v2.1) + summary: Get BGP Configs from NB (v2.2) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: - delete: - description: Delete the BGP peer configuration. - operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: + get: + description: List a specific BGP configuration from NB. + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: ID of the tenant. in: path @@ -4734,26 +6920,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. + - description: The ID of the BGP config. in: path - name: bgp_peer_id + name: bgp_config_id required: true schema: - description: Bgp Peer Id + description: Bgp Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N2' description: Successful Operation - summary: Delete BGP Peer Config (v2.1) + summary: Get BGP Config from NB (v2.2) tags: - Routing - get: - description: Get the BGP peer configuration. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + put: + description: Update the BGP configuration. + operationId: put-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: ID of the tenant. in: path @@ -4776,26 +6962,54 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. + - description: The ID of the BGP config. in: path - name: bgp_peer_id + name: bgp_config_id required: true schema: - description: Bgp Peer Id + description: Bgp Config Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' + description: Details of the bgp config to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N2' description: Successful Operation - summary: Get BGP Peer Config (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER + - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_HOLD_TIME + - code: BGP_CONFIG_INVALID_ADV_INTERVAL + - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME + - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS + - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT + - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE + - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update BGP Config (v2.2) tags: - Routing - put: - description: Update the BGP peer configuration. - operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/status: + get: + description: List all the BGP peer statuses from NB. + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-status parameters: - description: ID of the tenant. in: path @@ -4818,61 +7032,70 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. - in: path - name: bgp_peer_id - required: true - schema: - description: Bgp Peer Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N1' - description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N1' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerStatusV2N2' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: PEER_CONFIG_INVALID_PEER_IP - - code: BGP_CONFIG_INVALID_REMOTE_AS_NUM - - code: BGP_CONFIG_INVALID_LOCAL_AS_NUM - - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_HOLD_TIME - - code: BGP_CONFIG_INVALID_ADV_INTERVAL - - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME - - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS - - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT - - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE - - code: BGP_CONFIG_INVALID_PREFIX - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: INVALID_PEER_CONFIG_FOR_SPOKE - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW - - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW + summary: Get BGP Peer Status from NB (v2.2) + tags: + - Routing + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_config_id}/discoveredprefixes: + get: + description: Get BGP discovered prefix information. + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_config_id-discoveredprefixes + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The BGP peer config ID. + in: path + name: bgp_peer_config_id + required: true + schema: + description: Bgp Peer Config Id + type: string + responses: + '200': + content: + application/json: schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update BGP Peer Config (v2.1) + $ref: '#/components/schemas/BGPPeerDiscoveredPrefixesV2N2' + description: Successful Operation + summary: Get BGP Discovered Prefix Information (v2.2) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/status: + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/status: get: description: List the BGP peer status information from NB. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-status + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-status parameters: - description: ID of the tenant. in: path @@ -4907,15 +7130,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerStatusV2N1' + $ref: '#/components/schemas/BGPPeerStatusV2N2' description: Successful Operation - summary: Get BGP Peer Status from NB (v2.1) + summary: Get BGP Peer Status from NB (v2.2) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps: get: - description: List all the access lists for the element. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists + description: List all the route maps for an element. + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps parameters: - description: ID of the tenant. in: path @@ -4948,12 +7171,9 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' type: array type: object - items: - $ref: '#/components/schemas/RoutingAccessListV2N1' - type: array description: Successful Operation '400': content: @@ -4965,12 +7185,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Access List for Element (v2.1) + summary: Get Route Map for Element (v2.2) tags: - Routing post: - description: Create a AS-Path access list. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists + description: Create a route map. + operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps parameters: - description: ID of the tenant. in: path @@ -4997,14 +7217,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListScreenV2N1' - description: Details of the as-path access list to be created + $ref: '#/components/schemas/RoutingRouteMapV2N2' + description: Details of the route map to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' description: Successful Operation '400': content: @@ -5016,17 +7236,29 @@ paths: - code: ELEMENT_NOT_ASSIGNED_TO_SITE - code: NOT_SUPPORTED_BY_ELEMENT - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY + - code: INVALID_ROUTE_MAP_NAME + - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS + - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER + - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER + - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND + - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND + - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND + - code: BGP_CONFIG_INVALID_AS_NUMBER + - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create AS-Path Access List (v2.1) + summary: Create Route Map (v2.2) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/query: post: - description: Queries the DB for limit number of access lists that match query + description: Queries the DB for limit number of route maps that match the query parameters. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-query + operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-query parameters: - description: ID of the tenant. in: path @@ -5053,8 +7285,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListQuery' - description: Query details for access lists + $ref: '#/components/schemas/RoutingRouteMapQuery' + description: Query details for route maps responses: '200': content: @@ -5065,7 +7297,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessListQueryFilterV2N1' + $ref: '#/components/schemas/RoutingRouteMapQueryFilterV2N2' type: array type: object description: Successful Operation @@ -5080,13 +7312,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Access Lists (v2.1) + summary: Query DB for Route Maps (v2.2) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: delete: - description: Delete the access list. - operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + description: Delete a route map. + operationId: delete-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: ID of the tenant. in: path @@ -5109,7 +7341,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the access list. + - description: The ID of the route map. in: path name: config_id required: true @@ -5121,7 +7353,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' description: Successful Operation '400': content: @@ -5129,17 +7361,17 @@ paths: example: value: _error: - - code: ACCESS_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST + - code: ROUTE_MAP_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Access List (v2.1) + summary: Delete Route Map (v2.2) tags: - Routing get: - description: Get a specific access list. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + description: Get a specific route map. + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: ID of the tenant. in: path @@ -5174,14 +7406,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' description: Successful Operation - summary: Get Access List (v2.1) + summary: Get Route Map (v2.2) tags: - Routing put: - description: Updates the access list. - operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + description: Update a route map. + operationId: put-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: ID of the tenant. in: path @@ -5204,7 +7436,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the access list. + - description: The ID of the route map. in: path name: config_id required: true @@ -5215,14 +7447,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' - description: Details of the access list to be updated + $ref: '#/components/schemas/RoutingRouteMapV2N2' + description: Details of the route map to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' description: Successful Operation '400': content: @@ -5230,19 +7462,30 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST + - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY + - code: INVALID_ROUTE_MAP_NAME + - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS + - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER + - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER + - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND + - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND + - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND + - code: BGP_CONFIG_INVALID_AS_NUMBER + - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Access List (v2.1) + summary: Update Route Map (v2.2) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps: + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes: get: - description: List all the route maps for an element. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps + description: List all the static routes. + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes parameters: - description: ID of the tenant. in: path @@ -5275,26 +7518,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRouteV2N2' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Route Map for Element (v2.1) + summary: Get Static Routes (v2.2) tags: - Routing post: - description: Create a route map. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps + description: Create a static route. + operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes parameters: - description: ID of the tenant. in: path @@ -5321,14 +7554,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapV2N1' - description: Details of the route map to be created + $ref: '#/components/schemas/StaticRouteV2N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation '400': content: @@ -5336,32 +7568,36 @@ paths: example: value: _error: - - code: ELEMENT_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: NOT_SUPPORTED_BY_ELEMENT + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED - - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY - - code: INVALID_ROUTE_MAP_NAME - - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS - - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER - - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER - - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND - - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND - - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND - - code: BGP_CONFIG_INVALID_AS_NUMBER - - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX + - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 + - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE + - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE + - code: INVALID_NETWORK_CONTEXT + - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Route Map (v2.1) + summary: Create Static Route (v2.2) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/query: - post: - description: Queries the DB for limit number of route maps that match the query - parameters. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-query + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: + delete: + description: Delete a static route. + operationId: delete-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - description: ID of the tenant. in: path @@ -5384,25 +7620,19 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoutingRouteMapQuery' - description: Query details for route maps + - description: The ID of the static route. + in: path + name: static_route_id + required: true + schema: + description: Static Route Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/RoutingRouteMapQueryFilterV2N1' - type: array - type: object + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation '400': content: @@ -5410,18 +7640,16 @@ paths: example: value: _error: - - code: BAD_REQUEST - - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: STATICROUTE_CONFIG_INVALID_DEVICE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Route Maps (v2.1) + summary: Delete Static Route (v2.2) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: - delete: - description: Delete a route map. - operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id + get: + description: Get a specific static route. + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - description: ID of the tenant. in: path @@ -5444,19 +7672,66 @@ paths: schema: description: Element Id type: string - - description: The ID of the route map. + - description: The ID of the static route. in: path - name: config_id + name: static_route_id required: true schema: - description: Config Id + description: Static Route Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRouteV2N2' + description: Successful Operation + summary: Get Static Route (v2.2) + tags: + - Routing + put: + description: Update a static route. + operationId: put-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the static route. + in: path + name: static_route_id + required: true + schema: + description: Static Route Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StaticRouteV2N2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation '400': content: @@ -5464,17 +7739,36 @@ paths: example: value: _error: - - code: ROUTE_MAP_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX + - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 + - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE + - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE + - code: INVALID_NETWORK_CONTEXT + - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Route Map (v2.1) + summary: Update Static Route (v2.2) tags: - Routing + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}/status: get: - description: Get a specific route map. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id + description: Get the status of the static route. + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id-status parameters: - description: ID of the tenant. in: path @@ -5497,26 +7791,28 @@ paths: schema: description: Element Id type: string - - description: The BGP peer config ID. + - description: The ID of the static route. in: path - name: config_id + name: static_route_id required: true schema: - description: Config Id + description: Static Route Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRouteStatusV2N2' description: Successful Operation - summary: Get Route Map (v2.1) + summary: Get Static Route Status (v2.2) tags: - Routing - put: - description: Update a route map. - operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id + /v2.3/api/tenants/{tenant_id}/bgppeers/query: + post: + description: Queries the DB for limit number of BGP peers that match the query + parameters. + operationId: post-v2.3-api-tenants-tenant_id-bgppeers-query parameters: - description: ID of the tenant. in: path @@ -5525,39 +7821,25 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The ID of the route map. - in: path - name: config_id - required: true - schema: - description: Config Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapV2N1' - description: Details of the route map to be updated + $ref: '#/components/schemas/BGPPeerQuery' + description: Query Details for BGP Peers responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerQueryFilterV2N3' + type: array + type: object description: Successful Operation '400': content: @@ -5565,29 +7847,17 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED - - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY - - code: INVALID_ROUTE_MAP_NAME - - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS - - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER - - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER - - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND - - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND - - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND - - code: BGP_CONFIG_INVALID_AS_NUMBER - - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: BAD_QUERY_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Route Map (v2.1) + summary: Query DB for BGP Peers (v2.3) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes: + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs: get: - description: List all the static routes. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes + description: List all the BGP configurations from NB. + operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs parameters: - description: ID of the tenant. in: path @@ -5620,16 +7890,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/StaticRouteV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N3' type: array type: object description: Successful Operation - summary: Get Static Routes (v2.1) + summary: Get BGP Configs from NB (v2.3) tags: - Routing - post: - description: Create a static route. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: + get: + description: List a specific BGP configuration from NB. + operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: ID of the tenant. in: path @@ -5652,44 +7923,26 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StaticRouteV2N1' + - description: The ID of the BGP config. + in: path + name: bgp_config_id + required: true + schema: + description: Bgp Config Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N3' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: STATICROUTE_CONFIG_INVALID_DEVICE - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP - - code: INTERFACE_NOT_FOUND - - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE - - code: INVALID_NETWORK_CONTEXT - - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Static Route (v2.1) + summary: Get BGP Config from NB (v2.3) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: - delete: - description: Delete a static route. - operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id + put: + description: Update the BGP configuration. + operationId: put-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: ID of the tenant. in: path @@ -5712,26 +7965,54 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The ID of the BGP config. in: path - name: static_route_id + name: bgp_config_id required: true schema: - description: Static Route Id + description: Bgp Config Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPGlobalConfigScreenV2N3' + description: Details of the bgp config to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N3' description: Successful Operation - summary: Delete Static Route (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER + - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_HOLD_TIME + - code: BGP_CONFIG_INVALID_ADV_INTERVAL + - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME + - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS + - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT + - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE + - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update BGP Config (v2.3) tags: - Routing + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers: get: - description: Get a specific static route. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id + description: List all the BGP peer configurations from NB. + operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers parameters: - description: ID of the tenant. in: path @@ -5754,26 +8035,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. - in: path - name: static_route_id - required: true - schema: - description: Static Route Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N1' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerConfigV2N3' + type: array + type: object description: Successful Operation - summary: Get Static Route (v2.1) + summary: Get BGP Peer Configs from NB (v2.3) tags: - Routing - put: - description: Update a static route. - operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id + post: + description: Create a BGP peer configuration. + operationId: post-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers parameters: - description: ID of the tenant. in: path @@ -5796,24 +8077,18 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. - in: path - name: static_route_id - required: true - schema: - description: Static Route Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N1' + $ref: '#/components/schemas/BGPPeerConfigScreenV2N3' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N1' + $ref: '#/components/schemas/BGPPeerConfigV2N3' description: Successful Operation '400': content: @@ -5821,26 +8096,37 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: PEER_CONFIG_INVALID_PEER_IP + - code: BGP_CONFIG_INVALID_REMOTE_AS_NUMBER + - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER + - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_HOLD_TIME + - code: BGP_CONFIG_INVALID_ADV_INTERVAL + - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME + - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS + - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT + - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE + - code: BGP_CONFIG_INVALID_PREFIX - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: STATICROUTE_CONFIG_INVALID_DEVICE - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP - - code: INTERFACE_NOT_FOUND - - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE - - code: INVALID_NETWORK_CONTEXT - - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_PEER_CONFIG_FOR_SPOKE + - code: PEER_TYPE_NOT_SUPPORTED + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW + - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW + - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Static Route (v2.1) + summary: Create BGP Peer Config (v2.3) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}/status: - get: - description: Get the status of the static route. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id-status + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/query: + post: + description: Queries the DB for limit number of BGP peers that match query parameters. + operationId: post-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-query parameters: - description: ID of the tenant. in: path @@ -5858,40 +8144,10 @@ paths: type: string - description: The ID of the element. in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The ID of the static route. - in: path - name: static_route_id - required: true - schema: - description: Static Route Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/StaticRouteStatus' - description: Successful Operation - summary: Get Static Route Status (v2.1) - tags: - - Routing - /v2.2/api/tenants/{tenant_id}/bgppeers/query: - post: - description: Queries the DB for limit number of BGP peers that match the query - parameters. - operationId: post-v2.2-api-tenants-tenant_id-bgppeers-query - parameters: - - description: ID of the tenant. - in: path - name: tenant_id + name: element_id required: true schema: - description: Tenant Id + description: Element Id type: string requestBody: content: @@ -5923,13 +8179,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for BGP Peers (v2.2) + summary: Query DB for BGP Peers (v2.3) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs: - get: - description: List all the BGP configurations from NB. - operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: + delete: + description: Delete the BGP peer configuration. + operationId: delete-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: ID of the tenant. in: path @@ -5952,27 +8208,26 @@ paths: schema: description: Element Id type: string + - description: The ID of the BGP peer. + in: path + name: bgp_peer_id + required: true + schema: + description: Bgp Peer Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPGlobalConfigV2N2' - type: array - type: object + $ref: '#/components/schemas/BGPPeerConfigV2N3' description: Successful Operation - summary: Get BGP Configs from NB (v2.2) + summary: Delete BGP Peer Config (v2.3) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: get: - description: List a specific BGP configuration from NB. - operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id + description: Get the BGP peer configuration. + operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: ID of the tenant. in: path @@ -5995,26 +8250,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP config. + - description: The ID of the BGP peer. in: path - name: bgp_config_id + name: bgp_peer_id required: true schema: - description: Bgp Config Id + description: Bgp Peer Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N3' description: Successful Operation - summary: Get BGP Config from NB (v2.2) + summary: Get BGP Peer Config (v2.3) tags: - Routing put: - description: Update the BGP configuration. - operationId: put-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id + description: Update the BGP peer configuration. + operationId: put-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: ID of the tenant. in: path @@ -6037,25 +8292,25 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP config. + - description: The ID of the BGP peer. in: path - name: bgp_config_id + name: bgp_peer_id required: true schema: - description: Bgp Config Id + description: Bgp Peer Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' - description: Details of the bgp config to be updated + $ref: '#/components/schemas/BGPPeerConfigScreenV2N3' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N3' description: Successful Operation '400': content: @@ -6063,6 +8318,8 @@ paths: example: value: _error: + - code: PEER_CONFIG_INVALID_PEER_IP + - code: BGP_CONFIG_INVALID_REMOTE_AS_NUMBER - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME - code: BGP_CONFIG_INVALID_HOLD_TIME @@ -6071,20 +8328,27 @@ paths: - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE + - code: BGP_CONFIG_INVALID_PREFIX - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_PEER_CONFIG_FOR_SPOKE + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW + - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update BGP Config (v2.2) + summary: Update BGP Peer Config (v2.3) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers: + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes: get: - description: List all the BGP peer configurations from NB. - operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers + description: List all the static routes. + operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes parameters: - description: ID of the tenant. in: path @@ -6117,16 +8381,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/BGPPeerConfigV2N2' + $ref: '#/components/schemas/StaticRouteV2N3' type: array type: object description: Successful Operation - summary: Get BGP Peer Configs from NB (v2.2) + summary: Get Static Routes (v2.3) tags: - Routing post: - description: Create a BGP peer configuration. - operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers + description: Create a static route. + operationId: post-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes parameters: - description: ID of the tenant. in: path @@ -6153,14 +8417,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' - description: Details of the BGP peer config to be created + $ref: '#/components/schemas/StaticRouteV2N3' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N2' + $ref: '#/components/schemas/StaticRouteV2N3' description: Successful Operation '400': content: @@ -6168,37 +8431,36 @@ paths: example: value: _error: - - code: PEER_CONFIG_INVALID_PEER_IP - - code: BGP_CONFIG_INVALID_REMOTE_AS_NUMBER - - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER - - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_HOLD_TIME - - code: BGP_CONFIG_INVALID_ADV_INTERVAL - - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME - - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS - - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT - - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE - - code: BGP_CONFIG_INVALID_PREFIX + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: INVALID_PEER_CONFIG_FOR_SPOKE - - code: PEER_TYPE_NOT_SUPPORTED - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW - - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW - - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX + - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 + - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE + - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE + - code: INVALID_NETWORK_CONTEXT + - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create BGP Peer Config (v2.2) + summary: Create Static Route (v2.3) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/query: - post: - description: Queries the DB for limit number of BGP peers that match query parameters. - operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-query + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: + delete: + description: Delete a static route. + operationId: delete-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - description: ID of the tenant. in: path @@ -6221,25 +8483,19 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BGPPeerQuery' - description: Query Details for BGP Peers + - description: The ID of the static route. + in: path + name: static_route_id + required: true + schema: + description: Static Route Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPPeerQueryFilterV2N2' - type: array - type: object + $ref: '#/components/schemas/StaticRouteV2N3' description: Successful Operation '400': content: @@ -6247,17 +8503,16 @@ paths: example: value: _error: - - code: BAD_QUERY_REQUEST + - code: STATICROUTE_CONFIG_INVALID_DEVICE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for BGP Peers (v2.2) + summary: Delete Static Route (v2.3) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: - delete: - description: Delete the BGP peer configuration. - operationId: delete-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + get: + description: Get a specific static route. + operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - description: ID of the tenant. in: path @@ -6280,26 +8535,149 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. + - description: The ID of the static route. in: path - name: bgp_peer_id + name: static_route_id required: true schema: - description: Bgp Peer Id + description: Static Route Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StaticRouteV2N3' + description: Successful Operation + summary: Get Static Route (v2.3) + tags: + - Routing + put: + description: Update a static route. + operationId: put-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the static route. + in: path + name: static_route_id + required: true + schema: + description: Static Route Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StaticRouteV2N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StaticRouteV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX + - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 + - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE + - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE + - code: INVALID_NETWORK_CONTEXT + - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Static Route (v2.3) + tags: + - Routing + /v2.4/api/tenants/{tenant_id}/bgppeers/query: + post: + description: Queries the DB for limit number of BGP peers that match the query + parameters. + operationId: post-v2.4-api-tenants-tenant_id-bgppeers-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerQuery' + description: Query Details for BGP Peers responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N2' - description: Successful Operation - summary: Delete BGP Peer Config (v2.2) + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerQueryFilterV2N4' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for BGP Peers (v2.4) tags: - Routing + /v2.4/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers: get: - description: Get the BGP peer configuration. - operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + description: List all the BGP peer configurations from NB. + operationId: get-v2.4-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers parameters: - description: ID of the tenant. in: path @@ -6322,26 +8700,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. - in: path - name: bgp_peer_id - required: true - schema: - description: Bgp Peer Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N2' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerConfigV2N4' + type: array + type: object description: Successful Operation - summary: Get BGP Peer Config (v2.2) + summary: Get BGP Peer Configs from NB (v2.4) tags: - Routing - put: - description: Update the BGP peer configuration. - operationId: put-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + post: + description: Create a BGP peer configuration. + operationId: post-v2.4-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers parameters: - description: ID of the tenant. in: path @@ -6364,25 +8742,18 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. - in: path - name: bgp_peer_id - required: true - schema: - description: Bgp Peer Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' + $ref: '#/components/schemas/BGPPeerConfigScreenV2N4' description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N4' description: Successful Operation '400': content: @@ -6406,21 +8777,22 @@ paths: - code: INVALID_JSON_COMMON_ATTR_MISMATCH - code: ELEMENT_NOT_ASSIGNED_TO_SITE - code: INVALID_PEER_CONFIG_FOR_SPOKE + - code: PEER_TYPE_NOT_SUPPORTED - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE - - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST + - code: BGP_PEER_IP_CONFIG_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update BGP Peer Config (v2.2) + summary: Create BGP Peer Config (v2.4) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes: - get: - description: List all the static routes. - operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes + /v2.4/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/query: + post: + description: Queries the DB for limit number of BGP peers that match query parameters. + operationId: post-v2.4-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-query parameters: - description: ID of the tenant. in: path @@ -6443,96 +8815,43 @@ paths: schema: description: Element Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerQuery' + description: Query Details for BGP Peers responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/BGPPeerQueryFilterV2N4' type: array type: object description: Successful Operation - summary: Get Static Routes (v2.2) - tags: - - Routing - post: - description: Create a static route. - operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes - parameters: - - description: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StaticRouteV2N2' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/StaticRouteV2N2' - description: Successful Operation '400': content: application/json: example: value: _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: STATICROUTE_CONFIG_INVALID_DEVICE - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE - - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX - - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 - - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 - - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE - - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP - - code: INTERFACE_NOT_FOUND - - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE - - code: INVALID_NETWORK_CONTEXT - - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE + - code: BAD_QUERY_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Static Route (v2.2) + summary: Query DB for BGP Peers (v2.4) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: + /v2.4/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: delete: - description: Delete a static route. - operationId: delete-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id + description: Delete the BGP peer configuration. + operationId: delete-v2.4-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: ID of the tenant. in: path @@ -6555,36 +8874,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The ID of the BGP peer. in: path - name: static_route_id + name: bgp_peer_id required: true schema: - description: Static Route Id + description: Bgp Peer Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N4' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: STATICROUTE_CONFIG_INVALID_DEVICE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Static Route (v2.2) + summary: Delete BGP Peer Config (v2.4) tags: - Routing get: - description: Get a specific static route. - operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id + description: Get the BGP peer configuration. + operationId: get-v2.4-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: ID of the tenant. in: path @@ -6607,26 +8916,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The ID of the BGP peer. in: path - name: static_route_id + name: bgp_peer_id required: true schema: - description: Static Route Id + description: Bgp Peer Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N4' description: Successful Operation - summary: Get Static Route (v2.2) + summary: Get BGP Peer Config (v2.4) tags: - Routing put: - description: Update a static route. - operationId: put-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id + description: Update the BGP peer configuration. + operationId: put-v2.4-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: ID of the tenant. in: path @@ -6649,24 +8958,25 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The ID of the BGP peer. in: path - name: static_route_id + name: bgp_peer_id required: true schema: - description: Static Route Id + description: Bgp Peer Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/BGPPeerConfigScreenV2N4' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N4' description: Successful Operation '400': content: @@ -6674,79 +8984,83 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: PEER_CONFIG_INVALID_PEER_IP + - code: BGP_CONFIG_INVALID_REMOTE_AS_NUMBER + - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER + - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_HOLD_TIME + - code: BGP_CONFIG_INVALID_ADV_INTERVAL + - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME + - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS + - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT + - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE + - code: BGP_CONFIG_INVALID_PREFIX - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: STATICROUTE_CONFIG_INVALID_DEVICE - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE - - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX - - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 - - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 - - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE - - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP - - code: INTERFACE_NOT_FOUND - - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE - - code: INVALID_NETWORK_CONTEXT - - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_PEER_CONFIG_FOR_SPOKE + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW + - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW + - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE + - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST + - code: BGP_PEER_IP_CONFIG_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Static Route (v2.2) + summary: Update BGP Peer Config (v2.4) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}/status: - get: - description: Get the status of the static route. - operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id-status + /v3.0/api/tenants/{tenant_id}/prefixes/query: + post: + description: Query the prefix set. + operationId: post-v3.0-api-tenants-tenant_id-prefixes-query parameters: - - description: ID of the tenant. + - description: The tenant ID. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The ID of the static route. - in: path - name: static_route_id - required: true - schema: - description: Static Route Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PrefixQueryV3' + description: Query Details for prefixes responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteStatusV2N2' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PrefixQueryFilterV3' + type: array + type: object description: Successful Operation - summary: Get Static Route Status (v2.2) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Prefix Set (3.0) tags: - Routing - /v3.0/api/tenants/{tenant_id}/prefixes/query: + /v3.1/api/tenants/{tenant_id}/prefixes/query: post: description: Query the prefix set. - operationId: post-v3.0-api-tenants-tenant_id-prefixes-query + operationId: post-v3.1-api-tenants-tenant_id-prefixes-query parameters: - description: The tenant ID. in: path @@ -6759,7 +9073,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PrefixQueryV3' + $ref: '#/components/schemas/PrefixQueryV3N1' description: Query Details for prefixes responses: '200': @@ -6771,7 +9085,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/PrefixQueryFilterV3' + $ref: '#/components/schemas/PrefixQueryFilterV3N1' type: array type: object description: Successful Operation @@ -6785,7 +9099,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Prefix Set (2.0) + summary: Query Prefix Set (3.1) tags: - Routing servers: diff --git a/openapi-specs/sdwan/legacy/SNMP.yaml b/openapi-specs/sdwan/legacy/SNMP.yaml index 2a8a3eea5..d14171c50 100644 --- a/openapi-specs/sdwan/legacy/SNMP.yaml +++ b/openapi-specs/sdwan/legacy/SNMP.yaml @@ -15,18 +15,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string diff --git a/openapi-specs/sdwan/legacy/SecurityPolicy.yaml b/openapi-specs/sdwan/legacy/SecurityPolicy.yaml index 85553e99a..79bb0c886 100644 --- a/openapi-specs/sdwan/legacy/SecurityPolicy.yaml +++ b/openapi-specs/sdwan/legacy/SecurityPolicy.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view ElementSecurityZone: properties: id: @@ -306,7 +300,7 @@ components: Filter: properties: elements: - description: 'Filter by element. + description: 'Elements of the filter. ' items: @@ -314,7 +308,7 @@ components: type: string type: array path: - description: 'Filter by path. + description: 'Path of the filter. ' items: @@ -322,19 +316,15 @@ components: type: string type: array site: - description: 'Filter by site. + description: 'Site of the filter. ' type: object type: - description: 'Filter by type. + description: 'Type of the filter. ' type: string - required: - - path - - site - - elements GlobalPrefixQueryFilter: properties: description: @@ -405,10 +395,9 @@ components: ' type: string tags: - description: 'A information field that can be added to identify the priority - policy global prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' + description: "A information field that can be added to identify the priority\ + \ policy global prefix. Maximum 10 unique tags of length 1024 each are\ + \ allowed. \n" items: description: Tags type: string @@ -418,19 +407,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -456,7 +445,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -465,18 +454,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -716,10 +705,9 @@ components: ' type: string tags: - description: 'A information field that can be added to identify the security - policy global prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' + description: "A information field that can be added to identify the security\ + \ policy global prefix. Maximum 10 unique tags of length 1024 each are\ + \ allowed. \n" items: description: Tags type: string @@ -1345,7 +1333,9 @@ components: type: array user_or_group: $ref: '#/components/schemas/UserGroup' - description: "The details of the user or group. \n" + description: 'The details of the user or group. + + ' required: - enabled - action @@ -1431,7 +1421,9 @@ components: type: array user_or_group: $ref: '#/components/schemas/UserGroup' - description: "The details of the user or group. \n" + description: 'The details of the user or group. + + ' required: - enabled - action @@ -2416,7 +2408,9 @@ components: description: "The IP Prefix ID that associates with a site. \n" type: string site_id: - description: "The site ID binding the prefix. \n" + description: 'The site ID binding the prefix. + + ' type: string tags: description: 'A information field that can be added to identify the site @@ -4127,7 +4121,7 @@ paths: schema: description: Tenant Id type: string - - description: ID of the security policy set. + - description: ID of th esecurity policy set. in: path name: policy_set_id required: true diff --git a/openapi-specs/sdwan/legacy/Service&DCGroups.yaml b/openapi-specs/sdwan/legacy/Service&DCGroups.yaml index 3ffe80ada..012f8821d 100644 --- a/openapi-specs/sdwan/legacy/Service&DCGroups.yaml +++ b/openapi-specs/sdwan/legacy/Service&DCGroups.yaml @@ -68,11 +68,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -81,11 +76,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view Error: properties: _error: @@ -156,19 +150,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -194,7 +188,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -203,18 +197,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -2311,7 +2305,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Service Bindings (v2.3) + summary: Query DB for Service Bindings (v2.2) tags: - Service & DC Groups /v2.3/api/tenants/{tenant_id}/serviceendpoints/{service_endpoint_id}: diff --git a/openapi-specs/sdwan/legacy/Services.yaml b/openapi-specs/sdwan/legacy/Services.yaml index 5bbe30a99..660811df9 100644 --- a/openapi-specs/sdwan/legacy/Services.yaml +++ b/openapi-specs/sdwan/legacy/Services.yaml @@ -15,18 +15,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string diff --git a/openapi-specs/sdwan/legacy/SiteConfiguration.yaml b/openapi-specs/sdwan/legacy/SiteConfiguration.yaml index 9a73abeed..94180e71d 100644 --- a/openapi-specs/sdwan/legacy/SiteConfiguration.yaml +++ b/openapi-specs/sdwan/legacy/SiteConfiguration.yaml @@ -80,11 +80,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -93,26 +88,25 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string ClusterEvent: properties: @@ -194,7 +188,9 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string required: - site_id @@ -246,9 +242,9 @@ components: ' type: string subscription_factor: - description: 'Subscription Factor: Digits(fraction = 1, integer = 1, ) ValidateDecimal(allowZero - = false, increment = 5, max = 5, error = INVALID_VALUE_RANGE: Invalid - value range., min = 5) ' + description: 'The subscription factor. + + ' format: float type: number HubClusterElement: @@ -329,8 +325,9 @@ components: ' type: string peer_sites: - description: "The sites associated with the data center cluster. \ - \ \n" + description: 'The sites associated with the data center cluster. + + ' items: description: Peer Sites type: string @@ -631,7 +628,9 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string required: - site_id @@ -664,19 +663,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -702,7 +701,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -711,18 +710,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -850,7 +849,9 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string vpn_ciphers: description: 'The ciphers for the vpn connections. @@ -886,7 +887,9 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'The tenant ID. + + ' type: string vpn_ciphers: description: 'The ciphers for the vpn connections. @@ -968,7 +971,114 @@ components: ' format: int64 type: integer - SiteQueryFilterV4N4: + SiteQueryFilterV4N8: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. + + ' + admin_state: + description: 'The site mode of operation, can be in one of three states: + Active - the site is in Control mode and network policy is applied. Monitor + - the site is in Analytics mode, no network policy is applied. Disabled: + the site is disabled. + + ' + type: string + description: + description: 'Description for the site (Max size = 1024). + + ' + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. + + ' + type: string + extended_tags: + description: "Extended tags allow operators to add more information into\ + \ the site object. Current extended tags allow for additional configuration\ + \ related to Prisma Access and ZScaler to be added. \n" + items: + $ref: '#/components/schemas/ExtendedTag' + type: array + id: + description: 'The ID. + + ' + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' + multicast_peer_group_id: + description: 'The multicast peer group ID. + + ' + type: string + name: + description: 'The site name (Max size = 128). + + ' + type: string + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. + + ' + type: string + network_policysetstack_id: + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. + + ' + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. + + ' + type: string + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. + + ' + type: string + security_policyset_id: + description: Security Policyset Id + type: string + security_policysetstack_id: + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. + + ' + type: string + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. + + ' + type: string + tags: + description: 'A information field that can be added to identify the site. + + ' + items: + description: Tags + type: string + type: array + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string + required: + - element_cluster_role + - admin_state + - name + SiteQueryFilterV4N9: properties: address: $ref: '#/components/schemas/Address' @@ -992,6 +1102,15 @@ components: ' type: string + extended_tags: + description: 'Extended tags allow operators to add more information into + the site object. Current extended tags allow for additional configuration + related to Prisma Access and ZScaler to be added. + + ' + items: + $ref: '#/components/schemas/ExtendedTag' + type: array id: description: 'The ID. @@ -1002,20 +1121,31 @@ components: description: 'The geographical cordinates for the site address. ' + multicast_peer_group_id: + description: 'The multicast peer group ID. + + ' + type: string name: description: 'The site name (Max size = 128). ' type: string nat_policysetstack_id: - description: Nat Policysetstack Id + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. + + ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. ' type: string + perfmgmt_policysetstack_id: + description: "ID for the Performance Policyset Stack. \n" + type: string policy_set_id: description: 'The ID for the Original Network Policy Set. Can be retrieved using policysets API. @@ -1032,6 +1162,119 @@ components: description: 'The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API. + ' + type: string + security_policysetstack_id: + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. + + ' + type: string + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. + + ' + type: string + tags: + description: 'A information field that can be added to identify the site. + + ' + items: + description: Tags + type: string + type: array + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string + required: + - element_cluster_role + - admin_state + - name + SiteScreenV4N8: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. + + ' + admin_state: + description: 'The site mode of operation, can be in one of three states: + Active - the site is in Control mode and network policy is applied. Monitor + - the site is in Analytics mode, no network policy is applied. Disabled: + the site is disabled. + + ' + type: string + description: + description: 'Description for the site (Max size = 1024). + + ' + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. + + ' + type: string + extended_tags: + description: "Extended tags allow operators to add more information into\ + \ the site object. Current extended tags allow for additional configuration\ + \ related to Prisma Access and ZScaler to be added. \n" + items: + $ref: '#/components/schemas/ExtendedTag' + type: array + id: + description: 'The ID. + + ' + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' + multicast_peer_group_id: + description: 'The multicast peer group ID. + + ' + type: string + name: + description: 'The site name (Max size = 128). + + ' + type: string + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. + + ' + type: string + network_policysetstack_id: + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. + + ' + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. + + ' + type: string + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. + + ' + type: string + security_policyset_id: + description: Security Policyset Id + type: string + security_policysetstack_id: + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. + ' type: string service_binding: @@ -1048,7 +1291,16 @@ components: description: Tags type: string type: array - SiteQueryFilterV4N5: + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string + required: + - element_cluster_role + - admin_state + - name + SiteScreenV4N9: properties: address: $ref: '#/components/schemas/Address' @@ -1073,9 +1325,11 @@ components: ' type: string extended_tags: - description: 'Extended Tags: Valid ListObject(allowDuplicate = false, allowEmpty - = true, allowNull = true, listMaxSize = 10, message = INVALID_EXTENDED_TAG_SIZE_OR_DUPLICATE, - required = false) ' + description: 'Extended tags allow operators to add more information into + the site object. Current extended tags allow for additional configuration + related to Prisma Access and ZScaler to be added. + + ' items: $ref: '#/components/schemas/ExtendedTag' type: array @@ -1089,6 +1343,11 @@ components: description: 'The geographical cordinates for the site address. ' + multicast_peer_group_id: + description: 'The multicast peer group ID. + + ' + type: string name: description: 'The site name (Max size = 128). @@ -1101,11 +1360,14 @@ components: ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. ' type: string + perfmgmt_policysetstack_id: + description: "ID for the Performance Policyset Stack. \n" + type: string policy_set_id: description: 'The ID for the Original Network Policy Set. Can be retrieved using policysets API. @@ -1122,6 +1384,12 @@ components: description: 'The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API. + ' + type: string + security_policysetstack_id: + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. + ' type: string service_binding: @@ -1138,6 +1406,11 @@ components: description: Tags type: string type: array + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string required: - element_cluster_role - admin_state @@ -1193,7 +1466,7 @@ components: required: - site_id - tenant_id - SiteV4N6: + SiteV4N8: properties: address: $ref: '#/components/schemas/Address' @@ -1236,6 +1509,11 @@ components: description: 'The geographical cordinates for the site address. ' + multicast_peer_group_id: + description: 'The multicast peer group ID. + + ' + type: string name: description: 'The site name (Max size = 128). @@ -1248,8 +1526,8 @@ components: ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. ' type: string @@ -1272,7 +1550,10 @@ components: ' type: string security_policysetstack_id: - description: Security Policysetstack Id + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. + + ' type: string service_binding: description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps @@ -1288,11 +1569,16 @@ components: description: Tags type: string type: array + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string required: - element_cluster_role - admin_state - name - SiteV4N7: + SiteV4N9: properties: address: $ref: '#/components/schemas/Address' @@ -1357,6 +1643,9 @@ components: ' type: string + perfmgmt_policysetstack_id: + description: "ID for the Performance Policyset Stack. \n" + type: string policy_set_id: description: 'The ID for the Original Network Policy Set. Can be retrieved using policysets API. @@ -1395,6 +1684,11 @@ components: description: Tags type: string type: array + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string required: - element_cluster_role - admin_state @@ -1675,8 +1969,7 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of WAN interfaces that match the query - parameters. + description: 'The aggregate number of app defs that match the query parameters. ' dest_page: @@ -1686,7 +1979,7 @@ components: format: int32 type: integer getDeleted: - description: 'The number WAN interfaces deleted for a time frame. + description: 'The number app definitions deleted for a time frame. ' type: boolean @@ -1697,7 +1990,7 @@ components: type: string type: array id: - description: "List the WAN interfaces by ID. \n" + description: "List the app definitions by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -2737,6 +3030,7 @@ paths: - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: ADVERTISEMENT_INTERVAL_INVALID_DECIMAL - code: ADVERTISEMENT_INTERVAL_REQD + - code: ADVERTISEMENT_INTERVAL_LOWER_THAN_ONE_SEC_ERR schema: $ref: '#/components/schemas/Error' description: Bad Request @@ -4669,10 +4963,10 @@ paths: summary: Get Hub Cluster Status (v4.0) tags: - Site Configuration - /v4.4/api/tenants/{tenant_id}/sites/query: - post: - description: Queries the DB for limit number of sites that match the query parameters. - operationId: post-v4.4-api-tenants-tenant_id-sites-query + /v4.8/api/tenants/{tenant_id}/sites: + get: + description: Get all the sites of a tenant. + operationId: get-v4.8-api-tenants-tenant_id-sites parameters: - description: The tenant ID. in: path @@ -4681,33 +4975,26 @@ paths: schema: description: Tenant Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteQuery' - description: Query Details for the site responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/SiteQueryFilterV4N4' + $ref: '#/components/schemas/SiteV4N8' type: array type: object description: Successful Operation - summary: Query DB for Number of Sites that Match Query Params (v4.4) + summary: Get Sites of a Tenant (v4.8) tags: - Site Configuration - /v4.5/api/tenants/{tenant_id}/sites/query: post: - description: Queries the DB for limit number of sites that match the query parameters. - operationId: post-v4.5-api-tenants-tenant_id-sites-query + description: Create a new site. + operationId: post-v4.8-api-tenants-tenant_id-sites parameters: - description: The tenant ID. in: path @@ -4720,57 +5007,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteQuery' - description: Query Details for the site + $ref: '#/components/schemas/SiteScreenV4N8' + description: Details of the site to be created responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SiteQueryFilterV4N5' - type: array - type: object + $ref: '#/components/schemas/SiteV4N8' description: Successful Operation - summary: Query DB for Number of Sites that Match Query Params (v4.5) - tags: - - Site Configuration - /v4.6/api/tenants/{tenant_id}/sites: - get: - description: Get all the sites of a tenant. - operationId: get-v4.6-api-tenants-tenant_id-sites - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - responses: - '200': + '400': content: application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_SITE_CONFIG + - code: POLICY_NOT_AVAILABLE + - code: NGFWSETSTACK_NOT_FOUND + - code: SITE_STATE_INVALID + - code: MULTICAST_INVALID_PEER_GROUP_ID schema: - allOf: - - $ref: '#/components/schemas/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SiteV4N6' - type: array - type: object - description: Successful Operation - summary: Get Sites of a Tenant (v4.6) + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create a New Site (v4.8) tags: - Site Configuration + /v4.8/api/tenants/{tenant_id}/sites/query: post: - description: Create a new site. - operationId: post-v4.6-api-tenants-tenant_id-sites + description: Queries the DB for limit number of sites that match the query parameters. + operationId: post-v4.8-api-tenants-tenant_id-sites-query parameters: - description: The tenant ID. in: path @@ -4783,36 +5050,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' - description: Details of the site to be created + $ref: '#/components/schemas/SiteQuery' + description: Query Details for the site responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteQueryFilterV4N8' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_SITE_CONFIG - - code: POLICY_NOT_AVAILABLE - - code: NGFWSETSTACK_NOT_FOUND - - code: SITE_STATE_INVALID - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create a New Site (v4.6) + summary: Query DB for Number of Sites that Match Query Params (v4.8) tags: - Site Configuration - /v4.6/api/tenants/{tenant_id}/sites/{site_id}: + /v4.8/api/tenants/{tenant_id}/sites/{site_id}: delete: description: Delete a particular site. - operationId: delete-v4.6-api-tenants-tenant_id-sites-site_id + operationId: delete-v4.8-api-tenants-tenant_id-sites-site_id parameters: - description: The tenant ID. in: path @@ -4834,7 +5094,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' + $ref: '#/components/schemas/SiteV4N8' description: Successful Operation '400': content: @@ -4847,17 +5107,17 @@ paths: - code: DELETE_FORBIDDEN_INVALID_STATE - code: DELETE_FORBIDDEN_SITE_WAN_EXISTS - code: DELETE_FORBIDDEN_SITE_WAN_LQM_CONFIG_EXISTS - - code: DELETE_FORBIDDEN_ELEMENT_EXISTS + - code: DELETE_FORBIDDEN_ELEMENT_OR_ELEMENT_SHELL_EXISTS - code: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete a Site (v4.6) + summary: Delete a Site (v4.8) tags: - Site Configuration get: description: Get the site if a particular tenant. - operationId: get-v4.6-api-tenants-tenant_id-sites-site_id + operationId: get-v4.8-api-tenants-tenant_id-sites-site_id parameters: - description: The tenant ID. in: path @@ -4879,7 +5139,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' + $ref: '#/components/schemas/SiteV4N8' description: Successful Operation '400': content: @@ -4891,12 +5151,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Site of Tenant (v4.6) + summary: Get Site of Tenant (v4.8) tags: - Site Configuration put: description: Update an existing site. - operationId: put-v4.6-api-tenants-tenant_id-sites-site_id + operationId: put-v4.8-api-tenants-tenant_id-sites-site_id parameters: - description: The tenant ID. in: path @@ -4917,14 +5177,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' + $ref: '#/components/schemas/SiteScreenV4N8' description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' + $ref: '#/components/schemas/SiteV4N8' description: Successful Operation '400': content: @@ -4949,16 +5209,17 @@ paths: - code: INVALID_POLICYSET - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: MULTICAST_INVALID_PEER_GROUP_ID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update a Site (v4.6) + summary: Update a Site (v4.8) tags: - Site Configuration - /v4.7/api/tenants/{tenant_id}/sites: + /v4.9/api/tenants/{tenant_id}/sites: get: description: Get all the sites of a tenant. - operationId: get-v4.7-api-tenants-tenant_id-sites + operationId: get-v4.9-api-tenants-tenant_id-sites parameters: - description: The tenant ID. in: path @@ -4977,16 +5238,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteV4N9' type: array type: object description: Successful Operation - summary: Get Sites of a Tenant (v4.7) + summary: Get Sites of a Tenant (v4.9) tags: - Site Configuration post: description: Create a new site. - operationId: post-v4.7-api-tenants-tenant_id-sites + operationId: post-v4.9-api-tenants-tenant_id-sites parameters: - description: The tenant ID. in: path @@ -4999,14 +5260,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteV4N9' description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteScreenV4N9' description: Successful Operation '400': content: @@ -5020,16 +5281,55 @@ paths: - code: NGFWSETSTACK_NOT_FOUND - code: SITE_STATE_INVALID - code: MULTICAST_INVALID_PEER_GROUP_ID + - code: SITE_CONFIG_PERFMGMT_POLICY_NOT_SUPPORTED + - code: SITE_CONFIG_PERFMGMT_POLICYSETSTACK_FORBIDDEN + - code: SITE_CONFIG_PERFMGMT_POLICYSETSTACK_NOT_FOUND + - code: PERFMGMT_DEFAULT_STACK_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create a New Site (v4.7) + summary: Create a New Site (v4.9) + tags: + - Site Configuration + /v4.9/api/tenants/{tenant_id}/sites/query: + post: + description: Queries the DB for limit number of sites that match the query parameters. + operationId: post-v4.9-api-tenants-tenant_id-sites-query + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteQuery' + description: Query Details for the site + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteQueryFilterV4N9' + type: array + type: object + description: Successful Operation + summary: Query DB for Number of Sites that Match Query Params (v4.9) tags: - Site Configuration - /v4.7/api/tenants/{tenant_id}/sites/{site_id}: + /v4.9/api/tenants/{tenant_id}/sites/{site_id}: delete: description: Delete a particular site. - operationId: delete-v4.7-api-tenants-tenant_id-sites-site_id + operationId: delete-v4.9-api-tenants-tenant_id-sites-site_id parameters: - description: The tenant ID. in: path @@ -5051,7 +5351,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteV4N9' description: Successful Operation '400': content: @@ -5064,17 +5364,17 @@ paths: - code: DELETE_FORBIDDEN_INVALID_STATE - code: DELETE_FORBIDDEN_SITE_WAN_EXISTS - code: DELETE_FORBIDDEN_SITE_WAN_LQM_CONFIG_EXISTS - - code: DELETE_FORBIDDEN_ELEMENT_EXISTS + - code: DELETE_FORBIDDEN_ELEMENT_OR_ELEMENT_SHELL_EXISTS - code: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete a Site (v4.7) + summary: Delete a Site (v4.9) tags: - Site Configuration get: description: Get the site if a particular tenant. - operationId: get-v4.7-api-tenants-tenant_id-sites-site_id + operationId: get-v4.9-api-tenants-tenant_id-sites-site_id parameters: - description: The tenant ID. in: path @@ -5096,7 +5396,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteV4N9' description: Successful Operation '400': content: @@ -5108,12 +5408,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Site of Tenant (v4.7) + summary: Get Site of Tenant (v4.9) tags: - Site Configuration put: description: Update an existing site. - operationId: put-v4.7-api-tenants-tenant_id-sites-site_id + operationId: put-v4.9-api-tenants-tenant_id-sites-site_id parameters: - description: The tenant ID. in: path @@ -5134,14 +5434,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteScreenV4N9' description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteV4N9' description: Successful Operation '400': content: @@ -5167,10 +5467,14 @@ paths: - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH - code: MULTICAST_INVALID_PEER_GROUP_ID + - code: SITE_CONFIG_PERFMGMT_POLICY_NOT_SUPPORTED + - code: SITE_CONFIG_PERFMGMT_POLICYSETSTACK_FORBIDDEN + - code: SITE_CONFIG_PERFMGMT_POLICYSETSTACK_NOT_FOUND + - code: SITE_CONFIG_PERFMGMT_POLICYSETSTACK_REMOVED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update a Site (v4.7) + summary: Update a Site (v4.9) tags: - Site Configuration servers: diff --git a/openapi-specs/sdwan/legacy/SoftwareManagement.yaml b/openapi-specs/sdwan/legacy/SoftwareManagement.yaml index 4cb0f9d08..112253992 100644 --- a/openapi-specs/sdwan/legacy/SoftwareManagement.yaml +++ b/openapi-specs/sdwan/legacy/SoftwareManagement.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,26 +44,25 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string ElementImageV2N1: properties: @@ -146,19 +140,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -184,7 +178,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -193,18 +187,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -224,7 +218,9 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string upgrade_interval: description: 'The upgrade interval time limit until an upgrade attempt is @@ -339,7 +335,7 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: "ID of the tenant. \n" type: string tentative_version: description: 'The tenatative version of the device software. @@ -347,7 +343,9 @@ components: ' type: string upgrade_version: - description: "The upgrade device software version. \n" + description: 'The upgrade device software version. + + ' type: string required: - tenant_id diff --git a/openapi-specs/sdwan/legacy/SystemAdministration.yaml b/openapi-specs/sdwan/legacy/SystemAdministration.yaml index b287d37b4..51fb1c98e 100644 --- a/openapi-specs/sdwan/legacy/SystemAdministration.yaml +++ b/openapi-specs/sdwan/legacy/SystemAdministration.yaml @@ -45,7 +45,9 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string required: - api_versions @@ -392,11 +394,13 @@ components: $ref: '#/components/schemas/AuthRole' type: array settings: - description: "The MSP operator settings. Maximum of 100 KB data size is\ - \ allowed. \n" + description: 'The MSP operator settings. Maximum of 100 KB data size is + allowed. + + ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: "ID of the tenant. \n" type: string required: - client_id @@ -446,10 +450,12 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: "ID of the tenant. \n" type: string value: - description: "The custom permission value. \n" + description: 'The custom permission value. + + ' type: string required: - value @@ -496,9 +502,7 @@ components: $ref: '#/components/schemas/AuthPermission' type: array roles: - description: 'The names of the roles. - - ' + description: "The names of the roles. \n" items: $ref: '#/components/schemas/AuthRole' type: array @@ -575,7 +579,9 @@ components: $ref: '#/components/schemas/AuthRole' type: array tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string required: - name @@ -609,7 +615,9 @@ components: - EVAL type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string username: description: 'The username. Max length = 255. @@ -644,7 +652,9 @@ components: - EVAL type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string user_id: description: 'The element user ID. @@ -691,7 +701,9 @@ components: - EVAL type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string username: description: 'The username. Max length = 255. @@ -777,7 +789,7 @@ components: ' type: string tenant_id: - description: "The tenant ID. \n" + description: "The tenant ID. \n" type: string required: - conf @@ -903,7 +915,9 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string required: - idp_entity_id @@ -1019,7 +1033,9 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string required: - idp_entity_id @@ -1085,19 +1101,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -1123,7 +1139,7 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -1132,18 +1148,18 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string tenant_id: - description: 'The ID of the tenant. + description: 'The tenant ID. ' type: string @@ -1408,7 +1424,9 @@ components: ' type: boolean last_login: - description: "The last log in time. \n" + description: 'The last log in time. + + ' format: date type: string last_name: @@ -1457,7 +1475,7 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: "ID of the tenant. \n" type: string required: - linked_accounts @@ -1467,134 +1485,157 @@ components: OperatorV2N2: properties: addresses: - description: 'Addresses: Size(max = 20, error = OPERATOR_INVALID_ADDRESS_LIST_SIZE: - Provide a valid address list. A maximum of twenty addresses can be specified, - min = 0) Valid ' + description: 'The list of operator addresses. Max number of addresses = + 20. + + ' items: $ref: '#/components/schemas/Address' type: array custom_roles: - description: 'Custom Roles: Size(max = 100, error = OPERATOR_INVALID_CUSTOM_ROLES_LIST_SIZE: - Custom roles set is limited to {} length, min = 0) ' + description: "The list/details of the custom roles. \n" items: $ref: '#/components/schemas/CustomRoleV2N1' type: array disable_idp_login: - description: Disable Idp Login + description: "Lists if the tenant IdP log in option is disabled. \n" type: boolean disabled: - description: Disabled + description: 'List the disabled tenants. + + ' type: boolean disabled_reason: - description: 'Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, - min = 0) ' + description: 'The reason for disabling the tenant. + + ' type: string email: - description: 'Email: Email(error = OPERATOR_EMAIL_INVALID: Invalid email - {validatedValue}. Please use a valid email address, regexp = .*) Size(max - = 1000, error = OPERATOR_EMAIL_INVALID: Invalid email {validatedValue}. - Please use a valid email address, min = 1) NotEmpty ' + description: 'The operator email ID. + + ' type: string email_iam: - description: 'Email Iam: Email(error = OPERATOR_EMAIL_IAM_INVALID: Invalid - email {validatedValue}. Please use a valid email address, regexp = .*) - Size(max = 1000, error = OPERATOR_EMAIL_IAM_INVALID: Invalid email {validatedValue}. - Please use a valid email address, min = 1) ' + description: 'The operator email IAM ID. + + ' type: string email_validated: - description: Email Validated + description: 'Validate the email ID. + + ' type: boolean enable_session_ip_lock: - description: Enable Session Ip Lock + description: "Enable the sessin IP lock. \n" type: boolean first_name: - description: 'First Name: Size(max = 100, error = OPERATOR_FNAME_INVALID: - Invalid first name {validatedValue}. Please use a first name which is - 100 characters or less in length, min = 0) NotEmpty ' + description: 'The first name of the operator. Max size = 100. + + ' type: string from_esp: - description: From Esp + description: 'If the tenant is ESP. + + ' type: boolean from_esp_name: - description: 'From Esp Name: Length(max = 512, error = TENANT_INVALID_NAME: - Please provide a valid name with a length less than 512 characters, min - = 0) ' + description: 'The name of the ESP tenant. Max size = 512. + + ' type: string from_esp_tenant_id: - description: 'From Esp Tenant Id: Pattern(error = TENANT_INVALID_ID: Provide - a valid tenant id, regexp = ^[a-z0-9]{1,50}$) ' + description: 'The ESP tenant ID. + + ' type: string id: - description: Id + description: 'The ID. + + ' type: string inactive: - description: Inactive + description: 'List the inactive tenants. + + ' type: boolean inactive_reason: - description: 'Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, - min = 0) ' + description: "The reason for the tenant being inactive. \n" type: string ipv4_list: - description: 'Ipv4 List: Size(max = 100, error = OPERATOR_IPV4_INVALID: - Invalid ipv4 list, min = 0) Valid ' + description: 'The list of IPv4 addresses. + + ' items: $ref: '#/components/schemas/IPv4Address' type: array is_locked: - description: Is Locked + description: 'Locked. True or False. + + ' type: boolean is_system_owned: - description: Is System Owned + description: 'The custom role is system owned. + + ' type: boolean last_login: + description: 'The last log in time. + + ' format: date type: string last_name: - description: 'Last Name: Size(max = 100, error = OPERATOR_LNAME_INVALID: - Invalid last name {validatedValue}. Please use a last name which is 100 - characters or less in length, min = 0) ' + description: 'The last name of the ESP tenant. + + ' type: string linked_accounts: - description: 'Linked Accounts: Size(max = 20, error = OPERATOR_INVALID_LINKED_ACCOUNTS_SIZE: - Invalid linked account information. Maximum of 20 and at least 1 linked - account(s) should be specified, min = 1) NotEmpty ' + description: 'Details of any linked accounts. Maximum of 20 and at least + 1 linked account(s) should be specified. + + ' items: $ref: '#/components/schemas/LinkedAccount' type: array migration_state: $ref: '#/components/schemas/MigrationState' - description: Migration State + description: 'The migration state. + + ' phone_numbers: - description: 'Phone Numbers: Size(max = 20, error = OPERATOR_INVALID_PHONE_LIST_SIZE: - Invalid phone list size. Maximum of twenty phones can be specified, min - = 0) Valid ' + description: 'The details of the phone numbers. Maximum of twenty phones + can be specified. + + ' items: $ref: '#/components/schemas/PhoneNumber' type: array region: - description: Region + description: 'The region of the tenant. + + ' type: string roles: - description: 'Roles: Valid Size(max = 7, error = OPERATOR_INVALID_ROLE_LIST_SIZE: - Role list size is invalid. Maximum of seven and at least one role must - be specified, min = 0) ' + description: "The defined ESP roles. \n" items: $ref: '#/components/schemas/AuthRole' type: array secondary_emails: - description: 'Secondary Emails: Size(max = 20, error = OPERATOR_EMAIL_LIST_INVALID: - Invalid email list size {validatedValue}. Please use a valid email list, - min = 0) Valid ' + description: 'List of secondary email addresses. Max size = 20. + + ' items: $ref: '#/components/schemas/Email' type: array settings: - description: 'Settings: Size(max = 100000, error = OPERATOR_INVALID_SETTINGS_SIZE: - Invalid data size for settings. Maximum of 100KB data size is allowed, - min = 0) ' + description: 'The operator settings. + + ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string required: - linked_accounts @@ -1867,6 +1908,41 @@ components: security: description: Security type: string + SamlRequest: + properties: + LoginHint: + description: LoginHint + type: string + RelayState: + description: RelayState + type: string + SAMLRequest: + description: SAMLRequest + type: string + api_endpoint: + description: Api Endpoint + type: string + id: + description: Id + type: string + login_region: + description: Login Region + type: string + method: + description: Method + type: string + requestId: + description: RequestId + type: string + url: + description: Url + type: string + urlpath: + description: Urlpath + type: string + username: + description: Username + type: string SamlResponse: properties: relayState: @@ -1928,7 +2004,9 @@ components: ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string type: description: 'The session type. @@ -2155,216 +2233,302 @@ components: tenant_id: description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' type: string + tsg_id: + description: Tsg Id + type: string required: - tenant_id - TenantV2N4: + TenantV2N5: properties: address: $ref: '#/components/schemas/Address' - description: 'Address: Valid ' + description: 'The address of the site. + + ' canonical_name: - description: 'Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: - Please provide a valid canonical name with a length less than 128 characters, - e.g., mydomain.com, regexp = [0-9a-zA-Z\\.\\-_]{1,128}) ' + description: "The tenant canonical name. Max size = 128. \n" type: string clients: - description: 'Clients: Valid ' + description: "The client tenant. \n" items: description: Clients type: string type: array csp_tenant_id: - description: 'Csp Tenant Id: Length(max = 32, TENANT_INVALID_CSP_IT_TENANT_ID, - min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_CSP_IT_TENANT_ID) ' + description: 'The CSP tenant ID. Max length = 32. + + ' type: string description: - description: 'Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: - Please provide a description with a length less than 1024 characters, - min = 0) ' - type: string + description: 'The description of the tenant. Max size = 1024. + + ' disabled: - description: Disabled + description: 'List the disabled tenants. + + ' type: string disabled_reason: - description: 'Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, - min = 0) ' + description: 'The reason for disabling the tenant. + + ' type: string id: - description: Id + description: 'The ID. + + ' type: string inactive: - description: Inactive + description: 'List the inactive tenants. + + ' type: string inactive_reason: - description: 'Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, - min = 0) ' + description: "The reason for the tenant being inactive. \n" type: string ipv4_list: - description: 'Ipv4 List: Valid ' + description: "The list of IPv4 addresses. \n" items: $ref: '#/components/schemas/IPv4Address' type: array is_esp: - description: Is Esp + description: 'If the tenant is ESP. + + ' + type: boolean + is_pa_iot_security_license: + description: Is Pa Iot Security License type: boolean is_support: description: Is Support type: boolean name: - description: 'Name: Length(max = 512, error = TENANT_INVALID_NAME: Please - provide a valid name with a length less than 512 characters, min = 0) ' + description: 'The name of the tenant. Max size = 512. + + ' type: string operator: $ref: '#/components/schemas/Operator' - description: Operator + description: 'The details of the operator. + + ' pan_account_id: - description: 'Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, - min = 0) ' + description: 'The tenant PAN CSP account ID. Max size = 32. + + ' type: string pan_tenant_id: - description: 'Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, - min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) ' + description: 'The PAN tenant ID. Max size = 32. + + ' type: string password_policy: $ref: '#/components/schemas/PasswordPolicy' - description: 'Password Policy: Valid ' + description: 'The details of the password policy. + + ' phone_numbers: - description: 'Phone Numbers: Valid ' + description: 'The details of the phone numbers. + + ' items: $ref: '#/components/schemas/PhoneNumber' type: array prisma_access_tenant_id: - description: 'Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, - min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) ' + description: 'The prisma access tenant ID. Max size = 32. + + ' type: string provider_data: - description: 'Provider Data: Valid ' + description: 'The details of the provider data. + + ' items: $ref: '#/components/schemas/ProviderData' type: array region: - description: Region + description: 'The region of the tenant. + + ' type: string sase_at: + description: 'The sase date. + + ' format: date type: string telemetry_region: - description: Telemetry Region + description: 'The telemetry region. + + ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: "ID of the tenant. \n" type: string tsg_id: - description: 'Tsg Id: Length(max = 32, error = TENANT_INVALID_TSG_ID: Invalid - tsg id found. Contact support, min = 0) Digits(fraction = 0, integer = - 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support) ' + description: 'The tenant TSG ID. + + ' type: string + tsg_instances: + description: 'The details of the TSG instances. + + ' + items: + $ref: '#/components/schemas/TsgInstance' + type: array required: - tenant_id - TenantV2N5: + TenantV2N7: properties: + ? '' + : description: X Panw Region + type: string address: $ref: '#/components/schemas/Address' - description: 'Address: Valid ' + description: 'The address of the site. + + ' canonical_name: - description: 'Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: - Please provide a valid canonical name with a length less than 128 characters, - e.g., mydomain.com, regexp = [0-9a-zA-Z\\.\\-_]{1,128}) ' + description: "The tenant canonical name. Max size = 128. \n" type: string clients: - description: 'Clients: Valid ' + description: "The client tenant. \n" items: description: Clients type: string type: array csp_tenant_id: - description: 'Csp Tenant Id: Length(max = 32, TENANT_INVALID_CSP_IT_TENANT_ID, - min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_CSP_IT_TENANT_ID) ' + description: 'The CSP tenant ID. Max length = 32. + + ' type: string description: - description: 'Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: - Please provide a description with a length less than 1024 characters, - min = 0) ' - type: string + description: 'The description of the tenant. Max size = 1024. + + ' disabled: - description: Disabled + description: 'List the disabled tenants. + + ' type: string disabled_reason: - description: 'Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, - min = 0) ' + description: 'The reason for disabling the tenant. + + ' type: string id: - description: Id + description: 'The ID. + + ' type: string inactive: - description: Inactive + description: 'List the inactive tenants. + + ' type: string inactive_reason: - description: 'Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, - min = 0) ' + description: "The reason for the tenant being inactive. \n" type: string ipv4_list: - description: 'Ipv4 List: Valid ' + description: "The list of IPv4 addresses. \n" items: $ref: '#/components/schemas/IPv4Address' type: array is_esp: - description: Is Esp + description: 'If the tenant is ESP. + + ' + type: boolean + is_oneapp_ready: + description: 'True or False for oneapp. + + ' + type: boolean + is_pa_iot_security_license: + description: 'True or False for PA IoT security license. + + ' type: boolean is_support: - description: Is Support + description: 'True or False for support. + + ' type: boolean name: - description: 'Name: Length(max = 512, error = TENANT_INVALID_NAME: Please - provide a valid name with a length less than 512 characters, min = 0) ' + description: 'The name of the tenant. Max size = 512. + + ' type: string operator: $ref: '#/components/schemas/Operator' - description: Operator + description: 'The details of the operator. + + ' pan_account_id: - description: 'Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, - min = 0) ' + description: 'The tenant PAN CSP account ID. Max size = 32. + + ' type: string pan_tenant_id: - description: 'Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, - min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) ' + description: 'The PAN tenant ID. Max size = 32. + + ' type: string password_policy: $ref: '#/components/schemas/PasswordPolicy' - description: 'Password Policy: Valid ' + description: 'The details of the password policy. + + ' phone_numbers: - description: 'Phone Numbers: Valid ' + description: 'The details of the phone numbers. + + ' items: $ref: '#/components/schemas/PhoneNumber' type: array prisma_access_tenant_id: - description: 'Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, - min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) ' + description: 'The prisma access tenant ID. Max size = 32. + + ' type: string provider_data: - description: 'Provider Data: Valid ' + description: 'The details of the provider data. + + ' items: $ref: '#/components/schemas/ProviderData' type: array region: - description: Region + description: 'The region of the tenant. + + ' type: string sase_at: + description: 'The sase date. + + ' format: date type: string telemetry_region: - description: Telemetry Region + description: 'The telemetry region. + + ' type: string tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + description: 'ID of the tenant. + + ' type: string tsg_id: - description: 'Tsg Id: Length(max = 32, error = TENANT_INVALID_TSG_ID: Invalid - tsg id found. Contact support, min = 0) Digits(fraction = 0, integer = - 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support) ' + description: 'The tenant TSG ID. + + ' type: string tsg_instances: - description: 'Tsg Instances: Valid ' + description: 'The details of the TSG instances. + + ' items: $ref: '#/components/schemas/TsgInstance' type: array @@ -2377,47 +2541,115 @@ components: ' type: string - password: - description: "The new password. Max length = 1000. \n" - type: string - repeatPassword: - description: 'Repeat the new password. Max length = 1000. + password: + description: "The new password. Max length = 1000. \n" + type: string + repeatPassword: + description: 'Repeat the new password. Max length = 1000. + + ' + type: string + token: + description: "A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$ \n" + type: string + required: + - repeatPassword + - password + TsgInstance: + properties: + app_id: + description: 'The app ID of the TSG instance. + + ' + type: string + region: + description: 'The region of the TSG instance. + + ' + type: string + tenant_id: + description: Tenant Id + type: string + Type: + properties: + value: + description: Value + type: string + UserAgent: + properties: + name: + description: 'The name of the user agent. + + ' + type: string + UserIdentity: + properties: + disabled: + description: 'List the users in a disabled state. + + ' + type: boolean + disabled_reason: + description: 'List the reason for the disabled state. + + ' + type: string + first_name: + description: 'The first name of the user. Max size = 100. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + inactive: + description: 'Lists if the user is inactive. + + ' + type: boolean + inactive_reason: + description: 'Reason the user is inactive. ' type: string - token: - description: "A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$ \n" + last_name: + description: 'The last name of the user. + + ' type: string - required: - - repeatPassword - - password - TsgInstance: - properties: - app_id: - description: App Id + middle_name: + description: 'The middle name of the user. + + ' type: string region: - description: Region + description: 'The region. + + ' type: string tenant_id: - description: Tenant Id + description: 'ID of the tenant. + + ' type: string - Type: - properties: - value: - description: Value + user_dn: + description: 'The user dn. + + ' type: string - UserAgent: - properties: - name: - description: 'The name of the user agent. + user_fqn: + description: 'The user fqn. ' type: string + required: + - tenant_id info: contact: {} description: List of APIs used to manage the operators, IDPs, users, base roles, - base permissions, password change, sign up, and client roles, base roles. + base permissions, password change, sign up, client roles, and base roles. title: System Administration version: Latest openapi: 3.0.0 @@ -2501,7 +2733,7 @@ paths: - System Administration /v2.0/api/permissions: get: - description: Get list of permitted APIs that the current operator can invoke + description: Get list of permitted APIs that the current operator can invoke. operationId: get-v2.0-api-permissions responses: '200': @@ -2510,7 +2742,7 @@ paths: schema: $ref: '#/components/schemas/AuthResource' description: Successful Operation - summary: Get list of permitted APIs that the current operator can invoke (v2.0) + summary: Get Permitted List of APIs (v2.0) tags: - System Administration /v2.0/api/profile: @@ -2529,10 +2761,10 @@ paths: - System Administration /v2.0/api/tenants/{client_id}/logout: post: - description: Logout api for esp client. Reverts back to esp session + description: Logs out for MSP client and reverts back to the MSP session. operationId: post-v2.0-api-tenants-client_id-logout parameters: - - description: Client Id + - description: The client ID. in: path name: client_id required: true @@ -2567,7 +2799,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Logout api for esp client. Reverts back to esp session (v2.0) + summary: Logout for MSP client (v2.0) tags: - System Administration /v2.0/api/tenants/{tenant_id}/accounts/password/change: @@ -4542,6 +4774,44 @@ paths: summary: Create SSO Session (v2.0) tags: - System Administration + /v2.0/api/tenants/{tenant_id}/saml_idp: + post: + description: Process SAML request from SP. + operationId: post-v2.0-api-tenants-tenant_id-saml_idp + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SamlRequest' + description: SAMLRequest + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthResource' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Process SAML Request from SP (v2.0) + tags: + - System Administration /v2.0/api/tenants/{tenant_id}/signup: post: description: Sign up new operators. @@ -4585,6 +4855,203 @@ paths: summary: Sign New Operators (v2.0) tags: - System Administration + /v2.0/api/tenants/{tenant_id}/users: + get: + description: List all the users. + operationId: get-v2.0-api-tenants-tenant_id-users + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/UserIdentity' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Users (v2.0) + tags: + - System Administration + post: + description: Create an user identity. + operationId: post-v2.0-api-tenants-tenant_id-users + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Create an user identity + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create User Identity (v2.0) + tags: + - System Administration + /v2.0/api/tenants/{tenant_id}/users/{user_id}: + delete: + description: Delete an user identity. + operationId: delete-v2.0-api-tenants-tenant_id-users-user_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The user ID. + in: path + name: user_id + required: true + schema: + description: User Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete User Identity (v2.0) + tags: + - System Administration + get: + description: Get an user identity. + operationId: get-v2.0-api-tenants-tenant_id-users-user_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The user ID. + in: path + name: user_id + required: true + schema: + description: User Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get User Identity (v2.0) + tags: + - System Administration + put: + description: Update an user identity. + operationId: put-v2.0-api-tenants-tenant_id-users-user_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The user ID. + in: path + name: user_id + required: true + schema: + description: User Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Details of the site Network Policy local prefix to be associated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update User Identity (v2.0) + tags: + - System Administration /v2.1/api/profile: get: description: Get current user profile. @@ -5850,10 +6317,10 @@ paths: - System Administration /v2.2/api/tenants/{tenant_id}/operators: get: - description: Get a list of tenant operators + description: Get a list of tenant operators. operationId: get-v2.2-api-tenants-tenant_id-operators parameters: - - description: Tenant Id + - description: The tenant ID. in: path name: tenant_id required: true @@ -5874,14 +6341,14 @@ paths: type: array type: object description: Successful Operation - summary: Get a list of tenant operators (v2.2) + summary: Get Tenant Operators (v2.2) tags: - System Administration post: - description: Create a tenant operator + description: Create a tenant operator. operationId: post-v2.2-api-tenants-tenant_id-operators parameters: - - description: Tenant Id + - description: The tenant ID. in: path name: tenant_id required: true @@ -5919,22 +6386,22 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create a tenant operator (v2.2) + summary: Create Tenant Operator (v2.2) tags: - System Administration /v2.2/api/tenants/{tenant_id}/operators/{operator_id}: delete: - description: Delete a tenant operator + description: Delete a specific tenant operator. operationId: delete-v2.2-api-tenants-tenant_id-operators-operator_id parameters: - - description: Tenant Id + - description: The tenant ID. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: Operator Id + - description: The operator ID. in: path name: operator_id required: true @@ -5959,21 +6426,21 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete a tenant operator (v2.2) + summary: Delete Tenant Operator (v2.2) tags: - System Administration get: - description: Get a tenant operator + description: List a specific tenant operator. operationId: get-v2.2-api-tenants-tenant_id-operators-operator_id parameters: - - description: Tenant Id + - description: The tenant ID. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: Operator Id + - description: The operator ID. in: path name: operator_id required: true @@ -5987,21 +6454,21 @@ paths: schema: $ref: '#/components/schemas/OperatorV2N2' description: Successful Operation - summary: Get a tenant operator (v2.2) + summary: Get Tenant Operator (v2.2) tags: - System Administration put: - description: Update a tenant operator + description: Update a specific tenant operator. operationId: put-v2.2-api-tenants-tenant_id-operators-operator_id parameters: - - description: Tenant Id + - description: The tenant ID. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: Operator Id + - description: The operator ID. in: path name: operator_id required: true @@ -6040,15 +6507,15 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update a tenant operator (v2.2) + summary: Update Tenant Operator (v2.2) tags: - System Administration - /v2.4/api/tenants/{tenant_id}: + /v2.6/api/tenants/{tenant_id}: get: - description: Get tenant details for tenant id - operationId: get-v2.4-api-tenants-tenant_id + description: Get the tenant details for a tenant ID. + operationId: get-v2.6-api-tenants-tenant_id parameters: - - description: Tenant Id or Tsg Id + - description: The tenant or TSG ID. in: path name: tenant_id required: true @@ -6060,7 +6527,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N4' + $ref: '#/components/schemas/TenantV2N5' description: Successful Operation '400': content: @@ -6073,14 +6540,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get tenant details for tenant id (v2.4) + summary: Get Tenant Details for Tenant ID (v2.6) tags: - System Administration put: - description: Update tenant - operationId: put-v2.4-api-tenants-tenant_id + description: Update the tenant details for a tenant ID. + operationId: put-v2.6-api-tenants-tenant_id parameters: - - description: Tenant Id + - description: The tenant or TSG ID. in: path name: tenant_id required: true @@ -6091,14 +6558,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N4' + $ref: '#/components/schemas/TenantV2N5' description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N4' + $ref: '#/components/schemas/TenantV2N5' description: Successful Operation '400': content: @@ -6114,15 +6581,15 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update tenant (v2.4) + summary: Update Tenant Details for Tenant ID (v2.6) tags: - System Administration - /v2.5/api/tenants/{tenant_id}: + /v2.7/api/tenants/{tenant_id}: get: - description: Get tenant details for tenant id - operationId: get-v2.5-api-tenants-tenant_id + description: Get the tenant details for a tenant ID. + operationId: get-v2.7-api-tenants-tenant_id parameters: - - description: Tenant Id or Tsg Id + - description: The tenant or TSG ID. in: path name: tenant_id required: true @@ -6134,7 +6601,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' + $ref: '#/components/schemas/TenantV2N7' description: Successful Operation '400': content: @@ -6147,14 +6614,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get tenant details for tenant id (v2.5) + summary: Get Tenant Details for Tenant ID (v2.7) tags: - System Administration put: - description: Update tenant - operationId: put-v2.5-api-tenants-tenant_id + description: Update the tenant details for a tenant ID. + operationId: put-v2.7-api-tenants-tenant_id parameters: - - description: Tenant Id + - description: The tenant or TSG ID. in: path name: tenant_id required: true @@ -6165,14 +6632,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' + $ref: '#/components/schemas/TenantV2N7' description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' + $ref: '#/components/schemas/TenantV2N7' description: Successful Operation '400': content: @@ -6188,7 +6655,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update tenant (v2.5) + summary: Update Tenant Details for Tenant ID (v2.7) tags: - System Administration /v3.2/api/tenants/{tenant_id}/idps: diff --git a/openapi-specs/sdwan/legacy/Topology.yaml b/openapi-specs/sdwan/legacy/Topology.yaml index d7bfeb7a2..01c04f2a2 100644 --- a/openapi-specs/sdwan/legacy/Topology.yaml +++ b/openapi-specs/sdwan/legacy/Topology.yaml @@ -1,5 +1,37 @@ components: schemas: + Address: + properties: + city: + description: 'The name of the city. Max size = 100. + + ' + type: string + country: + description: 'The name of the country. Max size = 100. + + ' + type: string + post_code: + description: 'The postal code. Max size = 100. + + ' + type: string + state: + description: 'The name of the state. Max size = 100. + + ' + type: string + street: + description: 'The name of the street. Max size = 100. + + ' + type: string + street2: + description: 'The name of the street. Max size = 100. + + ' + type: string Aggregate: properties: data: @@ -36,11 +68,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,26 +76,295 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object + AnynetLinkV3N3: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + description: + description: 'The anynet link description. Max size = 256. + + ' + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_wan_if_id: + description: Ep1 Wan If Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_wan_if_id: + description: Ep2 Wan If Id + type: string + forced: + description: Forced + type: boolean + id: + description: 'The anynet link ID. + + ' + type: string + name: + description: 'The anynet link name. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the anynet + link. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tenant_id: + description: 'The active user tenant ID. + + ' + type: string + type: + description: 'Anynet link type. + + ' + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + AnynetLinkV3N4: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + description: + description: 'The anynet link description. Max size = 256. + + ' + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_wan_if_id: + description: Ep1 Wan If Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_wan_if_id: + description: Ep2 Wan If Id + type: string + forced: + description: Forced + type: boolean + id: + description: 'The anynet link ID. + + ' + type: string + name: + description: 'The anynet link name. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the anynet + link. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tenant_id: + description: 'The active user tenant ID. + + ' + type: string + type: + description: 'Anynet link type. + + ' + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + Anynetlink: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + description: + description: 'The anynet link description. Max size = 256. + + ' + disabled: + description: Disabled + type: boolean + disabled_reason: + description: 'Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, + min = 0) ' + type: string + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_site_role: + description: Ep1 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep1_wan_interface_id: + description: Ep1 Wan Interface Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_site_role: + description: Ep2 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep2_wan_interface_id: + description: Ep2 Wan Interface Id + type: string + id: + description: 'The anynet link ID. + + ' + type: string + inactive: + description: Inactive + type: boolean + inactive_reason: + description: 'Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, + min = 0) ' + type: string + name: + description: 'The anynet link name. Max size = 128. + + ' + type: string + region: + description: Region + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + tags: + description: 'A information field that can be added to identify the anynet + link. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + target_serviceendpoint_id: + description: Target Serviceendpoint Id + type: string + tenant_id: + description: 'The active user tenant ID. + + ' + type: string + type: + description: 'Anynet link type. + + ' + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - site_id + - tenant_id + BfdSession: + properties: + element_id: + description: "The element ID. \n" + type: string + peers: + description: 'The peers details. + + ' + items: + description: Peers + type: string + type: array + BfdUnderlay: + properties: + bfd_sessions: + description: "The element and peers information of the BFD sessions. \ + \ \n" + items: + $ref: '#/components/schemas/BfdSession' + type: array + site_id: + description: 'The site ID. + + ' + type: string required: - - value - - view + - site_id BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string Error: properties: @@ -85,19 +381,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -123,270 +419,1290 @@ components: ' type: string total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 type: integer type: object - VPLAdminState: + Location: properties: - al_id: - description: Al Id - type: string - enabled: - description: 'The enabled states on a VPN link. + description: + description: 'The decsription of the location. ' - type: boolean - id: - description: 'The ID of the VPN link. + latitude: + description: 'The latitude of the location. Max range = 90. ' - type: string - VPLOperations: + format: float + type: number + longitude: + description: 'The longitude of the location. Max range = 180. + + ' + format: float + type: number + NetworkLinkV2: properties: - action: - description: 'The actions performed on a VPN link. + anynet_link_id: + description: 'The anynet link ID.. ' - enum: - - refresh_vpnlink_status type: string + description: + description: 'The anynet link description. Max size = 256. + + ' id: - description: 'The ID of the VPN link. + description: 'The ID. ' type: string - VPLOperationsScreen: - properties: - action: - description: 'The actions performed on a VPN link. + network: + description: Network + type: string + path_id: + description: Path Id + type: string + source_node_id: + description: 'The source node ID. ' - enum: - - refresh_vpnlink_status type: string - id: - description: 'The ID of the VPN link. + source_wan_network: + description: 'The source WAN network. ' type: string - VPLStatus: - properties: - common_cipher: - description: Common Cipher + source_wan_nw_id: + description: 'The The source WAN network ID. + + ' type: string - ep1_cipher: - description: Ep1 Cipher + source_wan_path_id: + description: Source Wan Path Id type: string - ep1_element_id: - description: Ep1 Element Id + state: + description: State type: string - ep1_interface_id: - description: Ep1 Interface Id + status: + description: 'The status of the link. + + ' type: string - ep1_site_id: - description: Ep1 Site Id + sub_type: + description: Sub Type type: string - ep2_cipher: - description: Ep2 Cipher + target_node_id: + description: 'The target node ID. + + ' type: string - ep2_element_id: - description: Ep2 Element Id + target_wan_network: + description: 'The target WAN network. + + ' type: string - ep2_interface_id: - description: Ep2 Interface Id + target_wan_nw_id: + description: 'The The target WAN network ID. + + ' type: string - ep2_site_id: - description: Ep2 Site Id + target_wan_path_id: + description: Target Wan Path Id type: string - id: - description: Id + tenant_id: + description: 'The active user tenant ID. + + ' type: string - VPLStatusV2N1: + type: + description: 'Anynet link type. + + ' + type: string + vpnlinks: + description: 'The VPN links info. + + ' + items: + description: Vpnlinks + type: string + type: array + wan_nw_id: + description: 'The WAN network ID. + + ' + type: string + required: + - tenant_id + NetworkLinkV3N3: properties: - active: - description: Active + admin_up: + description: 'The interface admin state. + + ' type: boolean - common_cipher: - description: Common Cipher + anynet_link_id: + description: 'The anynet link ID.. + + ' type: string - ep1_cipher: - description: Ep1 Cipher + cost: + description: Cost + format: int32 + type: integer + description: + description: 'The anynet link description. Max size = 256. + + ' + elem_interface_id: + description: 'The element interface ID. + + ' type: string - ep1_element_id: - description: Ep1 Element Id + element_id: + description: 'The element ID. + + ' type: string - ep1_interface_id: - description: Ep1 Interface Id + id: + description: 'The ID. + + ' type: string - ep1_keep_alive_failure_count: - description: Ep1 Keep Alive Failure Count - type: integer - ep1_keep_alive_interval: - description: Ep1 Keep Alive Interval - type: integer - ep1_site_id: - description: Ep1 Site Id + in_use: + description: In Use + type: boolean + name: + description: 'The anynet link name. Max size = 128. + + ' type: string - ep2_cipher: - description: Ep2 Cipher + network: + description: Network type: string - ep2_element_id: - description: Ep2 Element Id + path_id: + description: Path Id type: string - ep2_interface_id: - description: Ep2 Interface Id + sep_id: + description: Sep Id type: string - ep2_keep_alive_failure_count: - description: Ep2 Keep Alive Failure Count - type: integer - ep2_keep_alive_interval: - description: Ep2 Keep Alive Interval - type: integer - ep2_site_id: - description: Ep2 Site Id + sep_name: + description: Sep Name type: string - id: - description: Id + source_circuit_name: + description: 'The name of the source circuit. + + ' type: string - link_up: - description: Link Up - type: boolean - usable: - description: Usable - type: boolean - VPNLinkQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of VPN links that match the query parameters. + source_elem_if_id: + description: 'The source element ID. ' - dest_page: - description: 'The destination page. + type: string + source_node_id: + description: 'The source node ID. ' - format: int32 - type: integer - getDeleted: - description: 'The number of VPN links deleted for a time frame. + type: string + source_site_name: + description: 'The source site name. ' - type: boolean - group_by: - description: 'Group the VPN links for the query. + type: string + source_wan_if_id: + description: 'The source WAN ID. + + ' + type: string + source_wan_network: + description: 'The source WAN network. + + ' + type: string + source_wan_nw_id: + description: 'The The source WAN network ID. + + ' + type: string + status: + description: 'The status of the link. + + ' + type: string + sub_type: + description: Sub Type + type: string + tags: + description: 'A information field that can be added to identify the anynet + link. Maximum 10 unique tags of length 1024 each are allowed. ' items: - description: Group By + description: Tags type: string type: array - id: - description: "Lists the VPN links by ID. \n" + target_circuit_name: + description: 'The target circuit name. + + ' type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + target_elem_if_id: + description: 'The target element ID. ' - format: int64 - type: integer - limit: - description: 'The query limit. + type: string + target_node_id: + description: 'The target node ID. ' - format: int32 - type: integer - next_query: - description: 'The limit. + type: string + target_site_name: + description: 'The target site name. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + type: string + target_wan_if_id: + description: 'The target WAN ID. + + ' + type: string + target_wan_network: + description: 'The target WAN network. + + ' + type: string + target_wan_nw_id: + description: 'The The target WAN network ID. + + ' + type: string + tenant_id: + description: 'The active user tenant ID. + + ' + type: string + type: + description: 'Anynet link type. + + ' + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + vpnlinks: + description: 'The VPN links info. ' items: - description: Retrieved Fields + description: Vpnlinks type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. + wan_if_id: + description: 'The WAN ID. + + ' + type: string + wan_nw_id: + description: 'The WAN network ID. + + ' + type: string + wan_nw_name: + description: 'The WAN network name. + + ' + type: string + required: + - tenant_id + NetworkLinkV3N4: + properties: + admin_up: + description: 'The interface admin state. ' type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + anynet_link_id: + description: 'The anynet link ID.. ' - format: int64 + type: string + cost: + description: Cost + format: int32 type: integer - WanOverlay: - properties: description: - description: 'The WAN overlay config description. Max size = 256. + description: 'The anynet link description. Max size = 256. + + ' + elem_interface_id: + description: 'The element interface ID. + + ' + type: string + element_id: + description: 'The element ID. ' + type: string id: - description: 'The ID of the WAN overlay. + description: 'The ID. ' type: string + in_use: + description: In Use + type: boolean name: - description: 'The WAN overlay config name. Max size = 128. + description: 'The anynet link name. Max size = 128. ' type: string - vni: - description: "The VNI value. \n" - format: int32 - type: integer - required: - - vni - - name -info: - contact: {} - description: List of APIs used to manage the network topology, WAN Overlays, VPN - Links, and Secure Fabric Links. - title: Topology - version: Latest -openapi: 3.0.0 -paths: - /v2.0/api/tenants/{tenant_id}/vpnlinks/query: - post: - description: Query DB for VPN links that match query parameters. - operationId: post-v2.0-api-tenants-tenant_id-vpnlinks-query - parameters: - - description: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id + network: + description: Network + type: string + path_id: + description: Path Id + type: string + sep_id: + description: Sep Id + type: string + sep_name: + description: Sep Name + type: string + source_circuit_name: + description: 'The name of the source circuit. + + ' + type: string + source_elem_if_id: + description: 'The source element ID. + + ' + type: string + source_node_id: + description: 'The source node ID. + + ' + type: string + source_site_name: + description: 'The source site name. + + ' + type: string + source_wan_if_id: + description: 'The source WAN ID. + + ' + type: string + source_wan_network: + description: 'The source WAN network. + + ' + type: string + source_wan_nw_id: + description: 'The The source WAN network ID. + + ' + type: string + status: + description: 'The status of the link. + + ' + type: string + sub_type: + description: Sub Type + type: string + tags: + description: 'A information field that can be added to identify the anynet + link. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + target_circuit_name: + description: 'The target circuit name. + + ' + type: string + target_elem_if_id: + description: 'The target element ID. + + ' + type: string + target_node_id: + description: 'The target node ID. + + ' + type: string + target_serviceendpoint_id: + description: Target Serviceendpoint Id + type: string + target_serviceendpoint_name: + description: Target Serviceendpoint Name + type: string + target_site_name: + description: 'The target site name. + + ' + type: string + target_wan_if_id: + description: 'The target WAN ID. + + ' + type: string + target_wan_network: + description: 'The target WAN network. + + ' + type: string + target_wan_nw_id: + description: 'The The target WAN network ID. + + ' + type: string + tenant_id: + description: 'The active user tenant ID. + + ' + type: string + type: + description: 'Anynet link type. + + ' + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + vpnlinks: + description: 'The VPN links info. + + ' + items: + description: Vpnlinks + type: string + type: array + wan_if_id: + description: 'The WAN ID. + + ' + type: string + wan_nw_id: + description: 'The WAN network ID. + + ' + type: string + wan_nw_name: + description: "The WAN network name.\n\n \n" + type: string + NetworkNode: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The network address details. + + ' + elem_hw_id: + description: 'The element hardware ID. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The network node location. + + ' + name: + description: 'The network name. Max size = 128. + + ' + type: string + role: + description: Role + type: string + site_id: + description: "The site ID. \n" + type: string + spoke_cluster_elem_status: + description: 'The spoke cluster element status. + + ' + type: string + state: + description: State + type: string + tenant_id: + description: 'The active user tenant ID. + + ' + type: string + type: + description: 'Anynet link type. + + ' + type: string + NetworkTopologyV3N3: + properties: + links: + description: 'Query the anynet links. + + ' + items: + $ref: '#/components/schemas/NetworkLinkV3N3' + type: array + nodes: + description: Nodes + items: + $ref: '#/components/schemas/NetworkNode' + type: array + type: + description: 'Anynet link type. + + ' + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string + NetworkTopologyV3N4: + properties: + links: + description: 'Query the anynet links. + + ' + items: + $ref: '#/components/schemas/NetworkLinkV3N4' + type: array + nodes: + description: Nodes + items: + $ref: '#/components/schemas/NetworkNode' + type: array + type: + description: 'Anynet link type. + + ' + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string + SiteEndpoints: + properties: + ep1_id: + description: Ep1 Id + type: string + ep2_id: + description: Ep2 Id + type: string + SiteLocation: + properties: + end: + $ref: '#/components/schemas/Location' + description: End + start: + $ref: '#/components/schemas/Location' + description: Start + TopologyQueryV3N1: + properties: + links: + description: 'Query the anynet links. + + ' + items: + description: Links + type: string + type: array + links_only: + description: 'The anynet link ID. True/False. + + ' + type: boolean + location: + $ref: '#/components/schemas/SiteLocation' + description: 'The anynet link start and end location. + + ' + nodes: + description: Nodes + items: + description: Nodes + type: string + type: array + servicelinks: + description: 'Servicelinks present. True/False. + + ' + type: boolean + site_id: + description: "The site ID. \n" + type: string + sites: + $ref: '#/components/schemas/SiteEndpoints' + description: 'The site endpoints. + + ' + stub_links: + description: Stub Links + type: boolean + type: + description: 'Anynet link type. + + ' + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string + VPLAdminState: + properties: + al_id: + description: Al Id + type: string + enabled: + description: 'The enabled states on a VPN link. + + ' + type: boolean + id: + description: 'The ID of the VPN link. + + ' + type: string + VPLOperations: + properties: + action: + description: 'The actions performed on a VPN link. + + ' + enum: + - refresh_vpnlink_status + type: string + id: + description: 'The ID of the VPN link. + + ' + type: string + VPLOperationsScreen: + properties: + action: + description: 'The actions performed on a VPN link. + + ' + enum: + - refresh_vpnlink_status + type: string + id: + description: 'The ID of the VPN link. + + ' + type: string + VPLStatus: + properties: + common_cipher: + description: Common Cipher + type: string + ep1_cipher: + description: Ep1 Cipher + type: string + ep1_element_id: + description: Ep1 Element Id + type: string + ep1_interface_id: + description: Ep1 Interface Id + type: string + ep1_site_id: + description: Ep1 Site Id + type: string + ep2_cipher: + description: Ep2 Cipher + type: string + ep2_element_id: + description: Ep2 Element Id + type: string + ep2_interface_id: + description: Ep2 Interface Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + id: + description: Id + type: string + VPLStatusV2N1: + properties: + active: + description: Active + type: boolean + common_cipher: + description: Common Cipher + type: string + ep1_cipher: + description: Ep1 Cipher + type: string + ep1_element_id: + description: Ep1 Element Id + type: string + ep1_interface_id: + description: Ep1 Interface Id + type: string + ep1_keep_alive_failure_count: + description: Ep1 Keep Alive Failure Count + type: integer + ep1_keep_alive_interval: + description: Ep1 Keep Alive Interval + type: integer + ep1_site_id: + description: Ep1 Site Id + type: string + ep2_cipher: + description: Ep2 Cipher + type: string + ep2_element_id: + description: Ep2 Element Id + type: string + ep2_interface_id: + description: Ep2 Interface Id + type: string + ep2_keep_alive_failure_count: + description: Ep2 Keep Alive Failure Count + type: integer + ep2_keep_alive_interval: + description: Ep2 Keep Alive Interval + type: integer + ep2_site_id: + description: Ep2 Site Id + type: string + id: + description: Id + type: string + link_up: + description: Link Up + type: boolean + usable: + description: Usable + type: boolean + VPNLinkConfiguration: + properties: + keep_alive_failure_count: + description: 'The VPN keep alive failure count (must be between 3 and 30). + + ' + type: integer + keep_alive_interval: + description: 'The VPN keep alive timeout interval (must be between 100ms-1740,000ms). + + ' + type: integer + required: + - keep_alive_failure_count + - keep_alive_interval + VPNLinkQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of VPN links that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of VPN links deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the VPN links for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "Lists the VPN links by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + WanOverlay: + properties: + description: + description: 'The WAN overlay config description. Max size = 256. + + ' + id: + description: 'The ID of the WAN overlay. + + ' + type: string + name: + description: 'The WAN overlay config name. Max size = 128. + + ' + type: string + vni: + description: "The VNI value. \n" + format: int32 + type: integer + required: + - vni + - name +info: + contact: {} + description: List of APIs used to manage the network topology, WAN Overlays, VPN + Links, and Secure Fabric Links. + title: Topology + version: Latest +openapi: 3.0.0 +paths: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/anynetlinks/{anynet_id}: + get: + description: Get the anynet link. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-anynetlinks-anynet_id + parameters: + - description: The ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The AnynetID. + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkLinkV2' + description: Successful Operation + '404': + description: not found + summary: Get Anynet Link (v2.0) + tags: + - Topology + /v2.0/api/tenants/{tenant_id}/vpnlinks/query: + post: + description: Query DB for VPN links that match query parameters. + operationId: post-v2.0-api-tenants-tenant_id-vpnlinks-query + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VPNLinkQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/VPNLinkQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: VPL_NOT_FOUND + - code: VPL_ACTION_INSUFFICIENT_VPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for VPN Links (v2.0) + tags: + - Topology + /v2.0/api/tenants/{tenant_id}/vpnlinks/{vpn_link_id}/operations: + post: + description: Perform an operation on a VPN link. + operationId: post-v2.0-api-tenants-tenant_id-vpnlinks-vpn_link_id-operations + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the VPN link. + in: path + name: vpn_link_id + required: true + schema: + description: Vpn Link Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VPLOperationsScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VPLOperations' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: VPL_NOT_FOUND + - code: VPL_ACTION_INSUFFICIENT_VPE + - code: VPNLINK_INVALID_ACTION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Perform Operation on VPN Link (v2.0) + tags: + - Topology + /v2.0/api/tenants/{tenant_id}/vpnlinks/{vpn_link_id}/state: + get: + description: List the admin state of the VPN link. + operationId: get-v2.0-api-tenants-tenant_id-vpnlinks-vpn_link_id-state + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the VPN link. + in: path + name: vpn_link_id + required: true + schema: + description: Vpn Link Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VPLAdminState' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: VPL_NOT_FOUND + - code: VPL_ACTION_INSUFFICIENT_VPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get VPN Link Admin State (v2.0) + tags: + - Topology + put: + description: Update the admin state of the VPN link. + operationId: put-v2.0-api-tenants-tenant_id-vpnlinks-vpn_link_id-state + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the VPN link. + in: path + name: vpn_link_id + required: true + schema: + description: Vpn Link Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VPLAdminState' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VPLAdminState' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: VPL_NOT_FOUND + - code: VPL_ACTION_INSUFFICIENT_VPE + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: ANYNET_VPL_ADMINSTATE_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update VPN Link Admin State (v2.0) + tags: + - Topology + /v2.0/api/tenants/{tenant_id}/vpnlinks/{vpn_link_id}/status: + get: + description: List the status of the VPN link. + operationId: get-v2.0-api-tenants-tenant_id-vpnlinks-vpn_link_id-status + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the VPN link. + in: path + name: vpn_link_id + required: true + schema: + description: Vpn Link Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VPLStatus' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: VPL_NOT_FOUND + - code: VPL_ACTION_INSUFFICIENT_VPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get VPN Link Status (v2.0) + tags: + - Topology + /v2.0/api/tenants/{tenant_id}/wanoverlays: + get: + description: List the app/wan contexts. + operationId: get-v2.0-api-tenants-tenant_id-wanoverlays + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WanOverlay' + type: array + type: object + description: Successful Operation + summary: Get App/WAN Contexts (v2.0) + tags: + - Topology + post: + description: Create a new app/wan context. + operationId: post-v2.0-api-tenants-tenant_id-wanoverlays + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WanOverlay' + description: Details of the appwan context to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WanOverlay' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WANOVERLAY_CONFIG_NAME_REQD + - code: NAME_EXCEEDS_LIMIT + - code: VNI_REQD + - code: INVALID_VNI_VALUE + - code: WANOVERLAY_CONFIG_DESCRIPTION_INVALID + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WAN_CONTEXT_ADD_FAILED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create App/WAN Context (v2.0) + tags: + - Topology + /v2.0/api/tenants/{tenant_id}/wanoverlays/{wan_overlay_id}: + delete: + description: Create a new app/wan context. + operationId: delete-v2.0-api-tenants-tenant_id-wanoverlays-wan_overlay_id + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the WAN overlay. + in: path + name: wan_overlay_id + required: true + schema: + description: Wan Overlay Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WanOverlay' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WANOVERLAY_IN_USE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete App/WAN Context (v2.0) + tags: + - Topology + get: + description: List the new app/wan context. + operationId: get-v2.0-api-tenants-tenant_id-wanoverlays-wan_overlay_id + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the WAN overlay. + in: path + name: wan_overlay_id + required: true + schema: + description: Wan Overlay Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VPNLinkQuery' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/VPNLinkQuery' - type: array - type: object + $ref: '#/components/schemas/WanOverlay' description: Successful Operation '400': content: @@ -394,18 +1710,18 @@ paths: example: value: _error: - - code: VPL_NOT_FOUND - - code: VPL_ACTION_INSUFFICIENT_VPE + - code: APPWAN_CONTEXT_DOES_NOT_EXIST + - code: APPWAN_CONTEXT_NAME_INVALID + - code: APPWAN_CONTEXT_DESCRIPTION_INVALID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for VPN Links (v2.0) + summary: Get App/WAN Context (v2.0) tags: - Topology - /v2.0/api/tenants/{tenant_id}/vpnlinks/{vpn_link_id}/operations: - post: - description: Perform an operation on a VPN link. - operationId: post-v2.0-api-tenants-tenant_id-vpnlinks-vpn_link_id-operations + put: + description: Update a new app/wan context. + operationId: put-v2.0-api-tenants-tenant_id-wanoverlays-wan_overlay_id parameters: - description: ID of the tenant. in: path @@ -414,24 +1730,25 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the VPN link. + - description: The ID of the WAN overlay. in: path - name: vpn_link_id + name: wan_overlay_id required: true schema: - description: Vpn Link Id + description: Wan Overlay Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/VPLOperationsScreen' + $ref: '#/components/schemas/WanOverlay' + description: Details of the appwan context to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VPLOperations' + $ref: '#/components/schemas/WanOverlay' description: Successful Operation '400': content: @@ -439,19 +1756,24 @@ paths: example: value: _error: - - code: VPL_NOT_FOUND - - code: VPL_ACTION_INSUFFICIENT_VPE - - code: VPNLINK_INVALID_ACTION + - code: APPWAN_CONTEXT_DOES_NOT_EXIST + - code: WANOVERLAY_CONFIG_NAME_REQD + - code: NAME_EXCEEDS_LIMIT + - code: VNI_REQD + - code: INVALID_VNI_VALUE + - code: WANOVERLAY_CONFIG_DESCRIPTION_INVALID + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Perform Operation on VPN Link (v2.0) + summary: Update App/WAN Context (v2.0) tags: - Topology - /v2.0/api/tenants/{tenant_id}/vpnlinks/{vpn_link_id}/state: + /v2.1/api/tenants/{tenant_id}/vpnlinks/{vpn_link_id}/status: get: - description: List the admin state of the VPN link. - operationId: get-v2.0-api-tenants-tenant_id-vpnlinks-vpn_link_id-state + description: List the status of the VPN link. + operationId: get-v2.1-api-tenants-tenant_id-vpnlinks-vpn_link_id-status parameters: - description: ID of the tenant. in: path @@ -472,7 +1794,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VPLAdminState' + $ref: '#/components/schemas/VPLStatusV2N1' description: Successful Operation '400': content: @@ -485,38 +1807,68 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get VPN Link Admin State (v2.0) + summary: Get VPN Link Status (v2.1) tags: - Topology - put: - description: Update the admin state of the VPN link. - operationId: put-v2.0-api-tenants-tenant_id-vpnlinks-vpn_link_id-state + /v3.0/api/tenants/{tenant_id}/sites/{site_id}/bfdpeers: + get: + description: Get the BFD peers. + operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-bfdpeers parameters: - - description: ID of the tenant. + - description: The ID of the tenant. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the VPN link. + - description: ID of the site. in: path - name: vpn_link_id + name: site_id required: true schema: - description: Vpn Link Id + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BfdUnderlay' + type: array + type: object + description: Successful Operation + summary: Get BFD Peers (v2.0) + tags: + - Topology + /v3.3/api/tenants/{tenant_id}/anynetlinks: + post: + description: Create an anynet link. + operationId: post-v3.3-api-tenants-tenant_id-anynetlinks + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/VPLAdminState' + $ref: '#/components/schemas/AnynetLinkV3N3' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VPLAdminState' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -524,20 +1876,19 @@ paths: example: value: _error: - - code: VPL_NOT_FOUND - - code: VPL_ACTION_INSUFFICIENT_VPE + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: ANYNET_VPL_ADMINSTATE_NOT_FOUND + - code: TOPOLOGY_REBUILD_IN_PROGRESS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update VPN Link Admin State (v2.0) + summary: Create Anynet Link (v3.3) tags: - Topology - /v2.0/api/tenants/{tenant_id}/vpnlinks/{vpn_link_id}/status: - get: - description: List the status of the VPN link. - operationId: get-v2.0-api-tenants-tenant_id-vpnlinks-vpn_link_id-status + /v3.3/api/tenants/{tenant_id}/anynetlinks/{anynet_id}: + delete: + description: Delete the anynet link. + operationId: delete-v3.3-api-tenants-tenant_id-anynetlinks-anynet_id parameters: - description: ID of the tenant. in: path @@ -546,19 +1897,19 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the VPN link. + - description: The anynet ID. in: path - name: vpn_link_id + name: anynet_id required: true schema: - description: Vpn Link Id + description: Anynet Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VPLStatus' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -566,18 +1917,18 @@ paths: example: value: _error: - - code: VPL_NOT_FOUND - - code: VPL_ACTION_INSUFFICIENT_VPE + - code: TOPOLOGY_REBUILD_IN_PROGRESS + - code: NO_ANYNETLINK_FOUND + - code: INVALID_ANYNETLINK_TYPE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get VPN Link Status (v2.0) + summary: Delete Anynet Link (v3.3) tags: - Topology - /v2.0/api/tenants/{tenant_id}/wanoverlays: get: - description: List the app/wan contexts. - operationId: get-v2.0-api-tenants-tenant_id-wanoverlays + description: Get the anynet link. + operationId: get-v3.3-api-tenants-tenant_id-anynetlinks-anynet_id parameters: - description: ID of the tenant. in: path @@ -586,26 +1937,28 @@ paths: schema: description: Tenant Id type: string + - description: The anynet ID. + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WanOverlay' - type: array - type: object + $ref: '#/components/schemas/NetworkLinkV3N3' description: Successful Operation - summary: Get App/WAN Contexts (v2.0) + '404': + description: not found + summary: Get Anynet Link (v3.3) tags: - Topology - post: - description: Create a new app/wan context. - operationId: post-v2.0-api-tenants-tenant_id-wanoverlays + put: + description: Update the anynet link. + operationId: put-v3.3-api-tenants-tenant_id-anynetlinks-anynet_id parameters: - description: ID of the tenant. in: path @@ -614,18 +1967,24 @@ paths: schema: description: Tenant Id type: string + - description: The anynet ID. + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' - description: Details of the appwan context to be created + $ref: '#/components/schemas/AnynetLinkV3N3' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -633,44 +1992,79 @@ paths: example: value: _error: - - code: WANOVERLAY_CONFIG_NAME_REQD - - code: NAME_EXCEEDS_LIMIT - - code: VNI_REQD - - code: INVALID_VNI_VALUE - - code: WANOVERLAY_CONFIG_DESCRIPTION_INVALID + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: WAN_CONTEXT_ADD_FAILED + - code: TOPOLOGY_REBUILD_IN_PROGRESS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create App/WAN Context (v2.0) + summary: Update Anynet Link (v3.3) tags: - Topology - /v2.0/api/tenants/{tenant_id}/wanoverlays/{wan_overlay_id}: - delete: - description: Create a new app/wan context. - operationId: delete-v2.0-api-tenants-tenant_id-wanoverlays-wan_overlay_id + /v3.3/api/tenants/{tenant_id}/topology: + post: + description: Query the topology elements of the tenant. + operationId: post-v3.3-api-tenants-tenant_id-topology parameters: - - description: ID of the tenant. + - description: The tenant ID. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the WAN overlay. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TopologyQueryV3N1' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkTopologyV3N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_TOPO_QUERY + - code: INVALID_TOPOLOGY_STUB_LINKS_OPTION + - code: TOPOLOGY_REBUILD_IN_PROGRESS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Topology (v3.3) + tags: + - Topology + /v3.4/api/tenants/{tenant_id}/anynetlinks: + post: + description: Create an anynet link. + operationId: post-v3.4-api-tenants-tenant_id-anynetlinks + parameters: + - description: The tenant ID. in: path - name: wan_overlay_id + name: tenant_id required: true schema: - description: Wan Overlay Id + description: Tenant Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV3N4' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -678,16 +2072,19 @@ paths: example: value: _error: - - code: WANOVERLAY_IN_USE + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: TOPOLOGY_REBUILD_IN_PROGRESS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete App/WAN Context (v2.0) + summary: Create Anynet Link (v3.4) tags: - Topology - get: - description: List the new app/wan context. - operationId: get-v2.0-api-tenants-tenant_id-wanoverlays-wan_overlay_id + /v3.4/api/tenants/{tenant_id}/anynetlinks/{anynet_id}: + delete: + description: Delete the anynet link. + operationId: delete-v3.4-api-tenants-tenant_id-anynetlinks-anynet_id parameters: - description: ID of the tenant. in: path @@ -696,19 +2093,19 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the WAN overlay. + - description: The anynet ID. in: path - name: wan_overlay_id + name: anynet_id required: true schema: - description: Wan Overlay Id + description: Anynet Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -716,18 +2113,48 @@ paths: example: value: _error: - - code: APPWAN_CONTEXT_DOES_NOT_EXIST - - code: APPWAN_CONTEXT_NAME_INVALID - - code: APPWAN_CONTEXT_DESCRIPTION_INVALID + - code: TOPOLOGY_REBUILD_IN_PROGRESS + - code: NO_ANYNETLINK_FOUND + - code: INVALID_ANYNETLINK_TYPE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get App/WAN Context (v2.0) + summary: Delete Anynet Link (v3.4) + tags: + - Topology + get: + description: Get the anynet link. + operationId: get-v3.4-api-tenants-tenant_id-anynetlinks-anynet_id + parameters: + - description: ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The anynet ID. + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkLinkV3N4' + description: Successful Operation + '404': + description: not found + summary: Get Anynet Link (v3.4) tags: - Topology put: - description: Update a new app/wan context. - operationId: put-v2.0-api-tenants-tenant_id-wanoverlays-wan_overlay_id + description: Update the anynet link. + operationId: put-v3.4-api-tenants-tenant_id-anynetlinks-anynet_id parameters: - description: ID of the tenant. in: path @@ -736,25 +2163,24 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the WAN overlay. + - description: The anynet ID. in: path - name: wan_overlay_id + name: anynet_id required: true schema: - description: Wan Overlay Id + description: Anynet Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' - description: Details of the appwan context to be updated + $ref: '#/components/schemas/AnynetLinkV3N4' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -762,45 +2188,38 @@ paths: example: value: _error: - - code: APPWAN_CONTEXT_DOES_NOT_EXIST - - code: WANOVERLAY_CONFIG_NAME_REQD - - code: NAME_EXCEEDS_LIMIT - - code: VNI_REQD - - code: INVALID_VNI_VALUE - - code: WANOVERLAY_CONFIG_DESCRIPTION_INVALID + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: TOPOLOGY_REBUILD_IN_PROGRESS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update App/WAN Context (v2.0) + summary: Update Anynet Link (v3.4) tags: - Topology - /v2.1/api/tenants/{tenant_id}/vpnlinks/{vpn_link_id}/status: - get: - description: List the status of the VPN link. - operationId: get-v2.1-api-tenants-tenant_id-vpnlinks-vpn_link_id-status + /v3.4/api/tenants/{tenant_id}/topology: + post: + description: Query the topology elements of the tenant. + operationId: post-v3.4-api-tenants-tenant_id-topology parameters: - - description: ID of the tenant. + - description: The tenant ID. in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the VPN link. - in: path - name: vpn_link_id - required: true - schema: - description: Vpn Link Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TopologyQueryV3N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VPLStatusV2N1' + $ref: '#/components/schemas/NetworkTopologyV3N4' description: Successful Operation '400': content: @@ -808,12 +2227,15 @@ paths: example: value: _error: - - code: VPL_NOT_FOUND - - code: VPL_ACTION_INSUFFICIENT_VPE + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_TOPO_QUERY + - code: INVALID_TOPOLOGY_STUB_LINKS_OPTION + - code: TOPOLOGY_REBUILD_IN_PROGRESS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get VPN Link Status (v2.1) + summary: Query Topology (v3.4) tags: - Topology servers: diff --git a/openapi-specs/sdwan/unified/ADEM.yaml b/openapi-specs/sdwan/unified/ADEM.yaml index 387a9f3be..835508d70 100644 --- a/openapi-specs/sdwan/unified/ADEM.yaml +++ b/openapi-specs/sdwan/unified/ADEM.yaml @@ -51,19 +51,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -84,7 +84,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -93,13 +93,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -134,7 +134,7 @@ paths: type: array type: object description: Successful operation - summary: Query ADEM Status (v2.0) + summary: Query ADEM Status tags: - ADEM /sdwan/v2.0/api/sites/{site_id}/demstatus: @@ -173,7 +173,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get ADEM Status (v2.0) + summary: Get ADEM Status tags: - ADEM /sdwan/v2.0/api/sites/{site_id}/demstatus/{dem_status_id}: @@ -222,7 +222,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get ADEM Status for Site (v2.0) + summary: Get ADEM Status for Site tags: - ADEM servers: diff --git a/openapi-specs/sdwan/unified/Applications.yaml b/openapi-specs/sdwan/unified/Applications.yaml index cf2a9b358..aaf7891ca 100644 --- a/openapi-specs/sdwan/unified/Applications.yaml +++ b/openapi-specs/sdwan/unified/Applications.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view AppDefQuery: properties: aggregate: @@ -129,7 +123,9 @@ components: ' type: string aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -138,7 +134,9 @@ components: ' type: string app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -228,11 +226,8 @@ components: ' type: string ingress_traffic_pct: - description: 'Ingress Traffic Pct: Required(message = required) DecimalMin(inclusive - = true, error = APPDEF_CONFIG_INVALID_INGRESS: Application ingress traffic - percentage should be in between 1-99, value = 1) DecimalMax(inclusive - = true, error = APPDEF_CONFIG_INVALID_INGRESS: Application ingress traffic - percentage should be in between 1-99, value = 99) ' + description: "The app def ingress traffic. Application ingress traffic percentage\ + \ should be in between 1-99. \n" format: int32 type: integer ip_rules: @@ -256,8 +251,8 @@ components: ' type: boolean order_number: - description: 'Order Number: Range(max = 65535L, error = APPDEF_CONFIG_INVALID_ORDER_NUMBER: - Order number should be between 1-65535, min = 1L) ' + description: "The app config order number. Order number should be between\ + \ 1-65535. \n" format: int32 type: integer overrides_allowed: @@ -338,14 +333,12 @@ components: AppDefQueryFilterTransformedV2N4: properties: abbreviation: - description: 'Abbreviation of the application name. Must not exceed 5 characters. + description: 'Abbreviation of the application name. ' type: string aggregate_flows: - description: 'The aggregate flow. - - ' + description: "Aggregate flows enabled. True / False. \n" type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -354,7 +347,7 @@ components: ' type: string app_unreachability_detection: - description: 'Application unreachability detection. + description: 'Aggregate reachability detection. True / False. ' type: boolean @@ -446,8 +439,8 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. + description: 'Application ingress traffic percentage should be in between + 1-99. ' format: int32 @@ -473,9 +466,8 @@ components: ' type: boolean order_number: - description: 'The app def config order number. - - ' + description: "The order number. Order number should be between 1-65535L.\ + \ \n" format: int32 type: integer overrides_allowed: @@ -493,9 +485,7 @@ components: description: P Parent Id type: string p_sub_category: - description: 'Parent app sub-category. - - ' + description: "Parent app sub-category. \n" type: string parent_id: description: 'Parent app ID. @@ -520,9 +510,7 @@ components: format: int32 type: integer supported_engines: - description: 'The app config supported engines. - - ' + description: "Supported engines values. \n" enum: - ave - ave-all @@ -584,7 +572,9 @@ components: ' type: string aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -593,7 +583,9 @@ components: ' type: string app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -710,8 +702,8 @@ components: ' type: boolean order_number: - description: 'Order Number: Range(max = 65535L, error = APPDEF_CONFIG_INVALID_ORDER_NUMBER: - Order number should be between 1-65535, min = 1L) ' + description: "The app config order number. Order number should be between\ + \ 1-65535. \n" format: int32 type: integer overrides_allowed: @@ -756,9 +748,9 @@ components: format: int32 type: integer supported_engines: - description: 'Supported Engines: ValidateEnum(enumClass = classOf[SupportedEngines], - error = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., - nullAllowed = true) ' + description: 'Supported engines. + + ' enum: - ave - ave-all @@ -815,12 +807,12 @@ components: AppDefScreenV2N5: properties: abbreviation: - description: 'Abbreviation of the application name. Must not exceed 5 characters. + description: 'Abbreviation of the application name. ' type: string aggregate_flows: - description: 'The aggregate flow. + description: 'Aggregate flows enabled. True / False. ' type: boolean @@ -831,7 +823,9 @@ components: ' type: string app_unreachability_detection: - description: App Unreachability Detection + description: 'Aggregate reachability detection. True / False. + + ' type: boolean category: description: 'The application category. @@ -921,8 +915,8 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. + description: 'Application ingress traffic percentage should be in between + 1-99. ' format: int32 @@ -948,9 +942,8 @@ components: ' type: boolean order_number: - description: 'The app def config order number. - - ' + description: "The order number. Order number should be between 1-65535L.\ + \ \n" format: int32 type: integer overrides_allowed: @@ -973,9 +966,7 @@ components: ' type: string parent_id: - description: 'Parent app ID. - - ' + description: "Parent app ID. \n" type: string path_affinity: description: "This parameter defines the path affinity characteristics to\ @@ -995,7 +986,7 @@ components: format: int32 type: integer supported_engines: - description: 'The app config supported engines. + description: 'Supported engines values. ' enum: @@ -1256,7 +1247,9 @@ components: ' type: string aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -1265,7 +1258,9 @@ components: ' type: string app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -1382,8 +1377,10 @@ components: ' type: boolean order_number: - description: 'Order Number: Range(max = 65535L, error = APPDEF_CONFIG_INVALID_ORDER_NUMBER: - Order number should be between 1-65535, min = 1L) ' + description: 'The app config order number. Order number should be between + 1-65535. + + ' format: int32 type: integer overrides_allowed: @@ -1428,9 +1425,7 @@ components: format: int32 type: integer supported_engines: - description: 'Supported Engines: ValidateEnum(enumClass = classOf[SupportedEngines], - error = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., - nullAllowed = true) ' + description: "Supported engines. \n" enum: - ave - ave-all @@ -1487,12 +1482,12 @@ components: AppDefV2N5: properties: abbreviation: - description: 'Abbreviation of the application name. Must not exceed 5 characters. + description: 'Abbreviation of the application name. ' type: string aggregate_flows: - description: 'The aggregate flow. + description: 'The aggregate flows. ' type: boolean @@ -1503,7 +1498,9 @@ components: ' type: string app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -1620,7 +1617,8 @@ components: ' type: boolean order_number: - description: 'The app def config order number. + description: 'The app config order number. Order number should be between + 1-65535. ' format: int32 @@ -1667,9 +1665,7 @@ components: format: int32 type: integer supported_engines: - description: 'The app config supported engines. - - ' + description: "Supported engines. \n" enum: - ave - ave-all @@ -1726,10 +1722,14 @@ components: AppdefOverrideScreenV2N2: properties: aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -1811,9 +1811,10 @@ components: ' type: string ingress_traffic_pct: - description: 'Ingress Traffic Pct: Range(max = 99L, error = APPDEF_CONFIG_INVALID_INGRESS: - Application ingress traffic percentage should be in between 1-99, min - = 1L) ' + description: 'The app def ingress traffic. Application ingress traffic percentage + should be in between 1-99. + + ' type: integer ip_rules: description: 'Applicable for L3/L4 applications. These are IP Prefix rules @@ -1903,10 +1904,14 @@ components: AppdefOverrideScreenV2N3: properties: aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -1988,9 +1993,10 @@ components: ' type: string ingress_traffic_pct: - description: 'Ingress Traffic Pct: Range(max = 99L, error = APPDEF_CONFIG_INVALID_INGRESS: - Application ingress traffic percentage should be in between 1-99, min - = 1L) ' + description: 'The app def ingress traffic. Application ingress traffic percentage + should be in between 1-99. + + ' type: integer ip_rules: description: 'Applicable for L3/L4 applications. These are IP Prefix rules @@ -2092,10 +2098,14 @@ components: AppdefOverrideV2N2: properties: aggregate_flows: - description: Aggregate Flows + description: 'The aggregate flows. + + ' type: boolean app_unreachability_detection: - description: App Unreachability Detection + description: 'Application unreachability detection. + + ' type: boolean category: description: 'The application category. @@ -2177,9 +2187,10 @@ components: ' type: string ingress_traffic_pct: - description: 'Ingress Traffic Pct: Range(max = 99L, error = APPDEF_CONFIG_INVALID_INGRESS: - Application ingress traffic percentage should be in between 1-99, min - = 1L) ' + description: 'The app def ingress traffic. Application ingress traffic percentage + should be in between 1-99. + + ' type: integer ip_rules: description: 'Applicable for L3/L4 applications. These are IP Prefix rules @@ -2458,18 +2469,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string DSCP: properties: @@ -2519,10 +2530,6 @@ components: ' type: string - required: - - path - - site - - elements GlobalPrefixFilter: properties: description: @@ -2530,9 +2537,7 @@ components: ' filters: - description: 'List the filters. - - ' + description: 'Filters: Required(PREFIXFILTER_REQUIRED) Valid ' items: $ref: '#/components/schemas/Filter' type: array @@ -2754,19 +2759,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -2787,7 +2792,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -2833,7 +2838,7 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queries that match the query parameters. + description: 'The aggregate number of app defs that match the query parameters. ' dest_page: @@ -2843,12 +2848,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number queries deleted for a time frame. + description: 'The number app definitions deleted for a time frame. ' type: boolean group_by: - description: 'Group the query. + description: 'Group the app definitions for the query. ' items: @@ -2856,7 +2861,7 @@ components: type: string type: array id: - description: "List the queries by ID. \n" + description: "List the app definitions by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -2935,36 +2940,42 @@ components: type: array server_port: $ref: '#/components/schemas/Port' - description: 'Server Port: Valid ' + description: 'The start and end server port ranges. + + ' TcpRuleV2: properties: client_filters: - description: 'Client Filters: ListString(allowDuplicate = false, allowEmpty - = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_IP_LIST: - IP List is not valid., noTrim = false, regex = [0-9]{1,30}, required = - false) ' + description: 'The app def config IP list. Max size = 8. + + ' items: description: Client Filters type: string type: array client_port: $ref: '#/components/schemas/Port' - description: 'Client Port: Valid ' + description: 'The start and end client port ranges. + + ' dscp: $ref: '#/components/schemas/DSCP' - description: 'Dscp: Valid ' + description: 'The DSP value. + + ' server_filters: - description: 'Server Filters: ListString(allowDuplicate = false, allowEmpty - = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_IP_LIST: - IP List is not valid., noTrim = false, regex = [0-9]{1,30}, required = - false) ' + description: 'The app def config IP list. Max size = 8. + + ' items: description: Server Filters type: string type: array server_port: $ref: '#/components/schemas/Port' - description: 'Server Port: Valid ' + description: 'The start and end server port ranges. + + ' server_prefixes: description: 'Server Prefixes: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_PREFIX: @@ -2987,9 +2998,7 @@ components: type: array udp_port: $ref: '#/components/schemas/Port' - description: 'The start and end UDP port ranges. - - ' + description: "The start and end UDP port ranges. \n" UdpRuleV2: properties: dest_prefixes: @@ -3004,19 +3013,20 @@ components: type: array dscp: $ref: '#/components/schemas/DSCP' - description: 'Dscp: Valid ' + description: 'The DSP value. + + ' udp_filters: - description: 'Udp Filters: ListString(allowDuplicate = false, allowEmpty - = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_IP_LIST: - IP List is not valid., noTrim = false, regex = [0-9]{1,30}, required = - false) ' + description: 'The app def config IP list. Max size = 8. + + ' items: description: Udp Filters type: string type: array udp_port: $ref: '#/components/schemas/Port' - description: 'Udp Port: Valid ' + description: "The start and end UDP port ranges. \n" info: contact: {} description: List of APIs used to manage an application definition specific query, @@ -3036,7 +3046,7 @@ paths: schema: $ref: '#/components/schemas/AppDefTenantVersion' description: Successful Operation - summary: Get Application Version for Tenant (v2.0) + summary: Get Application Version for a Tenant (v2.0) tags: - Applications /sdwan/v2.0/api/appdefs_version/{vid}: @@ -3329,8 +3339,7 @@ paths: - Applications /sdwan/v2.0/api/localprefixfilters/query: post: - description: Lists the query details for the list of parameters for local prefix - filter. + description: Lists the query details for the list of parameters for GlobalPrefixFilter. operationId: post-sdwan-v2.0-api-localprefixfilters-query requestBody: content: diff --git a/openapi-specs/sdwan/unified/Auditlogs.yaml b/openapi-specs/sdwan/unified/Auditlogs.yaml index f7aa2fdd0..8c9d62681 100644 --- a/openapi-specs/sdwan/unified/Auditlogs.yaml +++ b/openapi-specs/sdwan/unified/Auditlogs.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view AuditLog: properties: esp_tenant_id: @@ -281,7 +275,7 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queries. + description: 'The aggregate number of queried elements. ' dest_page: @@ -291,12 +285,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of queries deleted for a time frame. + description: 'The number of queried elements deleted for a time frame. ' type: boolean group_by: - description: 'Group the queries. + description: 'Group the elements state for the query. ' items: @@ -304,7 +298,7 @@ components: type: string type: array id: - description: "List the queries by ID. \n" + description: "List the element by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -361,19 +355,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -394,7 +388,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -403,20 +397,20 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: object info: contact: {} - description: List of APIs used to retrieve audit logs. + description: Query APIs used to retrieve audit logs. title: Auditlogs version: Latest openapi: 3.0.0 diff --git a/openapi-specs/sdwan/unified/BulkOperations.yaml b/openapi-specs/sdwan/unified/BulkOperations.yaml index f0f89bca5..3b97b9e0c 100644 --- a/openapi-specs/sdwan/unified/BulkOperations.yaml +++ b/openapi-specs/sdwan/unified/BulkOperations.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,16 +44,15 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BaseQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queries. + description: 'The aggregate number of queried elements. ' dest_page: @@ -68,12 +62,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of queries deleted for a time frame. + description: 'The number of queried elements deleted for a time frame. ' type: boolean group_by: - description: 'Group the queries. + description: 'Group the elements state for the query. ' items: @@ -81,7 +75,7 @@ components: type: string type: array id: - description: "List the queries by ID. \n" + description: "List the element by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -138,13 +132,13 @@ components: SetBulkResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -156,7 +150,7 @@ components: type: object type: array total_count: - description: 'The total number of responses. + description: 'Total number. ' format: int64 diff --git a/openapi-specs/sdwan/unified/Cellular.yaml b/openapi-specs/sdwan/unified/Cellular.yaml index 0b6253d60..f6576fc37 100644 --- a/openapi-specs/sdwan/unified/Cellular.yaml +++ b/openapi-specs/sdwan/unified/Cellular.yaml @@ -285,11 +285,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -298,26 +293,25 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string CellularModule: properties: @@ -1262,19 +1256,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -1295,7 +1289,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -1304,13 +1298,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string diff --git a/openapi-specs/sdwan/unified/CloudBlades.yaml b/openapi-specs/sdwan/unified/CloudBlades.yaml index 57e199af0..85b8f04d7 100644 --- a/openapi-specs/sdwan/unified/CloudBlades.yaml +++ b/openapi-specs/sdwan/unified/CloudBlades.yaml @@ -18,18 +18,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string Error: properties: @@ -46,13 +46,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string diff --git a/openapi-specs/sdwan/unified/DHCP.yaml b/openapi-specs/sdwan/unified/DHCP.yaml index 7ce96fbc7..850b7337f 100644 --- a/openapi-specs/sdwan/unified/DHCP.yaml +++ b/openapi-specs/sdwan/unified/DHCP.yaml @@ -18,8 +18,16 @@ components: required: - option_value - option_definition - DHCPServerScreenV2N1: + DHCPServerScreenV2N2: properties: + address_family: + description: 'The DHCP config address values. + + ' + enum: + - IPV4 + - IPV6 + type: string broadcast_address: description: 'The address of the site. @@ -94,7 +102,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMapping' + $ref: '#/components/schemas/StaticMappingV2' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -111,13 +119,15 @@ components: type: string type: array required: + - address_family - ip_ranges - subnet - DHCPServerScreenV2N2: + DHCPServerScreenV2N3: properties: address_family: - description: 'Address Family: ValidateEnum(enumClass = classOf[IPAddressFamily], - DHCP_CONFIG_ADDRESS_FAMILY_INVALID, nullAllowed = false) ' + description: 'The DHCP config address values. + + ' enum: - IPV4 - IPV6 @@ -212,12 +222,25 @@ components: description: Tags type: string type: array + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: - address_family - ip_ranges - subnet - DHCPServerV2N1: + DHCPServerV2N2: properties: + address_family: + description: 'The DHCP config address values. + + ' + enum: + - IPV4 + - IPV6 + type: string broadcast_address: description: 'The address of the site. @@ -292,7 +315,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMapping' + $ref: '#/components/schemas/StaticMappingV2' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -309,9 +332,10 @@ components: type: string type: array required: + - address_family - ip_ranges - subnet - DHCPServerV2N2: + DHCPServerV2N3: properties: address_family: description: 'The DHCP config address values. @@ -411,6 +435,11 @@ components: description: Tags type: string type: array + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: - address_family - ip_ranges @@ -443,19 +472,22 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: object - StaticMapping: + StaticMappingV2: properties: + client_duid: + description: "The DHCP server config duid provided for static mapping. \n" + type: string ip_address: description: 'IP addresses assigned mapped to MAC addresses of the clients. @@ -472,30 +504,6 @@ components: required: - ip_address - name - StaticMappingV2: - properties: - client_duid: - description: 'Client Duid: Pattern(error = DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID: - Invalid Client duid provided for static mapping., regexp = ([0-9a-fA-F]{1,2}:)*[0-9a-fA-F]{1,2}|([0-9a-fA-F]{1,2}:)*(:([0-9a-fA-F]{1,2}:)*)([0-9a-fA-F]{1,2})*) ' - type: string - ip_address: - description: 'Ip Address: NotNull(error = DHCPSERVER_CONFIG_STATIC_MAPPING_MISSING: - Provide all required attributes for static mappings.) ' - type: string - mac: - description: 'Mac: MACAddressFiveColons(error = DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_MAC_ADDR: - Invalid mac address provided for static mapping) ' - type: string - name: - description: 'Name: NotNull(error = DHCPSERVER_CONFIG_STATIC_MAPPING_MISSING: - Provide all required attributes for static mappings.) Size(max = 256, - error = DHCPSERVER_CONFIG_STATIC_MAPPING_NAME_EXCEEDS_LIMIT: Static Mapping - name execeeds the maximum limit, min = 0) Pattern(error = DHCPSERVER_CONFIG_STATIC_MAPPING_UNSUPPORTED_NAME: - Provide valid static mapping name, regexp = ^[a-zA-Z0-9]+(([a-zA-Z0-9\\-_])|(\\.?[a-zA-Z0-9\\-]))*\\.?$) ' - type: string - required: - - ip_address - - name info: contact: {} description: List of APIs used to manage the DHCP servers. @@ -503,10 +511,10 @@ info: version: Latest openapi: 3.0.0 paths: - /sdwan/v2.1/api/sites/{site_id}/dhcpservers: + /sdwan/v2.2/api/sites/{site_id}/dhcpservers: get: description: Get all the DHCP servers for a tenant on a site. - operationId: get-sdwan-v2.1-api-sites-site_id-dhcpservers + operationId: get-sdwan-v2.2-api-sites-site_id-dhcpservers parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -526,16 +534,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/DHCPServerV2N1' + $ref: '#/components/schemas/DHCPServerV2N2' type: array type: object description: Successful Operation - summary: Get DHCP Servers for Tenant on Site (v2.1) + summary: Get DHCP Servers for Tenant on Site (v2.2) tags: - DHCP post: description: Create a new DHCP server configuration for a subnet. - operationId: post-sdwan-v2.1-api-sites-site_id-dhcpservers + operationId: post-sdwan-v2.2-api-sites-site_id-dhcpservers parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -549,14 +557,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N1' + $ref: '#/components/schemas/DHCPServerScreenV2N2' description: Details of dhcp server config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N1' + $ref: '#/components/schemas/DHCPServerV2N2' description: Successful Operation '400': content: @@ -576,16 +584,24 @@ paths: - code: DHCPSERVER_CONFIG_IP_RANGE_MISSING - code: DHCPSERVER_CONFIG_INVALID_TAGS - code: DHCPSERVER_CONFIG_DESCRIPTION_EXCEEDS_LIMIT + - code: DHCPSERVER_CONFIG_GATEWAY_NOT_SUPPORTED_FOR_IPV6_FAMILY + - code: DHCPSERVER_CONFIG_INVALID_IPV6_SUBNET_ADDR + - code: DHCPSERVER_CONFIG_BROADCAST_ADDRESS_NOT_SUPPORTED_FOR_IPV6_FAMILY + - code: DHCPSERVER_CONFIG_IP_RANGE_INVALID_IPV6 + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_IPV6 + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_MAC_NOT_SUPPORTED + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID_NOT_SUPPORTED + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create DHCP Server Configuration for Subnet (v2.1) + summary: Create DHCP Server Configuration for Subnet (v2.2) tags: - DHCP - /sdwan/v2.1/api/sites/{site_id}/dhcpservers/{dhcp_server_id}: + /sdwan/v2.2/api/sites/{site_id}/dhcpservers/{dhcp_server_id}: delete: description: Delete the DHCP Server for a tenant on a site. - operationId: delete-sdwan-v2.1-api-sites-site_id-dhcpservers-dhcp_server_id + operationId: delete-sdwan-v2.2-api-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -607,14 +623,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N1' + $ref: '#/components/schemas/DHCPServerV2N2' description: Successful Operation - summary: Delete DHCP Server for Tenant on Site (v2.1) + summary: Delete DHCP Server for Tenant on Site (v2.2) tags: - DHCP get: description: List the DHCP server for a tenant on a site. - operationId: get-sdwan-v2.1-api-sites-site_id-dhcpservers-dhcp_server_id + operationId: get-sdwan-v2.2-api-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -636,14 +652,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N1' + $ref: '#/components/schemas/DHCPServerV2N2' description: Successful Operation - summary: Get DHCP Server for Tenant on Site (v2.1) + summary: Get DHCP Server for Tenant on Site (v2.2) tags: - DHCP put: description: Update an existing DHCP server configuration for a subnet. - operationId: put-sdwan-v2.1-api-sites-site_id-dhcpservers-dhcp_server_id + operationId: put-sdwan-v2.2-api-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -664,14 +680,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N1' + $ref: '#/components/schemas/DHCPServerScreenV2N2' description: Details of dhcp server config to be Updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N1' + $ref: '#/components/schemas/DHCPServerV2N2' description: Successful Operation '400': content: @@ -691,16 +707,24 @@ paths: - code: DHCPSERVER_CONFIG_IP_RANGE_MISSING - code: DHCPSERVER_CONFIG_INVALID_TAGS - code: DHCPSERVER_CONFIG_DESCRIPTION_EXCEEDS_LIMIT + - code: DHCPSERVER_CONFIG_GATEWAY_NOT_SUPPORTED_FOR_IPV6_FAMILY + - code: DHCPSERVER_CONFIG_INVALID_IPV6_SUBNET_ADDR + - code: DHCPSERVER_CONFIG_BROADCAST_ADDRESS_NOT_SUPPORTED_FOR_IPV6_FAMILY + - code: DHCPSERVER_CONFIG_IP_RANGE_INVALID_IPV6 + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_IPV6 + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_MAC_NOT_SUPPORTED + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID_NOT_SUPPORTED + - code: DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update DHCP Server Configuration (v2.1) + summary: Update DHCP Server Configuration (v2.2) tags: - DHCP - /sdwan/v2.2/api/sites/{site_id}/dhcpservers: + /sdwan/v2.3/api/sites/{site_id}/dhcpservers: get: description: Get all the DHCP servers for a tenant on a site. - operationId: get-sdwan-v2.2-api-sites-site_id-dhcpservers + operationId: get-sdwan-v2.3-api-sites-site_id-dhcpservers parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -720,16 +744,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServerV2N3' type: array type: object description: Successful Operation - summary: Get DHCP Servers for Tenant on Site (v2.2) + summary: Get DHCP Servers for Tenant on Site (v2.3) tags: - DHCP post: description: Create a new DHCP server configuration for a subnet. - operationId: post-sdwan-v2.2-api-sites-site_id-dhcpservers + operationId: post-sdwan-v2.3-api-sites-site_id-dhcpservers parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -743,14 +767,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N2' + $ref: '#/components/schemas/DHCPServerScreenV2N3' description: Details of dhcp server config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServerV2N3' description: Successful Operation '400': content: @@ -781,13 +805,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create DHCP Server Configuration for Subnet (v2.2) + summary: Create DHCP Server Configuration for Subnet (v2.3) tags: - DHCP - /sdwan/v2.2/api/sites/{site_id}/dhcpservers/{dhcp_server_id}: + /sdwan/v2.3/api/sites/{site_id}/dhcpservers/{dhcp_server_id}: delete: description: Delete the DHCP Server for a tenant on a site. - operationId: delete-sdwan-v2.2-api-sites-site_id-dhcpservers-dhcp_server_id + operationId: delete-sdwan-v2.3-api-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -809,14 +833,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServerV2N3' description: Successful Operation - summary: Delete DHCP Server for Tenant on Site (v2.2) + summary: Delete DHCP Server for Tenant on Site (v2.3) tags: - DHCP get: description: List the DHCP server for a tenant on a site. - operationId: get-sdwan-v2.2-api-sites-site_id-dhcpservers-dhcp_server_id + operationId: get-sdwan-v2.3-api-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -838,14 +862,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServerV2N3' description: Successful Operation - summary: Get DHCP Server for Tenant on Site (v2.2) + summary: Get DHCP Server for Tenant on Site (v2.3) tags: - DHCP put: description: Update an existing DHCP server configuration for a subnet. - operationId: put-sdwan-v2.2-api-sites-site_id-dhcpservers-dhcp_server_id + operationId: put-sdwan-v2.3-api-sites-site_id-dhcpservers-dhcp_server_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -866,14 +890,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N2' + $ref: '#/components/schemas/DHCPServerScreenV2N3' description: Details of dhcp server config to be Updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServerV2N3' description: Successful Operation '400': content: @@ -904,7 +928,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update DHCP Server Configuration (v2.2) + summary: Update DHCP Server Configuration (v2.3) tags: - DHCP servers: diff --git a/openapi-specs/sdwan/unified/DNSServices.yaml b/openapi-specs/sdwan/unified/DNSServices.yaml index b1e569b47..ff8eed212 100644 --- a/openapi-specs/sdwan/unified/DNSServices.yaml +++ b/openapi-specs/sdwan/unified/DNSServices.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view Alias: properties: mask: @@ -329,23 +323,27 @@ components: DnsForwardConfigV2: properties: dns_servers: - description: 'Dns Servers: ListString(allowDuplicate = true, allowEmpty - = false, allowNull = false, length = 0, listMaxSize = 0, INVALID_STRING, - noTrim = false, regex = , required = false) ' + description: 'Details of the DNS severs. + + ' items: $ref: '#/components/schemas/DnsServersV2' type: array max_source_port: - description: 'Max Source Port: Range(max = 65535L, error = DNSSERVICE_CONFIG_INVALID_MAXSOURCEPORT_VALUE: - Invalid max source port, min = 1L) ' + description: 'The DNS service max source port. + + ' type: integer min_source_port: - description: 'Min Source Port: Range(max = 65535L, error = DNSSERVICE_CONFIG_INVALID_MINSOURCEPORT_VALUE: - Invalid min source port, min = 1L) ' + description: 'The DNS service min source port. + + ' format: int32 type: integer send_to_all_dns_servers: - description: Send To All Dns Servers + description: 'If the option es enabled to send to all DNS servers. + + ' type: boolean required: - dns_servers @@ -510,38 +508,44 @@ components: DnsServersV2: properties: address_family: - description: Address Family + description: 'The DNS server address values. + + ' enum: - ipv4 - ipv6 - ipv4v6 type: string dnsserver_ip: - description: 'Dnsserver Ip: NotEmpty(error = DNSSERVER_IP_CONFIG_MISSING: - Dns Server ip is missing) ' + description: 'The DNS server IP address. + + ' type: string dnsserver_port: - description: 'Dnsserver Port: Range(max = 65535L, error = INVALID_DNSSERVER_PORT_RANGE_CONFIG: - Dns Server port is not in the valid range ''1 - 65535'', min = 1L) ' + description: 'The DNS server port. + + ' type: integer domain_names: - description: 'Domain Names: UniqueHostNames(allowNull = true, max = 2147483647, - message = DNSSERVER_DOMAIN_NAMES_CONFIG_INVALID_HOST, min = 0) ' + description: 'The DNS server domain names. + + ' items: description: Domain Names type: string type: array forward_dnsservicerole_id: - description: 'Forward Dnsservicerole Id: Size(max = 20, error = VALUE_EXCEEDS_LIMIT: - value length exceeds maximum limit, min = 0) ' + description: 'The DNS forward service role ID. Max size = 20. + + ' type: string ip_prefix: - description: Ip Prefix + description: "The DNS server IP prefix. \n" type: string source_port: - description: 'Source Port: Range(max = 65535L, error = INVALID_DNSSERVER_SOURCE_PORT_RANGE_CONFIG: - Dns Server source port is not in the valid range ''1 - 65535'', min = - 1L) ' + description: 'The DNS server source port. + + ' type: integer required: - dnsserver_ip @@ -1271,19 +1275,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -1304,7 +1308,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -1313,13 +1317,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string diff --git a/openapi-specs/sdwan/unified/DeviceConfiguration.yaml b/openapi-specs/sdwan/unified/DeviceConfiguration.yaml index 9ab713179..ad03f4379 100644 --- a/openapi-specs/sdwan/unified/DeviceConfiguration.yaml +++ b/openapi-specs/sdwan/unified/DeviceConfiguration.yaml @@ -87,11 +87,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -100,11 +95,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view ApplicationProbe: properties: description: @@ -203,7 +197,7 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queries. + description: 'The aggregate number of queried elements. ' dest_page: @@ -213,12 +207,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of queries deleted for a time frame. + description: 'The number of queried elements deleted for a time frame. ' type: boolean group_by: - description: 'Group the queries. + description: 'Group the elements state for the query. ' items: @@ -226,7 +220,7 @@ components: type: string type: array id: - description: "List the queries by ID. \n" + description: "List the element by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -271,18 +265,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string BypassInfo: properties: @@ -339,6 +333,15 @@ components: enum: - UPDATE_CASTORE type: string + CDLConnectionState: + properties: + connected: + description: Connected + type: boolean + state_change_time: + description: State Change Time + format: int64 + type: integer CellularInterfaceConfig: properties: apn_config: @@ -752,46 +755,72 @@ components: ElementImageStatusQueryFilterV2N1: properties: active_image_id: - description: Active Image Id + description: 'The active image ID. + + ' type: string active_version: - description: Active Version + description: 'The active version. + + ' type: string download_interval: - description: Download Interval + description: 'The download interval. + + ' type: integer download_percent: - description: Download Percent + description: 'The download percentage. + + ' type: integer element_id: description: Element Id type: string failure_info: - description: Failure Info + description: 'The element image failure information. + + ' type: string id: - description: Id + description: 'The ID. + + ' type: string previous_image_id: - description: Previous Image Id + description: 'The previous image ID. + + ' type: string rollback_version: - description: Rollback Version + description: 'The rollback version. + + ' type: string scheduled_download: - description: Scheduled Download + description: 'The scheduled download. + + ' type: string scheduled_upgrade: - description: Scheduled Upgrade + description: 'The scheduled upgrade. + + ' type: string upgrade_image_id: - description: Upgrade Image Id + description: 'The upgrade image ID. + + ' type: string upgrade_interval: - description: Upgrade Interval + description: 'The upgrade interval. + + ' type: integer upgrade_state: - description: Upgrade State + description: 'The upgrade state of the element. + + ' enum: - pending - init @@ -833,43 +862,69 @@ components: ElementImageStatusV2N1: properties: active_image_id: - description: Active Image Id + description: 'The active image ID. + + ' type: string active_version: - description: Active Version + description: 'The active version. + + ' type: string download_interval: - description: Download Interval + description: 'The download interval. + + ' type: integer download_percent: - description: Download Percent + description: 'The download percent. + + ' type: integer failure_info: - description: Failure Info + description: 'Detials of the failure information. + + ' type: string id: - description: Id + description: 'The ID. + + ' type: string previous_image_id: - description: Previous Image Id + description: 'The previous image ID. + + ' type: string rollback_version: - description: Rollback Version + description: 'The rollback version. + + ' type: string scheduled_download: - description: Scheduled Download + description: 'The scheduled download. + + ' type: string scheduled_upgrade: - description: Scheduled Upgrade + description: 'The scheduled upgrade. + + ' type: string upgrade_image_id: - description: Upgrade Image Id + description: 'The upgrade image ID. + + ' type: string upgrade_interval: - description: Upgrade Interval + description: 'The upgrade interval. + + ' type: integer upgrade_state: - description: Upgrade State + description: 'The upgrade state. + + ' enum: - pending - init @@ -928,79 +983,55 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of elements that match the query parameters. + description: Aggregate + description: + description: 'The description of the element. ' dest_page: - description: 'The destination page. - - ' + description: Dest Page format: int32 type: integer getDeleted: - description: 'The number of elements deleted for a time frame. - - ' + description: GetDeleted type: boolean group_by: - description: 'Group the elements for the query. - - ' + description: Group By items: description: Group By type: string type: array id: - description: "List the element by ID. \n" + description: Id type: string last_query_ts: - description: 'Return the ID of a specified query in the current session. - - ' + description: Last Query Ts format: int64 type: integer limit: - description: 'The query limit. - - ' + description: Limit format: int32 type: integer next_query: - description: 'The limit. - - ' type: object query_params: - description: 'Query using query parameters. - - ' type: object retrieved_fields: - description: 'Retrieve information from a field. - - ' + description: Retrieved Fields items: description: Retrieved Fields type: string type: array retrieved_fields_mask: - description: 'List the fields to query. - - ' + description: Retrieved Fields Mask type: boolean sort_params: - description: 'Specify the order in which you want the search criteria to - display. - - ' type: object total_count: - description: 'The total number of query parameters. - - ' + description: Total Count format: int64 type: integer - ElementQueryFilterV2N7: + ElementQueryFilterV3: properties: admin_action: description: 'The values of admin actions that can be performed. @@ -1182,13 +1213,8 @@ components: - PA_CONN type: string type: array - cluster_insertion_mode: - description: "The cluster insertion mode. \n" - type: string - cluster_member_id: - description: 'The cluster member ID. - - ' + cluster_id: + description: Cluster Id type: string connected: description: 'The element is connected. True or False. @@ -1379,7 +1405,7 @@ components: type: boolean required: - site_id - ElementQueryFilterV3: + ElementQueryFilterV3N1: properties: admin_action: description: 'The values of admin actions that can be performed. @@ -1595,6 +1621,26 @@ components: description: 'The description of the element. ' + device_change_mode_start_time: + description: Device Change Mode Start Time + format: int64 + type: integer + device_change_mode_state: + description: Device Change Mode State + enum: + - ELEMENT_CHANGE_MODE_INIT + - ELEMENT_CHANGE_MODE_IN_PROGRESS + - ELEMENT_CHANGE_MODE_FAILED + - ELEMENT_CHANGE_MODE_TIMEOUT + - ELEMENT_CHANGE_MODE + type: string + device_mode: + description: Device Mode + enum: + - none + - l3-mode + - l2-mode + type: string device_profile_id: description: 'The device profile ID. @@ -1753,156 +1799,189 @@ components: type: boolean required: - site_id - ElementScreenV2N7: + ElementScreenV3: properties: - cluster_insertion_mode: - description: Cluster Insertion Mode - type: string - cluster_member_id: - description: Cluster Member Id + cluster_id: + description: "The cluster ID. \n" type: string description: - description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: - Description length exceeds limit, min = 0) ' - type: string + description: 'The description of the element. + + ' device_profile_id: - description: Device Profile Id + description: "The device profile ID. \n" type: string id: - description: Id + description: "The element ID. \n" type: string l3_direct_private_wan_forwarding: - description: L3 Direct Private Wan Forwarding + description: 'The L3 direct private WAN is enabled. True or False. + + ' type: boolean l3_lan_forwarding: - description: L3 Lan Forwarding + description: 'The L3 LAN forwarding is enabled. Yes indicates that traffic + forwarding to and from LAN interface, when Enable L3 Direct Private WAN + Forwarding is enabled. + + ' type: boolean led_config: $ref: '#/components/schemas/LedConfig' - description: 'Led Config: Valid ' + description: 'Valid LED config. + + ' main_power_usage_threshold: - description: 'Main Power Usage Threshold: ValidateDecimal(allowZero = true, - increment = 0, max = 0, error = INVALID_MAIN_POWER_USAGE_THRESHOLD: Invalid - main power usage threshold. Allowed range is 50-100., min = 0) ' + description: "The main power usage threshold. Allowed range is 50-100. \ + \ \n" format: int32 type: integer name: - description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of - the resource exceeds limit., min = 0) ' + description: 'The name of the device. + + ' type: string nat_policysetstack_id: - description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, - error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. + + ' type: string network_policysetstack_id: - description: 'Network Policysetstack Id: Digits(fraction = 0, integer = - 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy - set stack id) ' + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. + + ' type: string priority_policysetstack_id: - description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = - 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy - set stack id) ' + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. + + ' type: string site_id: - description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) - NotNull ' + description: "The site ID. \n" type: string spoke_ha_config: $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'Spoke Ha Config: Valid ' + description: 'The details of the spoke HA configuration. + + ' sw_obj: $ref: '#/components/schemas/Software' - description: Sw Obj + description: 'The location and version of the software. + + ' switch_config: $ref: '#/components/schemas/SwitchConfig' - description: 'Switch Config: Valid ' + description: 'The details of the switch configuration. + + ' tags: - description: 'Tags: ListString(allowDuplicate = false, allowEmpty = true, - allowNull = true, length = 128, listMaxSize = 10, error = INVALID_TAG: - Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, - regex = [^,\\s]+, required = false) ' + description: 'A information field that can be added to identify the element. + + ' items: description: Tags type: string type: array vpn_to_vpn_forwarding: - description: Vpn To Vpn Forwarding + description: 'VPN to VPN forwarding. True or False. + + ' type: boolean required: - site_id - ElementScreenV3: + ElementScreenV3N1: properties: cluster_id: - description: Cluster Id + description: "The cluster ID. \n" type: string description: - description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: - Description length exceeds limit, min = 0) ' - type: string + description: 'The description of the element. + + ' device_profile_id: - description: Device Profile Id + description: "The device profile ID. \n" type: string id: - description: Id + description: "The element ID. \n" type: string l3_direct_private_wan_forwarding: - description: L3 Direct Private Wan Forwarding + description: 'The L3 direct private WAN is enabled. True or False. + + ' type: boolean l3_lan_forwarding: - description: L3 Lan Forwarding + description: 'The L3 LAN forwarding is enabled. Yes indicates that traffic + forwarding to and from LAN interface, when Enable L3 Direct Private WAN + Forwarding is enabled. + + ' type: boolean led_config: $ref: '#/components/schemas/LedConfig' - description: 'Led Config: Valid ' + description: 'Valid LED config. + + ' main_power_usage_threshold: - description: 'Main Power Usage Threshold: ValidateDecimal(allowZero = true, - increment = 0, max = 0, error = INVALID_MAIN_POWER_USAGE_THRESHOLD: Invalid - main power usage threshold. Allowed range is 50-100., min = 0) ' + description: "The main power usage threshold. Allowed range is 50-100. \ + \ \n" format: int32 type: integer name: - description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of - the resource exceeds limit., min = 0) ' + description: 'The name of the device. + + ' type: string nat_policysetstack_id: - description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, - error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. + + ' type: string network_policysetstack_id: - description: 'Network Policysetstack Id: Digits(fraction = 0, integer = - 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy - set stack id) ' + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. + + ' type: string priority_policysetstack_id: - description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = - 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy - set stack id) ' + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. + + ' type: string site_id: - description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) - NotNull ' + description: "The site ID. \n" type: string spoke_ha_config: $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'Spoke Ha Config: Valid ' + description: 'The details of the spoke HA configuration. + + ' sw_obj: $ref: '#/components/schemas/Software' - description: Sw Obj + description: 'The location and version of the software. + + ' switch_config: $ref: '#/components/schemas/SwitchConfig' - description: 'Switch Config: Valid ' + description: 'The details of the switch configuration. + + ' tags: - description: 'Tags: ListString(allowDuplicate = false, allowEmpty = true, - allowNull = true, length = 128, listMaxSize = 10, error = INVALID_TAG: - Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, - regex = [^,\\s]+, required = false) ' + description: 'A information field that can be added to identify the element. + + ' items: description: Tags type: string type: array vpn_to_vpn_forwarding: - description: Vpn To Vpn Forwarding + description: 'VPN to VPN forwarding. True or False. + + ' type: boolean required: - site_id @@ -2200,287 +2279,392 @@ components: ' format: int64 type: integer - ElementStatusV2N1: + ElementStatusV2N2: properties: analytics_backlog_connected: - description: Analytics Backlog Connected + description: 'The analytics backlog is connected. True or False. + + ' type: boolean analytics_backlog_connected_on_utc: - description: Analytics Backlog Connected On Utc + description: 'The analytics backlog is connected on utc. + + ' format: int64 type: integer analytics_backlog_disconnected_on_utc: - description: Analytics Backlog Disconnected On Utc + description: "The analytics backlog is disconnected on utc. \n" format: int64 type: integer analytics_backlog_from: - description: Analytics Backlog From + description: 'The IPv4 address of the analytics backlog. + + ' type: string analytics_live_connected: - description: Analytics Live Connected + description: "The live analytics is connected. True or False. \n" type: boolean analytics_live_connected_on_utc: - description: Analytics Live Connected On Utc + description: "The live analytics is connected on utc. \n" format: int64 type: integer analytics_live_disconnected_on_utc: - description: Analytics Live Disconnected On Utc + description: 'The live analytics is disconnected on utc. + + ' format: int64 type: integer analytics_live_from: - description: Analytics Live From + description: 'The IPv4 address of the live analytics. + + ' type: string config_and_events_connected: - description: Config And Events Connected + description: "The config and events are connected. True or False. \n" type: boolean config_and_events_connected_on_utc: - description: Config And Events Connected On Utc + description: 'The config and events are connected on utc. + + ' format: int64 type: integer config_and_events_disconnected_on_utc: - description: Config And Events Disconnected On Utc + description: "The config and events are disconnected on utc. \n" format: int64 type: integer config_and_events_from: - description: Config And Events From + description: 'The IPv4 address for config and events. + + ' type: string element_id: - description: Element Id + description: "The element ID. \n" type: string flows_backlog_connected: - description: Flows Backlog Connected + description: "The flows backlog is connected. True or False. \n" type: boolean flows_backlog_connected_on_utc: - description: Flows Backlog Connected On Utc + description: 'The flows backlog is connected on utc. + + ' format: int64 type: integer flows_backlog_disconnected_on_utc: - description: Flows Backlog Disconnected On Utc + description: "The flows backlog is disconnected on utc. \n" format: int64 type: integer flows_backlog_from: - description: Flows Backlog From + description: 'The IPv4 address of the flow backlog. + + ' type: string flows_live_connected: - description: Flows Live Connected + description: "The live flows is connected. True or False. \n" type: boolean flows_live_connected_on_utc: - description: Flows Live Connected On Utc + description: 'The live flows are connected on utc. + + ' format: int64 type: integer flows_live_disconnected_on_utc: - description: Flows Live Disconnected On Utc + description: "The live flows are disconnected on utc. \n" format: int64 type: integer flows_live_from: - description: Flows Live From + description: 'The IPV4 address of live flows. + + ' type: string id: - description: Id + description: 'The element ID. + + ' + type: string + last_disconnected_time: + description: 'The last disconnected time. + + ' + format: int64 + type: integer + last_rebooted_info: + description: "Information on the last reboot. \n" type: string + last_rebooted_time: + description: 'The last reboot time. + + ' + format: int64 + type: integer logs_backlog_connected: - description: Logs Backlog Connected + description: 'The backlog logs are connected. True or False. + + ' type: boolean logs_backlog_connected_on_utc: - description: Logs Backlog Connected On Utc + description: "The backlog logs are connected on utc. \n" format: int64 type: integer logs_backlog_disconnected_on_utc: - description: Logs Backlog Disconnected On Utc + description: 'The backlog logs disconnected on utc. + + ' format: int64 type: integer logs_backlog_from: - description: Logs Backlog From + description: 'The IPV4 address for logs backlog. + + ' type: string logs_live_connected: - description: Logs Live Connected + description: 'The connected live logs. True or False. + + ' type: boolean logs_live_connected_on_utc: - description: Logs Live Connected On Utc + description: "The live logs are connected on utc. \n" format: int64 type: integer logs_live_disconnected_on_utc: - description: Logs Live Disconnected On Utc + description: 'The live logs are disconnected on utc. + + ' format: int64 type: integer logs_live_from: - description: Logs Live From + description: "The IPv4 address from the live logs. \n" type: string main_max_power_supported: - description: Main Max Power Supported + description: 'The main max power supported. + + ' format: int32 type: integer main_power_allocated: - description: Main Power Allocated + description: 'The main power allocated. + + ' format: float type: number main_power_usage_threshold: - description: 'Main Power Usage Threshold: ValidateDecimal(allowZero = true, - increment = 0, max = 0, error = INVALID_MAIN_POWER_USAGE_THRESHOLD: Invalid - main power usage threshold. Allowed range is 50-100., min = 0) ' + description: "The main power usage threshold. \n" format: int32 type: integer poe_state: - description: Poe State + description: 'The poe_state. + + ' type: string site_id: - description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) - NotNull ' + description: "The site ID. \n" type: string switch_state: $ref: '#/components/schemas/SwitchState' - description: Switch State + description: 'The switch state. + + ' required: - site_id - ElementStatusV2N2: + ElementStatusV2N3: properties: analytics_backlog_connected: - description: Analytics Backlog Connected + description: 'The analytics backlog is connected. True or False. + + ' type: boolean analytics_backlog_connected_on_utc: - description: Analytics Backlog Connected On Utc + description: 'The analytics backlog is connected on utc. + + ' format: int64 type: integer analytics_backlog_disconnected_on_utc: - description: Analytics Backlog Disconnected On Utc + description: "The analytics backlog is disconnected on utc. \n" format: int64 type: integer analytics_backlog_from: - description: 'Analytics Backlog From: IPv4(error = INVALID_IPV4_ADDR_ANALYTICS_BACKLOG: - Invalid IPV4 address for analytics backlog., regexp = [/0-9.]*) ' + description: 'The IPv4 address of the analytics backlog. + + ' type: string analytics_live_connected: - description: Analytics Live Connected + description: "The live analytics is connected. True or False. \n" type: boolean analytics_live_connected_on_utc: - description: Analytics Live Connected On Utc + description: "The live analytics is connected on utc. \n" format: int64 type: integer analytics_live_disconnected_on_utc: - description: Analytics Live Disconnected On Utc + description: 'The live analytics is disconnected on utc. + + ' format: int64 type: integer analytics_live_from: - description: 'Analytics Live From: IPv4(error = INVALID_IPV4_ADDR_ANALYTICS_LIVE: - Invalid IPV4 address for analytics live., regexp = [/0-9.]*) ' + description: 'The IPv4 address of the live analytics. + + ' type: string + cdl_connection_state: + $ref: '#/components/schemas/CDLConnectionState' + description: Cdl Connection State config_and_events_connected: - description: Config And Events Connected + description: "The config and events are connected. True or False. \n" type: boolean config_and_events_connected_on_utc: - description: Config And Events Connected On Utc + description: 'The config and events are connected on utc. + + ' format: int64 type: integer config_and_events_disconnected_on_utc: - description: Config And Events Disconnected On Utc + description: "The config and events are disconnected on utc. \n" format: int64 type: integer config_and_events_from: - description: 'Config And Events From: IPv4(error = INVALID_IPV4_ADDR_CONFIG_AND_EVENTS: - Invalid IPV4 address for config and events., regexp = [/0-9.]*) ' + description: 'The IPv4 address for config and events. + + ' + type: string + controller_connection_intf: + description: Controller Connection Intf + type: string + device_mode: + description: Device Mode + enum: + - none + - l3-mode + - l2-mode type: string element_id: - description: Element Id + description: "The element ID. \n" type: string flows_backlog_connected: - description: Flows Backlog Connected + description: "The flows backlog is connected. True or False. \n" type: boolean flows_backlog_connected_on_utc: - description: Flows Backlog Connected On Utc + description: 'The flows backlog is connected on utc. + + ' format: int64 type: integer flows_backlog_disconnected_on_utc: - description: Flows Backlog Disconnected On Utc + description: "The flows backlog is disconnected on utc. \n" format: int64 type: integer flows_backlog_from: - description: 'Flows Backlog From: IPv4(error = INVALID_IPV4_ADDR_FLOWS_BACKLOG: - Invalid IPV4 address for flows backlog., regexp = [/0-9.]*) ' + description: 'The IPv4 address of the flow backlog. + + ' type: string flows_live_connected: - description: Flows Live Connected + description: "The live flows is connected. True or False. \n" type: boolean flows_live_connected_on_utc: - description: Flows Live Connected On Utc + description: 'The live flows are connected on utc. + + ' format: int64 type: integer flows_live_disconnected_on_utc: - description: Flows Live Disconnected On Utc + description: "The live flows are disconnected on utc. \n" format: int64 type: integer flows_live_from: - description: 'Flows Live From: IPv4(error = INVALID_IPV4_ADDR_FLOWS_LIVE: - Invalid IPV4 address for flows live., regexp = [/0-9.]*) ' + description: 'The IPV4 address of live flows. + + ' type: string id: - description: Id + description: 'The element ID. + + ' type: string last_disconnected_time: - description: Last Disconnected Time + description: 'The last disconnected time. + + ' format: int64 type: integer last_rebooted_info: - description: Last Rebooted Info + description: "Information on the last reboot. \n" type: string last_rebooted_time: - description: Last Rebooted Time + description: 'The last reboot time. + + ' format: int64 type: integer logs_backlog_connected: - description: Logs Backlog Connected + description: 'The backlog logs are connected. True or False. + + ' type: boolean logs_backlog_connected_on_utc: - description: Logs Backlog Connected On Utc + description: "The backlog logs are connected on utc. \n" format: int64 type: integer logs_backlog_disconnected_on_utc: - description: Logs Backlog Disconnected On Utc + description: 'The backlog logs disconnected on utc. + + ' format: int64 type: integer logs_backlog_from: - description: 'Logs Backlog From: IPv4(error = INVALID_IPV4_ADDR_LOGS_BACKLOG: - Invalid IPV4 address for logs backlog., regexp = [/0-9.]*) ' + description: 'The IPV4 address for logs backlog. + + ' type: string logs_live_connected: - description: Logs Live Connected + description: 'The connected live logs. True or False. + + ' type: boolean logs_live_connected_on_utc: - description: Logs Live Connected On Utc + description: "The live logs are connected on utc. \n" format: int64 type: integer logs_live_disconnected_on_utc: - description: Logs Live Disconnected On Utc + description: 'The live logs are disconnected on utc. + + ' format: int64 type: integer logs_live_from: - description: 'Logs Live From: IPv4(error = INVALID_IPV4_ADDR_LOGS_LIVE: - Invalid IPV4 address for logs live., regexp = [/0-9.]*) ' + description: "The IPv4 address from the live logs. \n" type: string main_max_power_supported: - description: Main Max Power Supported + description: 'The main max power supported. + + ' format: int32 type: integer main_power_allocated: - description: Main Power Allocated + description: 'The main power allocated. + + ' format: float type: number main_power_usage_threshold: - description: Main Power Usage Threshold + description: "The main power usage threshold. \n" format: int32 type: integer poe_state: - description: Poe State + description: 'The poe_state. + + ' type: string site_id: - description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) - NotNull ' + description: "The site ID. \n" type: string switch_state: $ref: '#/components/schemas/SwitchState' - description: Switch State + description: 'The switch state. + + ' required: - site_id - ElementV2N7: + ElementV3: properties: admin_action: description: 'The values of admin actions that can be performed. @@ -2662,13 +2846,8 @@ components: - PA_CONN type: string type: array - cluster_insertion_mode: - description: "The cluster insertion mode. \n" - type: string - cluster_member_id: - description: 'The cluster member ID. - - ' + cluster_id: + description: Cluster Id type: string connected: description: 'The element is connected. True or False. @@ -2859,7 +3038,7 @@ components: type: boolean required: - site_id - ElementV3: + ElementV3N1: properties: admin_action: description: 'The values of admin actions that can be performed. @@ -3042,7 +3221,7 @@ components: type: string type: array cluster_id: - description: Cluster Id + description: "The spoke HA config cluster ID. \n" type: string connected: description: 'The element is connected. True or False. @@ -3075,6 +3254,32 @@ components: description: 'The description of the element. ' + device_change_mode_start_time: + description: 'The device change mode start time. + + ' + format: int64 + type: integer + device_change_mode_state: + description: 'The device change mode state. + + ' + enum: + - ELEMENT_CHANGE_MODE_INIT + - ELEMENT_CHANGE_MODE_IN_PROGRESS + - ELEMENT_CHANGE_MODE_FAILED + - ELEMENT_CHANGE_MODE_TIMEOUT + - ELEMENT_CHANGE_MODE + type: string + device_mode: + description: 'The device mode values. + + ' + enum: + - none + - l3-mode + - l2-mode + type: string device_profile_id: description: 'The device profile ID. @@ -3359,7 +3564,7 @@ components: description: "The name of the extension. Max size = 128. \n" type: string namespace: - description: "The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$.\ + description: "The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$\ \ \n" type: string required: @@ -3475,8 +3680,33 @@ components: GREConfig: properties: csum: - description: Csum + description: 'The CSUM. + + ' + type: boolean + keepalive_enable: + description: 'Is keepalive enabled. True or False. + + ' type: boolean + keepalive_fail_count: + description: 'Value between 3 and 10. Indicates the number of consecutive + missed keep-alive packets before a link is declared as down. The default + value is 3. + + ' + format: int32 + type: integer + keepalive_interval: + description: 'Value between 100 ms and 600000 ms. Indicates the time interval + in milliseconds between two VPN keepalive packets. The default value is + 1000 ms. + + ' + format: int32 + type: integer + GeneveConfig: + properties: keepalive_enable: description: 'Is keepalive enabled. True or False. @@ -3498,6 +3728,16 @@ components: ' format: int32 type: integer + keepalive_local_ipv4: + description: 'The keepalive local ipv4 address. + + ' + type: string + keepalive_remote_ipv4: + description: 'The keepalive remote ipv4 address. + + ' + type: string HardwareBypass: properties: element_bypass: @@ -3547,6 +3787,12 @@ components: ' type: string + certificate_profile_id: + description: Certificate Profile Id + type: string + comment: + description: Comment + type: string ikev1_params: $ref: '#/components/schemas/IKEV1Params' description: 'Ikev1 Params: Valid ' @@ -3563,18 +3809,34 @@ components: - DN - HOSTNAME - CUSTOM + - NONE type: string local_id_custom: description: 'The custom local ID. ' type: string + local_pa_certificate_id: + description: Local Pa Certificate Id + type: string + pa_master_key_id: + description: Pa Master Key Id + type: string passphrase: description: Passphrase type: string passphrase_encrypted: description: 'Passphrase Encrypted: JsonIgnore(value = true) ' type: string + peer_id_check: + description: Peer Id Check + enum: + - EXACT + - WILDCARD + type: string + permit_peer_id_mismatch: + description: Permit Peer Id Mismatch + type: boolean private_key: description: 'The private key file uploaded for certificate authentication. @@ -3600,6 +3862,9 @@ components: secret_hash: description: 'Secret Hash: JsonIgnore(value = true) ' type: string + strict_validation_peer_extended_key_use: + description: Strict Validation Peer Extended Key Use + type: boolean type: description: 'The authentication type = PSK or Certificates. @@ -3645,18 +3910,22 @@ components: IPv6DNS: properties: name_servers: - description: Name Servers + description: 'The IPv6 configured DNS name servers. + + ' items: description: Name Servers type: string type: array search: - description: Search + description: 'The search parameters. + + ' items: description: Search type: string type: array - InterfaceScreenV4N14: + InterfaceScreenV4N16: properties: admin_up: description: 'The interface admin state. @@ -3743,7 +4012,7 @@ components: ' ipv6_config: - $ref: '#/components/schemas/Ipv6Config' + $ref: '#/components/schemas/Ipv6ConfigV1' description: 'The ipv6 config information. ' @@ -3778,9 +4047,9 @@ components: ' type: string nat_address_v6: - description: 'Nat Address V6: IPAddress(allowEmpty = true, allowLinkLocal - = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck - = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IPV6) ' + description: 'The NAT IPV6 address. + + ' type: string nat_pools: description: 'The NAT pools information. @@ -3816,6 +4085,14 @@ components: ' type: string + peer_bypasspair_wan_port_type: + description: 'The peer bypass pair WAN port type. + + ' + enum: + - none + - cellular + type: string poe_enabled: description: 'PoE enabled = true/false. @@ -3904,11 +4181,17 @@ components: description: 'The VLAN config details. ' + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: + - peer_bypasspair_wan_port_type - scope - used_for - type - InterfaceScreenV4N15: + InterfaceScreenV4N17: properties: admin_up: description: 'The interface admin state. @@ -4164,12 +4447,17 @@ components: description: 'The VLAN config details. ' + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: - peer_bypasspair_wan_port_type - scope - used_for - type - InterfaceStateV3N4: + InterfaceStateV3N5: properties: cellular_state: $ref: '#/components/schemas/CellularState' @@ -4191,6 +4479,12 @@ components: description: 'The DNS v6 config details. ' + effective_vlans: + description: Effective Vlans + items: + description: Effective Vlans + type: integer + type: array element_id: description: 'The element ID. @@ -4227,6 +4521,9 @@ components: link_local_address: description: "The link local address. \n" type: string + lldp_enabled: + description: Lldp Enabled + type: boolean mac_address: description: 'The interface configuration MAC address. @@ -4248,6 +4545,9 @@ components: ' type: string + poe_state: + $ref: '#/components/schemas/PoeStateS' + description: Poe State port: $ref: '#/components/schemas/Port' description: 'The start and end port details. @@ -4288,7 +4588,17 @@ components: description: 'The service link details ServiceLink. ' - InterfaceStateV3N5: + stp_state: + $ref: '#/components/schemas/STPStateS' + description: 'The STP state details. + + ' + svi_state: + $ref: '#/components/schemas/SVIStateS' + description: 'The svi details. + + ' + InterfaceStateV3N6: properties: cellular_state: $ref: '#/components/schemas/CellularState' @@ -4429,7 +4739,10 @@ components: description: 'The svi details. ' - InterfaceV4N14: + vrf: + $ref: '#/components/schemas/VRF' + description: "The VRF details. \n" + InterfaceV4N16: properties: admin_up: description: 'The interface admin state. @@ -4516,7 +4829,7 @@ components: ' ipv6_config: - $ref: '#/components/schemas/Ipv6Config' + $ref: '#/components/schemas/Ipv6ConfigV1' description: 'The ipv6 config information. ' @@ -4551,9 +4864,9 @@ components: ' type: string nat_address_v6: - description: 'Nat Address V6: IPAddress(allowEmpty = true, allowLinkLocal - = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck - = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IPV6) ' + description: 'The NAT IPV6 address. + + ' type: string nat_pools: description: 'The NAT pools information. @@ -4589,6 +4902,14 @@ components: ' type: string + peer_bypasspair_wan_port_type: + description: 'The peer bypass pair WAN port type. + + ' + enum: + - none + - cellular + type: string poe_enabled: description: 'PoE enabled = true/false. @@ -4677,11 +4998,17 @@ components: description: 'The VLAN config details. ' + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: + - peer_bypasspair_wan_port_type - scope - used_for - type - InterfaceV4N15: + InterfaceV4N17: properties: admin_up: description: 'The interface admin state. @@ -4937,6 +5264,11 @@ components: description: 'The VLAN config details. ' + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: - peer_bypasspair_wan_port_type - scope @@ -5025,51 +5357,44 @@ components: address: description: Address type: string - Ipv6Config: - properties: - dhcp_config: - $ref: '#/components/schemas/Ipv6Dhcp' - description: Dhcp Config - dns_v6_config: - $ref: '#/components/schemas/DNS' - description: 'Dns V6 Config: Valid ' - routes: - description: Routes - items: - $ref: '#/components/schemas/Route' - type: array - static_config: - $ref: '#/components/schemas/Ipv6Static' - description: Static Config - type: - description: Type - type: string Ipv6ConfigV1: properties: dhcp_config: $ref: '#/components/schemas/Ipv6Dhcp' - description: Dhcp Config + description: "The DHCP config information. \n" dns_v6_config: $ref: '#/components/schemas/DNS' - description: 'Dns V6 Config: Valid ' + description: 'The DNS V6 configurations. + + ' routes: - description: Routes + description: 'The route details. + + ' items: $ref: '#/components/schemas/Route' type: array static_config: $ref: '#/components/schemas/Ipv6StaticV1' - description: Static Config + description: 'The IPv6 static address. + + ' type: - description: Type + description: 'The interface config type. Max = 12. + + ' type: string Ipv6Dhcp: properties: client_id: - description: Client Id + description: 'The client ID. + + ' type: string hostname: - description: Hostname + description: 'The IPv6 DHCP host name. + + ' type: string Ipv6Route: properties: @@ -5083,22 +5408,17 @@ components: ' type: string - Ipv6Static: - properties: - address: - description: Address - type: string - enable_prefix_distribution: - description: 'Enable Prefix Distribution: JsonIgnoreProperties(allowGetters - = false, allowSetters = false, ignoreUnknown = true) ' - type: boolean Ipv6StaticV1: properties: address: - description: Address + description: 'The IPv6 static address. + + ' type: string enable_prefix_distribution: - description: Enable Prefix Distribution + description: 'Is prefix distribution enabled. True or False. + + ' type: boolean LanNetworkVlanMapping: properties: @@ -5121,19 +5441,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -5154,7 +5474,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -5163,18 +5483,43 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: object - MachineInfoV2N2: + LivelinessProbe: + properties: + failure_count: + description: "The liveliness probe failure count interval. \n" + format: int32 + type: integer + interval: + description: 'The probe interval. Must be between 1 to 30 seconds. + + ' + format: int32 + type: integer + ip_address: + description: "The probe address. \n" + type: string + local_ip_address: + description: 'The local probe address. + + ' + type: string + proxy_id: + description: 'The proxy ID. + + ' + type: string + Machine: properties: connected: description: "The device is connected. True or False. \n" @@ -5185,15 +5530,13 @@ components: em_element_id: description: "The element ID. \n" type: string - esp_tenant_id: - description: "The MSP tenant ID. \n" - type: string hw_id: description: 'The hardware ID. ' type: string id: + description: Id type: string image_version: description: 'The image version. @@ -5201,15 +5544,90 @@ components: ' type: string inventory_op: - $ref: '#/components/schemas/InventoryOperation' description: 'The inventory lifecycle values. ' + enum: + - CLAIM + - RETURN + - REVOKE + - REUSE + - RETIRE + - RECOVER + - REMANUFACTURE + - DEFAULT + - INVALID + - ALLOCATE + - RECEIVED_STOCK + - ESP_ALLOCATE + - ESP_RECEIVED_STOCK + - ESP_RETURN + - ESP_REVOKE + - ESP_REUSE + type: string machine_state: - $ref: '#/components/schemas/MachineState' description: 'The various device states. ' + enum: + - MANUFACTURED + - MANUFACTURED_QA_PENDING + - MANUFACTURED_QA_OK + - MANUFACTURED_QA_NOK + - MANUFACTURED_BATTERY_TEST_PENDING + - MANUFACTURED_BATTERY_TEST_START + - MANUFACTURED_BATTERY_TEST_PASS + - MANUFACTURED_BATTERY_TEST_FAILED + - MANUFACTURED_MIC_ISSUE_PENDING + - MANUFACTURED_MIC_ISSUED + - MANUFACTURED_MIC_FAILED + - MANUFACTURED_MIC_OPERATIONAL + - MANUFACTURED_CIC_ISSUE_PENDING + - MANUFACTURED_CIC_ISSUED + - MANUFACTURED_CIC_REVOKED + - MANUFACTURED_CIC_OPERATIONAL + - MANUFACTURED_MIC_SIGNING_PENDING + - MANUFACTURED_CIC_SIGNING_PENDING + - MACHINE_ALLOCATED + - MACHINE_ALLOCATED_TO_ESP + - MACHINE_ELEMENT_ID_PENDING + - MACHINE_INIT + - MACHINE_INIT_FAILED + - MACHINE_ASSIGNED + - MACHINE_CLAIM_PENDING + - MACHINE_CLAIMED + - MACHINE_CLAIM_FAILED + - MACHINE_TO_BE_RETURNED + - MACHINE_RETURNED + - MACHINE_REVOKED + - MACHINE_ELEMENT_DELETE_PENDING + - MACHINE_RETURN_FAILED + - MACHINE_RECEIVED_STOCK + - REMANUFACTURED + - MACHINE_RETIRED + - MACHINE_RECOVER + - MACHINE_DECOMMISSIONED + - MACHINE_CLAIM_VALID + - MACHINE_CLAIM_INVALID + - MACHINE_CIC_RENEW_INITIAL + - MACHINE_CIC_RENEW_ISSUE_PENDING + - MACHINE_CIC_RENEW_ISSUED + - MACHINE_CIC_RENEW_SIGNING_PENDING + - MACHINE_CIC_RENEW_FAILED + - MACHINE_CIC_RENEWED + - MACHINE_SUSPEND_INIT + - MACHINE_SUSPEND_IN_PROGRESS + - MACHINE_SUSPENDED_MIC_OPERATIONAL + - MACHINE_SUSPENDED_CIC_OPERATIONAL + - MACHINE_SUSPEND_FAILED + - MACHINE_SUSPENDED_EMPTY_TOKEN + - MACHINE_SUSPENDED_INVALID_TOKEN + - MACHINE_SUSPENDED_TOKEN_EXPIRED + - MACHINE_SUSPENDED + - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL + type: string manufacture_id: description: 'The manufacture ID. @@ -5219,25 +5637,84 @@ components: description: "The model name of the device. \n" type: string ordering_info: - description: 'The order information. - - ' - type: string - owner_tenant_id: - description: "The owner tenant ID. \n" + description: "The order information. \n" type: string pki_op: $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op renew_state: - $ref: '#/components/schemas/MachineState' description: 'The device renew states. ' + enum: + - MANUFACTURED + - MANUFACTURED_QA_PENDING + - MANUFACTURED_QA_OK + - MANUFACTURED_QA_NOK + - MANUFACTURED_BATTERY_TEST_PENDING + - MANUFACTURED_BATTERY_TEST_START + - MANUFACTURED_BATTERY_TEST_PASS + - MANUFACTURED_BATTERY_TEST_FAILED + - MANUFACTURED_MIC_ISSUE_PENDING + - MANUFACTURED_MIC_ISSUED + - MANUFACTURED_MIC_FAILED + - MANUFACTURED_MIC_OPERATIONAL + - MANUFACTURED_CIC_ISSUE_PENDING + - MANUFACTURED_CIC_ISSUED + - MANUFACTURED_CIC_REVOKED + - MANUFACTURED_CIC_OPERATIONAL + - MANUFACTURED_MIC_SIGNING_PENDING + - MANUFACTURED_CIC_SIGNING_PENDING + - MACHINE_ALLOCATED + - MACHINE_ALLOCATED_TO_ESP + - MACHINE_ELEMENT_ID_PENDING + - MACHINE_INIT + - MACHINE_INIT_FAILED + - MACHINE_ASSIGNED + - MACHINE_CLAIM_PENDING + - MACHINE_CLAIMED + - MACHINE_CLAIM_FAILED + - MACHINE_TO_BE_RETURNED + - MACHINE_RETURNED + - MACHINE_REVOKED + - MACHINE_ELEMENT_DELETE_PENDING + - MACHINE_RETURN_FAILED + - MACHINE_RECEIVED_STOCK + - REMANUFACTURED + - MACHINE_RETIRED + - MACHINE_RECOVER + - MACHINE_DECOMMISSIONED + - MACHINE_CLAIM_VALID + - MACHINE_CLAIM_INVALID + - MACHINE_CIC_RENEW_INITIAL + - MACHINE_CIC_RENEW_ISSUE_PENDING + - MACHINE_CIC_RENEW_ISSUED + - MACHINE_CIC_RENEW_SIGNING_PENDING + - MACHINE_CIC_RENEW_FAILED + - MACHINE_CIC_RENEWED + - MACHINE_SUSPEND_INIT + - MACHINE_SUSPEND_IN_PROGRESS + - MACHINE_SUSPENDED_MIC_OPERATIONAL + - MACHINE_SUSPENDED_CIC_OPERATIONAL + - MACHINE_SUSPEND_FAILED + - MACHINE_SUSPENDED_EMPTY_TOKEN + - MACHINE_SUSPENDED_INVALID_TOKEN + - MACHINE_SUSPENDED_TOKEN_EXPIRED + - MACHINE_SUSPENDED + - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL + type: string ship_state: - $ref: '#/components/schemas/MachineShipState' description: 'The shipping status. ' + enum: + - MACHINE_SHIPPED + - MACHINE_SHIPPED_CORRECT_ADDRESS + - MACHINE_SHIPPED_WRONG_ADDRESS + - MACHINE_NOT_SHIPPED + type: string sl_no: description: 'The serial number. @@ -5248,7 +5725,15 @@ components: ' type: string - type: object + required: + - ship_state + - manufacture_id + - renew_state + - machine_state + - image_version + - model_name + - sl_no + - hw_id MachineInfoV2N3: properties: connected: @@ -5402,7 +5887,7 @@ components: ' format: int64 type: integer - MachineQueryFilterV2N2: + MachineQueryFilterV2N3: properties: connected: description: "The device is connected. True or False. \n" @@ -5513,10 +5998,14 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string manufacture_id: description: 'The manufacture ID. + The manufacture ID. + ' type: string model_name: @@ -5591,6 +6080,13 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL + type: string + sales_order_number: + description: 'The sales order number. + + ' type: string ship_state: description: 'The shipping status. @@ -5603,9 +6099,7 @@ components: - MACHINE_NOT_SHIPPED type: string sl_no: - description: 'The serial number. - - ' + description: Sl No type: string suspend_state: description: 'The suspend state. @@ -5667,13 +6161,15 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string token: description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. ' type: string - MachineQueryFilterV2N3: + MachineQueryFilterV2N5: properties: connected: description: "The device is connected. True or False. \n" @@ -5681,8 +6177,13 @@ components: console_conf_passphrase: description: "The console password. \n" type: string + element_shell_id: + description: "The element shell ID. \n" + type: string em_element_id: - description: "The element ID. \n" + description: 'The element ID. + + ' type: string esp_tenant_id: description: 'The MSP tenant ID. @@ -5724,6 +6225,10 @@ components: - ESP_REVOKE - ESP_REUSE type: string + is_eval: + description: 'Is Eval: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], + value = ALWAYS, valueFilter = classOf[Void]) ' + type: string machine_state: description: 'The various device states. @@ -5784,6 +6289,8 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string manufacture_id: description: 'The manufacture ID. @@ -5862,6 +6369,8 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string sales_order_number: description: 'The sales order number. @@ -5879,9 +6388,7 @@ components: - MACHINE_NOT_SHIPPED type: string sl_no: - description: 'The serial number. - - ' + description: Sl No type: string suspend_state: description: 'The suspend state. @@ -5943,6 +6450,8 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string token: description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. @@ -6039,14 +6548,16 @@ components: ' type: string trusted_boot: - description: "The possible values in trusted boot. \n" + description: 'The possible values in trusted boot. + + ' enum: - PASSED - FAILED type: string required: - hardware_id - MachineV2N2: + MachineV2N3: properties: connected: description: "The device is connected. True or False. \n" @@ -6157,6 +6668,8 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string manufacture_id: description: 'The manufacture ID. @@ -6235,6 +6748,13 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL + type: string + sales_order_number: + description: 'The sales order number. + + ' type: string ship_state: description: 'The shipping status. @@ -6247,7 +6767,9 @@ components: - MACHINE_NOT_SHIPPED type: string sl_no: - description: Sl No + description: 'The serial number. + + ' type: string suspend_state: description: 'The suspend state. @@ -6309,19 +6831,36 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string token: description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. ' type: string - MachineV2N3: + required: + - suspend_state + - ship_state + - manufacture_id + - renew_state + - machine_state + - image_version + - model_name + - sl_no + - hw_id + MachineV2N5: properties: connected: description: "The device is connected. True or False. \n" type: boolean console_conf_passphrase: - description: "The console password. \n" + description: 'The console password. + + ' + type: string + element_shell_id: + description: "The element shell ID. \n" type: string em_element_id: description: "The element ID. \n" @@ -6366,6 +6905,10 @@ components: - ESP_REVOKE - ESP_REUSE type: string + is_eval: + description: 'Is Eval: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], + value = ALWAYS, valueFilter = classOf[Void]) ' + type: string machine_state: description: 'The various device states. @@ -6426,6 +6969,8 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string manufacture_id: description: 'The manufacture ID. @@ -6504,6 +7049,8 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string sales_order_number: description: 'The sales order number. @@ -6521,8 +7068,7 @@ components: - MACHINE_NOT_SHIPPED type: string sl_no: - description: 'Sl No: NotEmpty(message = Required sl_no) Readonly(message - = Readonly attribute., valid = true) ' + description: Sl No type: string suspend_state: description: 'The suspend state. @@ -6584,22 +7130,14 @@ components: - MACHINE_SUSPENDED_TOKEN_EXPIRED - MACHINE_SUSPENDED - MACHINE_SUSPEND_FAILED_TIMEOUT + - MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS + - MACHINE_ALLOCATED_TO_SHELL type: string token: description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. ' type: string - required: - - suspend_state - - ship_state - - manufacture_id - - renew_state - - machine_state - - image_version - - model_name - - sl_no - - hw_id MulticastInterfaceConfig: properties: igmp_version: @@ -6630,10 +7168,20 @@ components: ' type: string - PeerInfo: + PassiveMode: properties: - hostname: - description: 'The peer hostname. + enable: + description: "Passive mode enabled for the device. True or False. \n" + type: boolean + peer_ip_dynamic: + description: 'Peer IP dynamic enabled. True or False. + + ' + type: boolean + PeerInfo: + properties: + hostname: + description: 'The peer hostname. ' type: string @@ -6740,37 +7288,52 @@ components: ' type: string + Proxy: + properties: + local: + description: Local + type: string + local_port: + description: Local Port + type: integer + protocol: + description: Protocol + type: string + protocol_number: + description: Protocol Number + type: integer + proxy_id: + description: Proxy Id + type: string + remote: + description: Remote + type: string + remote_port: + description: Remote Port + type: integer RecoveryToken: properties: hardware_id: - description: "The machine hardware ID. \n" + description: Hardware Id type: string id: - description: 'The machine ID. - - ' + description: Id type: string ion_token: - description: 'The ION device token. - - ' + description: Ion Token type: string is_used: - description: "Values True or False. \n" + description: Is Used type: boolean secret_token: - description: 'The secret token. - - ' + description: Secret Token type: string token_validity_in_hour: - description: "The token validity in a hour. \n" + description: Token Validity In Hour format: int32 type: integer valid_till_secs: - description: 'The token validity in seconds. - - ' + description: Valid Till Secs format: int64 type: integer RecoveryTokenScreen: @@ -6860,6 +7423,35 @@ components: ' type: string + SaseIkeGWConfig: + properties: + ike_gw_name: + description: Ike Gw Name + type: string + ikev1_dpd_delay: + description: Ikev1 Dpd Delay + type: integer + ikev1_dpd_enable: + description: Ikev1 Dpd Enable + type: boolean + ikev1_dpd_timeout: + description: Ikev1 Dpd Timeout + type: integer + ikev1_enable_fragmentation: + description: Ikev1 Enable Fragmentation + type: boolean + ikev1_exchange_mode: + description: Ikev1 Exchange Mode + type: string + ikev2_liveness_check_enable: + description: Ikev2 Liveness Check Enable + type: boolean + ikev2_liveness_interval: + description: Ikev2 Liveness Interval + type: integer + ikev2_require_cookie: + description: Ikev2 Require Cookie + type: boolean SecondaryIPConfig: properties: ipv4_address: @@ -6870,6 +7462,34 @@ components: type: string ServiceLink: properties: + anti_replay: + description: 'The anti replay value. True or False. + + ' + type: boolean + anti_replay_window: + description: 'The anti replay window count. + + ' + type: integer + classic_site_id: + description: 'The site ID. + + ' + type: string + copy_tos: + description: Copy Tos + type: boolean + enable_gre_encapsulation: + description: 'Is GRE encapsulation enabled. True or False. + + ' + type: boolean + geneve_config: + $ref: '#/components/schemas/GeneveConfig' + description: 'Lists all the geneve configurations. + + ' gre_config: $ref: '#/components/schemas/GREConfig' description: 'The GRE config details. @@ -6885,15 +7505,48 @@ components: ' type: string + liveliness_probe: + $ref: '#/components/schemas/LivelinessProbe' + description: 'Lists the livliness probe details. + + ' + nat_traversal: + description: 'Nat traversal value. True or False. + + ' + type: boolean + pa_location_oid: + description: Pa Location Oid + type: string + pa_tunnel_oid: + description: Pa Tunnel Oid + type: string parent: description: 'The parent value = true. ' type: string + passive_mode: + $ref: '#/components/schemas/PassiveMode' + description: 'Passive mode enabled on the device. True or False + + ' peer: $ref: '#/components/schemas/PeerInfo' description: 'The peer information. + ' + proxy_ids: + description: 'The proxy details. + + ' + items: + $ref: '#/components/schemas/Proxy' + type: array + sase_ike_gw_config: + $ref: '#/components/schemas/SaseIkeGWConfig' + description: 'The SASE IKE GW configurations. + ' security_service_endpoint_id: description: 'The security service endpoint ID. @@ -6901,13 +7554,21 @@ components: ' type: string service_endpoint_id: - description: "The service endpoint ID. \n" + description: 'The service endpoint ID. + + ' + type: string + tunnel_role: + description: "The tunnel role. \n" type: string type: - description: "The service link type. \n" + description: 'The service link type. + + ' enum: - IPSEC - GRE + - GENEVE type: string required: - type @@ -6948,6 +7609,7 @@ components: enum: - IPSEC - GRE + - GENEVE type: string required: - type @@ -7156,24 +7818,32 @@ components: SwitchState: properties: bridge_id: - description: Bridge Id + description: 'The switch bridge ID + + ' type: string default_vlan_id: - description: Default Vlan Id + description: 'Default VLAN ID is 1. + + ' format: int32 type: integer designated_bridge_id: - description: Designated Bridge Id + description: "The designated bridge ID. \n" type: string last_topology_change: - description: Last Topology Change + description: 'Last topology change. + + ' type: string max_hops: description: Max Hops format: int32 type: integer mstp_enabled: - description: Mstp Enabled + description: 'The MSTP enabled. True or False. + + ' type: boolean root_bridge_id: description: Root Bridge Id @@ -7186,42 +7856,57 @@ components: description: Root Port type: string stp_aging_timer: - description: Stp Aging Timer + description: "The STP aging Timer between 10 - 1000000 seconds. \ + \ \n" format: int32 type: integer stp_forward_delay: - description: Stp Forward Delay + description: "Forward Delay is the length of time spent in listening state,\ + \ set the value between 4 - 30 seconds. \n" format: int32 type: integer stp_hello_time: - description: Stp Hello Time + description: "Hello Time is the time Interval between BPDU transmission,\ + \ set the value between 1-10 seconds. \n" format: int32 type: integer stp_max_age: - description: Stp Max Age + description: 'The length of Max Age time that the switch retains information + learned from BPDUs, set the value between 6 - 40 seconds. + + ' format: int32 type: integer stp_mode: - description: Stp Mode + description: 'The STP Mode is RSTP, default STP mode is RSTP + + ' type: string stp_priority: - description: Stp Priority + description: 'The Priority value is between 0 - 61440, in multiples of 4096. + + ' format: int32 type: integer TrackInterface: properties: interface_id: - description: Interface Id + description: 'The interface ID + + ' type: string reduce_priority: - description: 'Reduce Priority: Range(max = 254L, SPOKEHA_CONFIG_INVALID_REDUCE_PRIORITY, - min = 1L) ' + description: 'Reduce priority of the spoke HA config. + + ' format: int32 type: integer TrackV2: properties: interfaces: - description: "The details of the interfaces. \n" + description: 'The details of the interfaces. + + ' items: $ref: '#/components/schemas/TrackInterface' type: array @@ -7233,13 +7918,27 @@ components: TrackWANInterface: properties: reduce_priority: - description: 'The spoke HA config reduce priority. + description: 'Reduce priority of the spoke HA config. ' format: int32 type: integer wan_interface_id: - description: Wan Interface Id + description: 'The WAN interface ID + + ' + type: string + VRF: + properties: + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string + vrf_context_name: + description: 'The VFR context name. + + ' type: string VffInventoryOperation: enum: @@ -8064,6 +8763,42 @@ paths: summary: Update Element State (v2.0) tags: - Device Configuration + /sdwan/v2.0/api/machines/{machine_id}/allocate_to_shell: + post: + description: Allocate Element Shell to Machine + operationId: post-sdwan-v2.0-api-machines-machine_id-allocate_to_shell + parameters: + - in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N5' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N5' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_SHELL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Allocate Element Shell to Machine (v2.0) + tags: + - Device Configuration /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/admin_state: put: description: Update admin state Northbound. @@ -9247,42 +9982,6 @@ paths: summary: Update Extensions Configuration (v2.0) tags: - Device Configuration - /sdwan/v2.1/api/elements/status/query: - post: - description: Query the element status objects for a tenant. - operationId: post-sdwan-v2.1-api-elements-status-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementStatusQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementStatusQuery' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_STATUS_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Element Status Objects for Tenant (v2.1) - tags: - - Device Configuration /sdwan/v2.1/api/elements/{element_id}/fips_mode_change_operations: post: description: Change the mode of an element from FIPS to Non-FIPS or vice-versa. @@ -9359,38 +10058,6 @@ paths: summary: Get Software Upgrade Status (v2.1) tags: - Device Configuration - /sdwan/v2.1/api/elements/{element_id}/status: - get: - description: Get the specific element status for a tenant. - operationId: get-sdwan-v2.1-api-elements-element_id-status - parameters: - - description: The element ID. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ElementStatusV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_STATUS_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Element Status for Tenant (v2.1) - tags: - - Device Configuration /sdwan/v2.1/api/machines/{machine_id}/machinesystemstatus: get: description: Get the machine system status for a tenant. @@ -9659,10 +10326,78 @@ paths: summary: Get Status for Vff License (v2.1) tags: - Device Configuration - /sdwan/v2.2/api/clients/{client_id}/machines: + /sdwan/v2.2/api/elements/status/query: + post: + description: Query the element status objects for a tenant. + operationId: post-sdwan-v2.2-api-elements-status-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementStatusQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementStatusQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_STATUS_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Element Status Objects for Tenant (v2.2) + tags: + - Device Configuration + /sdwan/v2.2/api/elements/{element_id}/status: + get: + description: Get the specific element status for a tenant. + operationId: get-sdwan-v2.2-api-elements-element_id-status + parameters: + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementStatusV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_STATUS_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Element Status for Tenant (v2.2) + tags: + - Device Configuration + /sdwan/v2.3/api/clients/{client_id}/machines: get: description: List all the machines of a tenant. - operationId: get-sdwan-v2.2-api-clients-client_id-machines + operationId: get-sdwan-v2.3-api-clients-client_id-machines parameters: - description: The client ID. in: path @@ -9696,13 +10431,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machines of Tenant (v2.2) + summary: Get Machines of Tenant (v2.3) tags: - Device Configuration - /sdwan/v2.2/api/clients/{client_id}/machines/query: + /sdwan/v2.3/api/clients/{client_id}/machines/query: post: description: Query the machines allocated by the MSP to a client tenant. - operationId: post-sdwan-v2.2-api-clients-client_id-machines-query + operationId: post-sdwan-v2.3-api-clients-client_id-machines-query parameters: - description: The client ID. in: path @@ -9741,13 +10476,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Tenant's Client (v2.2) + summary: Query Tenant's Client (v2.3) tags: - Device Configuration - /sdwan/v2.2/api/clients/{client_id}/machines/{machine_id}: + /sdwan/v2.3/api/clients/{client_id}/machines/{machine_id}: get: description: Get a specific machine allocated by the MSP to a client tenant. - operationId: get-sdwan-v2.2-api-clients-client_id-machines-machine_id + operationId: get-sdwan-v2.3-api-clients-client_id-machines-machine_id parameters: - description: The client ID. in: path @@ -9768,7 +10503,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N2' + $ref: '#/components/schemas/MachineV2N3' description: Successful Operation '400': content: @@ -9782,14 +10517,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machine of Tenant (v2.2) + summary: Get Machine of Tenant (v2.3) tags: - Device Configuration - /sdwan/v2.2/api/clients/{client_id}/machines/{machine_id}/reallocate: + /sdwan/v2.3/api/clients/{client_id}/machines/{machine_id}/reallocate: post: description: Reallocate a specific machine from one client tenant to another, where both client tenants are clients of the same MSP. - operationId: post-sdwan-v2.2-api-clients-client_id-machines-machine_id-reallocate + operationId: post-sdwan-v2.3-api-clients-client_id-machines-machine_id-reallocate parameters: - description: The client ID. in: path @@ -9809,13 +10544,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineInfoV2N2' + $ref: '#/components/schemas/MachineInfoV2N3' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N2' + $ref: '#/components/schemas/MachineV2N3' description: Successful Operation '400': content: @@ -9839,13 +10574,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.2) + summary: Update Tenant Machine (v2.3) tags: - Device Configuration - /sdwan/v2.2/api/elements/status/query: + /sdwan/v2.3/api/elements/status/query: post: - description: Query and get element status objects for a tenant - operationId: post-sdwan-v2.2-api-elements-status-query + description: Query the element status objects for a tenant. + operationId: post-sdwan-v2.3-api-elements-status-query requestBody: content: application/json: @@ -9875,15 +10610,16 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query and get element status objects for a tenant (v2.2) + summary: Query Element Status Objects for Tenant (v2.3) tags: - Device Configuration - /sdwan/v2.2/api/elements/{element_id}/status: + /sdwan/v2.3/api/elements/{element_id}/status: get: - description: Get specific element status for a tenant - operationId: get-sdwan-v2.2-api-elements-element_id-status + description: Get the specific element status for a tenant. + operationId: get-sdwan-v2.3-api-elements-element_id-status parameters: - - in: path + - description: The element ID. + in: path name: element_id required: true schema: @@ -9894,7 +10630,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementStatusV2N2' + $ref: '#/components/schemas/ElementStatusV2N3' description: Successful Operation '400': content: @@ -9906,13 +10642,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get specific element status for a tenant (v2.2) + summary: Get Element Status for Tenant (v2.3) tags: - Device Configuration - /sdwan/v2.2/api/machines: + /sdwan/v2.3/api/machines: get: description: Get all the machines of a tenant. - operationId: get-sdwan-v2.2-api-machines + operationId: get-sdwan-v2.3-api-machines responses: '200': content: @@ -9923,7 +10659,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/MachineV2N2' + $ref: '#/components/schemas/MachineV2N3' type: array type: object description: Successful Operation @@ -9939,13 +10675,13 @@ paths: description: Bad Request '404': description: Machines not found - summary: Get Machines of Tenant (v2.2) + summary: Get Machines of Tenant (v2.3) tags: - Device Configuration - /sdwan/v2.2/api/machines/query: + /sdwan/v2.3/api/machines/query: post: description: Query the machines of a tenant. - operationId: post-sdwan-v2.2-api-machines-query + operationId: post-sdwan-v2.3-api-machines-query requestBody: content: application/json: @@ -9961,7 +10697,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/MachineQueryFilterV2N2' + $ref: '#/components/schemas/MachineQueryFilterV2N3' type: array type: object description: Successful Operation @@ -9975,13 +10711,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad request - summary: Query Machine of Tenant (v2.2) + summary: Query Machine of Tenant (v2.3) tags: - Device Configuration - /sdwan/v2.2/api/machines/{machine_id}: + /sdwan/v2.3/api/machines/{machine_id}: get: description: Get a specific machine of a tenant. - operationId: get-sdwan-v2.2-api-machines-machine_id + operationId: get-sdwan-v2.3-api-machines-machine_id parameters: - description: The machine ID. in: path @@ -9995,7 +10731,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N2' + $ref: '#/components/schemas/MachineV2N3' description: Successful Operation '400': content: @@ -10008,13 +10744,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Machine (v2.2) + summary: Get Tenant Machine (v2.3) tags: - Device Configuration - /sdwan/v2.2/api/machines/{machine_id}/operations: + /sdwan/v2.3/api/machines/{machine_id}/operations: post: description: Update a specific machine of a tenant using operations. - operationId: post-sdwan-v2.2-api-machines-machine_id-operations + operationId: post-sdwan-v2.3-api-machines-machine_id-operations parameters: - description: The machine ID. in: path @@ -10027,13 +10763,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineInfoV2N2' + $ref: '#/components/schemas/MachineInfoV2N3' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N2' + $ref: '#/components/schemas/MachineV2N3' description: Successful Operation '400': content: @@ -10060,15 +10796,15 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.2) + summary: Update Tenant Machine (v2.3) tags: - Device Configuration - /sdwan/v2.3/api/clients/{client_id}/machines: + /sdwan/v2.5/api/clients/{client_id}/machines: get: - description: List all the machines of a tenant. - operationId: get-sdwan-v2.3-api-clients-client_id-machines + description: Get all the machines allocated by ESP to a client tenant. + operationId: get-sdwan-v2.5-api-clients-client_id-machines parameters: - - description: The client ID. + - description: Tenant ID of the client tenant of the ESP. in: path name: client_id required: true @@ -10100,15 +10836,15 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machines of Tenant (v2.3) + summary: Get Machines Allocated by ESP to Client Tenant (v2.5) tags: - Device Configuration - /sdwan/v2.3/api/clients/{client_id}/machines/query: + /sdwan/v2.5/api/clients/{client_id}/machines/query: post: - description: Query the machines allocated by the MSP to a client tenant. - operationId: post-sdwan-v2.3-api-clients-client_id-machines-query + description: Query and get all machines allocated by ESP to a client tenant. + operationId: post-sdwan-v2.5-api-clients-client_id-machines-query parameters: - - description: The client ID. + - description: Tenant ID of the client tenant of the ESP. in: path name: client_id required: true @@ -10145,13 +10881,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Tenant's Client (v2.3) + summary: Query Machines Allocated by ESP to Client Tenant (v2.5) tags: - Device Configuration - /sdwan/v2.3/api/clients/{client_id}/machines/{machine_id}: + /sdwan/v2.5/api/clients/{client_id}/machines/{machine_id}: get: - description: Get a specific machine allocated by the MSP to a client tenant. - operationId: get-sdwan-v2.3-api-clients-client_id-machines-machine_id + description: Get a specific machine allocated by ESP to a client tenant. + operationId: get-sdwan-v2.5-api-clients-client_id-machines-machine_id parameters: - description: The client ID. in: path @@ -10172,7 +10908,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/MachineV2N5' description: Successful Operation '400': content: @@ -10186,16 +10922,16 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machine of Tenant (v2.3) + summary: Get Machine Allocated by ESP to Client Tenant (v2.5) tags: - Device Configuration - /sdwan/v2.3/api/clients/{client_id}/machines/{machine_id}/reallocate: + /sdwan/v2.5/api/clients/{client_id}/machines/{machine_id}/reallocate: post: description: Reallocate a specific machine from one client tenant to another, - where both client tenants are clients of the same MSP. - operationId: post-sdwan-v2.3-api-clients-client_id-machines-machine_id-reallocate + where both client tenants are clients of the same ESP. + operationId: post-sdwan-v2.5-api-clients-client_id-machines-machine_id-reallocate parameters: - - description: The client ID. + - description: Tenant ID (source) of the client tenant of ESP. in: path name: client_id required: true @@ -10219,7 +10955,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/MachineV2N5' description: Successful Operation '400': content: @@ -10243,24 +10979,25 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.3) + summary: Reallocate Machine Client Tenant of ESP (v2.5) tags: - Device Configuration - /sdwan/v2.3/api/machines: + /sdwan/v2.5/api/machines: get: description: Get all the machines of a tenant. - operationId: get-sdwan-v2.3-api-machines + operationId: get-sdwan-v2.5-api-machines responses: '200': content: application/json: schema: + $ref: '#/components/schemas/MachineQuery' allOf: - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/MachineV2N5' type: array type: object description: Successful Operation @@ -10271,18 +11008,19 @@ paths: value: _error: - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN schema: $ref: '#/components/schemas/Error' description: Bad Request '404': description: Machines not found - summary: Get Machines of Tenant (v2.3) + summary: Get Machines of Tenant (v2.5) tags: - Device Configuration - /sdwan/v2.3/api/machines/query: + /sdwan/v2.5/api/machines/query: post: description: Query the machines of a tenant. - operationId: post-sdwan-v2.3-api-machines-query + operationId: post-sdwan-v2.5-api-machines-query requestBody: content: application/json: @@ -10298,7 +11036,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/MachineQueryFilterV2N3' + $ref: '#/components/schemas/MachineQueryFilterV2N5' type: array type: object description: Successful Operation @@ -10312,13 +11050,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad request - summary: Query Machine of Tenant (v2.3) + summary: Query Machine of Tenant (v2.5) tags: - Device Configuration - /sdwan/v2.3/api/machines/{machine_id}: + /sdwan/v2.5/api/machines/{machine_id}: get: description: Get a specific machine of a tenant. - operationId: get-sdwan-v2.3-api-machines-machine_id + operationId: get-sdwan-v2.5-api-machines-machine_id parameters: - description: The machine ID. in: path @@ -10332,7 +11070,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/Machine' description: Successful Operation '400': content: @@ -10340,18 +11078,23 @@ paths: example: value: _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: MACHINE_UNKNOWN + - code: INVALID_OPERATION + - code: INVALID_STATE + - code: PLEASE_RETRY_LATER + - code: MACHINE_DISCONNECTED + - code: CLAIM_ALREADY_IN_PROGRESS + - code: NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Machine (v2.3) + summary: Get Tenant Machine (v2.5) tags: - Device Configuration - /sdwan/v2.3/api/machines/{machine_id}/operations: + /sdwan/v2.5/api/machines/{machine_id}/operations: post: description: Update a specific machine of a tenant using operations. - operationId: post-sdwan-v2.3-api-machines-machine_id-operations + operationId: post-sdwan-v2.5-api-machines-machine_id-operations parameters: - description: The machine ID. in: path @@ -10370,7 +11113,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/MachineV2N5' description: Successful Operation '400': content: @@ -10397,13 +11140,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.3) + summary: Update Tenant Machine using Operations (v2.5) tags: - Device Configuration - /sdwan/v2.7/api/elements: + /sdwan/v3.0/api/elements: get: description: Get the element of a tenant. - operationId: get-sdwan-v2.7-api-elements + operationId: get-sdwan-v3.0-api-elements responses: '200': content: @@ -10414,27 +11157,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementV2N7' + $ref: '#/components/schemas/ElementV3' type: array type: object description: Successful Operation - '404': - content: - application/json: - example: - value: - _error: - - code: NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Not Found - summary: Get Element of Tenant (v2.7) + summary: Get Element of Tenant (v3.0) tags: - Device Configuration - /sdwan/v2.7/api/elements/query: + /sdwan/v3.0/api/elements/query: post: description: Query the DB for elements that match the query parameters. - operationId: post-sdwan-v2.7-api-elements-query + operationId: post-sdwan-v3.0-api-elements-query requestBody: content: application/json: @@ -10451,7 +11184,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementQueryFilterV2N7' + $ref: '#/components/schemas/ElementQueryFilterV3' type: array type: object description: Successful Operation @@ -10465,13 +11198,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Elements (v2.7) + summary: Query DB for Elements (v3.0) tags: - Device Configuration - /sdwan/v2.7/api/elements/{element_id}: + /sdwan/v3.0/api/elements/{element_id}: get: description: Get the element of a tenant. - operationId: get-sdwan-v2.7-api-elements-element_id + operationId: get-sdwan-v3.0-api-elements-element_id parameters: - description: The element ID. in: path @@ -10485,24 +11218,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementV2N7' + $ref: '#/components/schemas/ElementV3' description: Successful Operation '404': content: application/json: - example: - value: - _error: - - code: NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Not Found - summary: Get Element of Tenant (v2.7) + description: Element not found + summary: Get Element of Tenant (v3.0) tags: - Device Configuration put: description: Update element for associations. - operationId: put-sdwan-v2.7-api-elements-element_id + operationId: put-sdwan-v3.0-api-elements-element_id parameters: - description: The element ID. in: path @@ -10515,14 +11244,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV2N7' + $ref: '#/components/schemas/ElementScreenV3' description: Update to the element responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV2N7' + $ref: '#/components/schemas/ElementScreenV3' description: Successful Operation '400': content: @@ -10530,21 +11259,73 @@ paths: example: value: _error: - - code: BAD_JSON + - code: NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_NETWORK_POLICYSETSTACK_ID + - code: INVALID_PRIORITY_POLICYSETSTACK_ID + - code: INVALID_NAT_POLICYSETSTACK_ID + - code: INVALID_TAG - code: ELEMENT_NOT_FOUND - - code: ELEMENT_NOT_CLAIMED + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: GENERAL_CONFIG_ERROR + - code: ELEMENT_SITE_STACKED_SECURITY_POLICY_INCOMPATIBLE + - code: INVALID_OPERATION + - code: NO_DEFAULT_CLUSTER_DEFINED - code: SITE_NOT_FOUND + - code: L3_FORWARDING_SUPPORTED_BY_BRANCH_DEVICES + - code: POLICY_REQUIRED + - code: SPOKE_SITE_CLUSTER_ID_INVALID + - code: ELEMENT_CONFIG_INVALID_VALUES + - code: ELEMENT_CLUSTER_UPDATE_NOT_ALLOWED + - code: CLUSTER_ID_NOT_PRESENT + - code: CLUSTER_ID_INVALID + - code: CLUSTER_CAPACITY_FULL + - code: ELEMENT_SOFTWARE_NON_CG_SERVICE_LINK_NOT_SUPPORTED + - code: CLUSTER_ID_NOT_NULL + - code: ELEMENT_NOT_BOUND + - code: FIPS_MODE_PLEASE_RETRY_RECOVER_LATER + - code: ELEMENT_SPOKE_CLUSTER_MEMBER + - code: SITE_WAN_INTERFACE_ID_EXISTS - code: ELEMENT_BOUND_ERROR + - code: INVALID_CLUSTER_ID + - code: CLUSTER_ID_SHOULD_BE_NULL_FOR_SPOKE + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: ELEMENT_CONFIG_POLICY_FOR_HUB_NOT_ALLOWED + - code: ELEMENT_NAT_POLICY_SUPPORT_REQUIRED + - code: ELEMENT_CONFIG_NAT_POLICYSETSTACK_NOT_FOUND + - code: L3_FORWARDING_NOT_SUPPORTED_BY_ELEMENT + - code: ENABLE_L3_LAN_FORWARDING_NOT_ALLOWED + - code: DISABLE_L3_LAN_FORWARDING_NOT_ALLOWED_SECONDARY_IP_PRESENT + - code: DISABLE_L3_LAN_FORWARDING_NOT_ALLOWED_STATIC_ARP_PRESENT + - code: L3_LAN_FORWARDING_DISABLE_NOT_SUPPORTED_WHEN_MULTICAST_ENABLED_ON_INTERFACE + - code: ELEMENT_HA_CONFIG_NOT_SUPPORTED + - code: ELEMENT_INVALID_HA_CONFIG_SITE + - code: ELEMENT_HA_CONFIG_TRACK_WAN_INTERFACES_NOT_SUPPORTED + - code: ELEMENT_INVALID_HA_CONFIG_CLUSTER_ID + - code: ELEMENT_INVALID_HA_CONFIG_EXCEEDS_LIMIT + - code: ELEMENT_INVALID_HA_CONFIG_SOURCE_INTERFACE + - code: ELEMENT_INVALID_HA_CONFIG_SOURCE_INTERFACE_CELLULAR + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_INTERFACES + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_INTERFACE_BYPASSPAIR + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_INTERFACE_CELLULAR + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_WAN_INTERFACES + - code: DUPLICATE_HA_CONFIG_TRACK_WAN_INTERFACES + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_WAN_INTERFACES_BYPASSPAIR_PRIVATE_L2 + - code: ELEMENT_INVALID_HA_CONFIG_TRACK_WAN_INTERFACES_WITHOUT_PORT + - code: ELEMENT_VPN_TO_VPN_FORWARDING_NOT_SUPPORTED + - code: ELEMENT_INVALID_VPN_TO_VPN_FORWARDING_SITE + - code: ADVERTISEMENT_INTERVAL_LOWER_THAN_ONE_SEC_ERR schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Element for Associations (v2.7) + summary: Update Element for Associations (v3.0) tags: - Device Configuration - /sdwan/v3.0/api/elements: + /sdwan/v3.1/api/elements: get: description: Get the element of a tenant. - operationId: get-sdwan-v3.0-api-elements + operationId: get-sdwan-v3.1-api-elements responses: '200': content: @@ -10555,17 +11336,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementV3' + $ref: '#/components/schemas/ElementV3N1' type: array type: object description: Successful Operation - summary: Get Element of Tenant (v3.0) + summary: Get Element of Tenant (v3.1) tags: - Device Configuration - /sdwan/v3.0/api/elements/query: + /sdwan/v3.1/api/elements/query: post: description: Query the DB for elements that match the query parameters. - operationId: post-sdwan-v3.0-api-elements-query + operationId: post-sdwan-v3.1-api-elements-query requestBody: content: application/json: @@ -10582,7 +11363,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementQueryFilterV3' + $ref: '#/components/schemas/ElementQueryFilterV3N1' type: array type: object description: Successful Operation @@ -10596,13 +11377,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Elements (v3.0) + summary: Query DB for Elements (v3.1) tags: - Device Configuration - /sdwan/v3.0/api/elements/{element_id}: + /sdwan/v3.1/api/elements/{element_id}: get: description: Get the element of a tenant. - operationId: get-sdwan-v3.0-api-elements-element_id + operationId: get-sdwan-v3.1-api-elements-element_id parameters: - description: The element ID. in: path @@ -10616,7 +11397,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementV3' + $ref: '#/components/schemas/ElementV3N1' description: Successful Operation '404': content: @@ -10624,12 +11405,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Element not found - summary: Get Element of Tenant (v3.0) + summary: Get Element of Tenant (v3.1) tags: - Device Configuration put: description: Update element for associations. - operationId: put-sdwan-v3.0-api-elements-element_id + operationId: put-sdwan-v3.1-api-elements-element_id parameters: - description: The element ID. in: path @@ -10642,14 +11423,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV3' + $ref: '#/components/schemas/ElementScreenV3N1' description: Update to the element responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV3' + $ref: '#/components/schemas/ElementScreenV3N1' description: Successful Operation '400': content: @@ -10716,7 +11497,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Element for Associations (v3.0) + summary: Update Element for Associations (v3.1) tags: - Device Configuration /sdwan/v3.1/api/machines/rquery: @@ -10773,10 +11554,10 @@ paths: summary: Query MSP Machines across Regions (v3.2) tags: - Device Configuration - /sdwan/v3.4/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: + /sdwan/v3.5/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: get: description: Get interface status. - operationId: get-sdwan-v3.4-api-sites-site_id-elements-element_id-interfaces-interface_id-status + operationId: get-sdwan-v3.5-api-sites-site_id-elements-element_id-interfaces-interface_id-status parameters: - description: The site ID. in: path @@ -10804,15 +11585,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceStateV3N4' + $ref: '#/components/schemas/InterfaceStateV3N5' description: Successful Operation - summary: Get Interface Status (v3.4) + summary: Get Interface Status (v3.5) tags: - Device Configuration - /sdwan/v3.5/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: + /sdwan/v3.6/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: get: description: Get interface status. - operationId: get-sdwan-v3.5-api-sites-site_id-elements-element_id-interfaces-interface_id-status + operationId: get-sdwan-v3.6-api-sites-site_id-elements-element_id-interfaces-interface_id-status parameters: - description: The site ID. in: path @@ -10840,15 +11621,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceStateV3N5' + $ref: '#/components/schemas/InterfaceStateV3N6' description: Successful Operation - summary: Get Interface Status (v3.5) + summary: Get Interface Status (v3.6) tags: - Device Configuration - /sdwan/v4.14/api/interfaces/query: + /sdwan/v4.16/api/interfaces/query: post: - description: Query the DB for limit number of interfaces that match query params. - operationId: post-sdwan-v4.14-api-interfaces-query + description: Queries db for limit number of interfaces that match query params. + operationId: post-sdwan-v4.16-api-interfaces-query requestBody: content: application/json: @@ -10868,13 +11649,14 @@ paths: type: array type: object description: Successful Operation - summary: Query Interfaces (v4.14) + summary: Queries db for limit number of interfaces that match query params. + (v4.16) tags: - Device Configuration - /sdwan/v4.14/api/sites/{site_id}/elements/{element_id}/interfaces: + /sdwan/v4.16/api/sites/{site_id}/elements/{element_id}/interfaces: get: description: Get all cellular interfaces. - operationId: get-sdwan-v4.14-api-sites-site_id-elements-element_id-interfaces + operationId: get-sdwan-v4.16-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -10900,16 +11682,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/InterfaceV4N14' + $ref: '#/components/schemas/InterfaceV4N16' type: array type: object description: Successful Operation - summary: Get all Cellular Interfaces (v4.14) + summary: Get all Cellular Interfaces (v4.16) tags: - Device Configuration post: description: Create an interface. - operationId: post-sdwan-v4.14-api-sites-site_id-elements-element_id-interfaces + operationId: post-sdwan-v4.16-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -10929,13 +11711,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N14' + $ref: '#/components/schemas/InterfaceScreenV4N16' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N14' + $ref: '#/components/schemas/InterfaceV4N16' description: Successful Operation '400': content: @@ -10976,7 +11758,6 @@ paths: - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT @@ -10990,16 +11771,18 @@ paths: - code: INTERFACE_CONFIG_VLAN_INVALID_MAX_VLAN_COUNT_EXCEEDED - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_UNSUPPORTED_CHARACTERS - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_NOT_ACCESS_WHEN_AUTHMODE_PRESENT + - code: INTERFACE_CONFIG_IPV6_AUTOCONF_NOT_SUPPORTED_ON_DEVICE + - code: INTERFACE_CONFIG_IPV6_DHCP_NOT_SUPPORTED_ON_DEVICE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create an Interface (v4.14) + summary: Create an Interface (v4.16) tags: - Device Configuration - /sdwan/v4.14/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + /sdwan/v4.16/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: delete: description: Delete a cellular interface. - operationId: delete-sdwan-v4.14-api-sites-site_id-elements-element_id-interfaces-interface_id + operationId: delete-sdwan-v4.16-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -11027,7 +11810,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N14' + $ref: '#/components/schemas/InterfaceV4N16' description: Successful Operation '400': content: @@ -11042,12 +11825,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Cellular Interface (v4.14) + summary: Delete Cellular Interface (v4.16) tags: - Device Configuration get: description: Get a cellular interface. - operationId: get-sdwan-v4.14-api-sites-site_id-elements-element_id-interfaces-interface_id + operationId: get-sdwan-v4.16-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -11075,14 +11858,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N14' + $ref: '#/components/schemas/InterfaceV4N16' description: Successful Operation - summary: Get Cellular Interface (v4.14) + summary: Get Cellular Interface (v4.16) tags: - Device Configuration put: description: Update a cellular interface. - operationId: put-sdwan-v4.14-api-sites-site_id-elements-element_id-interfaces-interface_id + operationId: put-sdwan-v4.16-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -11109,13 +11892,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N14' + $ref: '#/components/schemas/InterfaceScreenV4N16' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N14' + $ref: '#/components/schemas/InterfaceV4N16' description: Successful Operation '400': content: @@ -11175,7 +11958,6 @@ paths: - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT @@ -11213,16 +11995,18 @@ paths: - code: INTERFACE_CONFIG_VLAN_INVALID_MAX_VLAN_COUNT_EXCEEDED - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_UNSUPPORTED_CHARACTERS - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_NOT_ACCESS_WHEN_AUTHMODE_PRESENT + - code: INTERFACE_CONFIG_IPV6_AUTOCONF_NOT_SUPPORTED_ON_DEVICE + - code: INTERFACE_CONFIG_IPV6_DHCP_NOT_SUPPORTED_ON_DEVICE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Cellular Interface (v4.14) + summary: Update Cellular Interface (v4.16) tags: - Device Configuration - /sdwan/v4.15/api/interfaces/query: + /sdwan/v4.17/api/interfaces/query: post: - description: Query the DB for limit number of interfaces that match query params. - operationId: post-sdwan-v4.15-api-interfaces-query + description: Queries db for limit number of interfaces that match query params. + operationId: post-sdwan-v4.17-api-interfaces-query requestBody: content: application/json: @@ -11242,13 +12026,14 @@ paths: type: array type: object description: Successful Operation - summary: Query Interfaces (v4.15) + summary: Queries db for limit number of interfaces that match query params. + (v4.17) tags: - Device Configuration - /sdwan/v4.15/api/sites/{site_id}/elements/{element_id}/interfaces: + /sdwan/v4.17/api/sites/{site_id}/elements/{element_id}/interfaces: get: description: Get all cellular interfaces. - operationId: get-sdwan-v4.15-api-sites-site_id-elements-element_id-interfaces + operationId: get-sdwan-v4.17-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -11274,16 +12059,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/InterfaceV4N15' + $ref: '#/components/schemas/InterfaceV4N17' type: array type: object description: Successful Operation - summary: Get all Cellular Interfaces (v4.15) + summary: Get all Cellular Interfaces (v4.17) tags: - Device Configuration post: description: Create an interface. - operationId: post-sdwan-v4.15-api-sites-site_id-elements-element_id-interfaces + operationId: post-sdwan-v4.17-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -11303,13 +12088,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N15' + $ref: '#/components/schemas/InterfaceScreenV4N17' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N15' + $ref: '#/components/schemas/InterfaceV4N17' description: Successful Operation '400': content: @@ -11350,7 +12135,6 @@ paths: - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT @@ -11366,16 +12150,18 @@ paths: - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_NOT_ACCESS_WHEN_AUTHMODE_PRESENT - code: INTERFACE_CONFIG_IPV6_AUTOCONF_NOT_SUPPORTED_ON_DEVICE - code: INTERFACE_CONFIG_IPV6_DHCP_NOT_SUPPORTED_ON_DEVICE + - code: INTERFACE_CONFIG_CONTROLLER_INTF_ALREADY_EXISTS + - code: INTERFACE_CONFIG_USED_FOR_CONTROLLER_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create an Interface (v4.15) + summary: Create an Interface (v4.17) tags: - Device Configuration - /sdwan/v4.15/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + /sdwan/v4.17/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: delete: description: Delete a cellular interface. - operationId: delete-sdwan-v4.15-api-sites-site_id-elements-element_id-interfaces-interface_id + operationId: delete-sdwan-v4.17-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -11403,7 +12189,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N15' + $ref: '#/components/schemas/InterfaceV4N17' description: Successful Operation '400': content: @@ -11418,12 +12204,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Cellular Interface (v4.15) + summary: Delete Cellular Interface (v4.17) tags: - Device Configuration get: description: Get a cellular interface. - operationId: get-sdwan-v4.15-api-sites-site_id-elements-element_id-interfaces-interface_id + operationId: get-sdwan-v4.17-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -11451,14 +12237,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N15' + $ref: '#/components/schemas/InterfaceV4N17' description: Successful Operation - summary: Get Cellular Interface (v4.15) + summary: Get Cellular Interface (v4.17) tags: - Device Configuration put: description: Update a cellular interface. - operationId: put-sdwan-v4.15-api-sites-site_id-elements-element_id-interfaces-interface_id + operationId: put-sdwan-v4.17-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -11485,13 +12271,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N15' + $ref: '#/components/schemas/InterfaceScreenV4N17' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N15' + $ref: '#/components/schemas/InterfaceV4N17' description: Successful Operation '400': content: @@ -11551,7 +12337,6 @@ paths: - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_INVALID_ELEMENT_ROLE - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT @@ -11591,10 +12376,12 @@ paths: - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_NOT_ACCESS_WHEN_AUTHMODE_PRESENT - code: INTERFACE_CONFIG_IPV6_AUTOCONF_NOT_SUPPORTED_ON_DEVICE - code: INTERFACE_CONFIG_IPV6_DHCP_NOT_SUPPORTED_ON_DEVICE + - code: INTERFACE_CONFIG_CONTROLLER_INTF_ALREADY_EXISTS + - code: INTERFACE_CONFIG_USED_FOR_CONTROLLER_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Cellular Interface (v4.15) + summary: Update Cellular Interface (v4.17) tags: - Device Configuration servers: diff --git a/openapi-specs/sdwan/unified/DeviceSwitchConfiguration.yaml b/openapi-specs/sdwan/unified/DeviceSwitchConfiguration.yaml index 6609fb064..62138102e 100644 --- a/openapi-specs/sdwan/unified/DeviceSwitchConfiguration.yaml +++ b/openapi-specs/sdwan/unified/DeviceSwitchConfiguration.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view ClientDetails: properties: aging_timeout: @@ -114,15 +108,6 @@ components: ' type: integer - required: - - stats_start_time_ms - - uptime - - reauth_timeout - - vlan_id - - username - - mac_address - - interface_id - - element_id ElementRadius: properties: description: @@ -450,13 +435,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string diff --git a/openapi-specs/sdwan/unified/EventPolicy.yaml b/openapi-specs/sdwan/unified/EventPolicy.yaml index 4de956a17..470be2d53 100644 --- a/openapi-specs/sdwan/unified/EventPolicy.yaml +++ b/openapi-specs/sdwan/unified/EventPolicy.yaml @@ -1,37 +1,5 @@ components: schemas: - Address: - properties: - city: - description: 'The name of the city. Max size = 100. - - ' - type: string - country: - description: 'The name of the country. Max size = 100. - - ' - type: string - post_code: - description: 'The postal code. Max size = 100. - - ' - type: string - state: - description: 'The name of the state. Max size = 100. - - ' - type: string - street: - description: 'The name of the street. Max size = 100. - - ' - type: string - street2: - description: 'The name of the street. Max size = 100. - - ' - type: string Aggregate: properties: data: @@ -68,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -81,477 +44,289 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view - AnynetLinkQuery: + Error: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of anynet links that match the query - parameters. + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + type: string + message: + type: string + EscalationRule: + properties: + flap_rule: + $ref: '#/components/schemas/FlapRule' + description: 'Resource flaps more than the rate specified during the defined + interval, then a new flap rate exceeded alarm is generated. ' - dest_page: - description: 'The destination page. + standing_rule: + $ref: '#/components/schemas/StandingRule' + description: 'Alarms standing for more than the specified period. ' - format: int32 - type: integer - getDeleted: - description: 'The number anynet links deleted for a time frame. + EventCorrelationPolicyRule: + properties: + description: + description: 'Description of the event correlation policy rules. ' - type: boolean - group_by: - description: Group By - items: - description: Group By - type: string - type: array - id: - description: "List the anynet links by ID. \n" - type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + enabled: + description: 'The enabled event correlation policy rules. ' - format: int64 - type: integer - limit: - description: 'The query limit. + type: boolean + end_time: + description: 'The end date in MM/DD/YYYY HH: mm format of the applied event + policy rule. ' - format: int32 + format: int64 type: integer - next_query: - description: 'The limit. - - ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + escalation_rules: + $ref: '#/components/schemas/EscalationRule' + description: 'The alarms which have their priority escalated based on standing + rule and flap rule. ' + event_codes: + description: "List all the event codes. \n" items: - description: Retrieved Fields + description: Event Codes + enum: + - DEVICEHW_POWER_LOST + - DEVICEHW_INTERFACE_DOWN + - DEVICEHW_INTERFACE_HALFDUPLEX + - DEVICEHW_INTERFACE_ERRORS + - DEVICEHW_DISKUTIL_PARTITIONSPACE + - DEVICEHW_DISKENC_SYSTEM + - DEVICEHW_MEMUTIL_SWAPSPACE + - DEVICESW_GENERAL_PROCESSRESTART + - DEVICESW_GENERAL_PROCESSSTOP + - DEVICESW_CRITICAL_PROCESSRESTART + - DEVICESW_CRITICAL_PROCESSSTOP + - DEVICESW_LICENSE_VERIFICATION_FAILED + - DEVICESW_MONITOR_DISABLED + - DEVICESW_SYSTEM_BOOT + - DEVICESW_TOKEN_VERIFICATION_FAILED + - DEVICESW_IMAGE_UNSUPPORTED + - DEVICESW_DHCPSERVER_RESTART + - DEVICESW_DHCPRELAY_RESTART + - DEVICESW_DHCPSERVER_ERRORS + - DEVICESW_SNMP_AGENT_RESTART + - DEVICESW_SNMP_AGENT_FAILED_TO_START + - DEVICESW_SYSLOGSERVERS_DOWN + - DEVICESW_NTP_NO_SYNC + - DEVICEIF_ADDRESS_DUPLICATE + - DEVICEIF_IPV6_ADDRESS_DUPLICATE + - NETWORK_VPNLINK_DOWN + - NETWORK_VPNPEER_UNAVAILABLE + - NETWORK_VPNPEER_UNREACHABLE + - NETWORK_VPNSS_MISMATCH + - NETWORK_VPNSS_UNAVAILABLE + - NETWORK_VPNBFD_DOWN + - NETWORK_VPNLINKCIPHERS_INCOMPATIBLE + - NETWORK_DIRECTPRIVATE_DOWN + - NETWORK_DIRECTINTERNET_DOWN + - NETWORK_PRIVATEWAN_UNREACHABLE + - NETWORK_PRIVATEWAN_DEGRADED + - PEERING_EDGE_DOWN + - PEERING_CORE_DOWN + - PEERING_BGP_DOWN + - APPLICATION_APP_UNREACHABLE + - APPLICATION_IP_COLLISION + - APPLICATION_UNKNOWNS_HIGH + - APPLICATION_FLOWCTRL_APPUNREACHABLE + - APPLICATION_FLOWCTRL_APPREACHABLE + - APPLICATION_FLOWCTRL_APPWITHINSLA + - APPLICATION_FLOWCTRL_APPOUTSIDESLA + - OPERATOR_SIGNUP_TOKEN_DISABLED + - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED + - SITE_CIRCUIT_ABSENT_FOR_POLICY + - NETWORK_POLICY_RULE_CONFLICT + - PRIORITY_POLICY_RULE_CONFLICT + - APPLICATION_CUSTOM_RULE_CONFLICT + - NETWORK_POLICY_RULE_DROPPED + - PRIORITY_POLICY_RULE_DROPPED + - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN + - SPOKEHA_STATE_UPDATE + - SPOKEHA_MULTIPLE_ACTIVE_DEVICES + - SPOKEHA_CLUSTER_DEGRADED + - SPOKEHA_CLUSTER_DOWN + - NAT_POLICY_LEGACY_ALG_CONFIG_OVERRIDE + - NAT_POLICY_STATIC_NATPOOL_OVERRUN + - DEVICESW_CONNTRACK_FLOWLIMIT_EXCEEDED + - DEVICESW_INITIATED_CONNECTION_ON_EXCLUDED_PATH + - NETWORK_ANYNETLINK_DEGRADED + - NETWORK_ANYNETLINK_DOWN + - CLAIMCERT_RENEWAL_RETRY_LIMIT_EXCEEDED + - CLAIMCERT_RENEWAL_FAILED + - CLAIMCERT_AUTO_RENEWAL_DISABLED + - CLAIMCERT_RENEWALS_TOO_FREQUENT + - FLAP_RATE_EXCEEDED + - DEVICESW_ANALYTICS_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_FLOWS_DISCONNECTED_FROM_CONTROLLER + - APPLICATION_PROBE_DISABLED + - SITE_CONNECTIVITY_DOWN + - NETWORK_STANDARD_VPN_ENDPOINT_DOWN + - SECURITY_POLICY_RULE_INCOMPLETE + - SITE_NETWORK_SERVICE_ABSENT_FOR_POLICY + - DEVICESW_IPFIX_COLLECTORS_DOWN + - SITE_CONNECTIVITY_DEGRADED + - CLAIMCERT_EXPIRY_WARNING + - DEVICE_CELLULAR_ROAMING + - DEVICE_CELLULAR_SIM_REMOVAL + - DEVICE_CELLULAR_SIM_SWITCHOVER + - DEVICE_CELLULAR_SIGNAL_STRENGTH_THRESH + - DEVICE_CELLULAR_INTERNAL_MODEM_ERROR + - DEVICE_CELLULAR_TECH_CHANGE + - DEVICE_CELLULAR_SIM_PIN_ERROR + - DEVICE_CELLULAR_SIM_PUK_NEEDED + - DEVICE_CELLULAR_MODEM_TEMP_HIGH + - DEVICE_CELLULAR_MTU_MISMATCH + - DEVICE_CELLULAR_MODEM_DETECTION_ERROR + - DEVICE_CELLULAR_SIM_SECURITY_ERROR + - DEVICE_CELLULAR_FIRMWARE_NOT_AVAILABLE + - DEVICEHW_ION9000X722FW_OUTOFDATE + - DEVICESW_APPDEF_SIGFILE_MISMATCH + - SECURITY_POLICY_LIMITS_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_LIMIT_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - VION_BANDWIDTH_LIMIT_EXCEEDED + - VION_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - SPN_BANDWIDTH_LIMIT_EXCEEDED + - SPN_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - DEVICE_POE_PORT_POWER_STATUS + - DEVICE_POE_PORT_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_FAULT + - DOT1X_RADIUS_SERVER_UNREACHABLE + - DOT1X_DYNAMIC_VLAN_NOT_CONFIGURED + - DOT1X_CLIENT_AUTH_FAIL + - HUB_CLUSTER_SITE_COUNT_THRESHOLD_EXCEEDED + - DEVICEHW_DISKUTIL_FRUSSD + - DEVICEHW_TEMPERATURE_SENSOR + - USER_ID_DIRECTORY_SYNC_FAILED + - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. + id: + description: 'ID of the event policy set. ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + type: string + name: + description: 'Name of the event policy set. Max 25 characters. ' - format: int64 - type: integer - AnynetLinkQueryFilter: - properties: - admin_up: - description: Admin Up - type: boolean - ep1_site_id: - description: Ep1 Site Id type: string - ep1_site_role: - description: Ep1 Site Role + priority: + description: 'Priority level set for the event policy rule. + + ' enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep1_wan_interface_id: - description: Ep1 Wan Interface Id - type: string - ep2_site_id: - description: Ep2 Site Id + - p1 + - p2 + - p3 + - p4 + - p5 + - none type: string - ep2_site_role: - description: Ep2 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep2_wan_interface_id: - description: Ep2 Wan Interface Id - type: string - events: - description: Events + resource_ids: + description: 'The resource IDs configured for a rule. Max 128 resources + can be configured in a rule. + + ' items: - $ref: '#/components/schemas/AnynetlinkEventState' + description: Resource Ids + type: string type: array - id: - description: Id - type: string - type: - description: Type + resource_type: + description: "The resource on which the event policy rule is applied. \n" enum: - - AUTO - - MANUAL - - AUTO_PRIVATE - - MANUAL_PRIVATE - - AUTO_SASE - type: string - vpn_events: - description: Vpn Events - items: - $ref: '#/components/schemas/VPNEndpointEventState' - type: array - AnynetLinkQueryFilterV2N1: - properties: - admin_up: - description: Admin Up - type: boolean - ep1_site_id: - description: Ep1 Site Id - type: string - ep1_site_role: - description: Ep1 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep1_wan_interface_id: - description: Ep1 Wan Interface Id - type: string - ep2_site_id: - description: Ep2 Site Id - type: string - ep2_site_role: - description: Ep2 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep2_wan_interface_id: - description: Ep2 Wan Interface Id - type: string - events: - description: Events - items: - $ref: '#/components/schemas/AnynetlinkEventStateV2N1' - type: array - id: - description: Id - type: string - type: - description: Type - enum: - - AUTO - - MANUAL - - AUTO_PRIVATE - - MANUAL_PRIVATE - - AUTO_SASE - type: string - vpn_events: - description: Vpn Events - items: - $ref: '#/components/schemas/VPNEndpointEventState' - type: array - AnynetlinkEvent: - properties: - admin_up: - description: Admin Up - type: boolean - ep1_site_id: - description: Ep1 Site Id - type: string - ep1_site_role: - description: Ep1 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep1_wan_interface_id: - description: Ep1 Wan Interface Id - type: string - ep2_site_id: - description: Ep2 Site Id - type: string - ep2_site_role: - description: Ep2 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep2_wan_interface_id: - description: Ep2 Wan Interface Id - type: string - events: - description: Events - items: - $ref: '#/components/schemas/AnynetlinkEventState' - type: array - id: - description: Id - type: string - type: - description: Type - enum: - - AUTO - - MANUAL - - AUTO_PRIVATE - - MANUAL_PRIVATE - - AUTO_SASE - type: string - vpn_events: - description: Vpn Events - items: - $ref: '#/components/schemas/VPNEndpointEventState' - type: array - AnynetlinkEventState: - properties: - error_vpnlinks: - description: Error Vpnlinks - items: - description: Error Vpnlinks - type: string - type: array - event_code: - description: Event Code - type: string - event_id: - description: Event Id - type: string - id: - description: Id - type: string - priority: - description: Priority - format: int32 - type: integer - site_ids: - description: Site Ids - items: - description: Site Ids - type: string - type: array - standing: - description: Standing - type: boolean - suppressed: - description: Suppressed - type: boolean - suppressed_info: - $ref: '#/components/schemas/SuppressedInfo' - description: Suppressed Info - timestamp: - description: Timestamp - format: int64 - type: integer - AnynetlinkEventStateV2N1: - properties: - error_vpnlinks: - description: Error Vpnlinks - items: - description: Error Vpnlinks - type: string - type: array - event_code: - description: Event Code - type: string - event_id: - description: Event Id - type: string - id: - description: Id - type: string - priority: - description: Priority - format: int32 - type: integer - site_ids: - description: Site Ids - items: - description: Site Ids - type: string - type: array - standing: - description: Standing - type: boolean - suppressed: - description: Suppressed - type: boolean - suppressed_info: - $ref: '#/components/schemas/SuppressedInfo' - description: Suppressed Info - timestamp: - description: Timestamp - format: int64 - type: integer - AnynetlinkEventV2N1: - properties: - admin_up: - description: Admin Up - type: boolean - ep1_site_id: - description: Ep1 Site Id - type: string - ep1_site_role: - description: Ep1 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep1_wan_interface_id: - description: Ep1 Wan Interface Id - type: string - ep2_site_id: - description: Ep2 Site Id - type: string - ep2_site_role: - description: Ep2 Site Role - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - ep2_wan_interface_id: - description: Ep2 Wan Interface Id - type: string - events: - description: Events - items: - $ref: '#/components/schemas/AnynetlinkEventStateV2N1' - type: array - id: - description: Id - type: string - type: - description: Type - enum: - - AUTO - - MANUAL - - AUTO_PRIVATE - - MANUAL_PRIVATE - - AUTO_SASE - type: string - vpn_events: - description: Vpn Events - items: - $ref: '#/components/schemas/VPNEndpointEventState' - type: array - BaseEventState: - properties: - event_code: - description: "The event code. \n" - type: string - event_id: - description: "The event ID. \n" - type: string - id: - description: Id + - site + - element + - anynetlink + - bgppeer + - interface + - waninterface + - wannetwork + - networkpolicyset + - prioritypolicyset + - natpolicyset + - securitypolicyset + - appdef + - serviceendpoint + - cellular_module + - user_id type: string - priority: - description: "The priority set for the event. \n" - format: int32 - type: integer - standing: - description: 'The standing event. True or False. - - ' - type: boolean - suppressed: - description: 'The events are suppressed. True or False. - - ' - type: boolean - suppressed_info: - $ref: '#/components/schemas/SuppressedInfo' - description: 'The information on the suppressed events. - - ' - timestamp: - description: 'The time stamp of the event. + start_time: + description: 'The start date in MM/DD/YYYY HH: mm format of the event policy + rule applied. ' format: int64 type: integer - ElementEvent: - properties: - events: - description: 'The details of the events occurred. - - ' - items: - $ref: '#/components/schemas/BaseEventState' - type: array - id: - description: 'The element ID. - - ' - type: string - name: - description: 'The name of the element. - - ' - type: string - role: - description: 'The element role. + sub_resource_type: + description: 'The sub-resource type to narrow down the match criteria to + more specific elements. ' enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN + - spoke + - hub + - public + - private type: string - spoke_cluster_status: - description: 'The spoke cluster status. - - ' + suppress: + description: "The sub-resource type to narrow down the match criteria to\ + \ more specific elements.The event policy rule which suppresses or unsuppress\ + \ the alarms on the resources identified by the resource type, sub-resource\ + \ type, or matched event codes during the specified schedule. \ + \ \n" enum: - - init - - active - - backup - - unknown + - 'yes' + - 'no' + - none type: string - ElementQuery: + tags: + description: "A information field that can be added to identify the event\ + \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ + \ are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - priority + - suppress + - name + EventCorrelationPolicyRuleQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of elements that match the query parameters. + description: 'The aggregate number of queried rules. ' dest_page: @@ -561,20 +336,18 @@ components: format: int32 type: integer getDeleted: - description: 'The number of elements deleted for a time frame. + description: 'The number of queried rules deleted for a time frame. ' type: boolean group_by: - description: 'Group the elements for the query. - - ' + description: Group By items: description: Group By type: string type: array id: - description: "List the element by ID. \n" + description: "List the event state by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -594,9 +367,6 @@ components: ' type: object query_params: - description: 'Query using query parameters. - - ' type: object retrieved_fields: description: 'Retrieve information from a field. @@ -612,10 +382,6 @@ components: ' type: boolean sort_params: - description: 'Specify the order in which you want the search criteria to - display. - - ' type: object total_count: description: 'The total number of query parameters. @@ -623,185 +389,7 @@ components: ' format: int64 type: integer - ElementQueryFilter: - properties: - admin_action: - description: "The values of admin actions that can be performed. \n" - enum: - - ALLOCATE - - CLAIM - - BOUND - - UNBOUND - - DECLAIM - - RETURN - - REVOKE - - RETIRE - - STOCK - - UPGRADE - - REMANUFACTURE - - DEFAULT - - INVALID - type: string - allowed_roles: - description: "The allowed roles. \n" - items: - description: Allowed Roles - enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - - PA_WE_DC - - PA_CONN - type: string - type: array - cluster_insertion_mode: - description: "The cluster insertion mode. \n" - type: string - cluster_member_id: - description: 'The cluster member ID. - - ' - type: string - connected: - description: 'The device is connected. True or False. - - ' - type: boolean - deployment_op: - description: 'The deployment values. - - ' - enum: - - DECLAIM - - UPGRADE - - ABORT_UPGRADE - - DEFAULT - - INVALID - - REBIND - - READY - - IN_SERVICE - - REUNBIND - - RENEW_CIC - - ABORT_CELLULARMODULE_FIRMWARE_UPGRADE - - FIPS_AUTO - - NON_FIPS_AUTO - - FIPS_MANUAL - - NON_FIPS_MANUAL - - GET_MAC_ADDRESS_TABLE - type: string - description: - description: 'The description of the element filter. - - ' - events: - description: 'The details of the events occurred. - - ' - items: - $ref: '#/components/schemas/BaseEventState' - type: array - hw_id: - description: "The hardware ID. \n" - type: string - id: - description: Id - type: string - model_name: - description: "The model name of the device. \n" - type: string - name: - description: 'The name of the device. - - ' - type: string - role: - description: 'The element role. - - ' - enum: - - PA_WE_DC - - PA_WE_BR - - NONE - - PA_CONN - - SPOKE - - HUB - type: string - serial_number: - description: 'The serial number. - - ' - type: string - site_id: - description: 'The site ID. - - ' - type: string - software_version: - description: 'The software version. - - ' - type: string - spoke_cluster_status: - description: 'The spoke cluster status. - - ' - enum: - - init - - active - - backup - - unknown - type: string - state: - description: 'The element state. - - ' - enum: - - ACTIVE_INIT - - ACTIVE_INVENTORY_IN_PROGRESS - - ACTIVE_INVENTORY_OPERATION_FAILED - - ACTIVE_INVENTORY_GET_PENDING - - ACTIVE_INVENTORY_GET_COMPLETE - - ACTIVE_INVENTORY_POST_PENDING - - ACTIVE_INTF_CONFIG_GET_FAILED - - ACTIVE_INTF_STATE_GET_FAILED - - ACTIVE_READY - - ACTIVE_BOUND_IN_PROGRESS - - ACTIVE_UNBOUND_IN_PROGRESS - - ACTIVE_UNBOUND_FROM_SITE_FAILED - - ACTIVE_BOUND_TO_SITE - - ACTIVE_BOUND_TO_SITE_FAILED - - OOS - - ACTIVE_DECLAIM_IN_PROGRESS - type: string - required: - - site_id - Error: - properties: - _error: - items: - $ref: '#/components/schemas/ErrorResponse' - type: array - ErrorResponse: - properties: - code: - type: string - message: - type: string - EscalationRule: - properties: - flap_rule: - $ref: '#/components/schemas/FlapRule' - description: 'Resource flaps more than the rate specified during the defined - interval, then a new flap rate exceeded alarm is generated. - - ' - standing_rule: - $ref: '#/components/schemas/StandingRule' - description: 'Alarms standing for more than the specified period. - - ' - EventCorrelationPolicyRule: + EventCorrelationPolicyRuleQueryFilter: properties: description: description: 'Description of the event correlation policy rules. @@ -878,6 +466,7 @@ components: - APPLICATION_FLOWCTRL_APPOUTSIDESLA - OPERATOR_SIGNUP_TOKEN_DISABLED - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED - SITE_CIRCUIT_ABSENT_FOR_POLICY - NETWORK_POLICY_RULE_CONFLICT @@ -886,6 +475,7 @@ components: - NETWORK_POLICY_RULE_DROPPED - PRIORITY_POLICY_RULE_DROPPED - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN - SPOKEHA_STATE_UPDATE - SPOKEHA_MULTIPLE_ACTIVE_DEVICES - SPOKEHA_CLUSTER_DEGRADED @@ -945,6 +535,16 @@ components: - DEVICEHW_TEMPERATURE_SENSOR - USER_ID_DIRECTORY_SYNC_FAILED - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST type: string type: array id: @@ -955,6 +555,11 @@ components: name: description: 'Name of the event policy set. Max 25 characters. + ' + type: string + policyset_id: + description: 'The ID for the event policy set. + ' type: string priority: @@ -987,6 +592,7 @@ components: - bgppeer - interface - waninterface + - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -1028,7 +634,7 @@ components: tags: description: "A information field that can be added to identify the event\ \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ - \ are allowed. \n" + \ are allowed. \n" items: description: Tags type: string @@ -1037,75 +643,14 @@ components: - priority - suppress - name - EventCorrelationPolicyRuleQuery: + EventCorrelationPolicyRuleQueryFilterV2N1: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queried rules. + dampening_duration: + description: 'Dampening duration cannot be less than 5 minutes. Dampening + for duration cannot be more than 10080 minutes(a week). ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of queried rules deleted for a time frame. - - ' - type: boolean - group_by: - description: Group By - items: - description: Group By - type: string - type: array - id: - description: "List the event state by ID. \n" - type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. - - ' - format: int64 - type: integer - limit: - description: 'The query limit. - - ' - format: int32 - type: integer - next_query: - description: 'The limit. - - ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. - - ' - items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. - - ' - format: int64 type: integer - EventCorrelationPolicyRuleQueryFilter: - properties: description: description: 'Description of the event correlation policy rules. @@ -1181,6 +726,7 @@ components: - APPLICATION_FLOWCTRL_APPOUTSIDESLA - OPERATOR_SIGNUP_TOKEN_DISABLED - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED - SITE_CIRCUIT_ABSENT_FOR_POLICY - NETWORK_POLICY_RULE_CONFLICT @@ -1189,6 +735,7 @@ components: - NETWORK_POLICY_RULE_DROPPED - PRIORITY_POLICY_RULE_DROPPED - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN - SPOKEHA_STATE_UPDATE - SPOKEHA_MULTIPLE_ACTIVE_DEVICES - SPOKEHA_CLUSTER_DEGRADED @@ -1248,6 +795,16 @@ components: - DEVICEHW_TEMPERATURE_SENSOR - USER_ID_DIRECTORY_SYNC_FAILED - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST type: string type: array id: @@ -1295,6 +852,7 @@ components: - bgppeer - interface - waninterface + - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -1334,9 +892,11 @@ components: - none type: string tags: - description: "A information field that can be added to identify the event\ - \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ - \ are allowed. \n" + description: 'A information field that can be added to identify the event + correlation policy rule. Maximum 10 unique tags of length 1024 each are + allowed. + + ' items: description: Tags type: string @@ -1345,6 +905,73 @@ components: - priority - suppress - name + EventCorrelationPolicyRuleQueryV2N1: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of queried rules. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of queried rules deleted for a time frame. + + ' + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the event state by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer EventCorrelationPolicyRuleScreen: properties: description: @@ -1422,6 +1049,7 @@ components: - APPLICATION_FLOWCTRL_APPOUTSIDESLA - OPERATOR_SIGNUP_TOKEN_DISABLED - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED - SITE_CIRCUIT_ABSENT_FOR_POLICY - NETWORK_POLICY_RULE_CONFLICT @@ -1430,6 +1058,7 @@ components: - NETWORK_POLICY_RULE_DROPPED - PRIORITY_POLICY_RULE_DROPPED - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN - SPOKEHA_STATE_UPDATE - SPOKEHA_MULTIPLE_ACTIVE_DEVICES - SPOKEHA_CLUSTER_DEGRADED @@ -1489,6 +1118,16 @@ components: - DEVICEHW_TEMPERATURE_SENSOR - USER_ID_DIRECTORY_SYNC_FAILED - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST type: string type: array id: @@ -1531,6 +1170,7 @@ components: - bgppeer - interface - waninterface + - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -1581,546 +1221,439 @@ components: - priority - suppress - name - EventCorrelationPolicySet: + EventCorrelationPolicyRuleScreenV2N1: properties: - active_policyset: - description: 'Event policy sets set to active. - - ' - type: boolean - clone_from: - description: 'Policy sets cloned from existing policy sets. + dampening_duration: + description: 'Dampening duration cannot be less than 5 minutes. Dampening + for duration cannot be more than 10080 minutes(a week). ' - type: string + type: integer description: - description: 'Description of the event policy set. - - ' - id: - description: 'ID of the event policy set. - - ' - type: string - name: - description: "Name of the event policy set. Max 25 characters. \n" - type: string - policyrule_order: - description: 'The order for the execution of the policy rule. - - ' - items: - description: Policyrule Order - type: string - type: array - severity_priority_mapping: - description: 'Mapping of the priority and severity levels. - - ' - items: - $ref: '#/components/schemas/SeverityPriorityMapping' - type: array - tags: - description: "A information field that can be added to identify the event\ - \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ - \ are allowed. \n" - items: - description: Tags - type: string - type: array - required: - - name - EventCorrelationPolicySetQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queried rules. - - ' - dest_page: - description: 'The destination page. + description: 'Description of the event correlation policy rules. ' - format: int32 - type: integer - getDeleted: - description: 'The number of queried rules deleted for a time frame. + enabled: + description: 'The enabled event correlation policy rules. ' type: boolean - group_by: - description: Group By - items: - description: Group By - type: string - type: array - id: - description: "List the event state by ID. \n" - type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + end_time: + description: 'The end date in MM/DD/YYYY HH: mm format of the applied event + policy rule. ' format: int64 type: integer - limit: - description: 'The query limit. - - ' - format: int32 - type: integer - next_query: - description: 'The limit. - - ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + escalation_rules: + $ref: '#/components/schemas/EscalationRule' + description: 'The alarms which have their priority escalated based on standing + rule and flap rule. ' + event_codes: + description: "List all the event codes. \n" items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. - - ' - format: int64 - type: integer - EventCorrelationPolicySetQueryFilter: - properties: - active_policyset: - description: 'Event policy sets set to active. - - ' - type: boolean - clone_from: - description: 'Policy sets cloned from existing policy sets. - - ' - type: string - description: - description: 'Description of the event policy set. - - ' - id: - description: 'ID of the event policy set. - - ' - type: string - name: - description: "Name of the event policy set. Max 25 characters. \n" - type: string - policyrule_order: - description: 'The order for the execution of the policy rule. - - ' - items: - description: Policyrule Order - type: string - type: array - severity_priority_mapping: - description: 'Mapping of the priority and severity levels. - - ' - items: - $ref: '#/components/schemas/SeverityPriorityMapping' - type: array - tags: - description: "A information field that can be added to identify the event\ - \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ - \ are allowed. \n" - items: - description: Tags + description: Event Codes + enum: + - DEVICEHW_POWER_LOST + - DEVICEHW_INTERFACE_DOWN + - DEVICEHW_INTERFACE_HALFDUPLEX + - DEVICEHW_INTERFACE_ERRORS + - DEVICEHW_DISKUTIL_PARTITIONSPACE + - DEVICEHW_DISKENC_SYSTEM + - DEVICEHW_MEMUTIL_SWAPSPACE + - DEVICESW_GENERAL_PROCESSRESTART + - DEVICESW_GENERAL_PROCESSSTOP + - DEVICESW_CRITICAL_PROCESSRESTART + - DEVICESW_CRITICAL_PROCESSSTOP + - DEVICESW_LICENSE_VERIFICATION_FAILED + - DEVICESW_MONITOR_DISABLED + - DEVICESW_SYSTEM_BOOT + - DEVICESW_TOKEN_VERIFICATION_FAILED + - DEVICESW_IMAGE_UNSUPPORTED + - DEVICESW_DHCPSERVER_RESTART + - DEVICESW_DHCPRELAY_RESTART + - DEVICESW_DHCPSERVER_ERRORS + - DEVICESW_SNMP_AGENT_RESTART + - DEVICESW_SNMP_AGENT_FAILED_TO_START + - DEVICESW_SYSLOGSERVERS_DOWN + - DEVICESW_NTP_NO_SYNC + - DEVICEIF_ADDRESS_DUPLICATE + - DEVICEIF_IPV6_ADDRESS_DUPLICATE + - NETWORK_VPNLINK_DOWN + - NETWORK_VPNPEER_UNAVAILABLE + - NETWORK_VPNPEER_UNREACHABLE + - NETWORK_VPNSS_MISMATCH + - NETWORK_VPNSS_UNAVAILABLE + - NETWORK_VPNBFD_DOWN + - NETWORK_VPNLINKCIPHERS_INCOMPATIBLE + - NETWORK_DIRECTPRIVATE_DOWN + - NETWORK_DIRECTINTERNET_DOWN + - NETWORK_PRIVATEWAN_UNREACHABLE + - NETWORK_PRIVATEWAN_DEGRADED + - PEERING_EDGE_DOWN + - PEERING_CORE_DOWN + - PEERING_BGP_DOWN + - APPLICATION_APP_UNREACHABLE + - APPLICATION_IP_COLLISION + - APPLICATION_UNKNOWNS_HIGH + - APPLICATION_FLOWCTRL_APPUNREACHABLE + - APPLICATION_FLOWCTRL_APPREACHABLE + - APPLICATION_FLOWCTRL_APPWITHINSLA + - APPLICATION_FLOWCTRL_APPOUTSIDESLA + - OPERATOR_SIGNUP_TOKEN_DISABLED + - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED + - SITE_CIRCUIT_ABSENT_FOR_POLICY + - NETWORK_POLICY_RULE_CONFLICT + - PRIORITY_POLICY_RULE_CONFLICT + - APPLICATION_CUSTOM_RULE_CONFLICT + - NETWORK_POLICY_RULE_DROPPED + - PRIORITY_POLICY_RULE_DROPPED + - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN + - SPOKEHA_STATE_UPDATE + - SPOKEHA_MULTIPLE_ACTIVE_DEVICES + - SPOKEHA_CLUSTER_DEGRADED + - SPOKEHA_CLUSTER_DOWN + - NAT_POLICY_LEGACY_ALG_CONFIG_OVERRIDE + - NAT_POLICY_STATIC_NATPOOL_OVERRUN + - DEVICESW_CONNTRACK_FLOWLIMIT_EXCEEDED + - DEVICESW_INITIATED_CONNECTION_ON_EXCLUDED_PATH + - NETWORK_ANYNETLINK_DEGRADED + - NETWORK_ANYNETLINK_DOWN + - CLAIMCERT_RENEWAL_RETRY_LIMIT_EXCEEDED + - CLAIMCERT_RENEWAL_FAILED + - CLAIMCERT_AUTO_RENEWAL_DISABLED + - CLAIMCERT_RENEWALS_TOO_FREQUENT + - FLAP_RATE_EXCEEDED + - DEVICESW_ANALYTICS_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_FLOWS_DISCONNECTED_FROM_CONTROLLER + - APPLICATION_PROBE_DISABLED + - SITE_CONNECTIVITY_DOWN + - NETWORK_STANDARD_VPN_ENDPOINT_DOWN + - SECURITY_POLICY_RULE_INCOMPLETE + - SITE_NETWORK_SERVICE_ABSENT_FOR_POLICY + - DEVICESW_IPFIX_COLLECTORS_DOWN + - SITE_CONNECTIVITY_DEGRADED + - CLAIMCERT_EXPIRY_WARNING + - DEVICE_CELLULAR_ROAMING + - DEVICE_CELLULAR_SIM_REMOVAL + - DEVICE_CELLULAR_SIM_SWITCHOVER + - DEVICE_CELLULAR_SIGNAL_STRENGTH_THRESH + - DEVICE_CELLULAR_INTERNAL_MODEM_ERROR + - DEVICE_CELLULAR_TECH_CHANGE + - DEVICE_CELLULAR_SIM_PIN_ERROR + - DEVICE_CELLULAR_SIM_PUK_NEEDED + - DEVICE_CELLULAR_MODEM_TEMP_HIGH + - DEVICE_CELLULAR_MTU_MISMATCH + - DEVICE_CELLULAR_MODEM_DETECTION_ERROR + - DEVICE_CELLULAR_SIM_SECURITY_ERROR + - DEVICE_CELLULAR_FIRMWARE_NOT_AVAILABLE + - DEVICEHW_ION9000X722FW_OUTOFDATE + - DEVICESW_APPDEF_SIGFILE_MISMATCH + - SECURITY_POLICY_LIMITS_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_LIMIT_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - VION_BANDWIDTH_LIMIT_EXCEEDED + - VION_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - SPN_BANDWIDTH_LIMIT_EXCEEDED + - SPN_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - DEVICE_POE_PORT_POWER_STATUS + - DEVICE_POE_PORT_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_FAULT + - DOT1X_RADIUS_SERVER_UNREACHABLE + - DOT1X_DYNAMIC_VLAN_NOT_CONFIGURED + - DOT1X_CLIENT_AUTH_FAIL + - HUB_CLUSTER_SITE_COUNT_THRESHOLD_EXCEEDED + - DEVICEHW_DISKUTIL_FRUSSD + - DEVICEHW_TEMPERATURE_SENSOR + - USER_ID_DIRECTORY_SYNC_FAILED + - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST type: string type: array - required: - - name - EventCorrelationPolicySetScreen: - properties: - active_policyset: - description: 'Event policy sets set to active. - - ' - type: boolean - clone_from: - description: 'Policy sets cloned from existing policy sets. - - ' - type: string - description: - description: 'Description of the event policy set. - - ' id: description: 'ID of the event policy set. ' type: string name: - description: "Name of the event policy set. Max 25 characters. \n" - type: string - policyrule_order: - description: 'The order for the execution of the policy rule. - - ' - items: - description: Policyrule Order - type: string - type: array - severity_priority_mapping: - description: 'Mapping of the priority and severity levels. - - ' - items: - $ref: '#/components/schemas/SeverityPriorityMapping' - type: array - tags: - description: "A information field that can be added to identify the event\ - \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ - \ are allowed. \n" - items: - description: Tags - type: string - type: array - required: - - severity_priority_mapping - - name - FlapRule: - properties: - flap_duration: - description: 'Flap duration cannot be less than 5 minutes and more than - 10080 minutes (a week). - - ' - type: integer - flap_rate: - description: 'Flap count cannot be lower than 2 nor higher than 512. - - ' - type: integer - InterfaceEvent: - properties: - admin_up: - description: 'The interface admin state. - - ' - type: boolean - bound_interfaces: - description: 'The bound interfaces. - - ' - items: - description: Bound Interfaces - type: string - type: array - element_id: - description: 'The element ID. - - ' - type: string - events: - description: 'The details of the events occurred. - - ' - items: - $ref: '#/components/schemas/BaseEventState' - type: array - id: - description: "The interface ID. \n" - type: string - ipv4_addresses: - description: 'The IPv4 addresses configured for the interface. - - ' - items: - description: Ipv4 Addresses - type: string - type: array - name: - description: 'The name of the interface. - - ' - type: string - parent: - description: 'The parent interface. + description: 'Name of the event policy set. Max 25 characters. ' type: string - site_wan_interface_ids: - description: 'The site WAN interface IDs. - - ' - items: - description: Site Wan Interface Ids - type: string - type: array - type: - description: 'The interface type. + priority: + description: 'Priority level set for the event policy rule. ' enum: - - SERVICE_LINK - - LOOPBACK - - BYPASSPAIR - - SUBINTERFACE - - PPPOE - - PORTCHANNEL - - PORT - - VIRTUAL_INTERFACE - - CELLULAR + - p1 + - p2 + - p3 + - p4 + - p5 + - none type: string - used_for: - description: 'The value of where the interface is used. - - ' - enum: - - NONE - - PUBLIC - - PRIVATE - - LAN - - PRIVATE_L2 - - PRIVATE_WAN - type: string - InterfaceQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of interfaces that match the query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number interfaces deleted for a time frame. + resource_ids: + description: 'The resource IDs configured for a rule. Max 128 resources + can be configured in a rule. ' - type: boolean - group_by: - description: Group By items: - description: Group By + description: Resource Ids type: string type: array - id: - description: "List the interfaces by ID. \n" + resource_type: + description: "The resource on which the event policy rule is applied. \n" + enum: + - site + - element + - anynetlink + - bgppeer + - interface + - waninterface + - wannetwork + - networkpolicyset + - prioritypolicyset + - natpolicyset + - securitypolicyset + - appdef + - serviceendpoint + - cellular_module + - user_id type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. - - ' - format: int64 - type: integer - limit: - description: 'The query limit. - - ' - format: int32 - type: integer - next_query: - description: 'The limit. - - ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. - - ' - items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + start_time: + description: 'The start date in MM/DD/YYYY HH: mm format of the event policy + rule applied. ' format: int64 type: integer - InterfaceQueryFilter: - properties: - admin_up: - description: 'The interface admin state. - - ' - type: boolean - bound_interfaces: - description: 'The bound interfaces. - - ' - items: - description: Bound Interfaces - type: string - type: array - element_id: - description: 'The element ID. - - ' - type: string - events: - description: 'The details of the events occurred. - - ' - items: - $ref: '#/components/schemas/BaseEventState' - type: array - id: - description: "The interface ID. \n" - type: string - ipv4_addresses: - description: 'The IPv4 addresses configured for the interface. - - ' - items: - description: Ipv4 Addresses - type: string - type: array - name: - description: 'The name of the interface. - - ' - type: string - parent: - description: 'The parent interface. - - ' - type: string - site_wan_interface_ids: - description: 'The site WAN interface IDs. - - ' - items: - description: Site Wan Interface Ids - type: string - type: array - type: - description: 'The interface type. + sub_resource_type: + description: 'The sub-resource type to narrow down the match criteria to + more specific elements. ' enum: - - SERVICE_LINK - - LOOPBACK - - BYPASSPAIR - - SUBINTERFACE - - PPPOE - - PORTCHANNEL - - PORT - - VIRTUAL_INTERFACE - - CELLULAR + - spoke + - hub + - public + - private type: string - used_for: - description: 'The value of where the interface is used. - - ' + suppress: + description: "The sub-resource type to narrow down the match criteria to\ + \ more specific elements.The event policy rule which suppresses or unsuppress\ + \ the alarms on the resources identified by the resource type, sub-resource\ + \ type, or matched event codes during the specified schedule. \ + \ \n" enum: - - NONE - - PUBLIC - - PRIVATE - - LAN - - PRIVATE_L2 - - PRIVATE_WAN + - 'yes' + - 'no' + - none type: string - ListQueryResponse: - properties: - count: - description: 'The count of the query list. - - ' - format: int32 - type: integer - deleted_count: - description: 'The deleted number of queries. - - ' - format: int64 - type: integer - deleted_ids: - description: 'The deleted query IDs. + tags: + description: 'A information field that can be added to identify the event + correlation policy rule. Maximum 10 unique tags of length 1024 each are + allowed. ' items: + description: Tags type: string type: array - description: - description: 'Description of the query. Max size = 256. + required: + - priority + - suppress + - name + EventCorrelationPolicyRuleV2N1: + properties: + dampening_duration: + description: 'Dampening duration cannot be less than 5 minutes. Dampening + for duration cannot be more than 10080 minutes(a week). ' - id: - description: 'The ID. + type: integer + description: + description: 'Description of the event correlation policy rules. ' - type: string - next_query: - description: 'Details of the next query. + enabled: + description: 'The enabled event correlation policy rules. ' - type: object - total_count: - description: 'Total number of queries. + type: boolean + end_time: + description: 'The end date in MM/DD/YYYY HH: mm format of the applied event + policy rule. ' format: int64 type: integer - type: object - ListResponse: - properties: - count: - description: 'The number of responses. + escalation_rules: + $ref: '#/components/schemas/EscalationRule' + description: 'The alarms which have their priority escalated based on standing + rule and flap rule. ' - format: int32 - type: integer + event_codes: + description: "List all the event codes. \n" + items: + description: Event Codes + enum: + - DEVICEHW_POWER_LOST + - DEVICEHW_INTERFACE_DOWN + - DEVICEHW_INTERFACE_HALFDUPLEX + - DEVICEHW_INTERFACE_ERRORS + - DEVICEHW_DISKUTIL_PARTITIONSPACE + - DEVICEHW_DISKENC_SYSTEM + - DEVICEHW_MEMUTIL_SWAPSPACE + - DEVICESW_GENERAL_PROCESSRESTART + - DEVICESW_GENERAL_PROCESSSTOP + - DEVICESW_CRITICAL_PROCESSRESTART + - DEVICESW_CRITICAL_PROCESSSTOP + - DEVICESW_LICENSE_VERIFICATION_FAILED + - DEVICESW_MONITOR_DISABLED + - DEVICESW_SYSTEM_BOOT + - DEVICESW_TOKEN_VERIFICATION_FAILED + - DEVICESW_IMAGE_UNSUPPORTED + - DEVICESW_DHCPSERVER_RESTART + - DEVICESW_DHCPRELAY_RESTART + - DEVICESW_DHCPSERVER_ERRORS + - DEVICESW_SNMP_AGENT_RESTART + - DEVICESW_SNMP_AGENT_FAILED_TO_START + - DEVICESW_SYSLOGSERVERS_DOWN + - DEVICESW_NTP_NO_SYNC + - DEVICEIF_ADDRESS_DUPLICATE + - DEVICEIF_IPV6_ADDRESS_DUPLICATE + - NETWORK_VPNLINK_DOWN + - NETWORK_VPNPEER_UNAVAILABLE + - NETWORK_VPNPEER_UNREACHABLE + - NETWORK_VPNSS_MISMATCH + - NETWORK_VPNSS_UNAVAILABLE + - NETWORK_VPNBFD_DOWN + - NETWORK_VPNLINKCIPHERS_INCOMPATIBLE + - NETWORK_DIRECTPRIVATE_DOWN + - NETWORK_DIRECTINTERNET_DOWN + - NETWORK_PRIVATEWAN_UNREACHABLE + - NETWORK_PRIVATEWAN_DEGRADED + - PEERING_EDGE_DOWN + - PEERING_CORE_DOWN + - PEERING_BGP_DOWN + - APPLICATION_APP_UNREACHABLE + - APPLICATION_IP_COLLISION + - APPLICATION_UNKNOWNS_HIGH + - APPLICATION_FLOWCTRL_APPUNREACHABLE + - APPLICATION_FLOWCTRL_APPREACHABLE + - APPLICATION_FLOWCTRL_APPWITHINSLA + - APPLICATION_FLOWCTRL_APPOUTSIDESLA + - OPERATOR_SIGNUP_TOKEN_DISABLED + - DEVICESW_FPS_LIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOW_SOFTLIMIT_EXCEEDED + - DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED + - SITE_CIRCUIT_ABSENT_FOR_POLICY + - NETWORK_POLICY_RULE_CONFLICT + - PRIORITY_POLICY_RULE_CONFLICT + - APPLICATION_CUSTOM_RULE_CONFLICT + - NETWORK_POLICY_RULE_DROPPED + - PRIORITY_POLICY_RULE_DROPPED + - DEVICESW_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_USERIDAGENTS_DOWN + - SPOKEHA_STATE_UPDATE + - SPOKEHA_MULTIPLE_ACTIVE_DEVICES + - SPOKEHA_CLUSTER_DEGRADED + - SPOKEHA_CLUSTER_DOWN + - NAT_POLICY_LEGACY_ALG_CONFIG_OVERRIDE + - NAT_POLICY_STATIC_NATPOOL_OVERRUN + - DEVICESW_CONNTRACK_FLOWLIMIT_EXCEEDED + - DEVICESW_INITIATED_CONNECTION_ON_EXCLUDED_PATH + - NETWORK_ANYNETLINK_DEGRADED + - NETWORK_ANYNETLINK_DOWN + - CLAIMCERT_RENEWAL_RETRY_LIMIT_EXCEEDED + - CLAIMCERT_RENEWAL_FAILED + - CLAIMCERT_AUTO_RENEWAL_DISABLED + - CLAIMCERT_RENEWALS_TOO_FREQUENT + - FLAP_RATE_EXCEEDED + - DEVICESW_ANALYTICS_DISCONNECTED_FROM_CONTROLLER + - DEVICESW_FLOWS_DISCONNECTED_FROM_CONTROLLER + - APPLICATION_PROBE_DISABLED + - SITE_CONNECTIVITY_DOWN + - NETWORK_STANDARD_VPN_ENDPOINT_DOWN + - SECURITY_POLICY_RULE_INCOMPLETE + - SITE_NETWORK_SERVICE_ABSENT_FOR_POLICY + - DEVICESW_IPFIX_COLLECTORS_DOWN + - SITE_CONNECTIVITY_DEGRADED + - CLAIMCERT_EXPIRY_WARNING + - DEVICE_CELLULAR_ROAMING + - DEVICE_CELLULAR_SIM_REMOVAL + - DEVICE_CELLULAR_SIM_SWITCHOVER + - DEVICE_CELLULAR_SIGNAL_STRENGTH_THRESH + - DEVICE_CELLULAR_INTERNAL_MODEM_ERROR + - DEVICE_CELLULAR_TECH_CHANGE + - DEVICE_CELLULAR_SIM_PIN_ERROR + - DEVICE_CELLULAR_SIM_PUK_NEEDED + - DEVICE_CELLULAR_MODEM_TEMP_HIGH + - DEVICE_CELLULAR_MTU_MISMATCH + - DEVICE_CELLULAR_MODEM_DETECTION_ERROR + - DEVICE_CELLULAR_SIM_SECURITY_ERROR + - DEVICE_CELLULAR_FIRMWARE_NOT_AVAILABLE + - DEVICEHW_ION9000X722FW_OUTOFDATE + - DEVICESW_APPDEF_SIGFILE_MISMATCH + - SECURITY_POLICY_LIMITS_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_LIMIT_EXCEEDED + - SASE_SERVICEENDPOINT_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - VION_BANDWIDTH_LIMIT_EXCEEDED + - VION_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - SPN_BANDWIDTH_LIMIT_EXCEEDED + - SPN_BANDWIDTH_SOFT_LIMIT_EXCEEDED + - DEVICE_POE_PORT_POWER_STATUS + - DEVICE_POE_PORT_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_OVER_THRESHOLD + - DEVICE_POE_MAIN_POWER_FAULT + - DOT1X_RADIUS_SERVER_UNREACHABLE + - DOT1X_DYNAMIC_VLAN_NOT_CONFIGURED + - DOT1X_CLIENT_AUTH_FAIL + - HUB_CLUSTER_SITE_COUNT_THRESHOLD_EXCEEDED + - DEVICEHW_DISKUTIL_FRUSSD + - DEVICEHW_TEMPERATURE_SENSOR + - USER_ID_DIRECTORY_SYNC_FAILED + - USER_ID_HUB_SELECTION_FAILED + - DEVICE_POE_SHUT_CPU_TEMP_OVER_THRESHOLD + - DEVICESW_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_INTERFACE_CONFIG_OUTOFSYNC + - DEVICE_CELLULAR_MODULE_CONFIG_OUTOFSYNC + - CARRIER_PERFORMANCE_DEGRADED + - CIRCUIT_PERFORMANCE_DEGRADED + - APPLICATION_PERFORMANCE_DEGRADED + - DEVICE_ID_HUB_SELECTION_FAILED + - NETWORK_VPNKEK_UNAVAILABLE + - DEVICEHW_FAN_LOST + type: string + type: array id: - description: 'The ID of the response. + description: 'ID of the event policy set. ' type: string - type: object - Location: - properties: - description: - description: 'The decsription of the location. - - ' - latitude: - description: 'The latitude of the location. Max range = 90. - - ' - format: float - type: number - longitude: - description: 'The longitude of the location. Max range = 180. + name: + description: 'Name of the event policy set. Max 25 characters. ' - format: float - type: number - SeverityPriorityMapping: - properties: + type: string priority: - description: 'Priority specified for the rule. Range from Priority 1 (P1), - through Priority 5 (P5). + description: 'Priority level set for the event policy rule. ' enum: @@ -2131,65 +1664,131 @@ components: - p5 - none type: string - severity: - description: 'Severity of the rule. + resource_ids: + description: 'The resource IDs configured for a rule. Max 128 resources + can be configured in a rule. ' + items: + description: Resource Ids + type: string + type: array + resource_type: + description: "The resource on which the event policy rule is applied. \n" enum: - - major - - minor - - critical + - site + - element + - anynetlink + - bgppeer + - interface + - waninterface + - wannetwork + - networkpolicyset + - prioritypolicyset + - natpolicyset + - securitypolicyset + - appdef + - serviceendpoint + - cellular_module + - user_id type: string - required: - - priority - - severity - SiteEvent: - properties: - address: - $ref: '#/components/schemas/Address' - description: 'The address of the site where the event occurred. + start_time: + description: 'The start date in MM/DD/YYYY HH: mm format of the event policy + rule applied. ' - admin_state: - description: 'The site mode of operation, can be in one of three states: - Active - the site is in Control mode and network policy is applied. Monitor - - the site is in Analytics mode, no network policy is applied. Disabled: - the site is disabled. + format: int64 + type: integer + sub_resource_type: + description: 'The sub-resource type to narrow down the match criteria to + more specific elements. ' + enum: + - spoke + - hub + - public + - private type: string - element_cluster_role: - description: 'This attribute describes the type i.e. SPOKE or HUB. - - ' + suppress: + description: "The sub-resource type to narrow down the match criteria to\ + \ more specific elements.The event policy rule which suppresses or unsuppress\ + \ the alarms on the resources identified by the resource type, sub-resource\ + \ type, or matched event codes during the specified schedule. \ + \ \n" + enum: + - 'yes' + - 'no' + - none type: string - events: - description: 'The details of the events occurred. + tags: + description: 'A information field that can be added to identify the event + correlation policy rule. Maximum 10 unique tags of length 1024 each are + allowed. ' items: - $ref: '#/components/schemas/BaseEventState' + description: Tags + type: string type: array + required: + - priority + - suppress + - name + EventCorrelationPolicySet: + properties: + active_policyset: + description: 'Event policy sets set to active. + + ' + type: boolean + clone_from: + description: 'Policy sets cloned from existing policy sets. + + ' + type: string + description: + description: 'Description of the event policy set. + + ' id: - description: 'The site ID. + description: 'ID of the event policy set. ' type: string - location: - $ref: '#/components/schemas/Location' - description: 'The geographical cordinates for the site address. + name: + description: "Name of the event policy set. Max 25 characters. \n" + type: string + policyrule_order: + description: 'The order for the execution of the policy rule. ' - name: - description: 'The site name (Max size = 128). + items: + description: Policyrule Order + type: string + type: array + severity_priority_mapping: + description: 'Mapping of the priority and severity levels. ' - type: string - SiteQuery: + items: + $ref: '#/components/schemas/SeverityPriorityMapping' + type: array + tags: + description: "A information field that can be added to identify the event\ + \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ + \ are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + EventCorrelationPolicySetQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of sites that match the query parameters. + description: 'The aggregate number of queried rules. ' dest_page: @@ -2199,7 +1798,7 @@ components: format: int32 type: integer getDeleted: - description: 'The number sites deleted for a time frame. + description: 'The number of queried rules deleted for a time frame. ' type: boolean @@ -2210,7 +1809,7 @@ components: type: string type: array id: - description: "List the sites by ID. \n" + description: "List the event state by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -2252,381 +1851,232 @@ components: ' format: int64 type: integer - SiteQueryFilter: + EventCorrelationPolicySetQueryFilter: properties: - address: - $ref: '#/components/schemas/Address' - description: 'The address of the site. + active_policyset: + description: 'Event policy sets set to active. ' - admin_state: - description: 'The site mode of operation, can be in one of three states: - Active - the site is in Control mode and network policy is applied. Monitor - - the site is in Analytics mode, no network policy is applied. Disabled: - the site is disabled. + type: boolean + clone_from: + description: 'Policy sets cloned from existing policy sets. ' type: string description: - description: 'Description for the site (Max size = 1024). - - ' - element_cluster_role: - description: 'This attribute describes the type i.e. SPOKE or HUB. + description: 'Description of the event policy set. ' - type: string - events: - description: Events - items: - $ref: '#/components/schemas/BaseEventState' - type: array id: - description: 'The ID. + description: 'ID of the event policy set. ' type: string - location: - $ref: '#/components/schemas/Location' - description: 'The geographical cordinates for the site address. - - ' name: - description: 'The site name (Max size = 128). - - ' - type: string - policy_set_id: - description: 'The ID for the Original Network Policy Set. Can be retrieved - using policysets API. - - ' + description: "Name of the event policy set. Max 25 characters. \n" type: string - security_policyset_id: - description: 'The ID for the Original Security Policy Set. Can be retrieved - using securitypolicysets API. + policyrule_order: + description: 'The order for the execution of the policy rule. ' - type: string - service_binding: - description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps - API. + items: + description: Policyrule Order + type: string + type: array + severity_priority_mapping: + description: 'Mapping of the priority and severity levels. ' - type: string - StandingRule: + items: + $ref: '#/components/schemas/SeverityPriorityMapping' + type: array + tags: + description: "A information field that can be added to identify the event\ + \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ + \ are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + EventCorrelationPolicySetScreen: properties: - priority: - description: 'Priority specified for the standing rule. Range from Priority - 1 (P1), through Priority 5 (P5). + active_policyset: + description: 'Event policy sets set to active. ' - enum: - - p1 - - p2 - - p3 - - p4 - - p5 - - none - type: string - standing_for: - description: 'Standing for duration cannot be less than 5 minutes and more - than 10080 minutes(a week). + type: boolean + clone_from: + description: 'Policy sets cloned from existing policy sets. ' - type: integer - required: - - priority - SuppressedInfo: - properties: - root_cause_event_ids: - description: 'The event IDs of the root causes. + type: string + description: + description: 'Description of the event policy set. ' - items: - description: Root Cause Event Ids - type: string - type: array - suppressed_time: - description: 'The suppressed event time. + id: + description: 'ID of the event policy set. ' - format: date - type: string - VPNEndpointEventState: - properties: - al_id: - description: Al Id - type: string - eid: - description: Eid - type: string - event_code: - description: Event Code type: string - event_id: - description: Event Id - type: string - id: - description: Id - type: string - priority: - description: Priority - format: int32 - type: integer - site_id: - description: Site Id - type: string - standing: - description: Standing - type: boolean - suppressed: - description: Suppressed - type: boolean - suppressed_info: - $ref: '#/components/schemas/SuppressedInfo' - description: Suppressed Info - timestamp: - description: Timestamp - format: int64 - type: integer - vep_id: - description: Vep Id - type: string - vpnlink_id: - description: Vpnlink Id + name: + description: "Name of the event policy set. Max 25 characters. \n" type: string - WANInterfaceEvent: - properties: - events: - description: 'The details of the WAN events occurred. + policyrule_order: + description: 'The order for the execution of the policy rule. ' items: - $ref: '#/components/schemas/BaseEventState' + description: Policyrule Order + type: string type: array - id: - description: 'The WAN interface ID. + severity_priority_mapping: + description: 'Mapping of the priority and severity levels. ' - type: string - name: - description: 'The name of the WAN interface. + items: + $ref: '#/components/schemas/SeverityPriorityMapping' + type: array + tags: + description: "A information field that can be added to identify the event\ + \ correlation policy rule. Maximum 10 unique tags of length 1024 each\ + \ are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - severity_priority_mapping + - name + FlapRule: + properties: + flap_duration: + description: 'Flap duration cannot be less than 5 minutes and more than + 10080 minutes (a week). ' - type: string - network_id: - description: 'The network ID. + type: integer + flap_rate: + description: 'Flap count cannot be lower than 2 nor higher than 512. ' - type: string - type: - description: "The WAN interface type. \n" - enum: - - PUBLIC_WAN - - PRIVATE_WAN - type: string - WANInterfaceQuery: + type: integer + ListQueryResponse: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of WAN interfaces that match the query - parameters. + count: + description: 'The actual count. ' - dest_page: - description: 'The destination page. + format: int32 + type: integer + deleted_count: + description: 'The deleted number. ' - format: int32 + format: int64 type: integer - getDeleted: - description: 'The number WAN interfaces deleted for a time frame. + deleted_ids: + description: 'The deleted IDs. ' - type: boolean - group_by: - description: Group By items: - description: Group By type: string type: array - id: - description: "List the WAN interfaces by ID. \n" - type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + description: + description: 'Description of the query. Max size = 256. ' - format: int64 - type: integer - limit: - description: 'The query limit. + id: + description: 'The ID. ' - format: int32 - type: integer + type: string next_query: - description: 'The limit. - - ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. - - ' - items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. + description: 'Details of the next query. ' - type: boolean - sort_params: type: object total_count: - description: 'The total number of query parameters. + description: 'Total number. ' format: int64 type: integer - WANInterfaceQueryFilter: + type: object + ListResponse: properties: - events: - description: 'The details of the WAN events occurred. + count: + description: 'The actual count. ' - items: - $ref: '#/components/schemas/BaseEventState' - type: array + format: int32 + type: integer id: - description: 'The WAN interface ID. + description: 'The ID. ' type: string - name: - description: 'The name of the WAN interface. + type: object + SeverityPriorityMapping: + properties: + priority: + description: 'Priority specified for the rule. Range from Priority 1 (P1), + through Priority 5 (P5). + + ' + enum: + - p1 + - p2 + - p3 + - p4 + - p5 + - none + type: string + severity: + description: 'Severity of the rule. + + ' + enum: + - major + - minor + - critical + type: string + required: + - priority + - severity + StandingRule: + properties: + priority: + description: 'Priority specified for the standing rule. Range from Priority + 1 (P1), through Priority 5 (P5). ' + enum: + - p1 + - p2 + - p3 + - p4 + - p5 + - none type: string - network_id: - description: 'The network ID. + standing_for: + description: 'Standing for duration cannot be less than 5 minutes and more + than 10080 minutes(a week). ' - type: string - type: - description: "The WAN interface type. \n" - enum: - - PUBLIC_WAN - - PRIVATE_WAN - type: string + type: integer + required: + - priority info: contact: {} - description: List of APIs used to retrieve events, manage the event policy rules - that include managing of event correlation policy rules and sets and querying - of the rules and sets. - title: Events + description: List of APIs used to manage the event policy rules that inlcude managing + of event correlation policy rules and sets and querying of the rules and sets. + title: Event Policy version: Latest openapi: 3.0.0 paths: - /sdwan/v2.0/api/anynetlinks/correlationevents/query: - post: - description: Query all the anynet link correlation events. - operationId: post-sdwan-v2.0-api-anynetlinks-correlationevents-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AnynetLinkQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/AnynetLinkQueryFilter' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Anynet Link Correlation Events (v2.0) - tags: - - Event Policy - /sdwan/v2.0/api/anynetlinks/{anynetlink_id}/correlationevents: - get: - description: List all the anynet link correlation events. - operationId: get-sdwan-v2.0-api-anynetlinks-anynetlink_id-correlationevents - parameters: - - description: The anynetlink ID. - in: path - name: anynetlink_id - required: true - schema: - description: Anynetlink Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AnynetlinkEvent' - description: Successful Operation - summary: Get Anynet Link Correlation Events (v2.0) - tags: - - Event Policy - /sdwan/v2.0/api/elements/correlationevents/query: - post: - description: Query all the element correlation events. - operationId: post-sdwan-v2.0-api-elements-correlationevents-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementQueryFilter' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Element Correlation Events (v2.0) - tags: - - Event Policy /sdwan/v2.0/api/eventcorrelationpolicyrules/query: post: description: Queries the DB for limit number of event correlation policy rules @@ -3041,15 +2491,17 @@ paths: summary: Update Event Correlation Policy Rule Configuration (v2.0) tags: - Event Policy - /sdwan/v2.0/api/interfaces/correlationevents/query: + /sdwan/v2.1/api/eventcorrelationpolicyrules/query: post: - description: Query all the interface correlation events. - operationId: post-sdwan-v2.0-api-interfaces-correlationevents-query + description: Queries the DB for limit number of event correlation policy rules + that match query parameters. + operationId: post-sdwan-v2.1-api-eventcorrelationpolicyrules-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/InterfaceQuery' + $ref: '#/components/schemas/EventCorrelationPolicyRuleQueryV2N1' + description: Details for Event Correlation Policy Rule responses: '200': content: @@ -3060,7 +2512,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/InterfaceQueryFilter' + $ref: '#/components/schemas/EventCorrelationPolicyRuleQueryFilterV2N1' type: array type: object description: Successful Operation @@ -3074,220 +2526,183 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Interface Correlation Events (v2.0) + summary: Queries DB for Number of Event Correlation Policy Rules (v2.1) tags: - Event Policy - /sdwan/v2.0/api/sites/correlationevents/query: - post: - description: Query all the site correlation events. - operationId: post-sdwan-v2.0-api-sites-correlationevents-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteQuery' + /sdwan/v2.1/api/eventcorrelationpolicysets/{policy_set_id}/eventcorrelationpolicyrules: + get: + description: List all the event correlation policy rules. + operationId: get-sdwan-v2.1-api-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules + parameters: + - description: ID of the event policy set. + in: path + name: policy_set_id + required: true + schema: + description: Policy Set Id + type: string responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/SiteQueryFilter' + $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Site Correlation Events (v2.0) + summary: Get Event Correlation Policy Rules (v2.1) tags: - Event Policy - /sdwan/v2.0/api/sites/{site_id}/correlationevents: - get: - description: List all the site correlation events. - operationId: get-sdwan-v2.0-api-sites-site_id-correlationevents + post: + description: Create the event correlation policy rule configuration. + operationId: post-sdwan-v2.1-api-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules parameters: - - description: The site ID. + - description: ID of the event policy set. in: path - name: site_id + name: policy_set_id required: true schema: - description: Site Id + description: Policy Set Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EventCorrelationPolicyRuleScreenV2N1' + description: Details of the vent correlation policyrule to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteEvent' + $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' description: Successful Operation - summary: Get Site Correlation Events (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: EVENT_POLICY_INVALID_RESOURCES + - code: EVENT_POLICY_INVALID_PRIORITY + - code: EVENT_POLICY_INVALID_SUPPRESS + - code: EVENT_POLICY_INVALID_RESOURCE_SUB_TYPE + - code: EVENT_POLICY_RULE_MAX_RESOURCE_IDS + - code: EVENT_POLICY_INVALID_RESOURCE_TYPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Event Correlation Policy Rule Configuration (v2.1) tags: - Event Policy - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/correlationevents: - get: - description: List all the events for an element at a site. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-correlationevents + /sdwan/v2.1/api/eventcorrelationpolicysets/{policy_set_id}/eventcorrelationpolicyrules/{policy_rule_id}: + delete: + description: Delete a specific event correlation policy rule. + operationId: delete-sdwan-v2.1-api-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules-policy_rule_id parameters: - - description: The site ID. + - description: ID of the event policy set. in: path - name: site_id + name: policy_set_id required: true schema: - description: Site Id + description: Policy Set Id type: string - - description: The element ID. + - description: ID of the event policy rule. in: path - name: element_id + name: policy_rule_id required: true schema: - description: Element Id + description: Policy Rule Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementEvent' + $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' description: Successful Operation - summary: Get Element Events (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: EVENT_POLICY_INVALID_RESOURCES + - code: EVENT_POLICY_INVALID_PRIORITY + - code: EVENT_POLICY_INVALID_SUPPRESS + - code: EVENT_POLICY_INVALID_RESOURCE_SUB_TYPE + - code: EVENT_POLICY_RULE_MAX_RESOURCE_IDS + - code: EVENT_POLICY_INVALID_RESOURCE_TYPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Specific Event Correlation Policy Rule (v2.1) tags: - Event Policy - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/correlationevents: get: - description: List all the interface correlation events for an element at a site. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-interfaces-interface_id-correlationevents + description: List the event correlation policy rule. + operationId: get-sdwan-v2.1-api-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules-policy_rule_id parameters: - - description: The site ID. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The element ID. + - description: ID of the event policy set. in: path - name: element_id + name: policy_set_id required: true schema: - description: Element Id + description: Policy Set Id type: string - - description: The interface ID. + - description: ID of the event policy rule. in: path - name: interface_id + name: policy_rule_id required: true schema: - description: Interface Id + description: Policy Rule Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceEvent' + $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' description: Successful Operation - summary: Get Interface Correlation Events (v2.0) + summary: Get Event Correlation Policy Rule (v2.1) tags: - Event Policy - /sdwan/v2.0/api/sites/{site_id}/waninterfaces/{wan_interface_id}/correlationevents: - get: - description: List all the WAN interface correlation events for an element at - a site. - operationId: get-sdwan-v2.0-api-sites-site_id-waninterfaces-wan_interface_id-correlationevents + put: + description: Update the event correlation policy rule configuration. + operationId: put-sdwan-v2.1-api-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules-policy_rule_id parameters: - - description: The site ID. + - description: ID of the event policy set. in: path - name: site_id + name: policy_set_id required: true schema: - description: Site Id + description: Policy Set Id type: string - - description: The WAN interface ID. + - description: ID of the event policy rule. in: path - name: wan_interface_id + name: policy_rule_id required: true schema: - description: Wan Interface Id + description: Policy Rule Id type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/WANInterfaceEvent' - description: Successful Operation - summary: Get WAN Interface Correlation Events (v2.0) - tags: - - Event Policy - /sdwan/v2.0/api/waninterfaces/correlationevents/query: - post: - description: Query all the WAN interface correlation events. - operationId: post-sdwan-v2.0-api-waninterfaces-correlationevents-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/WANInterfaceQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANInterfaceQueryFilter' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query WAN Interface Correlation Events (v2.0) - tags: - - Event Policy - /sdwan/v2.1/api/anynetlinks/correlationevents/query: - post: - description: Query all the anynet link correlation events. - operationId: post-sdwan-v2.1-api-anynetlinks-correlationevents-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnynetLinkQuery' + $ref: '#/components/schemas/EventCorrelationPolicyRuleScreenV2N1' + description: Details of the event correlation policyrule to be updated responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/AnynetLinkQueryFilterV2N1' - type: array - type: object + $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' description: Successful Operation '400': content: @@ -3295,33 +2710,17 @@ paths: example: value: _error: - - code: BAD_QUERY_REQUEST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: EVENT_POLICY_INVALID_RESOURCES + - code: EVENT_POLICY_INVALID_PRIORITY + - code: EVENT_POLICY_INVALID_SUPPRESS + - code: EVENT_POLICY_INVALID_RESOURCE_SUB_TYPE + - code: EVENT_POLICY_RULE_MAX_RESOURCE_IDS + - code: EVENT_POLICY_INVALID_RESOURCE_TYPE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Anynet Link Correlation Events (v2.1) - tags: - - Event Policy - /sdwan/v2.1/api/anynetlinks/{anynetlink_id}/correlationevents: - get: - description: List all the anynet link correlation events. - operationId: get-sdwan-v2.1-api-anynetlinks-anynetlink_id-correlationevents - parameters: - - description: The anynetlink ID. - in: path - name: anynetlink_id - required: true - schema: - description: Anynetlink Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AnynetlinkEventV2N1' - description: Successful Operation - summary: Get Anynet Link Correlation Events (v2.1) + summary: Update Event Correlation Policy Rule Configuration (v2.1) tags: - Event Policy servers: diff --git a/openapi-specs/sdwan/unified/Events.yaml b/openapi-specs/sdwan/unified/Events.yaml new file mode 100644 index 000000000..0a856316c --- /dev/null +++ b/openapi-specs/sdwan/unified/Events.yaml @@ -0,0 +1,1785 @@ +components: + schemas: + Address: + properties: + city: + description: 'The name of the city. Max size = 100. + + ' + type: string + country: + description: 'The name of the country. Max size = 100. + + ' + type: string + post_code: + description: 'The postal code. Max size = 100. + + ' + type: string + state: + description: 'The name of the state. Max size = 100. + + ' + type: string + street: + description: 'The name of the street. Max size = 100. + + ' + type: string + street2: + description: 'The name of the street. Max size = 100. + + ' + type: string + Aggregate: + properties: + data: + description: 'The details of the aggregate data. + + ' + items: + $ref: '#/components/schemas/AggregateData' + type: array + field: + description: Field + type: string + name: + description: 'The name of the query response. + + ' + type: string + operator: + description: Operator + enum: + - max + - count + - min + - avg + - sum + type: string + statistic: + description: 'QoS application aggregate statistics. + + ' + type: string + unit: + description: 'The unit. + + ' + type: string + AggregateData: + properties: + value: + description: 'Value of the aggregate data. + + ' + type: number + view: + description: 'View the aggregate date. + + ' + type: object + AnynetLinkQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of anynet links that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number anynet links deleted for a time frame. + + ' + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the anynet links by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + AnynetLinkQueryFilter: + properties: + admin_up: + description: Admin Up + type: boolean + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_site_role: + description: Ep1 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep1_wan_interface_id: + description: Ep1 Wan Interface Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_site_role: + description: Ep2 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep2_wan_interface_id: + description: Ep2 Wan Interface Id + type: string + events: + description: Events + items: + $ref: '#/components/schemas/AnynetlinkEventState' + type: array + id: + description: Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpn_events: + description: Vpn Events + items: + $ref: '#/components/schemas/VPNEndpointEventState' + type: array + AnynetLinkQueryFilterV2N1: + properties: + admin_up: + description: Admin Up + type: boolean + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_site_role: + description: Ep1 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep1_wan_interface_id: + description: Ep1 Wan Interface Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_site_role: + description: Ep2 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep2_wan_interface_id: + description: Ep2 Wan Interface Id + type: string + events: + description: Events + items: + $ref: '#/components/schemas/AnynetlinkEventStateV2N1' + type: array + id: + description: Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpn_events: + description: Vpn Events + items: + $ref: '#/components/schemas/VPNEndpointEventState' + type: array + AnynetlinkEvent: + properties: + admin_up: + description: Admin Up + type: boolean + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_site_role: + description: Ep1 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep1_wan_interface_id: + description: Ep1 Wan Interface Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_site_role: + description: Ep2 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep2_wan_interface_id: + description: Ep2 Wan Interface Id + type: string + events: + description: Events + items: + $ref: '#/components/schemas/AnynetlinkEventState' + type: array + id: + description: Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpn_events: + description: Vpn Events + items: + $ref: '#/components/schemas/VPNEndpointEventState' + type: array + AnynetlinkEventState: + properties: + error_vpnlinks: + description: Error Vpnlinks + items: + description: Error Vpnlinks + type: string + type: array + event_code: + description: Event Code + type: string + event_id: + description: Event Id + type: string + id: + description: Id + type: string + priority: + description: Priority + format: int32 + type: integer + site_ids: + description: Site Ids + items: + description: Site Ids + type: string + type: array + standing: + description: Standing + type: boolean + suppressed: + description: Suppressed + type: boolean + suppressed_info: + $ref: '#/components/schemas/SuppressedInfo' + description: Suppressed Info + timestamp: + description: Timestamp + format: int64 + type: integer + AnynetlinkEventStateV2N1: + properties: + error_vpnlinks: + description: Error Vpnlinks + items: + description: Error Vpnlinks + type: string + type: array + event_code: + description: Event Code + type: string + event_id: + description: Event Id + type: string + id: + description: Id + type: string + priority: + description: Priority + format: int32 + type: integer + site_ids: + description: Site Ids + items: + description: Site Ids + type: string + type: array + standing: + description: Standing + type: boolean + suppressed: + description: Suppressed + type: boolean + suppressed_info: + $ref: '#/components/schemas/SuppressedInfo' + description: Suppressed Info + timestamp: + description: Timestamp + format: int64 + type: integer + AnynetlinkEventV2N1: + properties: + admin_up: + description: Admin Up + type: boolean + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_site_role: + description: Ep1 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep1_wan_interface_id: + description: Ep1 Wan Interface Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_site_role: + description: Ep2 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep2_wan_interface_id: + description: Ep2 Wan Interface Id + type: string + events: + description: Events + items: + $ref: '#/components/schemas/AnynetlinkEventStateV2N1' + type: array + id: + description: Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpn_events: + description: Vpn Events + items: + $ref: '#/components/schemas/VPNEndpointEventState' + type: array + BaseEventState: + properties: + event_code: + description: "The event code. \n" + type: string + event_id: + description: "The event ID. \n" + type: string + id: + description: Id + type: string + priority: + description: "The priority set for the event. \n" + format: int32 + type: integer + standing: + description: 'The standing event. True or False. + + ' + type: boolean + suppressed: + description: 'The events are suppressed. True or False. + + ' + type: boolean + suppressed_info: + $ref: '#/components/schemas/SuppressedInfo' + description: 'The information on the suppressed events. + + ' + timestamp: + description: 'The time stamp of the event. + + ' + format: int64 + type: integer + ElementEvent: + properties: + events: + description: 'The details of the events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: 'The element ID. + + ' + type: string + name: + description: 'The name of the element. + + ' + type: string + role: + description: 'The element role. + + ' + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + spoke_cluster_status: + description: 'The spoke cluster status. + + ' + enum: + - init + - active + - backup + - unknown + type: string + ElementQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: Aggregate + description: + description: 'The description of the element. + + ' + dest_page: + description: Dest Page + format: int32 + type: integer + getDeleted: + description: GetDeleted + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: Id + type: string + last_query_ts: + description: Last Query Ts + format: int64 + type: integer + limit: + description: Limit + format: int32 + type: integer + next_query: + type: object + query_params: + type: object + retrieved_fields: + description: Retrieved Fields + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: Retrieved Fields Mask + type: boolean + sort_params: + type: object + total_count: + description: Total Count + format: int64 + type: integer + ElementQueryFilter: + properties: + admin_action: + description: "The values of admin actions that can be performed. \n" + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID + type: string + allowed_roles: + description: "The allowed roles. \n" + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + type: array + cluster_insertion_mode: + description: "The element ID. \n" + type: string + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected + type: boolean + deployment_op: + description: Deployment Op + enum: + - DECLAIM + - UPGRADE + - ABORT_UPGRADE + - DEFAULT + - INVALID + - REBIND + - READY + - IN_SERVICE + - REUNBIND + - RENEW_CIC + - ABORT_CELLULARMODULE_FIRMWARE_UPGRADE + - FIPS_AUTO + - NON_FIPS_AUTO + - FIPS_MANUAL + - NON_FIPS_MANUAL + - GET_MAC_ADDRESS_TABLE + type: string + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + events: + description: Events + items: + $ref: '#/components/schemas/BaseEventState' + type: array + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + description: Id + type: string + model_name: + description: "The model name of the device. \n" + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + role: + description: Role + enum: + - PA_WE_DC + - PA_WE_BR + - NONE + - PA_CONN + - SPOKE + - HUB + type: string + serial_number: + description: Serial Number + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + software_version: + description: Software Version + type: string + spoke_cluster_status: + description: Spoke Cluster Status + enum: + - init + - active + - backup + - unknown + type: string + state: + description: State + enum: + - ACTIVE_INIT + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_READY + - ACTIVE_BOUND_IN_PROGRESS + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - OOS + - ACTIVE_DECLAIM_IN_PROGRESS + type: string + required: + - site_id + Error: + properties: + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + type: string + message: + type: string + InterfaceEvent: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + element_id: + description: 'The element ID. + + ' + type: string + events: + description: 'The details of the events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: "The interface ID. \n" + type: string + ipv4_addresses: + description: 'The IPv4 addresses configured for the interface. + + ' + items: + description: Ipv4 Addresses + type: string + type: array + name: + description: 'The name of the interface. + + ' + type: string + parent: + description: 'The parent interface. + + ' + type: string + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + type: + description: 'The interface type. + + ' + enum: + - SERVICE_LINK + - LOOPBACK + - BYPASSPAIR + - SUBINTERFACE + - PPPOE + - PORTCHANNEL + - PORT + - VIRTUAL_INTERFACE + - CELLULAR + type: string + used_for: + description: 'The value of where the interface is used. + + ' + enum: + - NONE + - PUBLIC + - PRIVATE + - LAN + - PRIVATE_L2 + - PRIVATE_WAN + type: string + InterfaceQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of interfaces that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number interfaces deleted for a time frame. + + ' + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the interfaces by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + InterfaceQueryFilter: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + element_id: + description: 'The element ID. + + ' + type: string + events: + description: 'The details of the events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: "The interface ID. \n" + type: string + ipv4_addresses: + description: 'The IPv4 addresses configured for the interface. + + ' + items: + description: Ipv4 Addresses + type: string + type: array + name: + description: 'The name of the interface. + + ' + type: string + parent: + description: 'The parent interface. + + ' + type: string + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + type: + description: 'The interface type. + + ' + enum: + - SERVICE_LINK + - LOOPBACK + - BYPASSPAIR + - SUBINTERFACE + - PPPOE + - PORTCHANNEL + - PORT + - VIRTUAL_INTERFACE + - CELLULAR + type: string + used_for: + description: 'The value of where the interface is used. + + ' + enum: + - NONE + - PUBLIC + - PRIVATE + - LAN + - PRIVATE_L2 + - PRIVATE_WAN + type: string + ListQueryResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + deleted_count: + description: 'The deleted number. + + ' + format: int64 + type: integer + deleted_ids: + description: 'The deleted IDs. + + ' + items: + type: string + type: array + description: + description: 'Description of the query. Max size = 256. + + ' + id: + description: 'The ID. + + ' + type: string + next_query: + description: 'Details of the next query. + + ' + type: object + total_count: + description: 'Total number. + + ' + format: int64 + type: integer + type: object + Location: + properties: + description: + description: 'The description of the location. + + ' + latitude: + description: 'The latitude of the location. Max range = 90. + + ' + format: float + type: number + longitude: + description: 'The longitude of the location. Max range = 180. + + ' + format: float + type: number + SiteEvent: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site where the event occurred. + + ' + admin_state: + description: 'The site mode of operation, can be in one of three states: + Active - the site is in Control mode and network policy is applied. Monitor + - the site is in Analytics mode, no network policy is applied. Disabled: + the site is disabled. + + ' + type: string + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. + + ' + type: string + events: + description: 'The details of the events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: 'The site ID. + + ' + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' + name: + description: 'The site name (Max size = 128). + + ' + type: string + SiteQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of sites that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number sites deleted for a time frame. + + ' + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the sites by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + SiteQueryFilter: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. + + ' + admin_state: + description: 'The site mode of operation, can be in one of three states: + Active - the site is in Control mode and network policy is applied. Monitor + - the site is in Analytics mode, no network policy is applied. Disabled: + the site is disabled. + + ' + type: string + description: + description: 'Description for the site (Max size = 1024). + + ' + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. + + ' + type: string + events: + description: Events + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: 'The ID. + + ' + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' + name: + description: 'The site name (Max size = 128). + + ' + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. + + ' + type: string + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. + + ' + type: string + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. + + ' + type: string + SuppressedInfo: + properties: + root_cause_event_ids: + description: 'The event IDs of the root causes. + + ' + items: + description: Root Cause Event Ids + type: string + type: array + suppressed_time: + description: 'The suppressed event time. + + ' + format: date + type: string + VPNEndpointEventState: + properties: + al_id: + description: Al Id + type: string + eid: + description: Eid + type: string + event_code: + description: Event Code + type: string + event_id: + description: Event Id + type: string + id: + description: Id + type: string + priority: + description: Priority + format: int32 + type: integer + site_id: + description: Site Id + type: string + standing: + description: Standing + type: boolean + suppressed: + description: Suppressed + type: boolean + suppressed_info: + $ref: '#/components/schemas/SuppressedInfo' + description: Suppressed Info + timestamp: + description: Timestamp + format: int64 + type: integer + vep_id: + description: Vep Id + type: string + vpnlink_id: + description: Vpnlink Id + type: string + WANInterfaceEvent: + properties: + events: + description: 'The details of the WAN events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: 'The WAN interface ID. + + ' + type: string + name: + description: 'The name of the WAN interface. + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + type: + description: 'The WAN interface type. + + ' + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + WANInterfaceQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of app defs that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number app definitions deleted for a time frame. + + ' + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the app definitions by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + WANInterfaceQueryFilter: + properties: + events: + description: 'The details of the WAN events occurred. + + ' + items: + $ref: '#/components/schemas/BaseEventState' + type: array + id: + description: 'The WAN interface ID. + + ' + type: string + name: + description: 'The name of the WAN interface. + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + type: + description: 'The WAN interface type. + + ' + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string +info: + contact: {} + description: List of APIs used to retrieve events, manage the event policy rules + that include managing of event correlation policy rules and sets and querying + of the rules and sets. + title: Events + version: Latest +openapi: 3.0.0 +paths: + /sdwan/v2.0/api/anynetlinks/correlationevents/query: + post: + description: Query AnynetLink correlation events. + operationId: post-sdwan-v2.0-api-anynetlinks-correlationevents-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AnynetLinkQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query AnynetLink Correlation Events (v2.0) + tags: + - Events + /sdwan/v2.0/api/anynetlinks/{anynetlink_id}/correlationevents: + get: + description: Get anynetlink correlation events. + operationId: get-sdwan-v2.0-api-anynetlinks-anynetlink_id-correlationevents + parameters: + - description: The anynet link ID. + in: path + name: anynetlink_id + required: true + schema: + description: Anynetlink Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetlinkEvent' + description: Successful Operation + summary: Get AnynetLink Correlation Events (v2.0) + tags: + - Events + /sdwan/v2.0/api/elements/correlationevents/query: + post: + description: Query element correlation events. + operationId: post-sdwan-v2.0-api-elements-correlationevents-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Element Correlation Events (v2.0) + tags: + - Events + /sdwan/v2.0/api/interfaces/correlationevents/query: + post: + description: Query interface correlation events. + operationId: post-sdwan-v2.0-api-interfaces-correlationevents-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Interface Correlation Events (v2.0) + tags: + - Events + /sdwan/v2.0/api/sites/correlationevents/query: + post: + description: Query site correlation events. + operationId: post-sdwan-v2.0-api-sites-correlationevents-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query SIte Correlation Events (v2.0) + tags: + - Events + /sdwan/v2.0/api/sites/{site_id}/correlationevents: + get: + description: Get site correlation events. + operationId: get-sdwan-v2.0-api-sites-site_id-correlationevents + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteEvent' + description: Successful Operation + summary: Get Site Correlation Events (v2.0) + tags: + - Events + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/correlationevents: + get: + description: Get element events. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-correlationevents + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementEvent' + description: Successful Operation + summary: Get Element Events (v2.0) + tags: + - Events + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/correlationevents: + get: + description: Get interface correlation events. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-interfaces-interface_id-correlationevents + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceEvent' + description: Successful Operation + summary: Get Interface Correlation Events (v2.0) + tags: + - Events + /sdwan/v2.0/api/sites/{site_id}/waninterfaces/{wan_interface_id}/correlationevents: + get: + description: Get wan interface correlation events. + operationId: get-sdwan-v2.0-api-sites-site_id-waninterfaces-wan_interface_id-correlationevents + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The wan interface ID. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceEvent' + description: Successful Operation + summary: Get WAN Interface Correlation Events (v2.0) + tags: + - Events + /sdwan/v2.0/api/waninterfaces/correlationevents/query: + post: + description: Query WAN interface correlation events. + operationId: post-sdwan-v2.0-api-waninterfaces-correlationevents-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query WAN Interface Correlation Events (v2.0) + tags: + - Events + /sdwan/v2.1/api/anynetlinks/correlationevents/query: + post: + description: Query AnynetLink correlation events. + operationId: post-sdwan-v2.1-api-anynetlinks-correlationevents-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AnynetLinkQueryFilterV2N1' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query AnynetLink Correlation Events (v2.1) + tags: + - Events + /sdwan/v2.1/api/anynetlinks/{anynetlink_id}/correlationevents: + get: + description: List all the anynet link correlation events. + operationId: get-sdwan-v2.1-api-anynetlinks-anynetlink_id-correlationevents + parameters: + - description: The anynetlink ID. + in: path + name: anynetlink_id + required: true + schema: + description: Anynetlink Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetlinkEventV2N1' + description: Successful Operation + summary: Get Anynet Link Correlation Events (v2.1) + tags: + - Events +servers: +- url: https://api.sase.paloaltonetworks.com +tags: +- name: Events diff --git a/openapi-specs/sdwan/unified/IPFIX.yaml b/openapi-specs/sdwan/unified/IPFIX.yaml index a48dd455f..025e4320e 100644 --- a/openapi-specs/sdwan/unified/IPFIX.yaml +++ b/openapi-specs/sdwan/unified/IPFIX.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,26 +44,25 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string CollectorConfig: properties: @@ -1202,19 +1196,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -1235,7 +1229,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 diff --git a/openapi-specs/sdwan/unified/IoT.yaml b/openapi-specs/sdwan/unified/IoT.yaml index f85057c8e..3db79e59f 100644 --- a/openapi-specs/sdwan/unified/IoT.yaml +++ b/openapi-specs/sdwan/unified/IoT.yaml @@ -1,5 +1,131 @@ components: schemas: + Aggregate: + properties: + data: + description: 'The details of the aggregate data. + + ' + items: + $ref: '#/components/schemas/AggregateData' + type: array + field: + description: Field + type: string + name: + description: 'The name of the query response. + + ' + type: string + operator: + description: Operator + enum: + - max + - count + - min + - avg + - sum + type: string + statistic: + description: 'QoS application aggregate statistics. + + ' + type: string + unit: + description: 'The unit. + + ' + type: string + AggregateData: + properties: + value: + description: 'Value of the aggregate data. + + ' + type: number + view: + description: 'View the aggregate date. + + ' + type: object + BulkDeleteStartNode: + properties: + description: + description: 'The start node description. + + ' + error_message: + description: 'Error message. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + ipv4_address: + description: 'The IPv4 address used as the starting point for network and + device discovery. + + ' + type: string + name: + description: 'Start node name. + + ' + type: string + scope: + description: 'Subnet scopes. A maximum of eight subnets can be entered per + start node. This limits the discovery to a set of devices within the specified + scope. + + ' + items: + $ref: '#/components/schemas/StartNodeScopeConfig' + type: array + tags: + description: 'A information field that can be added to start nodes. Maximum + 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - ipv4_address + BulkDeviceIdDeleteStartNode: + properties: + id: + description: 'The ID. + + ' + type: string + start_nodes: + description: 'Details of the start nodes. This is the IP address that the + ION device uses as a starting point for network and device discovery. + + ' + items: + $ref: '#/components/schemas/BulkDeleteStartNode' + type: array + BulkResponse: + properties: + count: + description: 'The total number. + + ' + format: int32 + type: integer + id: + description: 'The ID. + + ' + type: string + type: + description: "The type. \n" + type: string DeviceIdConfig: properties: cfg_device_id_enabled: @@ -12,42 +138,916 @@ components: ' type: string - DeviceIdConfigScreen: - properties: - cfg_device_id_enabled: - description: 'The CFG device ID, if enabled. - - ' - type: boolean - id: - description: 'The ID. - - ' + DeviceIdConfigQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of device ID config queries that match + the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of device ID config queries deleted for a time + frame. + + ' + type: boolean + group_by: + description: 'Group the device ID config queries. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the queries by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + description: 'Query using query parameters. + + ' + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + DeviceIdConfigScreen: + properties: + cfg_device_id_enabled: + description: 'The CFG device ID, if enabled. + + ' + type: boolean + id: + description: 'The ID. + + ' + type: string + DeviceIdConfigV2N1: + properties: + cfg_device_id_enabled: + description: 'The CFG device ID, if enabled. + + ' + type: boolean + deviceid_profile_id: + description: 'The deviceid profile ID. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + site_id: + description: 'The site ID. + + ' + type: string + required: + - site_id + DeviceIdElementConfig: + properties: + description: + description: "The device id element description. \n" + id: + description: 'The device ID. + + ' + type: string + name: + description: "Device ID element name. \n" + type: string + snmp_discovery_source_interface_id: + description: 'The snmp discovery source interface ID. + + ' + type: string + tags: + description: 'A information field that can be added to device id element. + Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + DeviceIdElementConfigScreen: + properties: + description: + description: "The device id element description. \n" + id: + description: 'The device ID. + + ' + type: string + name: + description: "Device ID element name. \n" + type: string + snmp_discovery_source_interface_id: + description: 'The snmp discovery source interface ID. + + ' + type: string + tags: + description: 'A information field that can be added to device id element. + Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + DeviceIdProfileOperations: + properties: + disabled: + description: 'Disable the device id profile. + + ' + type: boolean + disabled_reason: + description: 'Reason to disable the device id profile. + + ' + type: string + id: + description: 'Device ID. + + ' + type: string + inactive: + description: 'Device id profile (active or inactive). + + ' + type: boolean + inactive_reason: + description: 'Reason for profile to be inactive. + + ' + type: string + name: + description: 'Name of the device ID profile. + + ' + type: string + region: + description: 'Profile region. + + ' + type: string + sites: + description: 'The device ID site. + + ' + items: + $ref: '#/components/schemas/SiteDetails' + type: array + type: + description: 'The device ID profile type. + + ' + type: string + required: + - sites + DeviceIdStartNode: + properties: + description: + description: 'The device id start node description. + + ' + id: + description: 'The device ID. + + ' + type: string + ipv4_address: + description: 'The IPv4 address used as the starting point for network and + device discovery. + + ' + type: string + name: + description: 'Device ID start node name. + + ' + type: string + scope: + description: 'Subnet scopes. A maximum of eight subnets can be entered per + start node. This limits the discovery to a set of devices within the specified + scope. + + ' + items: + $ref: '#/components/schemas/StartNodeScopeConfig' + type: array + tags: + description: 'A information field that can be added to start nodes. Maximum + 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - ipv4_address + - name + DeviceIdStartNodeQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of queries that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of queries deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the users for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the users by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + description: 'Query using query parameters. + + ' + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + DeviceIdStartNodeScreen: + properties: + description: + description: 'The device id start node description. + + ' + id: + description: 'The device ID. + + ' + type: string + ipv4_address: + description: 'The IPv4 address used as the starting point for network and + device discovery. + + ' + type: string + name: + description: 'Device ID start node name. + + ' + type: string + scope: + description: 'Subnet scopes. A maximum of eight subnets can be entered per + start node. This limits the discovery to a set of devices within the specified + scope. + + ' + items: + $ref: '#/components/schemas/StartNodeScopeConfig' + type: array + tags: + description: 'A information field that can be added to start nodes. Maximum + 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - ipv4_address + - name + Error: + properties: + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + type: string + message: + type: string + ListQueryResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + deleted_count: + description: 'The deleted number. + + ' + format: int64 + type: integer + deleted_ids: + description: 'The deleted IDs. + + ' + items: + type: string + type: array + description: + description: 'Description of the query. Max size = 256. + + ' + id: + description: 'The ID. + + ' + type: string + next_query: + description: 'Details of the next query. + + ' + type: object + total_count: + description: 'Total number. + + ' + format: int64 + type: integer + type: object + ListResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + id: + description: 'The ID. + + ' + type: string + type: object + SiteDetails: + properties: + site_id: + description: 'The profile site ID. + + ' + type: string + StartNodeScopeConfig: + properties: + ipv4_prefix: + description: 'The prefix of the IPv4 address. + + ' + type: string +info: + contact: {} + description: List of APIs used to retrieve IoT specific configuration like device + IDs and more. + title: IoT + version: Latest +openapi: 3.0.0 +paths: + /sdwan/v2.0/api/deviceidconfigs/query: + post: + description: List the device ID profiles. + operationId: post-sdwan-v2.0-api-deviceidconfigs-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfigQuery' + description: Details of the Device ID profile to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfigV2N1' + description: Successful Operation + summary: Get Device ID Profiles (v2.0) + tags: + - IoT + /sdwan/v2.0/api/deviceidprofiles/{deviceid_profile_id}/operations: + post: + description: Associate multiple sites to a profile. + operationId: post-sdwan-v2.0-api-deviceidprofiles-deviceid_profile_id-operations + parameters: + - description: Device ID of the profile ID. + in: path + name: deviceid_profile_id + required: true + schema: + description: Deviceid Profile Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdProfileOperations' + description: Details of the Device ID profile and sites to be associated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdProfileOperations' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICEID_INVALID_PROFILE_OPERATION + - code: DEVICEID_SITES_MISSING + - code: DEVICEID_DUPLICATE_SITE_DETECTED + - code: DEVICEID_INVALID_DEVICEID_PROFILE + - code: DEVICEID_INVALID_SITE_IDS + - code: DEVICEID_PROFILE_UPDATE_FAILED + - code: DEVICEID_LOCAL_SNMP_DISCOVERY_CANNOT_BE_ENABLE_FOR_DC_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Associate Device ID Profiles in Bulk (v2.0) + tags: + - IoT + /sdwan/v2.0/api/sites/{site_id}/deviceidconfigs: + get: + description: List all the device ID site configs. + operationId: get-sdwan-v2.0-api-sites-site_id-deviceidconfigs + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfig' + description: Successful Operation + summary: Get Device ID Site Configs (v2.0) + tags: + - IoT + post: + description: Details of the device ID site config to be created. + operationId: post-sdwan-v2.0-api-sites-site_id-deviceidconfigs + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfigScreen' + description: Details of the Device ID site config to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfig' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICE_ID_NOT_SUPPORTED_IN_HUB + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Device ID Site Config (v2.0) + tags: + - IoT + /sdwan/v2.0/api/sites/{site_id}/deviceidconfigs/{config_id}: + get: + description: Get device ID site configs for a particular config entry. + operationId: get-sdwan-v2.0-api-sites-site_id-deviceidconfigs-config_id + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The source site config ID. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfig' + description: Successful Operation + summary: Get Device ID Site Config (v2.0) + tags: + - IoT + put: + description: Update the device ID site config. + operationId: put-sdwan-v2.0-api-sites-site_id-deviceidconfigs-config_id + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The source site config ID. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfigScreen' + description: Details of the Device ID site config to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfig' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICE_ID_NOT_SUPPORTED_IN_HUB + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Device ID Site Config (v2.0) + tags: + - IoT + /sdwan/v2.0/api/sites/{site_id}/deviceidconfigs/{deviceid_config_id}/bulkdelete_snmpdiscoverystartnodes: + post: + description: Bulk delete device ID of start network node config. + operationId: post-sdwan-v2.0-api-sites-site_id-deviceidconfigs-deviceid_config_id-bulkdelete_snmpdiscoverystartnodes + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkDeviceIdDeleteStartNode' + description: Details of the Device ID start network node config to be updated + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BulkDeleteStartNode' + type: array + type: object + description: Returns list of deleted start node ids based on query + summary: Bulk Delete Start Network Node Config (v2.0) + tags: + - IoT + /sdwan/v2.0/api/sites/{site_id}/deviceidconfigs/{deviceid_config_id}/snmpdiscoverystartnodes: + get: + description: Get all Start Network Node config. + operationId: get-sdwan-v2.0-api-sites-site_id-deviceidconfigs-deviceid_config_id-snmpdiscoverystartnodes + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNode' + description: Successful Operation + summary: Get Start Network Node Config (v2.0) + tags: + - IoT + post: + description: Create Start Network Node config. + operationId: post-sdwan-v2.0-api-sites-site_id-deviceidconfigs-deviceid_config_id-snmpdiscoverystartnodes + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNodeScreen' + description: Details of the Device ID start network node config to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNode' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICEID_START_NODE_MAX_LIMIT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Start Network Node Config (v2.0) + tags: + - IoT + /sdwan/v2.0/api/sites/{site_id}/deviceidconfigs/{deviceid_config_id}/snmpdiscoverystartnodes/{deviceid_start_node_id}: + delete: + description: Delete Start Network Node config. + operationId: delete-sdwan-v2.0-api-sites-site_id-deviceidconfigs-deviceid_config_id-snmpdiscoverystartnodes-deviceid_start_node_id + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id type: string - Error: - properties: - _error: - items: - $ref: '#/components/schemas/ErrorResponse' - type: array - ErrorResponse: - properties: - code: + - description: The deviceid start node ID. + in: path + name: deviceid_start_node_id + required: true + schema: + description: Deviceid Start Node Id type: string - message: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNode' + description: Successful Operation + summary: Delete Start Network Node Config (v2.0) + tags: + - IoT + get: + description: Get Start Network Node config. + operationId: get-sdwan-v2.0-api-sites-site_id-deviceidconfigs-deviceid_config_id-snmpdiscoverystartnodes-deviceid_start_node_id + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id type: string -info: - contact: {} - description: List of APIs used to retrieve IoT specific configurations. Example; - Device IDs. - title: IoT - version: Latest -openapi: 3.0.0 -paths: - /sdwan/v2.0/api/sites/{site_id}/deviceidconfigs: + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + - description: The deviceid start node ID. + in: path + name: deviceid_start_node_id + required: true + schema: + description: Deviceid Start Node Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNode' + description: Successful Operation + summary: Get Start Network Node Config (v2.0) + tags: + - IoT + put: + description: Update Start Network Node config. + operationId: put-sdwan-v2.0-api-sites-site_id-deviceidconfigs-deviceid_config_id-snmpdiscoverystartnodes-deviceid_start_node_id + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + - description: The deviceid start node ID. + in: path + name: deviceid_start_node_id + required: true + schema: + description: Deviceid Start Node Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNodeScreen' + description: Details of the Device ID start network node config to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNode' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICEID_START_NODE_MAX_LIMIT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Start Network Node Config (v2.0) + tags: + - IoT + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/deviceidconfigs: get: - description: List all the device ID site configs. - operationId: get-sdwan-v2.0-api-sites-site_id-deviceidconfigs + description: Get device id element level configs. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-deviceidconfigs parameters: - description: The site ID. in: path @@ -56,19 +1056,33 @@ paths: schema: description: Site Id type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeviceIdConfig' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/DeviceIdElementConfig' + type: array + type: object description: Successful Operation - summary: Get Device ID Site Configs (v2.0) + summary: Get Device ID Element Level Configs (v2.0) tags: - IoT post: - description: Details of the device ID site config to be created. - operationId: post-sdwan-v2.0-api-sites-site_id-deviceidconfigs + description: Create device id element level (source interface) config. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-deviceidconfigs parameters: - description: The site ID. in: path @@ -77,18 +1091,25 @@ paths: schema: description: Site Id type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeviceIdConfigScreen' - description: Details of the Device ID site config to be created + $ref: '#/components/schemas/DeviceIdElementConfigScreen' + description: Details of the Device ID element level config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeviceIdConfig' + $ref: '#/components/schemas/DeviceIdElementConfig' description: Successful Operation '400': content: @@ -96,17 +1117,195 @@ paths: example: value: _error: - - code: DEVICE_ID_NOT_SUPPORTED_IN_HUB + - code: DEVICEID_INVALID_SOURCE_INTERFACE + - code: DEVICEID_INVALID_INTERFACE + - code: DEVICEID_INVALID_INTERFACE_TYPE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Device ID Site Config (v2.0) + summary: Create Device ID Element Level Config (v2.0) tags: - IoT - /sdwan/v2.0/api/sites/{site_id}/deviceidconfigs/{config_id}: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/deviceidconfigs/{config_id}: get: - description: Get device ID site configs for a particular config entry. - operationId: get-sdwan-v2.0-api-sites-site_id-deviceidconfigs-config_id + description: Get element level configs. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-deviceidconfigs-config_id + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The element ID. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + summary: Get Element Config (v2.0) + tags: + - IoT + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/deviceidconfigs/{deviceid_config_id}: + delete: + description: Delete device id element level (source interface) config. + operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-deviceidconfigs-deviceid_config_id + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdElementConfig' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICEID_INVALID_SOURCE_INTERFACE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Device ID Element Level Config (v2.0) + tags: + - IoT + put: + description: Update device id element level (source interface) config. + operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-deviceidconfigs-deviceid_config_id + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The deviceid config ID. + in: path + name: deviceid_config_id + required: true + schema: + description: Deviceid Config Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdElementConfigScreen' + description: Details of the Device ID element level config to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdElementConfig' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEVICEID_INVALID_SOURCE_INTERFACE + - code: DEVICEID_INVALID_INTERFACE + - code: DEVICEID_INVALID_INTERFACE_TYPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Device ID Element Level Config (v2.0) + tags: + - IoT + /sdwan/v2.0/api/snmpdiscoverystartnodes/query: + post: + description: Query Start Network Node based on parameters. + operationId: post-sdwan-v2.0-api-snmpdiscoverystartnodes-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdStartNodeQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/DeviceIdStartNodeQuery' + type: array + type: object + description: Successful Operation + summary: Query Start Network Node (v2.0) + tags: + - IoT + /sdwan/v2.1/api/sites/{site_id}/deviceidconfigs: + get: + description: List all the device ID site configs. + operationId: get-sdwan-v2.1-api-sites-site_id-deviceidconfigs + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceIdConfigV2N1' + description: Successful Operation + summary: Get Device ID Site Configs (v2.0) + tags: + - IoT + /sdwan/v2.1/api/sites/{site_id}/deviceidconfigs/{config_id}: + get: + description: Get device ID for a site for a particular config entry. + operationId: get-sdwan-v2.1-api-sites-site_id-deviceidconfigs-config_id parameters: - description: The site ID. in: path @@ -127,14 +1326,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeviceIdConfig' + $ref: '#/components/schemas/DeviceIdConfigV2N1' description: Successful Operation summary: Get Device ID Site Config (v2.0) tags: - IoT put: - description: Update the device ID site config. - operationId: put-sdwan-v2.0-api-sites-site_id-deviceidconfigs-config_id + description: Update device ID site config and associate deviceid profile. + operationId: put-sdwan-v2.1-api-sites-site_id-deviceidconfigs-config_id parameters: - description: The site ID. in: path @@ -161,7 +1360,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeviceIdConfig' + $ref: '#/components/schemas/DeviceIdConfigV2N1' description: Successful Operation '400': content: @@ -169,7 +1368,7 @@ paths: example: value: _error: - - code: DEVICE_ID_NOT_SUPPORTED_IN_HUB + - code: DEVICEID_INVALID_PROFILE_ID schema: $ref: '#/components/schemas/Error' description: Bad Request diff --git a/openapi-specs/sdwan/unified/Metrics.yaml b/openapi-specs/sdwan/unified/Metrics.yaml index 9c9658f60..2314e2524 100644 --- a/openapi-specs/sdwan/unified/Metrics.yaml +++ b/openapi-specs/sdwan/unified/Metrics.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view AggregateMetric: properties: name: @@ -75,6 +69,89 @@ components: - statistic - unit - name + AggregateStatsFilter: + properties: + app: + description: 'Filter by aggregate stats app ID. + + ' + items: + description: App + type: string + type: array + path: + description: 'Filter by path. + + ' + items: + description: Path + type: string + type: array + site: + description: 'Filter by aggregate stats filter site ID. + + ' + items: + description: Site + type: string + type: array + required: + - site + - app + AggregateStatsQuery: + properties: + aggregates: + description: 'The aggregate number of supported app stats. Max number = + 10. + + ' + items: + description: Aggregates + type: map[string,aggregatestatstypeenum] + type: array + end_time: + description: 'The end time to get the app stats. + + ' + format: date + type: string + filter: + $ref: '#/components/schemas/AggregateStatsFilter' + description: "Filters according to the specifications. \n" + name: + description: 'The description of the app. Maz size = 128. + + ' + type: string + start_time: + description: "The start time to get the app statistics. \n" + format: date + type: string + required: + - filter + - aggregates + AggregateStatsResponse: + properties: + aggregates: + description: 'The aggregate number of supported app stats. Max number = + 10. + + ' + items: + type: object + type: array + end_time: + description: 'The end time to get the app stats. + + ' + format: date + type: string + start_time: + description: 'The start time to get the app statistics. + + ' + format: date + type: string AggregatesQueryResponse: properties: aggregates: @@ -84,8 +161,40 @@ components: items: $ref: '#/components/schemas/Aggregate' type: array - required: - - aggregates + AppObjectStatsResponse: + properties: + data: + description: Data + items: + type: object + type: array + end_time: + format: date + type: string + filter: + $ref: '#/components/schemas/AppStatsFilter' + description: Filter + object_type: + description: Object Type + enum: + - PeerStatistics + - IntfStatistics + - CellularModuleStatistics + - CellularAPNStatistics + - CellularAPNV6Statistics + - MulticastStatistics + - SecurityPolicyRule + - IntfPoEStatistics + - IntfLLDPStatistics + - IntfAAAStatistics + - IntfSTPStatistics + - STPStatistics + - PoEStatistics + - AppSummaryStats + type: string + start_time: + format: date + type: string AppStatsAggregate: properties: name: @@ -103,7 +212,6 @@ components: description: Unit type: string required: - - unit - name AppStatsAggregateData: properties: @@ -134,12 +242,6 @@ components: unit: description: Unit type: string - required: - - unit - - name - - start_time - - end_time - - data AppStatsAggregateFilter: properties: app: @@ -201,10 +303,6 @@ components: start_time: description: "The start time to get the app statistics. \n" type: string - required: - - end_time - - start_time - - aggregates AppStatsAggregatesQuery: properties: aggregates: @@ -236,11 +334,12 @@ components: format: date type: string required: - - filter - aggregates - - start_time - - name - - end_time + AppStatsFilter: + properties: + health_score: + description: Health Score + type: map[appstatsoperatortype,string] AppStatsSupportedAggregate: properties: description: @@ -260,21 +359,13 @@ components: description: Units type: string type: array - required: - - units - - name - - description AppStatsSupportedAggregatesResponse: properties: aggregates: - description: 'The supported number of app stats. - - ' + description: Aggregates items: $ref: '#/components/schemas/AppStatsSupportedAggregate' type: array - required: - - aggregates AppStatsTopNFilter: properties: app: @@ -381,12 +472,8 @@ components: - egress_audio_mos type: string required: - - filter - topn_basis - top_n - - start_time - - name - - end_time AppStatsTopNResponse: properties: top_n: @@ -394,8 +481,6 @@ components: description: 'The details of the Top N reports. ' - required: - - top_n AppStatsTopNResponseData: properties: end_time: @@ -452,13 +537,6 @@ components: - app - site type: string - required: - - topn_basis - - type - - items - - start_time - - limit - - end_time AppStatsTopNView: properties: limit: @@ -474,7 +552,6 @@ components: type: string required: - type - - limit ApplicationQosAggregatesQuery: properties: aggregates: @@ -510,11 +587,7 @@ components: description: "View the QoS metric details. \n" required: - filter - - view - aggregates - - start_time - - name - - end_time ApplicationQosMetricsFilter: properties: application_name: @@ -547,18 +620,12 @@ components: type: string type: array user: - description: 'Filter by user. - - ' + description: "Filter by user. \n" items: description: User type: string type: array required: - - direction - - email - - site - - user - application_name ApplicationQosMetricsQuery: properties: @@ -578,11 +645,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max datapoints of the application QoS metrics. @@ -615,22 +682,17 @@ components: ' required: - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time ApplicationQosMetricsResponse: properties: metrics: - description: Metrics + description: 'Details of the application metrics. + + ' items: $ref: '#/components/schemas/Metrics' type: array - required: - - metrics ApplicationUserData: properties: client_ip: @@ -651,11 +713,6 @@ components: user_name: description: "The user name of the application user. \n" type: string - required: - - client_ip - - site - - user_name - - email ApplicationUsersQuery: properties: application_name: @@ -682,9 +739,6 @@ components: type: string required: - application_name - - start_time - - name - - end_time ApplicationUsersResponse: properties: data: @@ -692,8 +746,6 @@ components: items: $ref: '#/components/schemas/ApplicationUserData' type: array - required: - - data BaseTopNQuery: properties: end_time: @@ -731,12 +783,8 @@ components: ' type: string required: - - filter - topn_basis - top_n - - start_time - - name - - end_time BaseTopNResponse: properties: top_n: @@ -744,8 +792,6 @@ components: description: 'The details of the Top N reports. ' - required: - - top_n BaseTopNResponseData: properties: end_time: @@ -783,13 +829,6 @@ components: ' type: string - required: - - topn_basis - - type - - items - - start_time - - limit - - end_time BaseTopNView: properties: limit: @@ -805,7 +844,124 @@ components: type: string required: - type - - limit + CapacityPredictionFilter: + properties: + direction: + description: 'Filter by direction of traffic. + + ' + enum: + - Ingress + - Egress + type: string + site: + description: 'Filter by site. + + ' + items: + description: Site + type: string + type: array + wn_path: + description: "Filter by WAN path. \n" + items: + description: Wn Path + type: string + type: array + CapacityPredictionQuery: + properties: + anomaly: + description: "The number of sites that will reach high capacity utilization\ + \ threshold within the next 28 days. \n" + items: + $ref: '#/components/schemas/Forecast' + type: array + end_time: + description: 'The end time of the capacity prediction query. End times need + to be specified in ISO8601 UTC format. + + ' + format: date + type: string + filter: + $ref: '#/components/schemas/CapacityPredictionFilter' + description: 'Filters according to the specifications. + + ' + forecast: + description: 'The details of the forecast. + + ' + items: + $ref: '#/components/schemas/Forecast' + type: array + forecast_basis: + description: 'The forecast basis types. Forecast basis need be to specified + according to 2.0 specifications. + + ' + items: + description: Forecast Basis Types + enum: + - CAPACITY_EXCEED_THRESHOLD + - ANOMALY + - CIRCUIT_CAPACITY_FORECAST + - CIRCUIT_UTILIZATION + - ANOMALY_SITE_CIRCUIT_DETAILS + type: string + type: array + forecast_date: + description: 'The forecast data. + + ' + format: date + type: string + name: + description: 'The name of the capacity prediction query. Maz size = 128. + + ' + type: string + start_time: + description: 'The start time to get the capacity prediction query. Start + times need to be specified in ISO8601 UTC format., + + ' + format: date + type: string + type: + description: 'The type of capacity prediction query. Type need to be specified + according to the specifications. + + ' + enum: + - SITE + - CIRCUIT + type: string + CapacityPredictionResponse: + properties: + anomaly: + description: "The number of sites that will reach high capacity utilization\ + \ threshold within the next 28 days. \n" + type: object + end_time: + description: "The end time of the capacity prediction query. End times need\ + \ to be specified in ISO8601 UTC format. \n" + format: date + type: string + forecast: + description: "The details of the forecast. \n" + type: object + forecast_date: + description: "The forecast data. \n" + format: date + type: string + start_time: + description: 'The start time to get the capacity prediction query. Start + times need to be specified in ISO8601 UTC format. + + ' + format: date + type: string CellularmetricsFilter: properties: apn: @@ -857,13 +1013,6 @@ components: description: Site type: string type: array - required: - - carrier - - apn - - cellular_module - - direction - - site - - element CellularmetricsQuery: properties: end_time: @@ -883,11 +1032,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max data points. @@ -923,14 +1072,8 @@ components: ' required: - - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time CellularmetricsResponse: properties: metrics: @@ -938,8 +1081,6 @@ components: items: $ref: '#/components/schemas/Metrics' type: array - required: - - metrics CellularmetricsSchemaResponse: properties: metrics: @@ -949,8 +1090,6 @@ components: items: $ref: '#/components/schemas/MetricSchema' type: array - required: - - metrics ClientDetails: properties: aging_timeout: @@ -1011,15 +1150,6 @@ components: ' type: integer - required: - - stats_start_time_ms - - uptime - - reauth_timeout - - vlan_id - - username - - mac_address - - interface_id - - element_id Data: properties: datapoints: @@ -1030,9 +1160,6 @@ components: statistics: description: Statistics type: object - required: - - datapoints - - statistics Datapoints: properties: duration: @@ -1052,6 +1179,9 @@ components: description: Links type: string type: array + ninetieth_percentile: + description: Ninetieth Percentile + type: number sites: description: 'The sites. @@ -1065,12 +1195,6 @@ components: ' type: number - required: - - filter_property_id - - sites - - links - - value - - duration Error: properties: _error: @@ -1111,201 +1235,31 @@ components: ' type: string - required: - - path - - site - - elements - FlowDecisionMetadata: + FlowSummary: properties: - available_wan_networks: - description: 'Available Wan Networks: JsonAlias(value = [bw_paths]) JsonInclude(content - = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = - classOf[Void]) ' - items: - description: Available Wan Networks - type: string - type: array - chosen_wan_path: - description: 'Chosen Wan Path: JsonAlias(value = [path_id]) ' + app_id: + description: App Id type: string - flow_decision_bitmap: - description: 'Flow Decision Bitmap: JsonAlias(value = [bitmap]) JsonInclude(content - = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = - classOf[Void]) ' - items: - description: Flow Decision Bitmap - format: int64 - type: integer - type: array - flow_decision_time: - description: 'Flow Decision Time: JsonAlias(value = [time]) ' - format: int64 - type: integer - policy_allowed_wan_paths: - description: 'Policy Allowed Wan Paths: JsonAlias(value = [policy_paths]) - JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, - valueFilter = classOf[Void]) ' - items: - description: Policy Allowed Wan Paths - type: string - type: array - predictive_wan_network_normalized_load: - description: 'Predictive Wan Network Normalized Load: JsonAlias(value = - [bw_values]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - items: - description: Predictive Wan Network Normalized Load - type: string - type: array - preferred_wan_path: - description: 'Preferred Wan Path: JsonAlias(value = [pref_wan_path]) JsonInclude(content - = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = - classOf[Void]) ' - type: string - sla_filtered_state_up_policy_allowed_wan_paths: - description: 'Sla Filtered State Up Policy Allowed Wan Paths: JsonAlias(value - = [policy_l2l3_sla_paths]) JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - items: - description: Sla Filtered State Up Policy Allowed Wan Paths - type: string - type: array - state_up_policy_allowed_wan_paths: - description: 'State Up Policy Allowed Wan Paths: JsonAlias(value = [policy_l2l3_paths]) - JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, - valueFilter = classOf[Void]) ' - items: - description: State Up Policy Allowed Wan Paths - type: string - type: array - required: - - flow_decision_time - - chosen_wan_path - - preferred_wan_path - - predictive_wan_network_normalized_load - - available_wan_networks - - sla_filtered_state_up_policy_allowed_wan_paths - - state_up_policy_allowed_wan_paths - - policy_allowed_wan_paths - - flow_decision_bitmap - FlowDetails: - properties: - app_id: - description: App Id - type: string - average_ntt: - description: 'Average Ntt: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - average_pg: - description: 'Average Pg: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - average_rtt: - description: 'Average Rtt: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - average_srt: - description: 'Average Srt: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - average_udp_trt: - description: 'Average Udp Trt: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_jitter_c2s: - description: 'Avg Jitter C2s: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_jitter_s2c: - description: 'Avg Jitter S2c: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_mos_c2s: - description: 'Avg Mos C2s: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_mos_s2c: - description: 'Avg Mos S2c: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_packet_loss_c2s: - description: 'Avg Packet Loss C2s: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - avg_packet_loss_s2c: - description: 'Avg Packet Loss S2c: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - bytes_c2s: - description: Bytes C2s + bytes_c2s: + description: Bytes C2s format: int64 type: integer bytes_s2c: description: Bytes S2c format: int64 type: integer - codec_c2s: - description: 'Codec C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - items: - description: Codec C2s - format: int64 - type: integer - type: array - codec_s2c: - description: 'Codec S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - items: - description: Codec S2c - format: int64 - type: integer - type: array destination_ip: description: Destination Ip type: string - destination_lan_network_id: - description: Destination Lan Network Id - type: string - destination_lan_vlan_id: - description: Destination Lan Vlan Id - type: integer destination_port: description: Destination Port type: integer - element_id: - description: Element Id - type: string fc_app_id: description: Fc App Id type: string - fin_c2s: - description: Fin C2s - format: int64 - type: integer - fin_s2c: - description: Fin S2c - format: int64 - type: integer flow_action: description: Flow Action type: string - flow_decision_metadata_list: - description: Flow Decision Metadata List - items: - $ref: '#/components/schemas/FlowDecisionMetadata' - type: array flow_end_time_ms: description: Flow End Time Ms format: int64 @@ -1314,176 +1268,21 @@ components: description: Flow Start Time Ms format: int64 type: integer - incomplete_trans: - description: 'Incomplete Trans: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: int64 - type: integer - init_success: - description: 'Init Success: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - type: boolean is_local_traffic: description: Is Local Traffic type: boolean - is_sec_policy_present: - description: Is Sec Policy Present - type: boolean is_v6: description: Is V6 type: boolean - lan_dscp_lan_to_wan: - description: 'Lan Dscp Lan To Wan: JsonDeserialize(as = classOf[Void], builder - = classOf[Void], contentAs = classOf[Void], contentConverter = classOf[Converter$None], - contentUsing = classOf[JsonDeserializer$None], converter = classOf[Converter$None], - keyAs = classOf[Void], keyUsing = classOf[KeyDeserializer$None], using - = classOf[CustomGetSetPositionsDeserializer]) ' - items: - description: Lan Dscp Lan To Wan - type: integer - type: array - lan_dscp_wan_to_lan: - description: 'Lan Dscp Wan To Lan: JsonDeserialize(as = classOf[Void], builder - = classOf[Void], contentAs = classOf[Void], contentConverter = classOf[Converter$None], - contentUsing = classOf[JsonDeserializer$None], converter = classOf[Converter$None], - keyAs = classOf[Void], keyUsing = classOf[KeyDeserializer$None], using - = classOf[CustomGetSetPositionsDeserializer]) ' - items: - description: Lan Dscp Wan To Lan - type: integer - type: array - lan_origination_id: - description: Lan Origination Id - type: string - lan_termination_id: - description: Lan Termination Id - type: string lan_to_wan: description: Lan To Wan type: boolean - max_jitter_c2s: - description: 'Max Jitter C2s: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_jitter_s2c: - description: 'Max Jitter S2c: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_mos_c2s: - description: 'Max Mos C2s: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_mos_s2c: - description: 'Max Mos S2c: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_ntt: - description: 'Max Ntt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_packet_loss_c2s: - description: 'Max Packet Loss C2s: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_packet_loss_s2c: - description: 'Max Packet Loss S2c: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_pg: - description: 'Max Pg: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_rtt: - description: 'Max Rtt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_srt: - description: 'Max Srt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - max_udp_trt: - description: 'Max Udp Trt: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - media_type: - description: 'Media Type: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - type: string - min_mos_c2s: - description: 'Min Mos C2s: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_mos_s2c: - description: 'Min Mos S2c: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_ntt: - description: 'Min Ntt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_pg: - description: 'Min Pg: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_rtt: - description: 'Min Rtt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_srt: - description: 'Min Srt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - min_udp_trt: - description: 'Min Udp Trt: JsonInclude(content = ALWAYS, contentFilter = - classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: float - type: number - network_policy_dst_prefix_id: - description: Network Policy Dst Prefix Id - type: string network_policy_id: description: Network Policy Id type: string - network_policy_nctx_id: - description: Network Policy Nctx Id - type: string network_policy_set_id: description: Network Policy Set Id type: string - network_policy_src_prefix_id: - description: Network Policy Src Prefix Id - type: string - network_policy_stack_id: - description: Network Policy Stack Id - type: string - new_flow: - description: New Flow - type: boolean - ooo_pkts_c2s: - description: Ooo Pkts C2s - format: int64 - type: integer - ooo_pkts_s2c: - description: Ooo Pkts S2c - format: int64 - type: integer packets_c2s: description: Packets C2s format: int64 @@ -1501,350 +1300,140 @@ components: policy_id: description: Policy Id type: string - priority_class: - description: 'Priority Class: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - type: integer - priority_policy_default_rule_mapping_incoming_dscp: - description: Priority Policy Default Rule Mapping Incoming Dscp - format: int64 - type: integer - priority_policy_dst_prefix_id: - description: Priority Policy Dst Prefix Id - type: string priority_policy_id: description: Priority Policy Id type: string - priority_policy_nctx_id: - description: Priority Policy Nctx Id - type: string - priority_policy_remark_dscp: - description: Priority Policy Remark Dscp - format: int64 - type: integer priority_policy_set_id: description: Priority Policy Set Id type: string - priority_policy_src_prefix_id: - description: Priority Policy Src Prefix Id - type: string - priority_policy_stack_id: - description: Priority Policy Stack Id - type: string protocol: description: Protocol type: integer - reset_c2s: - description: Reset C2s - format: int64 - type: integer - reset_s2c: - description: Reset S2c - format: int64 - type: integer - retransmit_bytes_c2s: - description: Retransmit Bytes C2s - format: int64 - type: integer - retransmit_bytes_s2c: - description: Retransmit Bytes S2c - format: int64 - type: integer - retransmit_pkts_c2s: - description: Retransmit Pkts C2s - format: int64 - type: integer - retransmit_pkts_s2c: - description: Retransmit Pkts S2c - format: int64 - type: integer - sack_pkts_c2s: - description: Sack Pkts C2s - format: int64 - type: integer - sack_pkts_s2c: - description: Sack Pkts S2c - format: int64 - type: integer - sec_fc_app_id: - description: Sec Fc App Id + sec_policy_actions: + description: Sec Policy Actions items: - description: Sec Fc App Id + description: Sec Policy Actions type: string type: array - security_policy_rules: - description: 'Security Policy Rules: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = NON_EMPTY, valueFilter = classOf[Void]) ' - items: - $ref: '#/components/schemas/SecurityPolicyRules' - type: array service_endpoint_id: - description: 'Service Endpoint Id: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' + description: Service Endpoint Id type: string source_ip: description: Source Ip type: string - source_lan_network_id: - description: Source Lan Network Id - type: string - source_lan_vlan_id: - description: Source Lan Vlan Id - type: integer source_port: description: Source Port type: integer - success_transactions: - description: 'Success Transactions: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - format: int64 - type: integer - syn_c2s: - description: Syn C2s - format: int64 - type: integer - syn_s2c: - description: Syn S2c - format: int64 - type: integer - traffic_type: - description: 'Traffic Type: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' - type: string unknown_domain: description: Unknown Domain type: string - unknown_reason: - description: Unknown Reason - type: string user_name: description: User Name type: string - vlan_id: - description: Vlan Id - type: integer - wan_path_change_reason: - description: 'Wan Path Change Reason: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' + vrf_id: + description: Vrf Id type: string - waninterface_id: - description: Waninterface Id - type: string - win_scaler_c2s: - description: Win Scaler C2s - format: int64 - type: integer - win_scaler_s2c: - description: Win Scaler S2c - format: int64 - type: integer - win_size_c2s: - description: Win Size C2s - format: int64 - type: integer - win_size_s2c: - description: Win Size S2c - format: int64 - type: integer - required: - - user_name - - is_v6 - - win_scaler_s2c - - win_scaler_c2s - - win_size_s2c - - win_size_c2s - - sack_pkts_s2c - - sack_pkts_c2s - - ooo_pkts_s2c - - ooo_pkts_c2s - - retransmit_pkts_s2c - - retransmit_pkts_c2s - - retransmit_bytes_s2c - - retransmit_bytes_c2s - - reset_s2c - - reset_c2s - - fin_s2c - - fin_c2s - - syn_s2c - - syn_c2s - - flow_decision_metadata_list - - security_policy_rules - - destination_lan_vlan_id - - source_lan_vlan_id - - destination_lan_network_id - - source_lan_network_id - - lan_termination_id - - lan_origination_id - - sec_fc_app_id - - is_sec_policy_present - - min_mos_s2c - - min_mos_c2s - - max_mos_s2c - - max_mos_c2s - - max_jitter_s2c - - max_jitter_c2s - - max_packet_loss_s2c - - max_packet_loss_c2s - - avg_mos_s2c - - avg_mos_c2s - - avg_jitter_s2c - - avg_jitter_c2s - - avg_packet_loss_s2c - - avg_packet_loss_c2s - - codec_s2c - - codec_c2s - - media_type - - min_udp_trt - - max_udp_trt - - average_udp_trt - - min_pg - - max_pg - - average_pg - - min_ntt - - max_ntt - - average_ntt - - min_srt - - max_srt - - average_srt - - min_rtt - - max_rtt - - average_rtt - - incomplete_trans - - success_transactions - - priority_policy_remark_dscp - - priority_policy_default_rule_mapping_incoming_dscp - - lan_dscp_wan_to_lan - - lan_dscp_lan_to_wan - - priority_class - - traffic_type - - packets_s2c - - packets_c2s - - bytes_s2c - - bytes_c2s - - unknown_domain - - unknown_reason - - flow_action - - priority_policy_stack_id - - priority_policy_set_id - - priority_policy_nctx_id - - priority_policy_dst_prefix_id - - priority_policy_src_prefix_id - - network_policy_stack_id - - network_policy_set_id - - network_policy_nctx_id - - network_policy_dst_prefix_id - - network_policy_src_prefix_id - - priority_policy_id - - network_policy_id - - policy_id - - service_endpoint_id - - vlan_id - - is_local_traffic - - flow_end_time_ms - - lan_to_wan - - path_type - - wan_path_change_reason - - waninterface_id - - path_id - - fc_app_id - - element_id - - app_id - - init_success - - new_flow - - flow_start_time_ms - - protocol - - destination_port - - destination_ip - - source_port - - source_ip FlowTupple: properties: destination_ip: - description: Destination Ip + description: 'Filter by destination IP address. + + ' items: description: Destination Ip type: string type: array destination_port: - description: Destination Port + description: 'Filter by destination port. + + ' items: description: Destination Port type: integer type: array protocol: - description: Protocol + description: 'Filter by protocol. + + ' type: integer source_ip: - description: Source Ip + description: 'Filter by source IP address. + + ' items: description: Source Ip type: string type: array source_port: - description: Source Port + description: 'Filter by source port. + + ' items: description: Source Port type: integer type: array - required: - - source_port - - source_ip - - protocol - - destination_port - - destination_ip Flows: properties: debug_level: - description: Debug Level + description: "The values of the debug levels. \n" type: string end_time: - description: End Time + description: "The end time to get the flows information. \n" type: string items: - description: Items + description: "The flow summary information. \n" items: - $ref: '#/components/schemas/FlowDetails' + $ref: '#/components/schemas/FlowSummary' type: array start_time: - description: Start Time + description: 'The start time to get the flow information. + + ' type: string - required: - - start_time - - items - - end_time - - debug_level FlowsFilter: properties: app: - description: App + description: 'Filter by app. + + ' items: description: App type: string type: array element: - description: Element + description: 'Filter by element. + + ' items: description: Element type: string type: array flow: $ref: '#/components/schemas/FlowTupple' - description: Flow + description: 'Filter by flows information. + + ' flow_type: - description: Flow Type + description: 'Filter by flows type. + + ' enum: - local - wan - all type: string path: - description: Path + description: 'Filter by path. + + ' items: description: Path type: string type: array path_type: - description: Path Type + description: 'Filter by path. + + ' items: description: Path Type enum: @@ -1857,55 +1446,52 @@ components: type: string type: array security_policy_destination_zone: - description: Security Policy Destination Zone + description: 'Filter by security policy destination zone. + + ' items: description: Security Policy Destination Zone type: string type: array security_policy_rule: - description: Security Policy Rule + description: 'Filter by security policy rule. + + ' items: description: Security Policy Rule type: string type: array security_policy_rule_action: - description: Security Policy Rule Action + description: 'Filter by policy rule action. + + ' enum: - allow - deny - reject type: string security_policy_source_zone: - description: Security Policy Source Zone + description: 'Filter by security policy source zone. + + ' items: description: Security Policy Source Zone type: string type: array site: - description: Site + description: "Filter by site. \n" items: description: Site type: string type: array waninterface: - description: Waninterface + description: 'Filter by waninterface. + + ' items: description: Waninterface type: string type: array - required: - - site - - security_policy_source_zone - - security_policy_rule_action - - security_policy_rule - - security_policy_destination_zone - - path_type - - waninterface - - path - - flow_type - - flow - - element - - app FlowsQuery: properties: debug_level: @@ -1929,30 +1515,217 @@ components: description: 'The max data points. ' - type: integer - name: - description: 'The description of the flow. Maz size = 128. + type: integer + name: + description: 'The description of the flow. Maz size = 128. + + ' + type: string + start_time: + description: "The start time to get the flow information. \n" + format: date + type: string + FlowsQueryResponse: + properties: + flows: + $ref: '#/components/schemas/Flows' + description: Flows + Forecast: + properties: + actual_forecast_date: + description: 'The forecast date and time. + + ' + format: date-time + type: string + bw_site_anomaly: + description: Bw Site Anomaly + type: number + forecast_status: + description: 'The forecast status. True or False. + + ' + type: boolean + items: + description: 'The deatils of the forecast results. + + ' + items: + $ref: '#/components/schemas/ForecastResult' + type: array + name: + description: 'The name of the forecast. + + ' + enum: + - CAPACITY_EXCEED_THRESHOLD + - ANOMALY + - CIRCUIT_CAPACITY_FORECAST + - CIRCUIT_UTILIZATION + - ANOMALY_SITE_CIRCUIT_DETAILS + type: string + type: + description: 'The type of forecast. + + ' + enum: + - FORECAST_28_DAYS + - FORECAST_7_DAYS + - CIRCUIT_UTILIZATION_ANOMALY + type: string + ForecastResult: + properties: + direction: + description: 'The direction of traffic. + + ' + type: map[string,capacityprediction] + site: + description: 'The site. + + ' + type: string + wn_path: + description: 'The WAN path. + + ' + type: string + HealthData: + properties: + fair: + description: Fair + type: object + good: + description: Good + type: object + others: + description: Others + type: object + poor: + description: Poor + type: object + total: + description: Total + type: number + type: + description: Type + type: string + HealthFilter: + properties: + application_health: + description: Application Health + items: + description: Application Health + enum: + - POOR + - FAIR + - GOOD + - OTHERS + - ALL + type: string + type: array + link_health: + description: Link Health + items: + description: Link Health + enum: + - POOR + - FAIR + - GOOD + - OTHERS + - ALL + type: string + type: array + site_health: + description: Site Health + items: + description: Site Health + enum: + - POOR + - FAIR + - GOOD + - OTHERS + - ALL + type: string + type: array + HealthScoreQuery: + properties: + end_time: + description: 'The end time to get the healthscore metrics. + + ' + format: date + type: string + filter: + $ref: '#/components/schemas/HealthFilter' + description: 'Filters according to the specifications. + + ' + interval: + description: 'The interval time of the healthscore responses. + + ' + enum: + - 10sec + - 1min + - 5min + - 1hour + - 1day + type: string + name: + description: 'The name of the healthscore filter. + + ' + type: string + start_time: + description: 'The start time to get the healthscore metrics. + + ' + format: date + type: string + view: + description: 'View the healthscore metrics. + + ' + enum: + - SUMMARY + - TIMESERIES + type: string + HealthScoreResponse: + properties: + data: + description: "The details of the health data. \n" + items: + $ref: '#/components/schemas/HealthData' + type: array + end_time: + description: 'The end time to get the health data. + + ' + format: date + type: string + interval: + description: 'The interval time of the health data response. ' + enum: + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string start_time: - description: "The start time to get the flow information. \n" + description: 'The start time to get the health data. + + ' format: date type: string - required: - - max_datapoints - - filter - - debug_level - - start_time - - name - - end_time - FlowsQueryResponse: - properties: - flows: - $ref: '#/components/schemas/Flows' - description: Flows - required: - - flows + view: + description: 'View the health score data. + + ' + type: object LqmStatsAggregateHealthScoreRequest: properties: aggregation: @@ -1990,9 +1763,6 @@ components: required: - healthscore_type - aggregation - - start_time - - name - - end_time LqmStatsAggregateHealthScoreResponse: properties: aggregation: @@ -2026,20 +1796,12 @@ components: start_time: description: "The start time to get the health score query. \n" type: string - required: - - items - - aggregation - - healthscore_type - - end_time - - start_time LqmStatsClientHealthScoreAggregateData: properties: value: description: Value format: int32 type: integer - required: - - value LqmStatsHealthScoreAggregateData: properties: count: @@ -2059,10 +1821,6 @@ components: - fair - good type: string - required: - - count - - data - - health MetricSchema: properties: description: @@ -2090,11 +1848,6 @@ components: description: Units type: string type: array - required: - - description - - statistics - - units - - name MetricSchemaResponse: properties: metrics: @@ -2104,8 +1857,6 @@ components: items: $ref: '#/components/schemas/MetricSchema' type: array - required: - - metrics Metrics: properties: series: @@ -2115,8 +1866,6 @@ components: items: $ref: '#/components/schemas/Series' type: array - required: - - series MonitorMetricsFilter: properties: anynet_link: @@ -2193,17 +1942,6 @@ components: description: Waninterface type: string type: array - required: - - anynet_link - - waninterface - - remote_site - - path_type - - path - - app - - sprid - - direction - - site - - element MonitorMetricsQuery: properties: end_time: @@ -2222,11 +1960,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max data points. @@ -2256,14 +1994,8 @@ components: ' required: - - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time MonitorMetricsResponse: properties: metrics: @@ -2273,8 +2005,6 @@ components: items: $ref: '#/components/schemas/Metrics' type: array - required: - - metrics MulticastRouteIncomingInterface: properties: iif: @@ -2292,10 +2022,6 @@ components: ' type: string - required: - - is_site_interface - - wanpath - - iif MulticastRouteOutgoingInterface: properties: is_site_interface: @@ -2314,10 +2040,6 @@ components: description: Wanpaths type: string type: array - required: - - is_site_interface - - wanpaths - - oif MulticastRouteOutgoingInterfaceStatsData: properties: is_site_interface: @@ -2331,10 +2053,6 @@ components: items: $ref: '#/components/schemas/MulticastRouteWanpathStatsData' type: array - required: - - is_site_interface - - wanpaths - - oif MulticastRouteOutgoingInterfaceStatsResponse: properties: end_time: @@ -2348,10 +2066,6 @@ components: start_time: description: Start Time type: string - required: - - start_time - - end_time - - oif_list MulticastRouteSourceGroupStatsData: properties: flags: @@ -2395,14 +2109,6 @@ components: ' type: string - required: - - rx_packets - - rx_bytes - - flags - - outgoing_interfaces - - incoming_interface - - group - - source MulticastRouteSourceGroupStatsResponse: properties: end_time: @@ -2422,10 +2128,6 @@ components: ' type: string - required: - - source_group_list - - start_time - - end_time MulticastRouteStatsFilter: properties: element: @@ -2461,7 +2163,6 @@ components: type: string type: array required: - - group - source - site - element @@ -2506,9 +2207,6 @@ components: - is_active - type - filter - - start_time - - name - - end_time MulticastRouteWanpathStatsData: properties: last_active: @@ -2525,11 +2223,6 @@ components: wanpath: description: Wanpath type: string - required: - - last_active - - tx_packets - - tx_bytes - - wanpath MulticastWANNeighborStatsFilter: properties: element: @@ -2596,9 +2289,6 @@ components: required: - filter - object_type - - start_time - - name - - end_time MulticastWANPIMStatsData: properties: end_time: @@ -2686,22 +2376,6 @@ components: ' type: string - required: - - pim_bsm_tx_pkts - - pim_bsm_rx_pkts - - pim_assert_tx_pkts - - pim_assert_rx_pkts - - pim_join_prune_rx_pkts - - pim_join_prune_tx_pkts - - pim_register_rx_pkts - - pim_register_tx_pkts - - pim_register_stop_rx_pkts - - pim_register_stop_tx_pkts - - pim_hello_rx_pkts - - pim_hello_tx_pkts - - remote_site_id - - start_time - - end_time MulticastWANPIMStatsResponse: properties: data: @@ -2709,8 +2383,6 @@ components: description: 'The multicast WAN PIM statistics. ' - required: - - data MulticastWANPathStats: properties: rx_bytes: @@ -2746,12 +2418,6 @@ components: ' type: string - required: - - rx_bytes - - tx_bytes - - tx_packets - - rx_packets - - wanpath MulticastWANPathStatsData: properties: end_time: @@ -2774,11 +2440,6 @@ components: items: $ref: '#/components/schemas/MulticastWANPathStats' type: array - required: - - wanpath_list - - remote_site_id - - start_time - - end_time MulticastWANPathStatsResponse: properties: data: @@ -2786,8 +2447,6 @@ components: description: 'The multicast WAN path statistics. ' - required: - - data MulticastWANTrafficStatsData: properties: end_time: @@ -2829,14 +2488,6 @@ components: ' format: int64 type: integer - required: - - rx_bytes - - tx_bytes - - tx_packets - - rx_packets - - remote_site_id - - start_time - - end_time MulticastWANTrafficStatsResponse: properties: data: @@ -2844,8 +2495,6 @@ components: description: 'The multicast WAN traffic statistics. ' - required: - - data NetworkPointMetrics: properties: name: @@ -2863,10 +2512,6 @@ components: unit: description: Unit type: string - required: - - sites - - unit - - name NetworkPointMetricsFilter: properties: direction: @@ -2914,13 +2559,6 @@ components: description: Waninterface type: string type: array - required: - - direction - - waninterface - - interface - - site - - sites - - element NetworkPointMetricsQuery: properties: end_time: @@ -2940,11 +2578,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string metrics: description: 'The details of the network point metric. Metrics need to specified @@ -2971,9 +2609,6 @@ components: - filter - metrics - interval - - start_time - - name - - end_time NetworkPointMetricsResponse: properties: interval: @@ -2981,11 +2616,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string metrics: description: 'The details of the network point metric. Metrics need to specified @@ -3008,11 +2643,6 @@ components: description: 'The individual and summary views. ' - required: - - view - - interval - - start_time - - metrics ObjectStatsFilter: properties: element: @@ -3029,6 +2659,8 @@ components: description: Site type: string type: array + required: + - site ObjectStatsQuery: properties: end_time: @@ -3080,15 +2712,10 @@ components: - filter - object_id - object_type - - start_time - - name - - end_time ObjectStatsResponse: properties: data: type: object - required: - - data ObjectStatsType: properties: description: @@ -3100,9 +2727,6 @@ components: ' type: string - required: - - description - - name ObjectStatsTypeResponse: properties: object_statistics: @@ -3112,8 +2736,6 @@ components: items: $ref: '#/components/schemas/ObjectStatsType' type: array - required: - - object_statistics PointData: properties: avail_disk: @@ -3233,33 +2855,6 @@ components: ' type: number - required: - - link_healthy - - bad_link_health_reason_bitmap - - rtt_latency - - sample_completeness - - uplink_mos_max - - uplink_mos_min - - uplink_mos_avg - - downlink_mos_max - - downlink_mos_min - - downlink_mos_avg - - uplink_pkt_loss_avg - - downlink_pkt_loss_avg - - uplink_jitter_avg - - downlink_jitter_avg - - tunnel_healthscore - - egress - - ingress - - dskmx - - dskmn - - avail_disk - - memmx - - memmn - - avail_mem - - avidlemx - - avidlemn - - avidle PointMetricsAnynet: properties: anynet_link_id: @@ -3272,9 +2867,6 @@ components: description: 'The data of the point metric Anynet. ' - required: - - data - - anynet_link_id PointMetricsQuery: properties: end_time: @@ -3294,11 +2886,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string metrics: description: 'The details of the point metric. Metrics need to specified @@ -3324,14 +2916,6 @@ components: view: $ref: '#/components/schemas/View' description: View - required: - - view - - interval - - filter - - metrics - - start_time - - name - - end_time PointMetricsResponse: properties: interval: @@ -3358,11 +2942,6 @@ components: description: 'The individual and summary views. ' - required: - - start_time - - interval - - view - - metrics PointMetricsSites: properties: data: @@ -3383,10 +2962,6 @@ components: items: $ref: '#/components/schemas/PointMetricsWanPath' type: array - required: - - data - - waninterfaces - - site_id PointMetricsWanPath: properties: anynetlinks: @@ -3406,10 +2981,6 @@ components: ' type: string - required: - - data - - anynetlinks - - wn_path_id QosMetricsFilter: properties: direction: @@ -3463,10 +3034,6 @@ components: required: - traffic_type - priority - - waninterface - - direction - - site - - element QosMetricsQuery: properties: end_time: @@ -3485,11 +3052,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max data points. @@ -3520,13 +3087,8 @@ components: ' required: - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time QosMetricsResponse: properties: metrics: @@ -3536,8 +3098,6 @@ components: items: $ref: '#/components/schemas/Metrics' type: array - required: - - metrics RadiusClientMetricsFilter: properties: element: @@ -3558,10 +3118,6 @@ components: description: Site type: string type: array - required: - - site - - interface - - element RadiusClientsRequest: properties: end_time: @@ -3594,12 +3150,6 @@ components: ' format: date type: string - required: - - max_datapoints - - filter - - start_time - - name - - end_time RadiusClientsResponse: properties: end_time: @@ -3621,10 +3171,6 @@ components: ' type: string - required: - - start_time - - items - - end_time RadiusMetricsFilter: properties: client_mac_address: @@ -3667,12 +3213,6 @@ components: description: Site type: string type: array - required: - - client_mac_address - - interface - - direction - - site - - element RadiusMetricsQuery: properties: end_time: @@ -3691,11 +3231,11 @@ components: description: 'Interval: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max data points. @@ -3729,14 +3269,8 @@ components: ' required: - - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time RadiusMetricsResponse: properties: metrics: @@ -3746,48 +3280,6 @@ components: items: $ref: '#/components/schemas/Metrics' type: array - required: - - metrics - SecurityPolicyRules: - properties: - bytes_c2s: - format: int64 - type: integer - bytes_s2c: - format: int64 - type: integer - packets_c2s: - format: int64 - type: integer - packets_s2c: - format: int64 - type: integer - security_destination_zone_id: - description: 'Security Destination Zone Id: JsonAlias(value = [dst_zone_id]) ' - type: string - security_policy_rule_action: - description: 'Security Policy Rule Action: JsonAlias(value = [action]) ' - type: string - security_policy_rule_id: - description: 'Security Policy Rule Id: JsonAlias(value = [rule_id]) ' - type: string - security_source_zone_id: - description: 'Security Source Zone Id: JsonAlias(value = [src_zone_id]) ' - type: string - time: - description: Time - format: int64 - type: integer - required: - - packets_s2c - - packets_c2s - - bytes_s2c - - bytes_c2s - - time - - security_policy_rule_action - - security_destination_zone_id - - security_source_zone_id - - security_policy_rule_id Series: properties: data: @@ -3813,12 +3305,6 @@ components: ' type: object - required: - - view - - unit - - name - - interval - - data SysMetricsFilter: properties: direction: @@ -3851,11 +3337,6 @@ components: description: Site type: string type: array - required: - - interface - - direction - - site - - element SysMetricsQuery: properties: end_time: @@ -3874,11 +3355,11 @@ components: ' enum: - - TEN_SEC - - ONE_MIN - - FIVE_MIN - - ONE_HOUR - - ONE_DAY + - 10sec + - 1min + - 5min + - 1hour + - 1day type: string max_datapoints: description: 'The max data points. @@ -3906,14 +3387,8 @@ components: $ref: '#/components/schemas/View' description: "View the system metric details. \n" required: - - filter - - view - - max_datapoints - interval - metrics - - start_time - - name - - end_time SysMetricsResponse: properties: metrics: @@ -3923,8 +3398,155 @@ components: items: $ref: '#/components/schemas/Metrics' type: array + TopNComparator: + properties: + end_time: + description: 'The end date to get the top n sites/apps. Start and end time + need to be specified in ISO8601 UTC format. + + ' + format: date + type: string + measurement: + description: 'The measurement values of the Top N reports. + + ' + enum: + - value + - value_growth + - value_reduction + - percentage_growth + - percentage_reduction + type: string + start_time: + description: 'The start date to get the top n sites/apps. Start and end + time need to be specified in ISO8601 UTC format. + + ' + format: date + type: string + TopNGrowth: + properties: + compare: + $ref: '#/components/schemas/TopNComparator' + description: "The topn n comparator metrics. \n" + filter: + $ref: '#/components/schemas/TopNGrowthFilter' + description: 'Filters according to the specifications. + + ' + limit: + description: "The query limit. \n" + type: integer + metrics: + $ref: '#/components/schemas/Metrics' + description: 'The topn n metrics. Metrics need to specified according to + 2.0 specifications. + + ' + type: + description: "The type of top n metrics. \n" + enum: + - app + - site + type: string required: - metrics + - type + TopNGrowthFilter: + properties: + app: + description: 'Filter by apps. + + ' + items: + description: App + type: string + type: array + direction: + description: 'Filter by the direction of the traffic. + + ' + items: + description: Direction + enum: + - Ingress + - Egress + type: string + type: array + element: + description: 'Filter by element. + + ' + items: + description: Element + type: string + type: array + path: + description: 'Filter by path. + + ' + items: + description: Path + type: string + type: array + path_type: + description: 'Filter by path type. Maximum number of allowed path types + is 10. + + ' + items: + description: Path Type + enum: + - public_direct + - public_vpn + - private_direct + - private_vpn + - unknown + - servicelink + type: string + type: array + site: + description: 'Filter by site. Max size = 10. + + ' + items: + description: Site + type: string + type: array + waninterface: + description: 'Filter by wan interfaces. Max size = 10. + + ' + items: + description: Waninterface + type: string + type: array + TopNGrowthQuery: + properties: + end_time: + description: 'The end time to get the top n sites/apps. If not specified, + it is default to now. End times need to be specified in ISO8601 UTC format. + + ' + format: date + type: string + name: + description: "The name of the of the top n sites/apps. \n" + type: string + start_time: + description: "The start time to get the top n sites/apps. If not specified,\ + \ it is default to epoch. Start times need to be specified in ISO8601\ + \ UTC format. \n" + format: date + type: string + top_n: + $ref: '#/components/schemas/TopNGrowth' + description: 'The details of the limit and type of the Top N reports. + + ' + required: + - top_n View: properties: individual: @@ -3955,14 +3577,11 @@ components: ' type: boolean - required: - - individual - - summary info: contact: {} description: List of APIs used to retrieve SDWAN metrics such as badnwidth utilization, - TCP transaction, application health, application performance, LQM, flows, interface - & system metrics. + TCP transaction, application health, application performance, LQM, flows, interface, + and system metrics. title: Metrics version: Latest openapi: 3.0.0 @@ -4214,10 +3833,344 @@ paths: content: application/json: schema: - oneOf: - - $ref: '#/components/schemas/MulticastWANPathStatsResponse' - - $ref: '#/components/schemas/MulticastWANPIMStatsResponse' - - $ref: '#/components/schemas/MulticastWANTrafficStatsResponse' + oneOf: + - $ref: '#/components/schemas/MulticastWANPathStatsResponse' + - $ref: '#/components/schemas/MulticastWANPIMStatsResponse' + - $ref: '#/components/schemas/MulticastWANTrafficStatsResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: MULTICAST_WAN_NEIGHBOR_QUERY_MISSING_OBJECT_TYPE + - code: MULTICAST_WAN_NEIGHBOR_QUERY_MISSING_REMOTE_SITE_ID + - code: MULTICAST_WAN_NEIGHBOR_QUERY_INVALID_REMOTE_SITE_ID + - code: MULTICAST_QUERY_MISSING_FILTER + - code: MULTICAST_QUERY_MISSING_ELEMENT_ID + - code: MULTICAST_QUERY_INVALID_ELEMENT_ID + - code: MULTICAST_QUERY_MISSING_SITE_ID + - code: MULTICAST_QUERY_INVALID_SITE_ID + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query WAN Neighbor Statistics (v2.0) + tags: + - Metrics + /sdwan/v2.0/api/monitor/aiops/aggregates: + get: + description: Get site or path level aggregated stats API v2.0 + operationId: get-sdwan-v2.0-api-monitor-aiops-aggregates + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AggregateStatsResponse' + description: Successful Operation + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Get site or path level aggregated statistics (v2.0) + tags: + - Metrics + post: + description: Query and get the site or path level aggregated statistics. + operationId: post-sdwan-v2.0-api-monitor-aiops-aggregates + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AggregateStatsQuery' + description: Details of app object stats query + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AggregateStatsResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: AGGREGATE_STATS_QUERY_AGGREGATES_REQUIRED + - code: AGGREGATE_STATS_APP_ID_REQUIRED + - code: AGGREGATE_STATS_APP_LENGTH_EXCEEDED + - code: AGGREGATE_STATS_QUERY_APP_INVALID_VALUE + - code: AGGREGATE_STATS_QUERY_FILTER_SITE_ID_REQUIRED + - code: AGGREGATE_STATS_QUERY_SITE_LIST_LENGTH_EXCEEDED + - code: AGGREGATE_STATS_QUERY_SITE_ID_INVALID_VALUE + - code: AGGREGATE_STATS_QUERY_PATH_ID_INVALID_VALUE + - code: AGGREGATE_STATS_QUERY_AGGREGATES_UNSUPPORTED + - code: AGGREGATE_STATS_QUERY_START_TIME_BEFORE_END_TIME + - code: AGGREGATE_STATS_QUERY_FILTER_UNSUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query and Get Site or Path Level Aggregated Statistics (v2.0) + tags: + - Metrics + /sdwan/v2.0/api/monitor/aiops/anomaly: + get: + description: Get circuit bandwidth anomaly. + operationId: get-sdwan-v2.0-api-monitor-aiops-anomaly + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CapacityPredictionResponse' + description: Successful Operation + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Get Circuit Bandwidth Anomaly (v2.0) + tags: + - Metrics + post: + description: Query circuit bandwidth anomaly. Start and end time need to be + specified in ISO8601 UTC format. Forecast basis need be to specified according + to 2.0 specifications. + operationId: post-sdwan-v2.0-api-monitor-aiops-anomaly + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CapacityPredictionQuery' + description: Query request for getting circuit bandwidth anomaly based on + anomaly basis + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CapacityPredictionQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: SCHEMA_MISMATCH + - code: START_TIME_GREATER_THAN_END_TIME + - code: MAX_DATAPOINTS_END_TIME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Circuit Bandwidth Anomaly (v2.0) + tags: + - Metrics + /sdwan/v2.0/api/monitor/aiops/forecast: + get: + description: Get capacity prediction for site. + operationId: get-sdwan-v2.0-api-monitor-aiops-forecast + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CapacityPredictionResponse' + description: Successful Operation + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Get Capacity Prediction (v2.0) + tags: + - Metrics + post: + description: 'Get capacity prediction for site v2.0 + + Note + + * Start and end time need to be specified in ISO8601 UTC format. + + * Forecast basis need be to specified according to 2.0 specifications. + + * Type need to be specified according to the specifications. + + ' + operationId: post-sdwan-v2.0-api-monitor-aiops-forecast + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CapacityPredictionQuery' + description: Query request for getting capacity prediction based on type and + forecast basis + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CapacityPredictionQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: SCHEMA_MISMATCH + - code: START_TIME_GREATER_THAN_END_TIME + - code: MAX_DATAPOINTS_END_TIME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Capacity Prediction (v2.0) + tags: + - Metrics + /sdwan/v2.0/api/monitor/aiops/health: + get: + description: Get healthscore parameters. + operationId: get-sdwan-v2.0-api-monitor-aiops-health + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HealthScoreResponse' + description: Successful Operation + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Get Healthscore Parameters (v2.0) + tags: + - Metrics + post: + description: Get health metrics for sites, links, and applications. Start time + need to be specified in ISO8601 UTC format. Metrics need to specified according + to 2.0 specifications. + operationId: post-sdwan-v2.0-api-monitor-aiops-health + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthScoreQuery' + description: Query request for getting healthscore metrics + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HealthScoreResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: SCHEMA_MISMATCH + - code: METRIC_NOT_SUPPORTED + - code: FUTURE_TIME_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Healthscore Metrics (v2.0) + tags: + - Metrics + /sdwan/v2.0/api/monitor/aiops/object_stats: + get: + description: Get the app object statistics. + operationId: get-sdwan-v2.0-api-monitor-aiops-object_stats + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppObjectStatsResponse' + description: Successful Operation + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Get App Object Statistics (v2.0) + tags: + - Metrics + post: + description: Run a query to get app object stats. + operationId: post-sdwan-v2.0-api-monitor-aiops-object_stats + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsQuery' + description: Details of app object stats query + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: OBJECT_STATS_QUERY_OBJECT_TYPE_REQUIRED + - code: OBJECT_STATS_QUERY_OBJECT_ID_REQUIRED + - code: OBJECT_STATS_QUERY_FILTER_REQUIRED + - code: OBJECT_STATS_QUERY_FILTER_SITE_ID_REQUIRED + - code: OBJECT_STATS_QUERY_OBJECT_TYPE_UNSUPPORTED + - code: OBJECT_STATS_QUERY_OBJECT_ID_INVALID_VALUE + - code: OBJECT_STATS_QUERY_ELEMENT_ID_INVALID_VALUE + - code: OBJECT_STATS_QUERY_SITE_ID_INVALID_VALUE + - code: OBJECT_STATS_QUERY_ELEMENT_LIST_LENGTH_EXCEEDED + - code: OBJECT_STATS_QUERY_SITE_LIST_LENGTH_EXCEEDED + - code: OBJECT_STATS_QUERY_START_TIME_BEFORE_END_TIME + - code: INVALID_STATS_REQUEST_BODY + - code: FUTURE_TIME_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query App Object Statistics (v2.0) + tags: + - Metrics + /sdwan/v2.0/api/monitor/aiops/topn: + post: + description: Get TopN sites or circuits based on growth. Start time need to + be specified in ISO8601 UTC format. Metrics need to specified according to + 2.0 specifications. + operationId: post-sdwan-v2.0-api-monitor-aiops-topn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TopNGrowthQuery' + description: Query request for getting TopN Sites/Apps based on growth + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TopNGrowthQuery' description: Successful Operation '400': content: @@ -4226,18 +4179,13 @@ paths: value: _error: - code: INVALID_REQUEST_ERROR_0001 - - code: MULTICAST_WAN_NEIGHBOR_QUERY_MISSING_OBJECT_TYPE - - code: MULTICAST_WAN_NEIGHBOR_QUERY_MISSING_REMOTE_SITE_ID - - code: MULTICAST_WAN_NEIGHBOR_QUERY_INVALID_REMOTE_SITE_ID - - code: MULTICAST_QUERY_MISSING_FILTER - - code: MULTICAST_QUERY_MISSING_ELEMENT_ID - - code: MULTICAST_QUERY_INVALID_ELEMENT_ID - - code: MULTICAST_QUERY_MISSING_SITE_ID - - code: MULTICAST_QUERY_INVALID_SITE_ID + - code: SCHEMA_MISMATCH + - code: METRIC_NOT_SUPPORTED + - code: FUTURE_TIME_ERROR schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query WAN Neighbor Statistics (v2.0) + summary: Get TopN Data with Metrics Output (v2.0) tags: - Metrics /sdwan/v2.0/api/monitor/application/qos_metrics: @@ -4375,8 +4323,17 @@ paths: tags: - Metrics post: - description: Get cellular metrics like Signal-to Noise Ratio (SNR) and cellular - bandwidth usage. + description: "Get cellular metrics like SNR, Cellular bandwidth usage etc. External\ + \ API used for stats queries.\nBelow are the tenet for queries\n* interval\ + \ is required\n* start_time, end_time and max_datapoints are optional with\ + \ the following restrictions, at least one of them needs to be specified.\n\ + \ all the three can not be specified, as the result is ambiguous.\nNote\n\ + * Start time, if not specified, default to epoch.\n* End time, if not specified,\ + \ default to now.\n* Limit, if not specified, defaults to None..\n* Start\ + \ and end times need to be specified in ISO8601 UTC format.\n* Metrics need\ + \ to specified according to 2.1 specifications. Invalid metrics will be ignored\ + \ and the result will not include them.\n* Filters need to be specified according\ + \ to the specifications.\n" operationId: post-sdwan-v2.0-api-monitor-cellular_metrics requestBody: content: @@ -4424,7 +4381,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Query Cellular Metrics (v2.0) + summary: Cellular metrics for Version 2.0 (v2.0) tags: - Metrics /sdwan/v2.0/api/monitor/cellular_metrics/topn: @@ -4623,33 +4580,319 @@ paths: - Metrics /sdwan/v2.0/api/monitor/qos_metrics: get: - description: Get details of Qos metrics + description: Get details of QoS metrics. operationId: get-sdwan-v2.0-api-monitor-qos_metrics responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MetricSchemaResponse' + $ref: '#/components/schemas/MetricSchemaResponse' + description: Successful Operation + summary: Get QoS Metrics (v2.0) + tags: + - Metrics + post: + description: Provides time series data for QOS stats + operationId: post-sdwan-v2.0-api-monitor-qos_metrics + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QosMetricsQuery' + description: Details of qos metrics query + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/QosMetricsResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: REQUIRED_PROPERTY + - code: INVALID_FILTER + - code: MAX_DATAPOINTS_NOT_SUPPORTED + - code: REQUESTED_VIEW_NOT_SUPPORTED + - code: START_TIME_GREATER_THAN_END_TIME + - code: REQUESTED_METRIC_NOT_SUPPORTED + - code: REQUESTED_METRIC_UNIT_NOT_SUPPORTED + - code: REQUESTED_METRIC_STATISTICS_NOT_SUPPORTED + - code: INVALID_STATS_REQUEST_BODY + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Qos metrics (v2.0) + tags: + - Metrics + /sdwan/v2.0/api/monitor/sys_metrics/topn: + post: + description: Query the details of the system metrics Top N. + operationId: post-sdwan-v2.0-api-monitor-sys_metrics-topn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseTopNQuery' + description: Filter for top N + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BaseTopNResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: APP_FILTER_NOT_SUPPORTED_FOR_TYPE + - code: SITE_FILTER_NOT_SUPPORTED_FOR_TYPE + - code: FILTER_NOT_SUPPORTED_WITHOUT_SITE + - code: START_TIME_GREATER_THAN_END_TIME + - code: PATH_NOT_SUPPORTED_WITH_PATH_TYPE + - code: TOPN_BASIS_NOT_SUPPORTED_WITHOUT_FILTER + - code: INVALID_LIMIT + - code: REQUIRED_PROPERTY + - code: LENGTH_EXCEEDED + - code: PATH_TYPE_LIST_LENGTH_EXCEEDED + - code: INVALID_FILTER + - code: FILTER_NOT_SUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query System Metrics Top N (v2.0) + tags: + - Metrics + /sdwan/v2.0/api/monitor/sys_point_metrics: + post: + description: Query the details of the system point metrics. + operationId: post-sdwan-v2.0-api-monitor-sys_point_metrics + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PointMetricsQuery' + description: Query request for getting sysmetrics + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PointMetricsResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: SCHEMA_MISMATCH + - code: METRIC_NOT_SUPPORTED + - code: FUTURE_TIME_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query System Point Metrics (v2.0) + tags: + - Metrics + /sdwan/v2.0/api/tenants/{esp_tenant_id}/monitor/aggregates/healthscore: + post: + description: Query the aggregate health score for MSP and its clients. + operationId: post-sdwan-v2.0-api-tenants-esp_tenant_id-monitor-aggregates-healthscore + parameters: + - description: ID of the MSP tenant. + in: path + name: esp_tenant_id + required: true + schema: + description: Esp Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LqmStatsAggregateHealthScoreRequest' + description: Filters for Aggregate HealthScore + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LqmStatsAggregateHealthScoreResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: AGGREGATION_REQUIRED + - code: HEALTHSCORE_TYPE_REQUIRED + - code: START_TIME_GREATER_THAN_END_TIME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Aggregate Health Score (v2.0) + tags: + - Metrics + /sdwan/v2.1/api/monitor/aiops/aggregates: + get: + description: Get the site or path level aggregated statistics. + operationId: get-sdwan-v2.1-api-monitor-aiops-aggregates + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AggregateStatsResponse' + description: Successful Operation + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Get Site or Path Level Aggregated Statistics (v2.1) + tags: + - Metrics + post: + description: Query and get the site or path level aggregated statistics. + operationId: post-sdwan-v2.1-api-monitor-aiops-aggregates + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AggregateStatsQuery' + description: Details of app object stats query + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AggregateStatsResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: AGGREGATE_STATS_QUERY_AGGREGATES_REQUIRED + - code: AGGREGATE_STATS_APP_ID_REQUIRED + - code: AGGREGATE_STATS_APP_LENGTH_EXCEEDED + - code: AGGREGATE_STATS_QUERY_APP_INVALID_VALUE + - code: AGGREGATE_STATS_QUERY_FILTER_SITE_ID_REQUIRED + - code: AGGREGATE_STATS_QUERY_SITE_LIST_LENGTH_EXCEEDED + - code: AGGREGATE_STATS_QUERY_SITE_ID_INVALID_VALUE + - code: AGGREGATE_STATS_QUERY_PATH_ID_INVALID_VALUE + - code: AGGREGATE_STATS_QUERY_AGGREGATES_UNSUPPORTED + - code: AGGREGATE_STATS_QUERY_START_TIME_BEFORE_END_TIME + - code: AGGREGATE_STATS_QUERY_FILTER_UNSUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query and Get Site or Path Level Aggregated Statistics (v2.1) + tags: + - Metrics + /sdwan/v2.1/api/monitor/aiops/forecast: + get: + description: Get capacity forecast prediction for site. + operationId: get-sdwan-v2.1-api-monitor-aiops-forecast + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CapacityPredictionResponse' + description: Successful Operation + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Get Capacity Forecast (v2.1) + tags: + - Metrics + post: + description: Get capacity prediction for site. Start and end time need to be + specified in ISO8601 UTC format. + operationId: post-sdwan-v2.1-api-monitor-aiops-forecast + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CapacityPredictionQuery' + description: Query request for getting capacity prediction based on type and + forecast basis + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CapacityPredictionQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: SCHEMA_MISMATCH + - code: START_TIME_GREATER_THAN_END_TIME + - code: MAX_DATAPOINTS_END_TIME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Capacity Prediction (v2.1) + tags: + - Metrics + /sdwan/v2.1/api/monitor/aiops/object_stats: + get: + description: Get the app object statistics. + operationId: get-sdwan-v2.1-api-monitor-aiops-object_stats + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsResponse' description: Successful Operation - summary: Get details of Qos metrics + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Get App Object Statistics (v2.1) tags: - Metrics post: - description: Query the time series data for QOS statistics. - operationId: post-sdwan-v2.0-api-monitor-qos_metrics + description: Run a query to get app object stats. + operationId: post-sdwan-v2.1-api-monitor-aiops-object_stats requestBody: content: application/json: schema: - $ref: '#/components/schemas/QosMetricsQuery' - description: Details of qos metrics query + $ref: '#/components/schemas/ObjectStatsQuery' + description: Details of app object stats query responses: '200': content: application/json: schema: - $ref: '#/components/schemas/QosMetricsResponse' + $ref: '#/components/schemas/ObjectStatsResponse' description: Successful Operation '400': content: @@ -4657,25 +4900,30 @@ paths: example: value: _error: - - code: REQUIRED_PROPERTY - - code: INVALID_FILTER - - code: MAX_DATAPOINTS_NOT_SUPPORTED - - code: REQUESTED_VIEW_NOT_SUPPORTED - - code: START_TIME_GREATER_THAN_END_TIME - - code: REQUESTED_METRIC_NOT_SUPPORTED - - code: REQUESTED_METRIC_UNIT_NOT_SUPPORTED - - code: REQUESTED_METRIC_STATISTICS_NOT_SUPPORTED + - code: INVALID_REQUEST_ERROR_0001 + - code: OBJECT_STATS_QUERY_OBJECT_TYPE_REQUIRED + - code: OBJECT_STATS_QUERY_OBJECT_ID_REQUIRED + - code: OBJECT_STATS_QUERY_FILTER_REQUIRED + - code: OBJECT_STATS_QUERY_FILTER_SITE_ID_REQUIRED + - code: OBJECT_STATS_QUERY_OBJECT_TYPE_UNSUPPORTED + - code: OBJECT_STATS_QUERY_OBJECT_ID_INVALID_VALUE + - code: OBJECT_STATS_QUERY_ELEMENT_ID_INVALID_VALUE + - code: OBJECT_STATS_QUERY_SITE_ID_INVALID_VALUE + - code: OBJECT_STATS_QUERY_ELEMENT_LIST_LENGTH_EXCEEDED + - code: OBJECT_STATS_QUERY_SITE_LIST_LENGTH_EXCEEDED + - code: OBJECT_STATS_QUERY_START_TIME_BEFORE_END_TIME - code: INVALID_STATS_REQUEST_BODY + - code: FUTURE_TIME_ERROR schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query QoS Metrics (v2.0) + summary: Query App Object Statistics (v2.1) tags: - Metrics - /sdwan/v2.0/api/monitor/sys_metrics/topn: + /sdwan/v2.1/api/monitor/sys_metrics/topn: post: description: Query the details of the system metrics Top N. - operationId: post-sdwan-v2.0-api-monitor-sys_metrics-topn + operationId: post-sdwan-v2.1-api-monitor-sys_metrics-topn requestBody: content: application/json: @@ -4711,66 +4959,46 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query System Metrics Top N (v2.0) + summary: Query System Metrics Top N (v2.1) tags: - Metrics - /sdwan/v2.0/api/monitor/sys_point_metrics: - post: - description: Query the details of the system point metrics. - operationId: post-sdwan-v2.0-api-monitor-sys_point_metrics - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PointMetricsQuery' - description: Query request for getting sysmetrics + /sdwan/v2.2/api/monitor/sys_metrics: + get: + description: 'Returns sysmetrics schema for Version 2.2 + + ' + operationId: get-sdwan-v2.2-api-monitor-sys_metrics responses: '200': content: application/json: schema: - $ref: '#/components/schemas/PointMetricsResponse' + $ref: '#/components/schemas/MetricSchemaResponse' description: Successful Operation - '400': + '500': content: application/json: - example: - value: - _error: - - code: INVALID_REQUEST_ERROR_0001 - - code: SCHEMA_MISMATCH - - code: METRIC_NOT_SUPPORTED - - code: FUTURE_TIME_ERROR schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query System Point Metrics (v2.0) + description: Internal Server Error + summary: Returns sysmetrics schema for Version 2.2 (v2.2) tags: - Metrics - /sdwan/v2.0/api/tenants/{esp_tenant_id}/monitor/aggregates/healthscore: post: - description: Query the aggregate health score for MSP and its clients. - operationId: post-sdwan-v2.0-api-tenants-esp_tenant_id-monitor-aggregates-healthscore - parameters: - - description: ID of the MSP tenant. - in: path - name: esp_tenant_id - required: true - schema: - description: Esp Tenant Id - type: string + description: List all the system metrics schema. + operationId: post-sdwan-v2.2-api-monitor-sys_metrics requestBody: content: application/json: schema: - $ref: '#/components/schemas/LqmStatsAggregateHealthScoreRequest' - description: Filters for Aggregate HealthScore + $ref: '#/components/schemas/SysMetricsQuery' + description: Query request for getting sysmetrics responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LqmStatsAggregateHealthScoreResponse' + $ref: '#/components/schemas/SysMetricsResponse' description: Successful Operation '400': content: @@ -4778,61 +5006,34 @@ paths: example: value: _error: - - code: AGGREGATION_REQUIRED - - code: HEALTHSCORE_TYPE_REQUIRED - - code: START_TIME_GREATER_THAN_END_TIME + - code: INVALID_REQUEST_ERROR_0001 + - code: SCHEMA_MISMATCH + - code: METRIC_NOT_SUPPORTED + - code: METRIC_UNIT_NOT_SUPPORTED + - code: UNSUPPORTED_FILTER_IN_VERSION + - code: UNSUPPORTED_FILTER_FOR_METRIC + - code: MISSING_INTERFACE_FILTER_PROPERTY + - code: MISSING_ELEMENT_FILTER_PROPERTY + - code: UNSUPPORTED_DIRECTION_FILTER + - code: DIRECTION_FILTER_EMPTY + - code: DIRECTION_VIEW_NOT_SUPPORTED + - code: MAX_DATAPOINTS_END_TIME schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Aggregate Health Score (v2.0) - tags: - - Metrics - /sdwan/v2.1/api/monitor/sys_metrics/topn: - post: - description: Query the details of the system metrics Top N. - operationId: post-sdwan-v2.1-api-monitor-sys_metrics-topn - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BaseTopNQuery' - description: Filter for top N - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BaseTopNResponse' - description: Successful Operation - '400': + '500': content: application/json: - example: - value: - _error: - - code: INVALID_REQUEST_ERROR_0001 - - code: APP_FILTER_NOT_SUPPORTED_FOR_TYPE - - code: SITE_FILTER_NOT_SUPPORTED_FOR_TYPE - - code: FILTER_NOT_SUPPORTED_WITHOUT_SITE - - code: START_TIME_GREATER_THAN_END_TIME - - code: PATH_NOT_SUPPORTED_WITH_PATH_TYPE - - code: TOPN_BASIS_NOT_SUPPORTED_WITHOUT_FILTER - - code: INVALID_LIMIT - - code: REQUIRED_PROPERTY - - code: LENGTH_EXCEEDED - - code: PATH_TYPE_LIST_LENGTH_EXCEEDED - - code: INVALID_FILTER - - code: FILTER_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query System Metrics Top N (v2.1) + description: Internal Server Error + summary: Get System Metrics Schema (v2.2) tags: - Metrics - /sdwan/v2.2/api/monitor/metrics: + /sdwan/v2.3/api/monitor/metrics: post: - description: Query the monitor metrics. - operationId: post-sdwan-v2.2-api-monitor-metrics + description: Query all the monitor metrics. + operationId: post-sdwan-v2.3-api-monitor-metrics requestBody: content: application/json: @@ -4857,6 +5058,7 @@ paths: - code: SCHEMA_MISMATCH - code: METRIC_NOT_SUPPORTED - code: METRIC_UNIT_NOT_SUPPORTED + - code: UNSUPPORTED_FILTER_FOR_VERSION - code: UNSUPPORTED_INDIVIDUAL_DIMENSION - code: VIEW_DIRECTION_AND_FILTER_DIRECTION_NOT_SUPPORTED - code: UNSUPPORTED_DIRECTION_FILTER @@ -4883,13 +5085,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Monitor Metrics (v2.1) + summary: Query Monitor Metrics (v2.3) tags: - Metrics - /sdwan/v2.2/api/monitor/metrics/{mtype}: + /sdwan/v2.3/api/monitor/metrics/{mtype}: get: - description: List details of the monitor metrics. - operationId: get-sdwan-v2.2-api-monitor-metrics-mtype + description: List all the details of the monitor metrics. + operationId: get-sdwan-v2.3-api-monitor-metrics-mtype parameters: - description: The metric type. in: path @@ -4915,15 +5117,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Monitor Metrics (v2.2) + summary: Get Monitor Metrics (v2.3) tags: - Metrics - /sdwan/v2.2/api/monitor/sys_metrics: + /sdwan/v2.3/api/monitor/sys_metrics: get: - description: 'Returns sysmetrics schema for Version 2.2 - - ' - operationId: get-sdwan-v2.2-api-monitor-sys_metrics + description: List all the system metrics schema. + operationId: get-sdwan-v2.3-api-monitor-sys_metrics responses: '200': content: @@ -4937,12 +5137,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Returns sysmetrics schema for Version 2.2 + summary: Get System Metrics Schema (v2.3) tags: - Metrics post: description: List all the system metrics schema. - operationId: post-sdwan-v2.2-api-monitor-sys_metrics + operationId: post-sdwan-v2.3-api-monitor-sys_metrics requestBody: content: application/json: @@ -4983,13 +5183,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get System Metrics Schema (v2.2) + summary: Get System Metrics Schema (v2.3) tags: - Metrics - /sdwan/v2.3/api/monitor/metrics: + /sdwan/v2.4/api/monitor/metrics: post: description: Query all the monitor metrics. - operationId: post-sdwan-v2.3-api-monitor-metrics + operationId: post-sdwan-v2.4-api-monitor-metrics requestBody: content: application/json: @@ -5038,16 +5238,17 @@ paths: - code: METRIC_MISSING_PATH_ID - code: METRIC_SUPPORTS_SINGLE_PATH_ID - code: METRIC_SUPPORTS_SINGLE_FILTER_WITH_LIST + - code: FILTER_NOT_SUPPORTED_FOR_METRIC schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Monitor Metrics (v2.3) + summary: Query Monitor Metrics (v2.4) tags: - Metrics - /sdwan/v2.3/api/monitor/metrics/{mtype}: + /sdwan/v2.4/api/monitor/metrics/{mtype}: get: description: List all the details of the monitor metrics. - operationId: get-sdwan-v2.3-api-monitor-metrics-mtype + operationId: get-sdwan-v2.4-api-monitor-metrics-mtype parameters: - description: The metric type. in: path @@ -5073,80 +5274,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Monitor Metrics (v2.3) - tags: - - Metrics - /sdwan/v2.3/api/monitor/sys_metrics: - get: - description: 'Returns sysmetrics schema for Version 2.3 - - ' - operationId: get-sdwan-v2.3-api-monitor-sys_metrics - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MetricSchemaResponse' - description: Successful Operation - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal Server Error - summary: Returns sysmetrics schema for Version 2.3 - tags: - - Metrics - post: - description: List all the system metrics schema. - operationId: post-sdwan-v2.3-api-monitor-sys_metrics - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SysMetricsQuery' - description: Query request for getting sysmetrics - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SysMetricsResponse' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_REQUEST_ERROR_0001 - - code: SCHEMA_MISMATCH - - code: METRIC_NOT_SUPPORTED - - code: METRIC_UNIT_NOT_SUPPORTED - - code: UNSUPPORTED_FILTER_IN_VERSION - - code: UNSUPPORTED_FILTER_FOR_METRIC - - code: MISSING_INTERFACE_FILTER_PROPERTY - - code: MISSING_ELEMENT_FILTER_PROPERTY - - code: UNSUPPORTED_DIRECTION_FILTER - - code: DIRECTION_FILTER_EMPTY - - code: DIRECTION_VIEW_NOT_SUPPORTED - - code: MAX_DATAPOINTS_END_TIME - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal Server Error - summary: Get System Metrics Schema (v2.3) + summary: Get Monitor Metrics (v2.4) tags: - Metrics /sdwan/v2.4/api/monitor/object_stats: get: - description: Get object stats API v2.4 + description: List details of the object statistics. operationId: get-sdwan-v2.4-api-monitor-object_stats responses: '200': @@ -5155,11 +5288,11 @@ paths: schema: $ref: '#/components/schemas/ObjectStatsTypeResponse' description: Successful Operation - summary: Get name and description of all object statistics + summary: Get Object Stats (v2.4) tags: - Metrics post: - description: List the object statistics. + description: List details of the object statistics. operationId: post-sdwan-v2.4-api-monitor-object_stats requestBody: content: @@ -5202,7 +5335,7 @@ paths: - Metrics /sdwan/v2.5/api/monitor/object_stats: get: - description: Get object stats API v2.5 + description: List details of the object statistics. operationId: get-sdwan-v2.5-api-monitor-object_stats responses: '200': @@ -5211,11 +5344,11 @@ paths: schema: $ref: '#/components/schemas/ObjectStatsTypeResponse' description: Successful Operation - summary: Get name and description of all object statistics + summary: Get Object Stats (v2.5) tags: - Metrics post: - description: List details of the object statistics. + description: Query details of the object statistics. operationId: post-sdwan-v2.5-api-monitor-object_stats requestBody: content: @@ -5253,12 +5386,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Object Stats (v2.5) + summary: Query Object Stats (v2.5) tags: - Metrics /sdwan/v3.0/api/monitor/aggregates: get: - description: Summary of supported aggregates + description: List all the supported app stats aggregates. operationId: get-sdwan-v3.0-api-monitor-aggregates responses: '200': @@ -5267,11 +5400,11 @@ paths: schema: $ref: '#/components/schemas/AppStatsSupportedAggregatesResponse' description: Successful Operation - summary: Supported App stats Aggregates + summary: Get App Stats Aggregates (v3.0) tags: - Metrics post: - description: List all the supported app stats aggregates. + description: Aggregate app_stats and app_prefix stats based on different metrics operationId: post-sdwan-v3.0-api-monitor-aggregates requestBody: content: @@ -5306,7 +5439,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get App Stats Aggregates (v3.0) + summary: Aggregate App stats (v3.0) tags: - Metrics /sdwan/v3.0/api/monitor/topn: @@ -5392,10 +5525,10 @@ paths: summary: Get Top N Data (v3.1) tags: - Metrics - /sdwan/v3.6/api/monitor/flows: + /sdwan/v3.7/api/monitor/flows: post: - description: List all the flow information. - operationId: post-sdwan-v3.6-api-monitor-flows + description: List all the flows information. + operationId: post-sdwan-v3.7-api-monitor-flows requestBody: content: application/json: @@ -5436,13 +5569,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get Flow Information (v3.6) + summary: Get Flows Information (v3.7) tags: - Metrics - /sdwan/v3.7/api/monitor/flows: + /sdwan/v3.8/api/monitor/flows: post: - description: List all the flow information. - operationId: post-sdwan-v3.7-api-monitor-flows + description: List all the flows information. + operationId: post-sdwan-v3.8-api-monitor-flows requestBody: content: application/json: @@ -5483,7 +5616,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get Flow Information (v3.7) + summary: Get Flows Information (v3.8) tags: - Metrics servers: diff --git a/openapi-specs/sdwan/unified/Multicast.yaml b/openapi-specs/sdwan/unified/Multicast.yaml index b34138423..f1a9790f1 100644 --- a/openapi-specs/sdwan/unified/Multicast.yaml +++ b/openapi-specs/sdwan/unified/Multicast.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view DynamicRp: properties: groups: @@ -70,7 +64,7 @@ components: type: string type: description: "The type of dynamic RP. BSR\u2014Indicates that the RP is\ - \ learnt dynamically via BSM.\n" + \ learnt dynamically via BSM. \n" type: string Error: properties: @@ -99,19 +93,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -132,7 +126,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -141,13 +135,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -372,10 +366,8 @@ components: ' type: string uptime: - description: 'The period for which the host has been a part of the multicast - group. - - ' + description: "The period for which the host has been a part of the multicast\ + \ group. \n" type: string MulticastIgmpMembership: properties: @@ -483,9 +475,7 @@ components: ' type: string name: - description: 'Details of the igmp group members. - - ' + description: "Details of the igmp group members. \n" type: string site_id: description: 'The ID of the site. @@ -700,7 +690,9 @@ components: MulticastPeerSite: properties: peer_site_id: - description: Peer Site Id + description: 'The peer site ID. + + ' type: string MulticastPimProtocolConfig: properties: @@ -2495,17 +2487,17 @@ paths: - Multicast /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/multicastrps: get: - description: List all the multicast RP configs. + description: API to get all multicast rp configs operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-multicastrps parameters: - - description: ID of the site. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: ID of the element. + - description: Element Id in: path name: element_id required: true @@ -2526,21 +2518,21 @@ paths: type: array type: object description: Successful Operation - summary: Get Multicast RP Configs (v2.0) + summary: Get all Multicast RP configs (v2.0) tags: - Multicast post: - description: API to create multicast rp config + description: Create multicast RP configs. operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-multicastrps parameters: - - description: Site Id + - description: ID of the site. in: path name: site_id required: true schema: description: Site Id type: string - - description: Element Id + - description: ID of the element. in: path name: element_id required: true @@ -2572,7 +2564,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Creates Multicast RP config (v2.0) + summary: Create Multicast RP Configs (v2.0) tags: - Multicast /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/multicastrps/{config_id}: @@ -2809,10 +2801,10 @@ paths: - Multicast /sdwan/v2.0/api/sites/{site_id}/multicastsourcesiderps/query: post: - description: API to query multicast source side RPs + description: Query multicast source side RPs. operationId: post-sdwan-v2.0-api-sites-site_id-multicastsourcesiderps-query parameters: - - description: Site ID + - description: ID of the site. in: path name: site_id required: true @@ -2848,7 +2840,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query multicast source side RPs (v2.0) + summary: Query Multicast Source Side RPs (v2.0) tags: - Multicast /sdwan/v2.0/api/sites/{site_id}/multicastsourcesiderps/{rp_id}: @@ -2911,7 +2903,7 @@ paths: tags: - Multicast post: - description: Create a multicast source site config. + description: Use the API to create multicast source site configs. operationId: post-sdwan-v2.0-api-sites-site_id-multicastsourcesiteconfigs parameters: - description: The site ID where you wish to create multicast source site configs. diff --git a/openapi-specs/sdwan/unified/NATPolicy.yaml b/openapi-specs/sdwan/unified/NATPolicy.yaml index 7c03d8ea4..3134ec468 100644 --- a/openapi-specs/sdwan/unified/NATPolicy.yaml +++ b/openapi-specs/sdwan/unified/NATPolicy.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BasePolicyPrefixS: properties: description: @@ -120,7 +114,7 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of queries. + description: 'The aggregate number of queried elements. ' dest_page: @@ -130,12 +124,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of queries deleted for a time frame. + description: 'The number of queried elements deleted for a time frame. ' type: boolean group_by: - description: 'Group the queries. + description: 'Group the elements state for the query. ' items: @@ -143,7 +137,7 @@ components: type: string type: array id: - description: "List the queries by ID. \n" + description: "List the element by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -188,18 +182,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string Error: properties: @@ -323,19 +317,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -356,7 +350,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -365,13 +359,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string diff --git a/openapi-specs/sdwan/unified/NTP.yaml b/openapi-specs/sdwan/unified/NTP.yaml index 7e041ac06..b1a3d5e1e 100644 --- a/openapi-specs/sdwan/unified/NTP.yaml +++ b/openapi-specs/sdwan/unified/NTP.yaml @@ -3,18 +3,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string ElementNTP: properties: diff --git a/openapi-specs/sdwan/unified/NetworkConstructs.yaml b/openapi-specs/sdwan/unified/NetworkConstructs.yaml index d14f9b3f9..cb7b8b5d6 100644 --- a/openapi-specs/sdwan/unified/NetworkConstructs.yaml +++ b/openapi-specs/sdwan/unified/NetworkConstructs.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BaseCustomDHCPOptions: properties: option_definition: @@ -72,18 +66,18 @@ components: BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string DHCPRelay: properties: @@ -239,6 +233,9 @@ components: ' type: boolean + lifesize: + $ref: '#/components/schemas/Lifesize' + description: Lifesize lifetime: description: 'The life time for the ESP Group. The default lifetime of an ESP Group is 24 hours. @@ -246,6 +243,9 @@ components: ' format: int32 type: integer + lifetime_units: + description: Lifetime Units + type: string mode: description: 'The IPsec config ESP tunnel mode. @@ -261,8 +261,10 @@ components: items: $ref: '#/components/schemas/Proposals' type: array + responder_sase_proposals: + $ref: '#/components/schemas/ResponderSaseProposals' + description: Responder Sase Proposals required: - - proposals - mode Error: properties: @@ -284,6 +286,9 @@ components: ' type: boolean + authentication_multiple: + description: Authentication Multiple + type: integer key_exchange: description: 'The key exchange for the IKE group = IKEv1 or IKEv2. @@ -299,6 +304,9 @@ components: ' format: int32 type: integer + lifetime_units: + description: Lifetime Units + type: string port: description: 'The port number of the communication port. The default port is 500. The port number configured in the IKE group has to be the same @@ -323,7 +331,6 @@ components: ' type: boolean required: - - proposals - key_exchange IKEV1Params: properties: @@ -375,6 +382,12 @@ components: ' type: string + certificate_profile_id: + description: Certificate Profile Id + type: string + comment: + description: Comment + type: string ikev1_params: $ref: '#/components/schemas/IKEV1Params' description: 'Ikev1 Params: Valid ' @@ -391,18 +404,34 @@ components: - DN - HOSTNAME - CUSTOM + - NONE type: string local_id_custom: description: 'The custom local ID. ' type: string + local_pa_certificate_id: + description: Local Pa Certificate Id + type: string + pa_master_key_id: + description: Pa Master Key Id + type: string passphrase: description: Passphrase type: string passphrase_encrypted: description: 'Passphrase Encrypted: JsonIgnore(value = true) ' type: string + peer_id_check: + description: Peer Id Check + enum: + - EXACT + - WILDCARD + type: string + permit_peer_id_mismatch: + description: Permit Peer Id Mismatch + type: boolean private_key: description: 'The private key file uploaded for certificate authentication. @@ -428,6 +457,9 @@ components: secret_hash: description: 'Secret Hash: JsonIgnore(value = true) ' type: string + strict_validation_peer_extended_key_use: + description: Strict Validation Peer Extended Key Use + type: boolean type: description: 'The authentication type = PSK or Certificates. @@ -792,7 +824,7 @@ components: - site_id - scope - name - LANNetworkQueryFilterV3N1: + LANNetworkQueryFilterV3N2: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -805,6 +837,11 @@ components: $ref: '#/components/schemas/LanNetworkIPv4Config' description: 'The Ipv4 config of the LAN network. Maz size = 256. + ' + ipv6_config: + $ref: '#/components/schemas/LanNetworkIPv6Config' + description: 'The Ipv6 config of the LAN network. Maz size = 256. + ' name: description: 'The name of the LAN network. Max size = 128. @@ -836,7 +873,7 @@ components: required: - scope - name - LANNetworkQueryFilterV3N2: + LANNetworkQueryFilterV3N3: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -882,10 +919,13 @@ components: description: Tags type: string type: array + vrf_context_id: + description: "The vrf context id. \n" + type: string required: - scope - name - LANNetworkScreenV3N1: + LANNetworkScreenV3N2: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -898,6 +938,11 @@ components: $ref: '#/components/schemas/LanNetworkIPv4Config' description: 'The Ipv4 config of the LAN network. Maz size = 256. + ' + ipv6_config: + $ref: '#/components/schemas/LanNetworkIPv6Config' + description: 'The Ipv6 config of the LAN network. Maz size = 256. + ' name: description: 'The name of the LAN network. Max size = 128. @@ -918,8 +963,10 @@ components: - LOCAL type: string tags: - description: "An information field that can be added to identify the LAN\ - \ network. Maximum 10 unique tags of length 1024 each are allowed. \n" + description: 'An information field that can be added to identify the LAN + network. Maximum 10 unique tags of length 1024 each are allowed. + + ' items: description: Tags type: string @@ -927,7 +974,7 @@ components: required: - scope - name - LANNetworkScreenV3N2: + LANNetworkScreenV3N3: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -973,10 +1020,14 @@ components: description: Tags type: string type: array + vrf_context_id: + description: "The VRF (Virtual Routing and Forwarding) ID. \ + \ \n" + type: string required: - scope - name - LANNetworkV3N1: + LANNetworkV3N2: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -989,6 +1040,11 @@ components: $ref: '#/components/schemas/LanNetworkIPv4Config' description: 'The Ipv4 config of the LAN network. Maz size = 256. + ' + ipv6_config: + $ref: '#/components/schemas/LanNetworkIPv6Config' + description: 'The Ipv6 config of the LAN network. Maz size = 256. + ' name: description: 'The name of the LAN network. Max size = 128. @@ -1020,7 +1076,7 @@ components: required: - scope - name - LANNetworkV3N2: + LANNetworkV3N3: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -1066,6 +1122,11 @@ components: description: Tags type: string type: array + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string required: - scope - name @@ -1136,22 +1197,31 @@ components: description: Prefixes type: string type: array + Lifesize: + properties: + units: + description: Units + type: string + value: + description: Value + format: int32 + type: integer ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -1172,7 +1242,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -1181,13 +1251,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -1282,6 +1352,7 @@ components: - AES128CTR - AES192CTR - AES256CTR + - AES128CCM16 - AES128CCM64 - AES192CCM64 - AES256CCM64 @@ -1291,8 +1362,10 @@ components: - AES128CCM128 - AES192CCM128 - AES256CCM128 + - AES128GCM16 - AES128GCM64 - AES192GCM64 + - AES256GCM16 - AES256GCM64 - AES128GCM96 - AES192GCM96 @@ -1332,11 +1405,116 @@ components: - AES128GMAC - AES192GMAC - AES256GMAC + - NONE type: string required: - hash - encryption - dh_groups + ResponderSaseProposals: + properties: + dh_group: + description: Dh Group + items: + description: Dh Group + enum: + - NONE + - MODP768 + - MODP1024 + - MODP1536 + - MODP2048 + - MODP3072 + - MODP4096 + - MODP6144 + - MODP8192 + - MODP1024S160 + - MODP2048S224 + - MODP2048S256 + - ECP192 + - ECP224 + - ECP256 + - ECP384 + - ECP521 + - ECP224BP + - ECP256BP + - ECP384BP + - ECP512BP + - CURVE25519 + type: string + type: array + encryption: + description: 'The encryption values. + + ' + items: + description: Encryption + enum: + - NONE + - AES128 + - AES192 + - AES256 + - AES128CTR + - AES192CTR + - AES256CTR + - AES128CCM16 + - AES128CCM64 + - AES192CCM64 + - AES256CCM64 + - AES128CCM96 + - AES192CCM96 + - AES256CCM96 + - AES128CCM128 + - AES192CCM128 + - AES256CCM128 + - AES128GCM16 + - AES128GCM64 + - AES192GCM64 + - AES256GCM16 + - AES256GCM64 + - AES128GCM96 + - AES192GCM96 + - AES256GCM96 + - AES128GCM128 + - AES192GCM128 + - AES256GCM128 + - AES128GMAC + - AES192GMAC + - AES256GMAC + - TRIPLEDES + - BLOWFISH128 + - BLOWFISH192 + - BLOWFISH256 + - CAMELLIA128 + - CAMELLIA192 + - CAMELLIA256 + - SERPENT128 + - SERPENT192 + - SERPENT256 + - TWOFISH128 + - TWOFISH192 + - TWOFISH256 + type: string + type: array + hash: + description: 'The hash values. + + ' + items: + description: Hash + enum: + - MD5 + - SHA1 + - SHA256 + - SHA384 + - SHA512 + - SHA256_96 + - AESXCBC + - AES128GMAC + - AES192GMAC + - AES256GMAC + - NONE + type: string + type: array SiteIPFixPrefixAssociation: properties: id: @@ -3272,10 +3450,10 @@ paths: summary: Update WAN Interface Label (v2.4) tags: - Network Constructs - /sdwan/v3.1/api/lannetworks/query: + /sdwan/v3.2/api/lannetworks/query: post: description: Query the DB for site LAN networks that match query parameters. - operationId: post-sdwan-v3.1-api-lannetworks-query + operationId: post-sdwan-v3.2-api-lannetworks-query requestBody: content: application/json: @@ -3305,13 +3483,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Site LAN Networks (v3.1) + summary: Query DB for Site LAN Networks (v3.2) tags: - Network Constructs - /sdwan/v3.1/api/sites/{site_id}/lannetworks: + /sdwan/v3.2/api/sites/{site_id}/lannetworks: get: description: List all the LAN networks. - operationId: get-sdwan-v3.1-api-sites-site_id-lannetworks + operationId: get-sdwan-v3.2-api-sites-site_id-lannetworks parameters: - description: The ID of the site. in: path @@ -3330,16 +3508,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkV3N1' + $ref: '#/components/schemas/LANNetworkV3N2' type: array type: object description: Successful Operation - summary: Get LAN Networks (v3.1) + summary: Get LAN Networks (v3.2) tags: - Network Constructs post: description: Create a new LAN network. - operationId: post-sdwan-v3.1-api-sites-site_id-lannetworks + operationId: post-sdwan-v3.2-api-sites-site_id-lannetworks parameters: - description: The ID of the site. in: path @@ -3352,14 +3530,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N1' + $ref: '#/components/schemas/LANNetworkScreenV3N2' description: Details of the network to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N1' + $ref: '#/components/schemas/LANNetworkV3N2' description: Successful Operation '400': content: @@ -3379,16 +3557,20 @@ paths: - code: DEFAULT_ROUTER_PREFIX_MISMATCH - code: SAME_IPV4_DEFAULT_ROUTER_ADDRESS - code: LAN_NETWORK_ADD_FAILURE + - code: INVALID_IPV6_PREFIX + - code: NO_LAN_NET_V6_PREFIX + - code: DEFAULT_ROUTER_V6_EXCEEDS_LIMIT + - code: SAME_IPV6_PREFIX schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create LAN Network (v3.1) + summary: Create LAN Network (v3.2) tags: - Network Constructs - /sdwan/v3.1/api/sites/{site_id}/lannetworks/query: + /sdwan/v3.2/api/sites/{site_id}/lannetworks/query: post: description: Query LAN networks that match query parameters. - operationId: post-sdwan-v3.1-api-sites-site_id-lannetworks-query + operationId: post-sdwan-v3.2-api-sites-site_id-lannetworks-query parameters: - description: The ID of the site. in: path @@ -3412,17 +3594,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkQueryFilterV3N1' + $ref: '#/components/schemas/LANNetworkQueryFilterV3N2' type: array type: object description: Successful Operation - summary: Query LAN Networks (v3.1) + summary: Query LAN Networks (v3.2) tags: - Network Constructs - /sdwan/v3.1/api/sites/{site_id}/lannetworks/{lannetwork_id}: + /sdwan/v3.2/api/sites/{site_id}/lannetworks/{lannetwork_id}: delete: description: Delete an existing LAN network. - operationId: delete-sdwan-v3.1-api-sites-site_id-lannetworks-lannetwork_id + operationId: delete-sdwan-v3.2-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3443,7 +3625,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N1' + $ref: '#/components/schemas/LANNetworkV3N2' description: Successful Operation '400': content: @@ -3456,12 +3638,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete LAN Network (v3.1) + summary: Delete LAN Network (v3.2) tags: - Network Constructs get: description: List a LAN network. - operationId: get-sdwan-v3.1-api-sites-site_id-lannetworks-lannetwork_id + operationId: get-sdwan-v3.2-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3482,14 +3664,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N1' + $ref: '#/components/schemas/LANNetworkV3N2' description: Successful Operation - summary: Get LAN Network (v3.1) + summary: Get LAN Network (v3.2) tags: - Network Constructs put: description: Update an existing LAN network. - operationId: put-sdwan-v3.1-api-sites-site_id-lannetworks-lannetwork_id + operationId: put-sdwan-v3.2-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3509,14 +3691,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N1' + $ref: '#/components/schemas/LANNetworkScreenV3N2' description: Details of the network to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N1' + $ref: '#/components/schemas/LANNetworkV3N2' description: Successful Operation '400': content: @@ -3537,16 +3719,20 @@ paths: - code: SAME_IPV4_DEFAULT_ROUTER_ADDRESS - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE - code: OVERLAPPING_LAN_NET_PREFIXES + - code: INVALID_IPV6_PREFIX + - code: NO_LAN_NET_V6_PREFIX + - code: DEFAULT_ROUTER_V6_EXCEEDS_LIMIT + - code: SAME_IPV6_PREFIX schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update LAN Network (v3.1) + summary: Update LAN Network (v3.2) tags: - Network Constructs - /sdwan/v3.2/api/lannetworks/query: + /sdwan/v3.3/api/lannetworks/query: post: description: Query the DB for site LAN networks that match query parameters. - operationId: post-sdwan-v3.2-api-lannetworks-query + operationId: post-sdwan-v3.3-api-lannetworks-query requestBody: content: application/json: @@ -3576,13 +3762,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Site LAN Networks (v3.2) + summary: Query DB for Site LAN Networks (v3.3) tags: - Network Constructs - /sdwan/v3.2/api/sites/{site_id}/lannetworks: + /sdwan/v3.3/api/sites/{site_id}/lannetworks: get: description: List all the LAN networks. - operationId: get-sdwan-v3.2-api-sites-site_id-lannetworks + operationId: get-sdwan-v3.3-api-sites-site_id-lannetworks parameters: - description: The ID of the site. in: path @@ -3601,16 +3787,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3N3' type: array type: object description: Successful Operation - summary: Get LAN Networks (v3.2) + summary: Get LAN Networks (v3.3) tags: - Network Constructs post: description: Create a new LAN network. - operationId: post-sdwan-v3.2-api-sites-site_id-lannetworks + operationId: post-sdwan-v3.3-api-sites-site_id-lannetworks parameters: - description: The ID of the site. in: path @@ -3623,14 +3809,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N2' + $ref: '#/components/schemas/LANNetworkScreenV3N3' description: Details of the network to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3N3' description: Successful Operation '400': content: @@ -3657,13 +3843,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create LAN Network (v3.2) + summary: Create LAN Network (v3.3) tags: - Network Constructs - /sdwan/v3.2/api/sites/{site_id}/lannetworks/query: + /sdwan/v3.3/api/sites/{site_id}/lannetworks/query: post: description: Query LAN networks that match query parameters. - operationId: post-sdwan-v3.2-api-sites-site_id-lannetworks-query + operationId: post-sdwan-v3.3-api-sites-site_id-lannetworks-query parameters: - description: The ID of the site. in: path @@ -3687,17 +3873,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkQueryFilterV3N2' + $ref: '#/components/schemas/LANNetworkQueryFilterV3N3' type: array type: object description: Successful Operation - summary: Query LAN Networks (v3.2) + summary: Query LAN Networks (v3.3) tags: - Network Constructs - /sdwan/v3.2/api/sites/{site_id}/lannetworks/{lannetwork_id}: + /sdwan/v3.3/api/sites/{site_id}/lannetworks/{lannetwork_id}: delete: description: Delete an existing LAN network. - operationId: delete-sdwan-v3.2-api-sites-site_id-lannetworks-lannetwork_id + operationId: delete-sdwan-v3.3-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3718,7 +3904,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3N3' description: Successful Operation '400': content: @@ -3731,12 +3917,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete LAN Network (v3.2) + summary: Delete LAN Network (v3.3) tags: - Network Constructs get: description: List a LAN network. - operationId: get-sdwan-v3.2-api-sites-site_id-lannetworks-lannetwork_id + operationId: get-sdwan-v3.3-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3757,14 +3943,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3N3' description: Successful Operation - summary: Get LAN Network (v3.2) + summary: Get LAN Network (v3.3) tags: - Network Constructs put: description: Update an existing LAN network. - operationId: put-sdwan-v3.2-api-sites-site_id-lannetworks-lannetwork_id + operationId: put-sdwan-v3.3-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3784,14 +3970,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N2' + $ref: '#/components/schemas/LANNetworkScreenV3N3' description: Details of the network to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3N3' description: Successful Operation '400': content: @@ -3819,7 +4005,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update LAN Network (v3.2) + summary: Update LAN Network (v3.3) tags: - Network Constructs servers: diff --git a/openapi-specs/sdwan/unified/PathPolicy.yaml b/openapi-specs/sdwan/unified/PathPolicy.yaml index cc034e3f0..f2ea3edaa 100644 --- a/openapi-specs/sdwan/unified/PathPolicy.yaml +++ b/openapi-specs/sdwan/unified/PathPolicy.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,47 +44,46 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BasePolicyRule: properties: description: - description: 'The description of the network policy rule. Max size = 256. + description: 'The description of the policy rule. Max size = 256. ' disabled: - description: "Lists if the network policy rules are disabled. \n" + description: "Lists if the policy rules are disabled. \n" type: boolean disabled_reason: - description: 'Reason the network policy rule is disabled. + description: 'Reason the policy rule is disabled. ' type: string id: - description: 'The network policy rule ID. + description: 'The policy rule ID. ' type: string inactive: - description: 'Lists if the network policy rule is inactive. + description: 'Lists if the policy rule is inactive. ' type: boolean inactive_reason: - description: 'Reason the network policy rule is inactive. + description: 'Reason the policy rule is inactive. ' type: string name: - description: 'The name of the network policy rule. + description: 'The name of the policy rule. ' type: string policyset_id: - description: 'The ID of the network policy set. + description: 'The ID of the policy set. ' type: string @@ -99,8 +93,8 @@ components: ' type: string tags: - description: 'A information field that can be added to identify the network - policy rule. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the policy + rule. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -297,19 +291,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -330,7 +324,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -339,13 +333,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -1253,17 +1247,23 @@ components: PathsAllowedV2N1: properties: active_paths: - description: Active Paths + description: 'The configured active path for the rule. + + ' items: $ref: '#/components/schemas/WANPath' type: array backup_paths: - description: Backup Paths + description: 'The configured backup path for the rule. + + ' items: $ref: '#/components/schemas/WANPath' type: array l3_failure_paths: - description: L3 Failure Paths + description: 'The configured l3 failure path for the rule. + + ' items: $ref: '#/components/schemas/WANPath' type: array @@ -1567,7 +1567,9 @@ components: description: "The IP Prefix ID that associates with a site. \n" type: string site_id: - description: "The site ID binding the prefix. \n" + description: 'The site ID binding the prefix. + + ' type: string tags: description: 'A information field that can be added to identify the site @@ -2203,7 +2205,7 @@ paths: - Path Policy /sdwan/v2.0/api/networkpolicysetstacks: get: - description: Get all network policy set stacks of tenant. + description: List all the network policy set stacks of a tenant. operationId: get-sdwan-v2.0-api-networkpolicysetstacks responses: '200': @@ -2219,7 +2221,7 @@ paths: type: array type: object description: Successful Operation - summary: Get all network policy set stacks of tenant. (v2.0) + summary: Get Network Policy Set Stacks (v2.0) tags: - Path Policy post: diff --git a/openapi-specs/sdwan/unified/PathPolicyOriginal.yaml b/openapi-specs/sdwan/unified/PathPolicyOriginal.yaml index 102f90df6..f9d83b173 100644 --- a/openapi-specs/sdwan/unified/PathPolicyOriginal.yaml +++ b/openapi-specs/sdwan/unified/PathPolicyOriginal.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BandwidthAllocationScheme: properties: bandwidth_range: @@ -147,19 +141,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -180,7 +174,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -189,13 +183,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string diff --git a/openapi-specs/sdwan/unified/PerformancePolicy.yaml b/openapi-specs/sdwan/unified/PerformancePolicy.yaml new file mode 100644 index 000000000..8dc43128b --- /dev/null +++ b/openapi-specs/sdwan/unified/PerformancePolicy.yaml @@ -0,0 +1,1701 @@ +components: + schemas: + Aggregate: + properties: + data: + description: 'The details of the aggregate data. + + ' + items: + $ref: '#/components/schemas/AggregateData' + type: array + field: + description: Field + type: string + name: + description: 'The name of the query response. + + ' + type: string + operator: + description: Operator + enum: + - max + - count + - min + - avg + - sum + type: string + statistic: + description: 'QoS application aggregate statistics. + + ' + type: string + unit: + description: 'The unit. + + ' + type: string + AggregateData: + properties: + value: + description: 'Value of the aggregate data. + + ' + type: number + view: + description: 'View the aggregate date. + + ' + type: object + ApplicationFilter: + properties: + app_transfer_types: + description: 'Lists the app transfer types. Maximum 4 app transfer types + are supported. + + ' + items: + description: App Transfer Types + enum: + - RT_AUDIO + - RT_VIDEO + - TRANSACTIONAL + - BULK + type: string + type: array + application_ids: + description: 'Lists the application IDs in a rule. Maximum 64 applications + can be specified in a rule. + + ' + items: + description: Application Ids + type: string + type: array + BasePolicyRule: + properties: + description: + description: 'The description of the policy rule. Max size = 256. + + ' + disabled: + description: "Lists if the policy rules are disabled. \n" + type: boolean + disabled_reason: + description: 'Reason the policy rule is disabled. + + ' + type: string + id: + description: 'The policy rule ID. + + ' + type: string + inactive: + description: 'Lists if the policy rule is inactive. + + ' + type: boolean + inactive_reason: + description: 'Reason the policy rule is inactive. + + ' + type: string + name: + description: 'The name of the policy rule. + + ' + type: string + policyset_id: + description: 'The ID of the policy set. + + ' + type: string + region: + description: 'The region of the site. + + ' + type: string + tags: + description: 'A information field that can be added to identify the policy + rule. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + Error: + properties: + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + type: string + message: + type: string + LQMThresholdConfig: + properties: + max_jitter: + description: 'The max jitter threshold range. Max = 100L. + + ' + type: integer + max_latency: + description: 'The max latency threshold range. Max = 500L. + + ' + type: integer + max_packet_loss: + description: 'The max packet loss threshold range. Max = 20L. + + ' + type: integer + ListQueryResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + deleted_count: + description: 'The deleted number. + + ' + format: int64 + type: integer + deleted_ids: + description: 'The deleted IDs. + + ' + items: + type: string + type: array + description: + description: 'Description of the query. Max size = 256. + + ' + id: + description: 'The ID. + + ' + type: string + next_query: + description: 'Details of the next query. + + ' + type: object + total_count: + description: 'Total number. + + ' + format: int64 + type: integer + type: object + ListResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + id: + description: 'The ID. + + ' + type: string + type: object + PathFilter: + properties: + label: + description: 'The policy rule path label. + + ' + type: string + path_type: + description: 'The path type specified in the path filter. + + ' + enum: + - vpn + - direct + - servicelink + - all + type: string + required: + - path_type + PerfMgmtAction: + properties: + action_type: + description: 'The values of the action type for the performance policy rule. + + ' + enum: + - RAISE_ALARM + - MOVE_FLOWS + - FEC + - VISIBILITY + type: string + app_perf: + $ref: '#/components/schemas/PerfMgmtActionParameters' + description: 'The details of the application performance parameters. + + ' + lqm_perf: + $ref: '#/components/schemas/PerfMgmtActionParameters' + description: 'The details of the LQM performance parameters. + + ' + required: + - action_type + PerfMgmtActionParameters: + properties: + bad_health_thresholds: + $ref: '#/components/schemas/PerfMgmtHealthThresholds' + description: 'Lists the valid / invalid performance policy rules thresholds. + + ' + monitoring_approach: + description: 'The monitoring approach for the rule. + + ' + enum: + - AGGRESSIVE + - MODERATE + - CONSERVATIVE + type: string + required: + - monitoring_approach + PerfMgmtHealthThresholds: + properties: + clear_below: + description: 'The clear_below value should be between 1-80L. + + ' + format: int32 + type: integer + raise_above: + description: 'The raise_above value should be between 10-100L. + + ' + format: int32 + type: integer + PerfMgmtPolicyRule: + properties: + actions: + description: 'The valid actions configured for the performance policy rule. + + ' + items: + $ref: '#/components/schemas/PerfMgmtAction' + type: array + app_filters: + $ref: '#/components/schemas/ApplicationFilter' + description: 'The details of the app filters used for the performance policy + rule. + + ' + description: + description: 'The description of the performance policy rule. Max characters + = 256. + + ' + enabled: + description: 'Lists if the performance policy rule is enabled. + + ' + type: boolean + id: + description: 'Lists the performance policy rules by ID. + + ' + type: string + name: + description: 'The name of the performance policy rule. + + ' + type: string + path_filters: + description: 'Lists the path filters applied. Maximum 32 path filters are + supported. + + ' + items: + $ref: '#/components/schemas/PathFilter' + type: array + service_label_ids: + description: 'Lists the service label IDs. Maximum 32 service labels are + supported. + + ' + items: + description: Service Label Ids + type: string + type: array + tags: + description: 'A information field that can be added to identify the performance + policy rule. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + thresholdprofile_id: + description: 'Lists the threshold profile IDs. + + ' + type: string + type: + description: 'The type of performance policy rule. + + ' + enum: + - APP_CIRCUIT_HEALTH + type: string + required: + - type + - name + PerfMgmtPolicyRuleQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of performance policy rules that match + the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number performance policy rules deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the performance policy rules for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the performance policy rules by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + description: 'Query using query parameters. + + ' + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + PerfMgmtPolicyRuleQueryFilter: + properties: + actions: + description: 'The valid actions configured for the performance policy rule. + + ' + items: + $ref: '#/components/schemas/PerfMgmtAction' + type: array + app_filters: + $ref: '#/components/schemas/ApplicationFilter' + description: 'The details of the app filters used for the performance policy + rule. + + ' + description: + description: 'The description of the performance policy rule. Max characters + = 256. + + ' + enabled: + description: 'Lists if the performance policy rule is enabled. + + ' + type: boolean + id: + description: 'Lists the performance policy rules by ID. + + ' + type: string + name: + description: 'The name of the performance policy rule. + + ' + type: string + path_filters: + description: 'Lists the path filters applied. Maximum 32 path filters are + supported. + + ' + items: + $ref: '#/components/schemas/PathFilter' + type: array + service_label_ids: + description: 'Lists the service label IDs. Maximum 32 service labels are + supported. + + ' + items: + description: Service Label Ids + type: string + type: array + tags: + description: 'A information field that can be added to identify the performance + policy rule. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + thresholdprofile_id: + description: 'Lists the threshold profile IDs. + + ' + type: string + type: + description: 'The type of performance policy rule. + + ' + enum: + - APP_CIRCUIT_HEALTH + type: string + required: + - type + - name + PerfMgmtPolicySet: + properties: + clone_from: + description: 'The performance policy set that has been cloned from. + + ' + type: string + defaultrule_policyset: + description: "The default rule of the policy set. \n" + type: boolean + description: + description: 'The description of the performance policy set. Max size = + 256. + + ' + disabled: + description: "Lists if the performance policy sets are disabled. \n" + type: boolean + disabled_reason: + description: 'Reason the performance policy set is disabled. + + ' + type: string + id: + description: 'The ID of the policy set. + + ' + type: string + inactive: + description: 'Lists if the performance policy set is inactive. + + ' + type: boolean + inactive_reason: + description: "Reason the performance policy set is inactive. \n" + type: string + link_health_policyrule_order: + description: "The order of the policy rule. \n" + items: + description: Link Health Policyrule Order + type: string + type: array + link_health_rules: + description: 'The details of the policy rule. + + ' + items: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + type: array + name: + description: 'The name of the performnace policy set. Max size = 128. + + ' + type: string + policy_rules: + description: 'Lists the details of the policy rules. + + ' + items: + $ref: '#/components/schemas/BasePolicyRule' + type: array + region: + description: 'The region of the site. + + ' + type: string + send_to_element: + description: Send To Element + type: boolean + tags: + description: 'A information field that can be added to identify the policy + set. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + PerfMgmtPolicySetStack: + properties: + default_policysetstack: + description: "The default policy set stack. \n" + type: boolean + defaultrule_policyset_id: + description: 'The ID of the default rule policy set. + + ' + type: string + description: + description: 'The description of the policy set stack. Max size = 256. + + ' + id: + description: 'The policy set stack ID. + + ' + type: string + name: + description: 'Name: Required(error = NAME_REQD: Please provide resource + name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource + exceeds limit., min = 0) ' + type: string + policyset_ids: + description: 'The policy set IDs.Should be between 1-4. + + ' + items: + description: Policyset Ids + type: string + type: array + tags: + description: 'A information field that can be added to identify the policy + set stack. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - defaultrule_policyset_id + - name + PerfMgmtPolicySetState: + properties: + id: + description: 'The ID of the performance policy set. + + ' + type: string + policy_req_state: + description: 'The policy required state. + + ' + enum: + - POLICY_REQ_PENDING + - POLICY_CREATE_INPROGRESS + - POLICY_CREATE_COMPLETE + - POLICY_REPLICATE + - POLICY_CREATE_FAILED + - POLICY_REQ_COMPLETE + type: string + policyset_id: + description: 'The ID of the policy set. + + ' + type: string + PerfMgmtThresholdProfile: + properties: + description: + description: 'The description of the threshold profile. Max size = 256. + + ' + disabled: + description: "Lists if the threshold profiles are disabled. \n" + type: boolean + disabled_reason: + description: 'Reason the threshold profile is disabled. + + ' + type: string + hard_limit_app_metrics: + $ref: '#/components/schemas/StaticAppMetricConfig' + description: 'The hard limits set for the app metrics. + + ' + id: + description: 'The ID of the threshold profile. + + ' + type: string + inactive: + description: 'Lists if the threshold profile is inactive. + + ' + type: boolean + inactive_reason: + description: "Reason the threshold profile is inactive. \n" + type: string + is_default: + description: 'The default threshold. + + ' + type: boolean + lqm_thresholds: + $ref: '#/components/schemas/LQMThresholdConfig' + description: 'Details of the LQM threshold configurations. + + ' + name: + description: 'The name of the profile. Max size = 128. + + ' + type: string + region: + description: 'The region of the site. + + ' + type: string + soft_limit_app_metrics: + $ref: '#/components/schemas/StaticAppMetricConfig' + description: 'The soft limits set for the app metrics. + + ' + tags: + description: 'A information field that can be added to identify the profile. + Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + PerfMgmtThresholdProfileScreen: + properties: + description: + description: 'The description of the threshold profile. Max size = 256. + + ' + hard_limit_app_metrics: + $ref: '#/components/schemas/StaticAppMetricConfig' + description: 'The hard limits set for the app metrics. + + ' + id: + description: 'The ID of the threshold profile. + + ' + type: string + lqm_thresholds: + $ref: '#/components/schemas/LQMThresholdConfig' + description: 'Details of the LQM threshold configurations. + + ' + name: + description: 'The name of the profile. Max size = 128. + + ' + type: string + soft_limit_app_metrics: + $ref: '#/components/schemas/StaticAppMetricConfig' + description: 'The soft limits set for the app metrics. + + ' + tags: + description: 'A information field that can be added to identify the profile. + Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - hard_limit_app_metrics + - name + StaticAppMetricConfig: + properties: + max_init_failure_rate: + description: 'The max init failure rate threshold. Max = 100L. + + ' + type: integer + max_rtt: + description: 'The max rtt threshold range. Max = 500L. + + ' + type: integer +info: + contact: {} + description: List of APIs used to manage performance policy. + title: Performance Policy + version: Latest +openapi: 3.0.0 +paths: + /sdwan/v2.0/api/perfmgmtpolicyrules/query: + post: + description: Query details for the performance policy rules. + operationId: post-sdwan-v2.0-api-perfmgmtpolicyrules-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRuleQuery' + description: Details of the query for PERFMGMT Policy Rule + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PerfMgmtPolicyRuleQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Performance Policy Rules (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtpolicysets: + get: + description: Get details of the performance policy sets. + operationId: get-sdwan-v2.0-api-perfmgmtpolicysets + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PerfMgmtPolicySet' + type: array + type: object + description: Successful Operation + summary: Get Performance Policy Sets (v2.0) + tags: + - Performance Policy + post: + description: Create a new performance policy set. + operationId: post-sdwan-v2.0-api-perfmgmtpolicysets + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Details of PERFMGMT Policy Set to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: POLICY_SET_CONFIG_CREATION_FAILED + - code: PERFMGMT_SET_CONFIG_INVALID_CLONE_FROM + - code: PERFMGMT_DUPLICATE_RULES_IN_RULES_ORDER + - code: PERFMGMT_INVALID_POLICY_SET_ORDER + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Performance Policy Set (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtpolicysets/query: + post: + description: Query details for the performance policy set. + operationId: post-sdwan-v2.0-api-perfmgmtpolicysets-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Details of query for PERFMGMT Policy Set + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Performance Policy Set (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtpolicysets/{id}/status: + get: + description: Get the status of the performance policy sets. + operationId: get-sdwan-v2.0-api-perfmgmtpolicysets-id-status + parameters: + - description: The performance policy set ID. + in: path + name: id + required: true + schema: + description: Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetState' + description: Successful Operation + summary: Get Performance Policy Set Status (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtpolicysets/{perfmgmtpolicyset_id}: + delete: + description: Delete a performance policy set. + operationId: delete-sdwan-v2.0-api-perfmgmtpolicysets-perfmgmtpolicyset_id + parameters: + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: PERFMGMT_SET_IN_USE + - code: DEFAULT_POLICY_SET_CANNOT_BE_DELETED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Performance Policy Set (v2.0) + tags: + - Performance Policy + get: + description: Get a performance policy set. + operationId: get-sdwan-v2.0-api-perfmgmtpolicysets-perfmgmtpolicyset_id + parameters: + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Successful Operation + summary: Get Performance Policy Set (v2.0) + tags: + - Performance Policy + put: + description: Update a performance policy set. + operationId: put-sdwan-v2.0-api-perfmgmtpolicysets-perfmgmtpolicyset_id + parameters: + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Details of PERFMGMT Policy Set to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySet' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: POLICY_SET_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: READONLY_CLONE_FROM + - code: DEFAULT_RULES_CANNOT_BE_REMOVED_FROM_SET + - code: PERFMGMT_DEFAULT_RESOURCE_NAME_CHANGE_NOT_ALLOWED + - code: PERFMGMT_DUPLICATE_RULES_IN_RULES_ORDER + - code: PERFMGMT_INVALID_POLICY_SET_ORDER + - code: PERFMGMT_POLICY_DEFAULT_SET_UPDATE_NOT_ALLOWED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Performance Policy Set (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtpolicysets/{perfmgmtpolicyset_id}/perfmgmtpolicyrules: + get: + description: Get details of the performance policy rules of a policy set. + operationId: get-sdwan-v2.0-api-perfmgmtpolicysets-perfmgmtpolicyset_id-perfmgmtpolicyrules + parameters: + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + type: array + type: object + description: Successful Operation + summary: Get Policy Rules of Performance Policy Set (v2.0) + tags: + - Performance Policy + post: + description: Create a new performance policy rule. + operationId: post-sdwan-v2.0-api-perfmgmtpolicysets-perfmgmtpolicyset_id-perfmgmtpolicyrules + parameters: + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Details of PERFMGMT Policy Rule to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: PERFMGMT_INVALID_PATH_TYPE + - code: PERFMGMT_INVALID_APP_TRANSFER_TYPE + - code: PERFMGMT_INVALID_ACTION_TYPE + - code: PERFMGMT_INVALID_MONITORING_APPROACH + - code: PERFMGMT_INVALID_RAISE_ABOVE + - code: PERFMGMT_INVALID_CLEAR_BELOW + - code: PERFMGMT_RULE_THRESHOLD_CLEAR_BELOW_INVALID + - code: PERFMGMT_INVALID_SERVICE_LABEL_IDS + - code: PERFMGMT_INVALID_THRESHOLD_PROFILE_ID + - code: PERFMGMT_POLICY_RULE_NOT_PRESENT + - code: PERFMGMT_MISSING_THRESHOLD_PROFILE_ID + - code: PERFMGMT_RULE_MISSING_ACTIONS + - code: PERFMGMT_RULE_LQM_THRESHOLD_MISSING + - code: PERFMGMT_RULE_APP_THRESHOLD_MISSING + - code: PERFMGMT_RULE_APP_PERF_BAD_HEALTH_THRESHOLD_MISSING + - code: PERFMGMT_RULE_MISSING_ACTION_TYPE + - code: PERFMGMT_RULE_APP_FILTER_AND_APP_THRESHOLDS_NOT_ALLOWED + - code: PERFMGMT_RULE_THRESHOLDS_MISSING + - code: PERFMGMT_RULE_APP_FILTER_MISSING + - code: PERFMGMT_RULE_INVALID_APP_FILTER + - code: PERFMGMT_INVALID_APPLICATION_IDS + - code: PERFMGMT_RULE_DUPLICATE_APPLICATION_IDS + - code: PERFMGMT_RULE_DUPLICATE_SERVICE_LABEL_IDS + - code: PERFMGMT_RULE_DUPLICATE_APP_TRANSFER_TYPES + - code: PERFMGMT_RULE_DUPLICATE_PATH_TYPE_IN_PATH_FILTERS + - code: PERFMGMT_RULE_DUPLICATE_LABEL_IN_PATH_FILTERS + - code: PERFMGMT_RULE_DUPLICATE_ACTION_TYPE + - code: PERFMGMT_INVALID_RULE_TYPE + - code: PERFMGMT_APP_TRANSFER_TYPE_LIST_SIZE_EXCEEDED + - code: PERFMGMT_PATH_FILTERS_LIST_SIZE_EXCEEDED + - code: PERFMGMT_APP_FILTER_MANDATORY_FOR_APP_THRESHOLDS + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY + - code: PERFMGMT_RULE_EXCEEDS_MAX_LIMIT + - code: PERFMGMT_RULE_DUPLICATE_PATH_LABEL_PATH_TYPE_IN_PATH_FILTERS + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY_FOR_ACTION_FEC + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY_FOR_ACTION_MOVE_FLOWS + - code: PERFMGMT_RULE_LQM_THRESHOLDS_REQUIRED_FOR_VISIBILITY + - code: PERFMGMT_RULE_VISIBILITY_APP_FILTERS_PROHIBITED + - code: PERFMGMT_RULE_FEC_APP_THRESHOLDS_PROHIBITED + - code: PERFMGMT_RULE_THRESHOLDS_MISSING_FOR_APP_PERF + - code: PERFMGMT_RULE_APP_FILTER_MISSING_FOR_APP_PERF + - code: PERFMGMT_RULE_LQM_THRESHOLD_MISSING_FOR_LQM_PERF + - code: PERFMGMT_RULE_LQM_PERF_APP_PERF_NOT_ALLOWED + - code: PERFMGMT_SERVICE_LABELS_NOT_ALLOWED_FOR_DIRECT_PATHS + - code: PERFMGMT_RULE_CANNOT_BE_CREATED_FOR_DEFAULT_SET + - code: APP_DEF_ID_LIST_SIZE_EXCEEDED_64 + - code: SERVICE_LABEL_ID_LIST_SIZE_EXCEEDED + - code: PERFMGMT_RULE_OVERLAPPING_PATH_FILTERS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Performance Policy Rule (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtpolicysets/{perfmgmtpolicyset_id}/perfmgmtpolicyrules/{perfmgmtpolicyrule_id}: + delete: + description: Delete a performance policy rule of the tenant. + operationId: delete-sdwan-v2.0-api-perfmgmtpolicysets-perfmgmtpolicyset_id-perfmgmtpolicyrules-perfmgmtpolicyrule_id + parameters: + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + - description: The performance policy rule ID. + in: path + name: perfmgmtpolicyrule_id + required: true + schema: + description: Perfmgmtpolicyrule Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: PERFMGMT_SET_NOT_FOUND + - code: PERFMGMT_POLICY_RULE_IN_USE + - code: DEFAULT_POLICY_RULE_CANNOT_BE_DELETED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Performance Policy Rule (v2.0) + tags: + - Performance Policy + get: + description: Get a specific performance policy rule of the tenant. + operationId: get-sdwan-v2.0-api-perfmgmtpolicysets-perfmgmtpolicyset_id-perfmgmtpolicyrules-perfmgmtpolicyrule_id + parameters: + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + - description: The performance policy rule ID. + in: path + name: perfmgmtpolicyrule_id + required: true + schema: + description: Perfmgmtpolicyrule Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Successful Operation + summary: Get Performance Policy Rule (v2.0) + tags: + - Performance Policy + put: + description: Update a performance policy rule of the tenant. + operationId: put-sdwan-v2.0-api-perfmgmtpolicysets-perfmgmtpolicyset_id-perfmgmtpolicyrules-perfmgmtpolicyrule_id + parameters: + - description: The performance policy set ID. + in: path + name: perfmgmtpolicyset_id + required: true + schema: + description: Perfmgmtpolicyset Id + type: string + - description: The performance policy rule ID. + in: path + name: perfmgmtpolicyrule_id + required: true + schema: + description: Perfmgmtpolicyrule Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Details of PERFMGMT Policy Rule to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicyRule' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: PERFMGMT_INVALID_PATH_TYPE + - code: PERFMGMT_INVALID_APP_TRANSFER_TYPE + - code: PERFMGMT_INVALID_ACTION_TYPE + - code: PERFMGMT_INVALID_MONITORING_APPROACH + - code: PERFMGMT_INVALID_RAISE_ABOVE + - code: PERFMGMT_INVALID_CLEAR_BELOW + - code: PERFMGMT_RULE_THRESHOLD_CLEAR_BELOW_INVALID + - code: PERFMGMT_INVALID_SERVICE_LABEL_IDS + - code: PERFMGMT_INVALID_THRESHOLD_PROFILE_ID + - code: PERFMGMT_POLICY_RULE_NOT_PRESENT + - code: PERFMGMT_MISSING_THRESHOLD_PROFILE_ID + - code: PERFMGMT_RULE_MISSING_ACTIONS + - code: PERFMGMT_RULE_LQM_THRESHOLD_MISSING + - code: PERFMGMT_RULE_APP_THRESHOLD_MISSING + - code: PERFMGMT_RULE_APP_PERF_BAD_HEALTH_THRESHOLD_MISSING + - code: PERFMGMT_RULE_MISSING_ACTION_TYPE + - code: PERFMGMT_RULE_APP_FILTER_AND_APP_THRESHOLDS_NOT_ALLOWED + - code: PERFMGMT_RULE_THRESHOLDS_MISSING + - code: PERFMGMT_RULE_APP_FILTER_MISSING + - code: PERFMGMT_RULE_INVALID_APP_FILTER + - code: PERFMGMT_INVALID_APPLICATION_IDS + - code: PERFMGMT_RULE_DUPLICATE_APPLICATION_IDS + - code: PERFMGMT_RULE_DUPLICATE_SERVICE_LABEL_IDS + - code: PERFMGMT_RULE_DUPLICATE_APP_TRANSFER_TYPES + - code: PERFMGMT_RULE_DUPLICATE_PATH_TYPE_IN_PATH_FILTERS + - code: PERFMGMT_RULE_DUPLICATE_LABEL_IN_PATH_FILTERS + - code: PERFMGMT_RULE_DUPLICATE_ACTION_TYPE + - code: PERFMGMT_DEFAULT_RESOURCE_NAME_CHANGE_NOT_ALLOWED + - code: PERFMGMT_DEFAULT_RULE_MATCH_CRITERIA_CHANGE_NOT_ALLOWED + - code: PERFMGMT_ACTION_CANNOT_BE_REMOVED_FROM_DEFAULT_RULE + - code: PERFMGMT_INVALID_RULE_TYPE + - code: PERFMGMT_APP_TRANSFER_TYPE_LIST_SIZE_EXCEEDED + - code: PERFMGMT_PATH_FILTERS_LIST_SIZE_EXCEEDED + - code: PERFMGMT_APP_FILTER_MANDATORY_FOR_APP_THRESHOLDS + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY + - code: PERFMGMT_RULE_EXCEEDS_MAX_LIMIT + - code: PERFMGMT_RULE_DUPLICATE_PATH_LABEL_PATH_TYPE_IN_PATH_FILTERS + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY_FOR_ACTION_FEC + - code: PERFMGMT_RULE_APP_FILTER_MANDATORY_FOR_ACTION_MOVE_FLOWS + - code: PERFMGMT_RULE_LQM_THRESHOLDS_REQUIRED_FOR_VISIBILITY + - code: PERFMGMT_RULE_VISIBILITY_APP_FILTERS_PROHIBITED + - code: PERFMGMT_RULE_FEC_APP_THRESHOLDS_PROHIBITED + - code: PERFMGMT_RULE_THRESHOLDS_MISSING_FOR_APP_PERF + - code: PERFMGMT_RULE_APP_FILTER_MISSING_FOR_APP_PERF + - code: PERFMGMT_RULE_LQM_THRESHOLD_MISSING_FOR_LQM_PERF + - code: PERFMGMT_RULE_TYPE_CHANGE_NOT_ALLOWED + - code: PERFMGMT_RULE_LQM_PERF_APP_PERF_NOT_ALLOWED + - code: PERFMGMT_CANNOT_SET_APP_METRICS_APP_FILTER_MISSING + - code: PERFMGMT_SERVICE_LABELS_NOT_ALLOWED_FOR_DIRECT_PATHS + - code: PERFMGMT_DEFAULT_RULE_CANNOT_BE_DISABLED + - code: APP_DEF_ID_LIST_SIZE_EXCEEDED_64 + - code: SERVICE_LABEL_ID_LIST_SIZE_EXCEEDED + - code: PERFMGMT_RULE_OVERLAPPING_PATH_FILTERS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Performance Policy Rule (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtpolicysetstacks: + get: + description: Get all the performance policy set stacks. + operationId: get-sdwan-v2.0-api-perfmgmtpolicysetstacks + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + type: array + type: object + description: Successful Operation + summary: Get Performance Policy Set Stacks (v2.0) + tags: + - Performance Policy + post: + description: Create a new performance policy set stack. + operationId: post-sdwan-v2.0-api-perfmgmtpolicysetstacks + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Details of PERFMGMT Policy Set Stack to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: POLICYSETSTACK_CONFIG_DUPLICATE_POLICYSETID + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_IDS + - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_STATE + - code: PERFMGMT_STACKS_EXCEEDS_MAX_LIMIT_FOR_SETS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Performance Policy Set Stack (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtpolicysetstacks/query: + post: + description: Query details for the performance policy set stack. + operationId: post-sdwan-v2.0-api-perfmgmtpolicysetstacks-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Details of query for PERFMGMT Policy Set Stack + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Performance Policy Set Stack (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtpolicysetstacks/{id}: + delete: + description: Delete a performance policy set stack. + operationId: delete-sdwan-v2.0-api-perfmgmtpolicysetstacks-id + parameters: + - description: The performance policy set ID. + in: path + name: id + required: true + schema: + description: Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DEFAULT_POLICYSETSTACK_CAN_NOT_BE_DELETED + - code: POLICYSETSTACK_IN_USE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Performance Policy Set Stack (v2.0) + tags: + - Performance Policy + get: + description: Get a performance set stack. + operationId: get-sdwan-v2.0-api-perfmgmtpolicysetstacks-id + parameters: + - description: The performance policy set ID. + in: path + name: id + required: true + schema: + description: Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Successful Operation + summary: Get Performance Policy Set Stack (v2.0) + tags: + - Performance Policy + put: + description: Update a performance policy set stack. + operationId: put-sdwan-v2.0-api-perfmgmtpolicysetstacks-id + parameters: + - description: The performance policy set ID. + in: path + name: id + required: true + schema: + description: Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Details of PERFMGMT Policy Set Stack to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtPolicySetStack' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: POLICYSETSTACK_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: DEFAULT_POLICY_SET_CANNOT_BE_REMOVED_FROM_DEFAULT_STACK + - code: PERFMGMT_DEFAULT_RESOURCE_NAME_CHANGE_NOT_ALLOWED + - code: DEFAULT_POLICYSET_STACK_EXISTS + - code: POLICYSETSTACK_CONFIG_DUPLICATE_POLICYSETID + - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_IDS + - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_STATE + - code: PERFMGMT_STACKS_EXCEEDS_MAX_LIMIT_FOR_SETS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Performance Policy Set Stack (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtthresholdprofiles: + get: + description: Get details of the threshold profile list. + operationId: get-sdwan-v2.0-api-perfmgmtthresholdprofiles + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Successful Operation + summary: Get Threshold Profile List (v2.0) + tags: + - Performance Policy + post: + description: Create a new threshold profile. + operationId: post-sdwan-v2.0-api-perfmgmtthresholdprofiles + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfileScreen' + description: Details of the Threshold profile to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_VALUE + - code: PERFMGMT_HARD_LIMIT_APP_METRICS_REQUIRED + - code: PERFMGMT_MAX_INIT_FAILURE_RATE_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_LATENCY_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_JITTER_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_PACKET_LOSS_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_RTT_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_LQM + - code: PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_APP_METRICS + - code: PERFMGMT_LQM_OR_APP_THREHOLDS_EXPECTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Threshold Profile (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtthresholdprofiles/query: + post: + description: Query the DB for limit number of tenant level threshold profiles + that match the query params. + operationId: post-sdwan-v2.0-api-perfmgmtthresholdprofiles-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Query Details for Threshold profile + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Tenant Level Threshold Profiles (v2.0) + tags: + - Performance Policy + /sdwan/v2.0/api/perfmgmtthresholdprofiles/{profile_id}: + delete: + description: Delete a threshold profile. + operationId: delete-sdwan-v2.0-api-perfmgmtthresholdprofiles-profile_id + parameters: + - description: The threshold ID. + in: path + name: profile_id + required: true + schema: + description: Profile Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: PERFMGMT_THRESHOLD_PROFILE_IN_USE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Threshold Profile (v2.0) + tags: + - Performance Policy + get: + description: Get a threshold profile. + operationId: get-sdwan-v2.0-api-perfmgmtthresholdprofiles-profile_id + parameters: + - description: The threshold ID. + in: path + name: profile_id + required: true + schema: + description: Profile Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Successful Operation + summary: Get Threshold Profile (v2.0) + tags: + - Performance Policy + put: + description: Update a threshold profile. + operationId: put-sdwan-v2.0-api-perfmgmtthresholdprofiles-profile_id + parameters: + - description: The threshold ID. + in: path + name: profile_id + required: true + schema: + description: Profile Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfileScreen' + description: Details of the Threshold profile to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PerfMgmtThresholdProfile' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_VALUE + - code: PERFMGMT_HARD_LIMIT_APP_METRICS_REQUIRED + - code: PERFMGMT_MAX_INIT_FAILURE_RATE_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_LATENCY_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_JITTER_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_PACKET_LOSS_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_MAX_RTT_THRESHOLD_RANGE_INVALID + - code: PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_LQM + - code: PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_APP_METRICS + - code: PERFMGMT_CANNOT_UNSET_LQM_THRESHOLD_PROFILE_IN_USE + - code: PERFMGMT_CANNOT_SET_APP_METRICS_APP_FILTER_MISSING + - code: PERFMGMT_DEFAULT_RESOURCE_NAME_CHANGE_NOT_ALLOWED + - code: PERFMGMT_DEFAULT_THRESHOLD_PROFILE_LQM_UNSET_NOT_ALLOWED + - code: PERFMGMT_LQM_OR_APP_THREHOLDS_EXPECTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Threshold Profile (v2.0) + tags: + - Performance Policy +servers: +- url: https://api.sase.paloaltonetworks.com +tags: +- name: Performance Policy diff --git a/openapi-specs/sdwan/unified/PrismaAccessConfigs.yaml b/openapi-specs/sdwan/unified/PrismaAccessConfigs.yaml index d356610d3..5b16303e2 100644 --- a/openapi-specs/sdwan/unified/PrismaAccessConfigs.yaml +++ b/openapi-specs/sdwan/unified/PrismaAccessConfigs.yaml @@ -15,19 +15,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -48,7 +48,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -98,6 +98,12 @@ components: - site_id RemoteNetwork: properties: + edge_location_display: + description: Edge Location Display + type: string + edge_location_value: + description: Edge Location Value + type: string remote_network_names: description: 'The names of the remote networks. @@ -106,6 +112,12 @@ components: description: Remote Network Names type: string type: array + service_link_ids: + description: Service Link Ids + items: + description: Service Link Ids + type: string + type: array spn_name: description: 'The SPN (Security Processing Name) of the prisma access config. @@ -115,7 +127,7 @@ components: - spn_name info: contact: {} - description: No description available. + description: List of APIs that are used for Prisma Access configuration. title: Prisma Access Configs version: Latest openapi: 3.0.0 diff --git a/openapi-specs/sdwan/unified/QOSPolicy.yaml b/openapi-specs/sdwan/unified/QOSPolicy.yaml index 82f230cec..63c93e7d9 100644 --- a/openapi-specs/sdwan/unified/QOSPolicy.yaml +++ b/openapi-specs/sdwan/unified/QOSPolicy.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BandwidthAllocationSchemeV2: properties: bandwidth_range: @@ -318,10 +312,9 @@ components: ' type: string tags: - description: 'A information field that can be added to identify the priority - policy global prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' + description: "A information field that can be added to identify the priority\ + \ policy global prefix. Maximum 10 unique tags of length 1024 each are\ + \ allowed. \n" items: description: Tags type: string @@ -331,19 +324,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -364,7 +357,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -373,13 +366,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -871,48 +864,70 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: Aggregate + description: 'The aggregate number of priority policy rules that match the + query parameters. + + ' dest_page: - description: Dest Page + description: 'The destination page. + + ' format: int32 type: integer getDeleted: - description: GetDeleted + description: 'The number of priority policy rules deleted for a time frame. + + ' type: boolean group_by: - description: Group By + description: 'Group the priority policy rules for the query. + + ' items: description: Group By type: string type: array id: - description: Id + description: "Lists the priority policy rules by ID. \n" type: string last_query_ts: - description: Last Query Ts + description: 'Return the ID of a specified query in the current session. + + ' format: int64 type: integer limit: - description: Limit + description: 'The query limit. + + ' format: int32 type: integer next_query: + description: 'The limit. + + ' type: object query_params: type: object retrieved_fields: - description: Retrieved Fields + description: 'Retrieve information from a field. + + ' items: description: Retrieved Fields type: string type: array retrieved_fields_mask: - description: Retrieved Fields Mask + description: 'List the fields to query. + + ' type: boolean sort_params: type: object total_count: - description: Total Count + description: 'The total number of query parameters. + + ' format: int64 type: integer PriorityPolicyRuleV2N1: diff --git a/openapi-specs/sdwan/unified/Routing.yaml b/openapi-specs/sdwan/unified/Routing.yaml index eeaf0aa21..79de64558 100644 --- a/openapi-specs/sdwan/unified/Routing.yaml +++ b/openapi-specs/sdwan/unified/Routing.yaml @@ -57,11 +57,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -70,11 +65,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BGPConfig: properties: adv_interval: @@ -126,7 +120,7 @@ components: \ default is 120 seconds. \n" format: int32 type: integer - BGPGlobalConfigScreenV2N1: + BGPGlobalConfigScreenV2N2: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -194,6 +188,12 @@ components: ' format: int32 type: integer + peer_auth_type: + description: "The authentication type of the BGP peer. \n" + enum: + - md5 + - none + type: string peer_retry_time: description: 'The peer retry time should be between 0 - 65535 seconds. The default is 120 seconds. @@ -208,7 +208,9 @@ components: ' type: string prefix_adv_type_to_lan: - description: Prefix Adv Type To Lan + description: 'The prefix advertises to LAN. + + ' type: string prefixes_to_adv_to_wan: description: 'The prefix advertises to WAN. @@ -230,7 +232,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigScreenV2N2: + BGPGlobalConfigScreenV2N3: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -261,6 +263,14 @@ components: id: description: "The BGP configuration ID. \n" type: string + ipv6_prefixes_to_adv_to_wan: + description: 'Ipv6 Prefixes To Adv To Wan: ListIPv6Address(bcast = DENY, + listMaxSize = 0, error = BGP_CONFIG_INVALID_PREFIX: IP prefix is not valid + OR is not within the valid prefix range, required = false, type = GATEWAYCIDRV6) ' + items: + description: Ipv6 Prefixes To Adv To Wan + type: string + type: array keepalive_time: description: 'The keep-alive time of the BGP config. The keep-alive time should be between 3 - 200 seconds. @@ -299,7 +309,9 @@ components: format: int32 type: integer peer_auth_type: - description: "The authentication type of the BGP peer. \n" + description: 'The authentication type of the BGP peer. + + ' enum: - md5 - none @@ -342,7 +354,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigV2N1: + BGPGlobalConfigV2N2: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -410,6 +422,14 @@ components: ' format: int32 type: integer + peer_auth_type: + description: 'The authentication type of the BGP peer. + + ' + enum: + - md5 + - none + type: string peer_retry_time: description: 'The peer retry time should be between 0 - 65535 seconds. The default is 120 seconds. @@ -424,7 +444,9 @@ components: ' type: string prefix_adv_type_to_lan: - description: Prefix Adv Type To Lan + description: 'The prefix advertises to LAN. + + ' type: string prefixes_to_adv_to_wan: description: 'The prefix advertises to WAN. @@ -446,7 +468,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigV2N2: + BGPGlobalConfigV2N3: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -477,6 +499,14 @@ components: id: description: "The BGP configuration ID. \n" type: string + ipv6_prefixes_to_adv_to_wan: + description: 'List of IPv6 prefixes advertised to WAN. + + ' + items: + description: Ipv6 Prefixes To Adv To Wan + type: string + type: array keepalive_time: description: 'The keep-alive time of the BGP config. The keep-alive time should be between 3 - 200 seconds. @@ -578,14 +608,27 @@ components: ' type: string - BGPPeerConfigEtag: + BGPPeerAdvertisedPrefixesV2N1: properties: - id: - description: 'The BGP peer config etag ID. + advertised_ipv6_prefix_count: + description: Advertised Ipv6 Prefix Count + format: int32 + type: integer + advertised_prefix_count: + description: Advertised Prefix Count + format: int32 + type: integer + advertised_prefixes: + $ref: '#/components/schemas/PrefixSet' + description: 'Advertised Prefixes: Valid ' + description: + description: 'The description of the prefix filter list. Max size = 1024. ' + id: + description: "The ID of the prefix filter list. \n" type: string - BGPPeerConfigV2N1: + BGPPeerConfigScreenV2N3: properties: bgp_config: $ref: '#/components/schemas/BGPConfig' @@ -605,7 +648,7 @@ components: ' type: string peer_ip: - description: "The peer IP address. \n" + description: "The peer IP address. \n" type: string peer_type: description: 'The peer type = Classic. The Peer Type option is available @@ -626,13 +669,19 @@ components: route_map_out_id: description: 'The ID of the Route Map Out to filter outgoing routes. + ' + type: string + router_id: + description: 'The IP address of the ION device. + ' type: string scope: - description: "The scope of the static route = Local or Global. If scope\ - \ is local, the device does not advertise the route to other sites and\ - \ if scope is global, the device advertises the route to other sites.\ - \ \n" + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' enum: - GLOBAL - LOCAL @@ -650,16 +699,27 @@ components: type: string type: array update_source: - description: 'The Update Source IP address. - - ' + description: "The Update Source IP address. \n" + type: string + vrf_context_id: + description: "The VRF (Virtual Routing and Forwarding) ID. The scope\ + \ of the static route = Local or Global. If scope is local, the device\ + \ does not advertise the route to other sites and if scope is global,\ + \ the device advertises the route to other sites. \n" type: string required: - remote_as_num - - peer_ip - name - BGPPeerConfigV2N2: + BGPPeerConfigScreenV2N4: properties: + allow_v4_prefixes: + description: 'Allow v4 prefixes. + + ' + type: boolean + allow_v6_prefixes: + description: "Allow v6 prefixes. \n" + type: boolean bgp_config: $ref: '#/components/schemas/BGPConfig' description: 'The details of the BGP config. @@ -678,7 +738,12 @@ components: ' type: string peer_ip: - description: "The peer IP address. \n" + description: 'The peer IP address. + + ' + type: string + peer_ip_v6: + description: "The peer IPv6 address. \n" type: string peer_type: description: 'The peer type = Classic. The Peer Type option is available @@ -701,11 +766,15 @@ components: ' type: string + router_id: + description: "The IP address of the ION device. \n" + type: string scope: - description: "The scope of the static route = Local or Global. If scope\ - \ is local, the device does not advertise the route to other sites and\ - \ if scope is global, the device advertises the route to other sites.\ - \ \n" + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' enum: - GLOBAL - LOCAL @@ -727,116 +796,22 @@ components: ' type: string - required: - - remote_as_num - - peer_ip - - name - BGPPeerDiscoveredPrefixes: - properties: - discovered_ipv4_prefixes: - description: 'The discovered IPv4 prefixes for the BGP peer. - - ' - items: - $ref: '#/components/schemas/PrefixInfo' - type: array - discovered_ipv4_prefixes_count: - description: 'The discovered IPv4 prefixes count for the BGP peer. - - ' - format: int32 - type: integer - id: - description: 'The ID of the BGP peer. + update_source_v6: + description: 'The Update Source IPv6 address. ' type: string - BGPPeerOperations: - properties: - action: - description: 'Action: ValidateEnum(enumClass = classOf[BGPPeerOperations], - error = INVALID_OPERATION: Invalid Operation, nullAllowed = false) ' - enum: - - HARD_RESET - - SOFT_RESET - - REVERT_AUTOGENERATED - - REFRESH_STATUS - type: string - id: - description: Id - type: string - required: - - action - BGPPeerQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of BGP peers that match the query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of BGP peers deleted for a time frame. + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' - type: boolean - group_by: - description: 'Group the BGP peers for the query. - - ' - items: - description: Group By - type: string - type: array - id: - description: "Lists the BGP peers by ID. \n" type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. - - ' - format: int64 - type: integer - limit: - description: 'The query limit. - - ' - format: int32 - type: integer - next_query: - description: 'The limit. - - ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. - - ' - items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. - - ' - format: int64 - type: integer - BGPPeerQueryFilterV2N1: + required: + - allow_v6_prefixes + - allow_v4_prefixes + - remote_as_num + - name + BGPPeerConfigV2N3: properties: bgp_config: $ref: '#/components/schemas/BGPConfig' @@ -879,11 +854,11 @@ components: ' type: string + router_id: + description: "The IP address of the ION device. \n" + type: string scope: - description: "The scope of the static route = Local or Global. If scope\ - \ is local, the device does not advertise the route to other sites and\ - \ if scope is global, the device advertises the route to other sites.\ - \ \n" + description: '' enum: - GLOBAL - LOCAL @@ -903,14 +878,26 @@ components: update_source: description: 'The Update Source IP address. + ' + type: string + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + ' type: string required: - remote_as_num - - peer_ip - name - BGPPeerQueryFilterV2N2: + BGPPeerConfigV2N4: properties: + allow_v4_prefixes: + description: 'Allow v4 prefixes. + + ' + type: boolean + allow_v6_prefixes: + description: "Allow v6 prefixes. \n" + type: boolean bgp_config: $ref: '#/components/schemas/BGPConfig' description: 'The details of the BGP config. @@ -929,7 +916,12 @@ components: ' type: string peer_ip: - description: "The peer IP address. \n" + description: 'The peer IP address. + + ' + type: string + peer_ip_v6: + description: "The peer IPv6 address. \n" type: string peer_type: description: 'The peer type = Classic. The Peer Type option is available @@ -952,11 +944,15 @@ components: ' type: string + router_id: + description: "The IP address of the ION device. \n" + type: string scope: - description: "The scope of the static route = Local or Global. If scope\ - \ is local, the device does not advertise the route to other sites and\ - \ if scope is global, the device advertises the route to other sites.\ - \ \n" + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' enum: - GLOBAL - LOCAL @@ -976,23 +972,34 @@ components: update_source: description: 'The Update Source IP address. + ' + type: string + update_source_v6: + description: 'The Update Source IPv6 address. + + ' + type: string + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + ' type: string required: + - allow_v6_prefixes + - allow_v4_prefixes - remote_as_num - - peer_ip - name - BGPPeerReachablePrefixes: + BGPPeerDiscoveredPrefixes: properties: - filtered_ipv4_prefixes: - description: 'The filtered IPv4 prefixes for the BGP peer. + discovered_ipv4_prefixes: + description: 'The discovered IPv4 prefixes for the BGP peer. ' items: $ref: '#/components/schemas/PrefixInfo' type: array - filtered_ipv4_prefixes_count: - description: 'The filtered IPv4 prefixes count for the BGP peer. + discovered_ipv4_prefixes_count: + description: 'The discovered IPv4 prefixes count for the BGP peer. ' format: int32 @@ -1002,749 +1009,894 @@ components: ' type: string - reachable_ipv4_prefixes: - description: 'The reachable IPv4 prefixes for the BGP peer. + BGPPeerDiscoveredPrefixesV2N1: + properties: + discovered_ipv4_prefixes: + description: 'The discovered IPv4 prefixes for the BGP peer. ' items: $ref: '#/components/schemas/PrefixInfo' type: array - reachable_ipv4_prefixes_count: - description: 'The reachable IPv4 prefixes count for the BGP peer. + discovered_ipv4_prefixes_count: + description: 'The discovered IPv4 prefixes count for the BGP peer. ' format: int32 type: integer - BGPPeerStatus: - properties: - downtime: - description: 'The downtime configured for the BGP peer. - - ' - type: string id: description: 'The ID of the BGP peer. ' type: string - state: - description: 'The state of the BGP peer. + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' type: string - uptime: - description: 'The uptime configured for the BGP peer. + BGPPeerDiscoveredPrefixesV2N2: + properties: + discovered_ipv4_prefixes: + description: 'The discovered IPv4 prefixes for the BGP peer. ' - type: string - BGPPeerStatusV2N1: - properties: - direction: - description: "The direction for the BGP peer. \n" - type: string - downtime: - description: 'The downtime configured for the BGP peer. + items: + $ref: '#/components/schemas/PrefixInfo' + type: array + discovered_ipv4_prefixes_count: + description: 'The discovered IPv4 prefixes count for the BGP peer. ' - type: string + format: int32 + type: integer + discovered_ipv6_prefixes: + description: 'The discovered IPv6 prefixes for the BGP peer. + + ' + items: + $ref: '#/components/schemas/PrefixInfo' + type: array + discovered_ipv6_prefixes_count: + description: 'The discovered IPv6 prefixes count for the BGP peer. + + ' + format: int32 + type: integer id: description: 'The ID of the BGP peer. ' type: string - state: - description: 'The state of the BGP peer. + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' type: string - uptime: - description: 'The uptime configured for the BGP peer. + BGPPeerOperations: + properties: + action: + description: 'The BGP peer actions. ' + enum: + - HARD_RESET + - SOFT_RESET + - REVERT_AUTOGENERATED + - REFRESH_STATUS type: string - Direction: {} - EnterprisePrefixSetN: - properties: id: - description: 'The ID of the tenant enterprise prefix set. + description: 'The ID of the BGP peer. ' type: string - ipv4_enterprise_prefixes: - description: 'The IPv4 configuration of the tenant enterprise prefix. + required: + - action + BGPPeerQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of BGP peers that match the query parameters. ' - items: - description: Ipv4 Enterprise Prefixes - type: string - type: array - EnterprisePrefixSetNV2N1: - properties: - id: - description: 'The ID of the tenant enterprise prefix set. + dest_page: + description: 'The destination page. ' - type: string - ipv4_enterprise_prefixes: - description: 'The IPv4 configuration of the tenant enterprise prefix. + format: int32 + type: integer + getDeleted: + description: 'The number of BGP peers deleted for a time frame. ' - items: - description: Ipv4 Enterprise Prefixes - type: string - type: array - ipv6_enterprise_prefixes: - description: 'The IPv6 configuration of the tenant enterprise prefix. + type: boolean + group_by: + description: 'Group the BGP peers for the query. ' items: - description: Ipv6 Enterprise Prefixes + description: Group By type: string type: array - Error: - properties: - _error: - items: - $ref: '#/components/schemas/ErrorResponse' - type: array - ErrorResponse: - properties: - code: - type: string - message: + id: + description: "Lists the BGP peers by ID. \n" type: string - ListQueryResponse: - properties: - count: - description: 'The count of the query list. + last_query_ts: + description: 'Return the ID of a specified query in the current session. ' - format: int32 + format: int64 type: integer - deleted_count: - description: 'The deleted number of queries. + limit: + description: 'The query limit. ' - format: int64 + format: int32 type: integer - deleted_ids: - description: 'The deleted query IDs. + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' items: + description: Retrieved Fields type: string type: array - description: - description: 'Description of the query. Max size = 256. - - ' - id: - description: 'The ID. - - ' - type: string - next_query: - description: 'Details of the next query. + retrieved_fields_mask: + description: 'List the fields to query. ' + type: boolean + sort_params: type: object total_count: - description: 'Total number of queries. + description: 'The total number of query parameters. ' format: int64 type: integer - type: object - ListResponse: + BGPPeerQueryFilterV2N2: properties: - count: - description: 'The number of responses. + bgp_config: + $ref: '#/components/schemas/BGPConfig' + description: 'The details of the BGP config. ' - format: int32 - type: integer + description: + description: "The description of the BGP peer config. Max size = 1024. \n" id: - description: 'The ID of the response. + description: 'The ID of the BGP peer config. ' type: string - type: object - LocalNetwork: - properties: - prefix_set: - description: 'Prefix Set: Valid ' - items: - $ref: '#/components/schemas/Network' - type: array - prefix_set_v6: - description: 'Prefix Set V6: Valid ' - items: - $ref: '#/components/schemas/NetworkV6' - type: array - security_policies: - description: 'Security Policies: Valid ' - items: - $ref: '#/components/schemas/SecurityPolicy' - type: array - vlan_id: - description: 'Vlan Id: Min(message = min, value = 0L) Max(message = max, - value = 4095L) ' - format: int32 - type: integer - LocalPrefixSet: - properties: - local_networks: - description: 'Local Networks: Valid ' - items: - $ref: '#/components/schemas/LocalNetwork' - type: array - MatchClauses: - properties: - as_path_id: - description: 'The AS path ID. + name: + description: 'The name of the BGP peer config. Max size = 128. ' type: string - community_list_id: - description: "The community list ID. \n" + peer_ip: + description: "The peer IP address. \n" type: string - ip_next_hop_id: - description: 'The IP next-hop ID. + peer_type: + description: 'The peer type = Classic. The Peer Type option is available + only for data center ION devices. ' type: string - ip_prefix_list_id: - description: 'The IP prefix list ID. + remote_as_num: + description: 'The remote AS number. ' type: string - tag: - description: 'A information field that can be added to identify the match - clause. + route_map_in_id: + description: 'The ID of the Route Map In to filter incoming routes. ' - format: int32 - type: integer - Network: - properties: - gateway: - description: 'The network gateway. + type: string + route_map_out_id: + description: 'The ID of the Route Map Out to filter outgoing routes. ' type: string - ipv4_prefix: - description: 'The IPv4 address prefix. + scope: + description: "The scope of the static route = Local or Global. If scope\ + \ is local, the device does not advertise the route to other sites and\ + \ if scope is global, the device advertises the route to other sites.\ + \ \n" + enum: + - GLOBAL + - LOCAL + type: string + shutdown: + description: Shutdown + type: boolean + tags: + description: 'A information field that can be added to identify the BGP + peer. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + update_source: + description: 'The Update Source IP address. ' type: string - NetworkV6: + required: + - remote_as_num + - name + BGPPeerQueryFilterV2N3: properties: - gateway: - description: 'The network gateway. + bgp_config: + $ref: '#/components/schemas/BGPConfig' + description: 'The details of the BGP config. ' - type: string - ipv6_prefix: - description: 'The IPv6 address prefix. + description: + description: "The description of the BGP peer config. Max size = 1024. \n" + id: + description: 'The ID of the BGP peer config. ' type: string - NextHop: - properties: - admin_distance: - description: 'The admin distance for a specific route. The default value - for admin distance is 1. + name: + description: 'The name of the BGP peer config. Max size = 128. ' - type: integer - nexthop_interface_id: - description: 'The next hop interface ID. + type: string + peer_ip: + description: "The peer IP address. \n" + type: string + peer_type: + description: 'The peer type = Classic. The Peer Type option is available + only for data center ION devices. ' type: string - nexthop_ip: - description: "The next hop IPv4 address. \n" + remote_as_num: + description: 'The remote AS number. + + ' type: string - self: - description: "Set to True to indicate that traffic is destined for the ION\ - \ device. By default, Self is set to False. \n" + route_map_in_id: + description: 'The ID of the Route Map In to filter incoming routes. + + ' + type: string + route_map_out_id: + description: 'The ID of the Route Map Out to filter outgoing routes. + + ' + type: string + router_id: + description: 'Router Id: Size(max = 256, ROUTER_ID_EXCEEDS_LIMIT, min = + 0) IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, + bcast = DENY, defaultRoute = false, dnsCheck = false, BGP_CONFIG_INVALID_ROUTER_ID, + type = IP) ' + type: string + scope: + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' + enum: + - GLOBAL + - LOCAL + type: string + shutdown: + description: Shutdown type: boolean - PrefixInfo: - properties: - as_path: - description: 'The AS path of the IPv4 prefix. + tags: + description: 'A information field that can be added to identify the BGP + peer. Maximum 10 unique tags of length 1024 each are allowed. ' items: - description: As Path - format: int64 - type: integer + description: Tags + type: string type: array - network: - description: 'The network of the IPv4 prefix. + update_source: + description: 'The Update Source IP address. ' type: string - nexthop: - description: 'The next-hop of the IPv4 prefix. + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' type: string - PrefixQueryFilterV3: + required: + - remote_as_num + - name + BGPPeerQueryFilterV2N4: properties: - element_id: - description: 'The element ID. + allow_v4_prefixes: + description: 'Allow v4 prefixes. + + ' + type: boolean + allow_v6_prefixes: + description: "Allow v6 prefixes. \n" + type: boolean + bgp_config: + $ref: '#/components/schemas/BGPConfig' + description: 'The details of the BGP config. + + ' + description: + description: "The description of the BGP peer config. Max size = 1024. \n" + id: + description: 'The ID of the BGP peer config. ' type: string - ipv4_prefix: - description: 'The IPv4 address prefix. + name: + description: 'The name of the BGP peer config. Max size = 128. ' type: string - resource_id: - description: 'The resource ID. + peer_ip: + description: 'The peer IP address. ' type: string - resource_type: - description: 'The resource type. + peer_ip_v6: + description: "The peer IPv6 address. \n" + type: string + peer_type: + description: 'The peer type = Classic. The Peer Type option is available + only for data center ION devices. ' - enum: - - static_route - - interface - - lan_network - - BGP type: string - scope: - description: "The prefix scope. \n" - enum: - - GLOBAL - - LOCAL + remote_as_num: + description: 'The remote AS number. + + ' type: string - site_id: - description: 'The site ID. + route_map_in_id: + description: 'The ID of the Route Map In to filter incoming routes. ' type: string - required: - - site_id - PrefixQueryV3: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of prefix sets that match the query parameters. + route_map_out_id: + description: 'The ID of the Route Map Out to filter outgoing routes. ' - dest_page: - description: 'The destination page. + type: string + router_id: + description: 'The ID of the Route. ' - format: int32 - type: integer - ge: - type: integer - getDeleted: - description: 'The number prefix sets deleted for a time frame. + type: string + scope: + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. ' + enum: + - GLOBAL + - LOCAL + type: string + shutdown: + description: Shutdown type: boolean - group_by: - description: 'Group the prefix sets for the query. + tags: + description: 'A information field that can be added to identify the BGP + peer. Maximum 10 unique tags of length 1024 each are allowed. ' items: - description: Group By + description: Tags type: string type: array - id: - description: "List the prefix sets by ID. \n" + update_source: + description: 'The Update Source IP address. + + ' type: string - ipv4_prefix: - description: Ipv4 Prefix + update_source_v6: + description: 'The Update Source IPv6 address. + + ' type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' - format: int64 - type: integer - le: - type: integer - limit: - description: 'The query limit. + type: string + required: + - allow_v6_prefixes + - allow_v4_prefixes + - remote_as_num + - name + BGPPeerReachablePrefixes: + properties: + filtered_ipv4_prefixes: + description: 'The filtered IPv4 prefixes for the BGP peer. ' - format: int32 - type: integer - next_query: - description: 'The limit. + items: + $ref: '#/components/schemas/PrefixInfo' + type: array + filtered_ipv4_prefixes_count: + description: 'The filtered IPv4 prefixes count for the BGP peer. ' - type: object - query_params: - description: 'Query using query parameters. + format: int32 + type: integer + id: + description: 'The ID of the BGP peer. ' - type: object - retrieved_fields: - description: 'Retrieve information from a field. + type: string + reachable_ipv4_prefixes: + description: 'The reachable IPv4 prefixes for the BGP peer. ' items: - description: Retrieved Fields - type: string + $ref: '#/components/schemas/PrefixInfo' type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' - type: boolean - sort_params: - description: 'Specify the order in which you want the search criteria to - display. + reachable_ipv4_prefixes_count: + description: 'The reachable IPv4 prefixes count for the BGP peer. ' - type: object - total_count: - description: "The total number of query parameters. \n" - format: int64 + format: int32 type: integer - PrefixSet: + BGPPeerReachablePrefixesV2N1: properties: - ipv4_set: - description: 'The set of The IPv4 addresses. + filtered_ipv4_prefixes: + description: 'The filtered IPv4 prefixes for the BGP peer. ' items: - description: Ipv4 Set - type: string + $ref: '#/components/schemas/PrefixInfo' type: array - ipv6_set: - description: 'The set of The IPv4 addresses. + filtered_ipv4_prefixes_count: + description: 'The filtered IPv4 prefixes count for the BGP peer. ' - items: - description: Ipv6 Set - type: string - type: array - RoutingAccessList: - properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + format: int32 + type: integer + filtered_ipv6_prefixes: + description: 'The filtered IPv6 prefixes for the BGP peer. ' items: - $ref: '#/components/schemas/ASPathRegex' + $ref: '#/components/schemas/PrefixInfo' type: array - auto_generated: - description: "The value true or false for auto-generated access lists. \n" - type: boolean - description: - description: 'The description of the access list. Max size = 1024. + filtered_ipv6_prefixes_count: + description: "The filtered IPv6 prefixes count for the BGP peer. \n" + format: int32 + type: integer + id: + description: 'The ID of the BGP peer. ' - id: - description: "The ID of the access list. \n" type: string - name: - description: 'The name of the access list. Max size = 128. + reachable_ipv4_prefixes: + description: 'The reachable IPv4 prefixes for the BGP peer. ' - type: string - tags: - description: 'A information field that can be added to identify the access - list. Maximum 10 unique tags of length 1024 each are allowed. + items: + $ref: '#/components/schemas/PrefixInfo' + type: array + reachable_ipv4_prefixes_count: + description: "The reachable IPv4 prefixes count for the BGP peer. \n" + format: int32 + type: integer + reachable_ipv6_prefixes: + description: 'The reachable IPv6 prefixes for the BGP peer. ' items: - description: Tags - type: string + $ref: '#/components/schemas/PrefixInfo' type: array - required: - - name - RoutingAccessListQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of access/prefix lists that match the - query parameters. - - ' - dest_page: - description: 'The destination page. + reachable_ipv6_prefixes_count: + description: 'The reachable IPv6 prefixes count for the BGP peer. ' format: int32 type: integer - getDeleted: - description: 'The number of access/prefix lists deleted for a time frame. + BGPPeerStatusV2N1: + properties: + direction: + description: "The direction for the BGP peer. \n" + type: string + downtime: + description: 'The downtime configured for the BGP peer. ' - type: boolean - group_by: - description: 'Group the access/prefix lists for the query. + type: string + id: + description: 'The ID of the BGP peer. ' - items: - description: Group By - type: string - type: array - id: - description: "Lists the access/prefix lists by ID. \n" type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + state: + description: 'The state of the BGP peer. ' - format: int64 - type: integer - limit: - description: 'The query limit. + type: string + uptime: + description: 'The uptime configured for the BGP peer. ' - format: int32 - type: integer - next_query: - description: 'The limit. + type: string + BGPPeerStatusV2N2: + properties: + direction: + description: 'The direction for the BGP peer. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + type: string + downtime: + description: 'The downtime configured for the BGP peer. ' - items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. + type: string + id: + description: 'The ID of the BGP peer. ' - type: boolean - sort_params: - type: object - total_count: - description: "The total number of query parameters. \n" - format: int64 - type: integer - RoutingAccessListQueryFilter: - properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + type: string + state: + description: 'The state of the BGP peer. ' - items: - $ref: '#/components/schemas/ASPathRegex' - type: array - auto_generated: - description: "The value true or false for auto-generated access lists. \n" + type: string + uptime: + description: 'The uptime configured for the BGP peer. + + ' + type: string + v4_capability_negotiated: + description: "The v4 negotiated capability. \n" type: boolean - description: - description: 'The description of the access list. Max size = 1024. + v6_capability_negotiated: + description: 'The v6 negotiated capability. ' + type: boolean + Direction: {} + EnterprisePrefixSetN: + properties: id: - description: "The peer IP address. \n" - type: string - name: - description: 'The name of the access list. Max size = 128. + description: 'The ID of the tenant enterprise prefix set. ' type: string - tags: - description: 'A information field that can be added to identify the access - list. Maximum 10 unique tags of length 1024 each are allowed. + ipv4_enterprise_prefixes: + description: 'The IPv4 configuration of the tenant enterprise prefix. ' items: - description: Tags + description: Ipv4 Enterprise Prefixes type: string type: array - required: - - name - RoutingAccessListQueryFilterV2N1: + EnterprisePrefixSetNV2N1: properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. - - ' - items: - $ref: '#/components/schemas/ASPathRegex' - type: array - auto_generated: - description: "The value true or false for auto-generated access lists. \n" - type: boolean - description: - description: 'The description of the access list. Max size = 1024. + id: + description: 'The ID of the tenant enterprise prefix set. ' - id: - description: "The ID of the access list. \n" type: string - name: - description: 'The name of the access list. Max size = 128. + ipv4_enterprise_prefixes: + description: 'The IPv4 configuration of the tenant enterprise prefix. ' - type: string - tags: - description: 'A information field that can be added to identify the access - list. Maximum 10 unique tags of length 1024 each are allowed. + items: + description: Ipv4 Enterprise Prefixes + type: string + type: array + ipv6_enterprise_prefixes: + description: 'The IPv6 configuration of the tenant enterprise prefix. ' items: - description: Tags + description: Ipv6 Enterprise Prefixes type: string type: array - required: - - name - RoutingAccessListScreen: + Error: properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + type: string + message: + type: string + ListQueryResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + deleted_count: + description: 'The deleted number. + + ' + format: int64 + type: integer + deleted_ids: + description: 'The deleted IDs. ' items: - $ref: '#/components/schemas/ASPathRegex' + type: string type: array - auto_generated: - description: "The value true or false for auto-generated access/community\ - \ lists. \n" - type: boolean description: - description: 'The description of the access/community list. Max size = 1024. + description: 'Description of the query. Max size = 256. ' id: - description: "The ID of the access/community list. \n" - type: string - name: - description: 'The name of the access/community list. Max size = 128. + description: 'The ID. ' type: string - tags: - description: 'A information field that can be added to identify the access/community - list. Maximum 10 unique tags of length 1024 each are allowed. + next_query: + description: 'Details of the next query. ' - items: - description: Tags - type: string - type: array - required: - - name - RoutingAccessListScreenV2N1: - properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + type: object + total_count: + description: 'Total number. ' - items: - $ref: '#/components/schemas/ASPathRegex' - type: array - auto_generated: - description: "The value true or false for auto-generated access lists. \n" - type: boolean - description: - description: 'The description of the access list. Max size = 1024. + format: int64 + type: integer + type: object + ListResponse: + properties: + count: + description: 'The actual count. ' + format: int32 + type: integer id: - description: "The ID of the access list. \n" - type: string - name: - description: 'The name of the access list. Max size = 128. + description: 'The ID. ' type: string - tags: - description: "A information field that can be added to identify the access\ - \ list. Maximum 10 unique tags of length 1024 each are allowed. \n" - items: - description: Tags - type: string - type: array - required: - - name - RoutingAccessListV2N1: + type: object + LocalNetwork: properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + prefix_set: + description: 'The valid local prefix set for the site. ' items: - $ref: '#/components/schemas/ASPathRegex' + $ref: '#/components/schemas/Network' type: array - auto_generated: - description: "The value true or false for auto-generated access lists. \n" - type: boolean - description: - description: 'The description of the access list. Max size = 1024. + prefix_set_v6: + description: 'The v6 prefix set for the site. ' - id: - description: "The ID of the access list. \n" - type: string - name: - description: 'The name of the access list. Max size = 128. + items: + $ref: '#/components/schemas/NetworkV6' + type: array + security_policies: + description: 'The details of the security policy. + + ' + items: + $ref: '#/components/schemas/SecurityPolicy' + type: array + vlan_id: + description: "The vlan ID. \n" + format: int32 + type: integer + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. ' type: string - tags: - description: 'A information field that can be added to identify the access - list. Maximum 10 unique tags of length 1024 each are allowed. + LocalPrefixSet: + properties: + local_networks: + description: 'The details of the local networks prefix sets. ' items: - description: Tags - type: string + $ref: '#/components/schemas/LocalNetwork' type: array - required: - - name - RoutingCommunityList: + MatchClauses: properties: - auto_generated: - description: 'The value true or false for auto-generated IP community lists. + as_path_id: + description: 'The AS path ID. + + ' + type: string + community_list_id: + description: "The community list ID. \n" + type: string + ip_next_hop_id: + description: 'The IP next-hop ID. + + ' + type: string + ip_prefix_list_id: + description: 'The IP prefix list ID. + + ' + type: string + tag: + description: 'A information field that can be added to identify the match + clause. + + ' + format: int32 + type: integer + Network: + properties: + gateway: + description: 'The network gateway. + + ' + type: string + ipv4_prefix: + description: 'The IPv4 address prefix. + + ' + type: string + NetworkV6: + properties: + gateway: + description: 'The network gateway. ' + type: string + ipv6_prefix: + description: 'The IPv6 address prefix. + + ' + type: string + NextHop: + properties: + admin_distance: + description: 'The admin distance for a specific route. The default value + for admin distance is 1. + + ' + type: integer + nexthop_interface_id: + description: 'The next hop interface ID. + + ' + type: string + nexthop_ip: + description: "The next hop IPv4 address. \n" + type: string + self: + description: "Set to True to indicate that traffic is destined for the ION\ + \ device. By default, Self is set to False. \n" type: boolean - community_list: - description: "The details of the IP community lists. \n" + PrefixInfo: + properties: + as_path: + description: 'The AS path of the IPv4/IPv6 prefix. + + ' items: - $ref: '#/components/schemas/RoutingIPCommunity' + description: As Path + format: int64 + type: integer type: array - description: - description: 'The description of the IP community list. Max size = 1024. + network: + description: 'The network of the IPv4/IPv6 prefix. ' - id: - description: "The ID of the IP community list. \n" type: string - name: - description: 'The name of the IP community list. Max size = 128. + nexthop: + description: 'The next-hop of the IPv4/IPv6 prefix. + + ' + type: string + PrefixQueryFilterV3: + properties: + element_id: + description: 'The element ID. + + ' + type: string + ipv4_prefix: + description: 'The IPv4 address prefix. + + ' + type: string + resource_id: + description: 'The resource ID. + + ' + type: string + resource_type: + description: 'The resource type. + + ' + enum: + - static_route + - interface + - lan_network + - BGP + type: string + scope: + description: "The prefix scope. \n" + enum: + - GLOBAL + - LOCAL + type: string + site_id: + description: 'The site ID. ' type: string - tags: - description: "A information field that can be added to identify the IP community\ - \ list. Maximum 10 unique tags of length 1024 each are allowed. \n" - items: - description: Tags - type: string - type: array required: - - name - RoutingCommunityListQuery: + - site_id + PrefixQueryFilterV3N1: + properties: + element_id: + description: 'The element ID. + + ' + type: string + ipv4_prefix: + description: 'The IPv4 address prefix. + + ' + type: string + ipv6_prefix: + description: 'The IPv6 address prefix. + + ' + type: string + resource_id: + description: 'The resource ID. + + ' + type: string + resource_type: + description: 'The resource type. + + ' + enum: + - static_route + - interface + - lan_network + - BGP + type: string + scope: + description: "The prefix scope. \n" + enum: + - GLOBAL + - LOCAL + type: string + site_id: + description: 'The site ID. + + ' + type: string + required: + - site_id + PrefixQueryV3: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of community lists that match the query - parameters. + description: 'The aggregate number of prefix sets that match the query parameters. ' dest_page: @@ -1753,13 +1905,15 @@ components: ' format: int32 type: integer + ge: + type: integer getDeleted: - description: 'The number of community lists deleted for a time frame. + description: 'The number prefix sets deleted for a time frame. ' type: boolean group_by: - description: 'Group the community lists for the query. + description: 'Group the prefix sets for the query. ' items: @@ -1767,7 +1921,10 @@ components: type: string type: array id: - description: "Lists the community lists by ID. \n" + description: "List the prefix sets by ID. \n" + type: string + ipv4_prefix: + description: Ipv4 Prefix type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -1775,6 +1932,8 @@ components: ' format: int64 type: integer + le: + type: integer limit: description: 'The query limit. @@ -1787,6 +1946,9 @@ components: ' type: object query_params: + description: 'Query using query parameters. + + ' type: object retrieved_fields: description: 'Retrieve information from a field. @@ -1802,6 +1964,10 @@ components: ' type: boolean sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' type: object total_count: description: 'The total number of query parameters. @@ -1809,67 +1975,134 @@ components: ' format: int64 type: integer - RoutingCommunityListQueryFilter: + PrefixQueryV3N1: properties: - auto_generated: - description: 'The value true or false for auto-generated IP community lists. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of prefix sets that match the query parameters. ' - type: boolean - community_list: - description: "The details of the IP community lists. \n" - items: - $ref: '#/components/schemas/RoutingIPCommunity' - type: array - description: - description: 'The description of the IP community list. Max size = 1024. + dest_page: + description: 'The destination page. ' - id: - description: "The ID of the IP community list. \n" - type: string - name: - description: 'The name of the IP community list. Max size = 128. + format: int32 + type: integer + ge: + type: integer + getDeleted: + description: 'The number prefix sets deleted for a time frame. ' - type: string - tags: - description: 'A information field that can be added to identify the IP community - list. Maximum 10 unique tags of length 1024 each are allowed. - + type: boolean + group_by: + description: 'Group the prefix sets for the query. + ' items: - description: Tags + description: Group By type: string type: array - required: - - name - RoutingCommunityListScreen: - properties: - auto_generated: - description: 'The value true or false for auto-generated IP community lists. + id: + description: "List the prefix sets by ID. \n" + type: string + ipv4_prefix: + description: Ipv4 Prefix + type: string + ipv6_prefix: + description: Ipv6 Prefix + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + le: + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + description: 'Query using query parameters. + + ' + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. ' type: boolean - community_list: - description: "The details of the IP community lists. \n" + sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' + type: object + total_count: + description: "The total number of query parameters. \n" + format: int64 + type: integer + PrefixSet: + properties: + ipv4_set: + description: 'The set of The IPv4 addresses. + + ' items: - $ref: '#/components/schemas/RoutingIPCommunity' + description: Ipv4 Set + type: string + type: array + ipv6_set: + description: 'The set of The IPv6 addresses. + + ' + items: + description: Ipv6 Set + type: string + type: array + RoutingAccessList: + properties: + as_path_regex_list: + description: 'The AS Path Regex expression list. + + ' + items: + $ref: '#/components/schemas/ASPathRegex' type: array + auto_generated: + description: "The value true or false for auto-generated access lists. \n" + type: boolean description: - description: 'The description of the IP community list. Max size = 1024. + description: 'The description of the access list. Max size = 1024. ' id: - description: "The ID of the IP community list. \n" + description: "The ID of the access list. \n" type: string name: - description: 'The name of the IP community list. Max size = 128. + description: 'The name of the access list. Max size = 128. ' type: string tags: - description: 'A information field that can be added to identify the IP community + description: 'A information field that can be added to identify the access list. Maximum 10 unique tags of length 1024 each are allowed. ' @@ -1879,79 +2112,101 @@ components: type: array required: - name - RoutingIPCommunity: + RoutingAccessListQuery: properties: - community_str: - description: 'The community string. Max size = 256. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of access/prefix lists that match the + query parameters. ' - type: string - permit: - description: "The permit of the IP community sctring = Permit or Deny. \n" - type: boolean - required: - - community_str - RoutingPrefixFilter: - properties: - ge: - description: 'The prefix filter value for ge operator should be within the - range 1-32. + dest_page: + description: 'The destination page. ' format: int32 type: integer - le: - description: "The prefix filter value for le operator should be within the\ - \ range 1-32. \n" - format: int32 + getDeleted: + description: 'The number of access/prefix lists deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the access/prefix lists for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "Lists the access/prefix lists by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 type: integer - order: - description: 'The order of the prefix filter. + limit: + description: 'The query limit. ' format: int32 type: integer - permit: - description: 'The permit of the IP community sctring = Permit or Deny. + next_query: + description: 'The limit. ' - type: boolean - prefix: - description: 'The valid prefix filters. + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' - type: string - required: - - prefix - RoutingPrefixList: + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: "The total number of query parameters. \n" + format: int64 + type: integer + RoutingAccessListQueryFilter: properties: - auto_generated: - description: 'The value true or false for auto-generated prefix list for - an element. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' + items: + $ref: '#/components/schemas/ASPathRegex' + type: array + auto_generated: + description: "The value true or false for auto-generated access lists. \n" type: boolean description: - description: 'The description of the prefix filter list. Max size = 1024. + description: 'The description of the access list. Max size = 1024. ' id: - description: "The ID of the prefix filter list. \n" + description: "The peer IP address. \n" type: string name: - description: 'The name of the prefix filter list. Max size = 128. + description: 'The name of the access list. Max size = 128. ' type: string - prefix_filter_list: - description: "The details of the prefix filter list used to filter routes.\ - \ \n" - items: - $ref: '#/components/schemas/RoutingPrefixFilter' - type: array tags: - description: 'A information field that can be added to identify the prefix - filter list. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the access + list. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -1960,35 +2215,33 @@ components: type: array required: - name - RoutingPrefixListQueryFilter: + RoutingAccessListQueryFilterV2N1: properties: - auto_generated: - description: 'The value true or false for auto-generated prefix list for - an element. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' + items: + $ref: '#/components/schemas/ASPathRegex' + type: array + auto_generated: + description: "The value true or false for auto-generated access lists. \n" type: boolean description: - description: 'The description of the prefix filter list. Max size = 1024. + description: 'The description of the access list. Max size = 1024. ' id: - description: "The ID of the prefix list. \n" + description: "The ID of the access list. \n" type: string name: - description: 'The name of the prefix filter list. Max size = 128. + description: 'The name of the access list. Max size = 128. ' type: string - prefix_filter_list: - description: "The details of the prefix filter list used to filter routes.\ - \ \n" - items: - $ref: '#/components/schemas/RoutingPrefixFilter' - type: array tags: - description: 'A information field that can be added to identify the prefix - filter list. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the access + list. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -1997,35 +2250,34 @@ components: type: array required: - name - RoutingPrefixListScreen: + RoutingAccessListScreen: properties: - auto_generated: - description: 'The value true or false for auto-generated prefix list for - an element. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' + items: + $ref: '#/components/schemas/ASPathRegex' + type: array + auto_generated: + description: "The value true or false for auto-generated access/community\ + \ lists. \n" type: boolean description: - description: 'The description of the prefix filter list. Max size = 1024. + description: 'The description of the access/community list. Max size = 1024. ' id: - description: "The ID of the prefix filter list. \n" + description: "The ID of the access/community list. \n" type: string name: - description: 'The name of the prefix filter list. Max size = 128. + description: 'The name of the access/community list. Max size = 128. ' type: string - prefix_filter_list: - description: "The details of the prefix filter list used to filter routes.\ - \ \n" - items: - $ref: '#/components/schemas/RoutingPrefixFilter' - type: array tags: - description: 'A information field that can be added to identify the prefix - filter list. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the access/community + list. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -2034,103 +2286,113 @@ components: type: array required: - name - RoutingRouteMap: + RoutingAccessListScreenV2N1: properties: - auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' + items: + $ref: '#/components/schemas/ASPathRegex' + type: array + auto_generated: + description: "The value true or false for auto-generated access lists. \n" type: boolean description: - description: 'The description of the route map. Max size = 1024. + description: 'The description of the access list. Max size = 1024. ' id: - description: "The ID of the route map. \n" + description: "The ID of the access list. \n" type: string name: - description: 'The name of the route map. Max size = 128. + description: 'The name of the access list. Max size = 128. ' type: string - route_map_entries: - description: "The details of the route map entries. \n" - items: - $ref: '#/components/schemas/RoutingRouteMapEntry' - type: array tags: - description: 'A information field that can be added to identify the route - map. Maximum 10 unique tags of length 1024 each are allowed. - - ' + description: "A information field that can be added to identify the access\ + \ list. Maximum 10 unique tags of length 1024 each are allowed. \n" items: description: Tags type: string type: array required: - name - RoutingRouteMapEntry: + RoutingAccessListV2N1: properties: - continue_entry: - description: 'To continue to use the rule that the route matches. - - ' - type: string - match: - $ref: '#/components/schemas/MatchClauses' - description: "The details of route match. \n" - order: - description: 'Enter an order number from 1 to 65535 to define the order - in which this route map will be used. - - ' - format: int32 - type: integer - permit: - description: 'It allow routes to be advertised or Deny to block the routes - from being advertised. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' + items: + $ref: '#/components/schemas/ASPathRegex' + type: array + auto_generated: + description: "The value true or false for auto-generated access lists. \n" type: boolean - set: - $ref: '#/components/schemas/SetClauses' - description: 'The details of the route map set. + description: + description: 'The description of the access list. Max size = 1024. ' - RoutingRouteMapEntryV2N1: - properties: - continue_entry: - description: 'To continue to use the rule that the route matches. + id: + description: "The ID of the access list. \n" + type: string + name: + description: 'The name of the access list. Max size = 128. ' type: string - match: - $ref: '#/components/schemas/MatchClauses' - description: "The details of route match. \n" - order: - description: 'Enter an order number from 1 to 65535 to define the order - in which this route map will be used. + tags: + description: 'A information field that can be added to identify the access + list. Maximum 10 unique tags of length 1024 each are allowed. ' - format: int32 - type: integer - permit: - description: 'It allow routes to be advertised or Deny to block the routes - from being advertised. + items: + description: Tags + type: string + type: array + required: + - name + RoutingCommunityList: + properties: + auto_generated: + description: 'The value true or false for auto-generated IP community lists. ' type: boolean - set: - $ref: '#/components/schemas/SetClauses' - description: 'The details of the route map set. + community_list: + description: "The details of the IP community lists. \n" + items: + $ref: '#/components/schemas/RoutingIPCommunity' + type: array + description: + description: 'The description of the IP community list. Max size = 1024. ' - RoutingRouteMapQuery: + id: + description: "The ID of the IP community list. \n" + type: string + name: + description: 'The name of the IP community list. Max size = 128. + + ' + type: string + tags: + description: "A information field that can be added to identify the IP community\ + \ list. Maximum 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + RoutingCommunityListQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of route maps that match the query parameters. + description: 'The aggregate number of community lists that match the query + parameters. ' dest_page: @@ -2140,12 +2402,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of route maps deleted for a time frame. + description: 'The number of community lists deleted for a time frame. ' type: boolean group_by: - description: 'Group the route maps for the query. + description: 'Group the community lists for the query. ' items: @@ -2153,7 +2415,7 @@ components: type: string type: array id: - description: "Lists the route maps by ID. \n" + description: "Lists the community lists by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -2195,34 +2457,33 @@ components: ' format: int64 type: integer - RoutingRouteMapQueryFilter: + RoutingCommunityListQueryFilter: properties: auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + description: 'The value true or false for auto-generated IP community lists. ' type: boolean + community_list: + description: "The details of the IP community lists. \n" + items: + $ref: '#/components/schemas/RoutingIPCommunity' + type: array description: - description: 'The description of the route map. Max size = 1024. + description: 'The description of the IP community list. Max size = 1024. ' id: - description: "The ID of the route map. \n" + description: "The ID of the IP community list. \n" type: string name: - description: 'The name of the route map. Max size = 128. + description: 'The name of the IP community list. Max size = 128. ' type: string - route_map_entries: - description: "The details of the route map entries. \n" - items: - $ref: '#/components/schemas/RoutingRouteMapEntry' - type: array tags: - description: 'A information field that can be added to identify the route - map. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the IP community + list. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -2231,34 +2492,33 @@ components: type: array required: - name - RoutingRouteMapQueryFilterV2N1: + RoutingCommunityListScreen: properties: auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + description: 'The value true or false for auto-generated IP community lists. ' type: boolean + community_list: + description: "The details of the IP community lists. \n" + items: + $ref: '#/components/schemas/RoutingIPCommunity' + type: array description: - description: 'The description of the route map. Max size = 1024. + description: 'The description of the IP community list. Max size = 1024. ' id: - description: "The ID of the route map. \n" + description: "The ID of the IP community list. \n" type: string name: - description: 'The name of the route map. Max size = 128. + description: 'The name of the IP community list. Max size = 128. ' type: string - route_map_entries: - description: "The details of the route map entries. \n" - items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' - type: array tags: - description: 'A information field that can be added to identify the route - map. Maximum 10 unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the IP community + list. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -2267,373 +2527,2051 @@ components: type: array required: - name - RoutingRouteMapScreen: + RoutingIPCommunity: properties: - auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + community_str: + description: 'The community string. Max size = 256. ' + type: string + permit: + description: "The permit of the IP community sctring = Permit or Deny. \n" type: boolean - description: - description: 'The description of the route map. Max size = 1024. + required: + - community_str + RoutingPrefixFilter: + properties: + ge: + description: 'The prefix filter value for ge operator should be within the + range 1-32. ' - id: - description: "The ID of the route map. \n" - type: string - name: - description: 'The name of the route map. Max size = 128. + format: int32 + type: integer + ipv6_prefix: + description: 'The IPv6 address prefix. ' type: string - route_map_entries: - description: "The details of the route map entries. \n" - items: - $ref: '#/components/schemas/RoutingRouteMapEntry' - type: array - tags: - description: 'A information field that can be added to identify the route - map. Maximum 10 unique tags of length 1024 each are allowed. + le: + description: "The prefix filter value for le operator should be within the\ + \ range 1-32. \n" + format: int32 + type: integer + order: + description: 'The order of the prefix filter. ' - items: - description: Tags - type: string - type: array - required: - - name - RoutingRouteMapScreenV2N1: - properties: - auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + format: int32 + type: integer + permit: + description: 'The permit of the IP community sctring = Permit or Deny. ' type: boolean - description: - description: 'The description of the route map. Max size = 1024. + prefix: + description: 'The valid prefix filters. ' - id: - description: "The ID of the route map. \n" type: string - name: - description: 'The name of the route map. Max size = 128. + RoutingPrefixFilterV2N1: + properties: + ge: + description: 'The prefix filter value for ge operator should be within the + range 1-32. ' - type: string - route_map_entries: - description: "The details of the route map entries. \n" + format: int32 + type: integer + ipv6_prefix: + description: 'Ipv6 Prefix: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, IPV6_PREFIX_INVALID, type = GATEWAYCIDRV6) ' + type: string + le: + description: "The prefix filter value for le operator should be within the\ + \ range 1-32. \n" + format: int32 + type: integer + order: + description: 'The order of the prefix filter. + + ' + format: int32 + type: integer + permit: + description: 'The permit of the IP community sctring = Permit or Deny. + + ' + type: boolean + prefix: + description: 'The valid prefix filters. + + ' + type: string + RoutingPrefixList: + properties: + auto_generated: + description: 'The value true or false for auto-generated prefix list for + an element. + + ' + type: boolean + description: + description: 'The description of the prefix filter list. Max size = 1024. + + ' + id: + description: "The ID of the prefix filter list. \n" + type: string + name: + description: 'The name of the prefix filter list. Max size = 128. + + ' + type: string + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + $ref: '#/components/schemas/RoutingPrefixFilter' type: array tags: - description: "A information field that can be added to identify the route\ - \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. + + ' items: description: Tags type: string type: array required: - name - RoutingRouteMapV2N1: + RoutingPrefixListQueryFilter: properties: auto_generated: - description: 'The value true or false for auto-generated route map for an - element. + description: 'The value true or false for auto-generated prefix list for + an element. ' type: boolean description: - description: 'The description of the route map. Max size = 1024. + description: 'The description of the prefix filter list. Max size = 1024. ' id: - description: "The ID of the route map. \n" + description: "The ID of the prefix list. \n" type: string name: - description: 'The name of the route map. Max size = 128. + description: 'The name of the prefix filter list. Max size = 128. ' type: string - route_map_entries: - description: "The details of the route map entries. \n" + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + $ref: '#/components/schemas/RoutingPrefixFilter' type: array tags: - description: "A information field that can be added to identify the route\ - \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. + + ' items: description: Tags type: string type: array required: - name - SecurityPolicy: + RoutingPrefixListQueryFilterV2N1: properties: - action: - $ref: '#/components/schemas/Action' - description: 'The action to allow, deny, or reject traffic based on the - security intent of the enterprise. - - ' - app_ids: - description: 'The App IDs. - - ' - items: - description: App Ids - type: string - type: array - direction: - $ref: '#/components/schemas/Direction' - description: 'The direction of the traffic. + auto_generated: + description: 'The value true or false for auto-generated prefix list for + an element. ' - SetClauses: - properties: - as_path_prepend: - description: 'The AS path prepend. + type: boolean + description: + description: 'The description of the prefix filter list. Max size = 1024. ' + id: + description: "The ID of the prefix list. \n" type: string - community: - description: "The community. \n" - type: string - ip_next_hop: - description: Ip Next Hop - type: string - local_preference: - description: 'The local preference. - - ' - format: int64 - type: integer - tag: - description: 'A information field that can be added to identify the set - clause. + name: + description: 'The name of the prefix filter list. Max size = 128. ' - format: int32 - type: integer - weight: - description: 'The weight of the set clause. + type: string + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" + items: + $ref: '#/components/schemas/RoutingPrefixFilterV2N1' + type: array + tags: + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. ' - format: int64 - type: integer - StateNextHop: + items: + description: Tags + type: string + type: array + required: + - name + RoutingPrefixListScreen: properties: - nexthop_ip: - description: 'The IP address of the next hop. - - ' - type: string - reachability_status: - description: 'The reachability status. + auto_generated: + description: 'The value true or false for auto-generated prefix list for + an element. ' type: boolean - StaticRouteStatus: - properties: - id: - description: 'The ID of the static route. + description: + description: 'The description of the prefix filter list. Max size = 1024. ' + id: + description: "The ID of the prefix filter list. \n" type: string - nexthops: - description: 'The details of the next hop. + name: + description: 'The name of the prefix filter list. Max size = 128. ' + type: string + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" items: - $ref: '#/components/schemas/StateNextHop' + $ref: '#/components/schemas/RoutingPrefixFilter' type: array - required: - - nexthops - StaticRouteStatusV2N2: - properties: - id: - description: 'The ID of the static route. - - ' - type: string - nexthops: - description: 'The details of the next hop. + tags: + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. ' items: - $ref: '#/components/schemas/StateNextHop' + description: Tags + type: string type: array - StaticRouteV2N1: + required: + - name + RoutingPrefixListScreenV2N1: properties: - description: - description: 'The description of the static route. Max size = 256. + auto_generated: + description: 'The value true or false for auto-generated prefix list for + an element. ' - destination_prefix: - description: 'The IPv4 or IPv6 address mask for next hop Destination Prefix - (IPv4 or IPv6). + type: boolean + description: + description: 'The description of the prefix filter list. Max size = 1024. ' - type: string id: - description: 'The ID of the static route. - - ' + description: "The ID of the prefix filter list. \n" type: string name: - description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of - the resource exceeds limit., min = 0) ' - type: string - network_context_id: - description: 'The ID of the network context. + description: 'The name of the prefix filter list. Max size = 128. ' type: string - nexthop_reachability_probe: - description: Nexthop Reachability Probe - type: boolean - nexthops: - description: 'The details of the next hops configured on the static route. - - ' + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" items: - $ref: '#/components/schemas/NextHop' + $ref: '#/components/schemas/RoutingPrefixFilterV2N1' type: array - scope: - description: 'The scope of the static route = Local or Global. If scope - is local, the device does not advertise the route to other sites and if - scope is global, the device advertises the route to other sites. + tags: + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. ' - enum: - - GLOBAL - - LOCAL - type: string - tags: - description: "A information field that can be added to identify the static\ - \ route. Maximum 10 unique tags of length 1024 each are allowed. \n" items: description: Tags type: string type: array required: - - scope - - nexthops - - destination_prefix - StaticRouteV2N2: + - name + RoutingPrefixListV2N1: properties: - address_family: - description: "The static route address family. \n" - type: string - description: - description: 'The description of the static route. Max size = 256. + auto_generated: + description: 'The value true or false for auto-generated prefix list for + an element. ' - destination_prefix: - description: 'The IPv4 or IPv6 address mask for next hop Destination Prefix - (IPv4 or IPv6). + type: boolean + description: + description: 'The description of the prefix filter list. Max size = 1024. + + ' + id: + description: "The ID of the prefix filter list. \n" + type: string + name: + description: 'The name of the prefix filter list. Max size = 128. + + ' + type: string + prefix_filter_list: + description: "The details of the prefix filter list used to filter routes.\ + \ \n" + items: + $ref: '#/components/schemas/RoutingPrefixFilterV2N1' + type: array + tags: + description: 'A information field that can be added to identify the prefix + filter list. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + RoutingRouteMapEntryV2N1: + properties: + continue_entry: + description: 'To continue to use the rule that the route matches. + + ' + type: string + match: + $ref: '#/components/schemas/MatchClauses' + description: "The details of route match. \n" + order: + description: 'Enter an order number from 1 to 65535 to define the order + in which this route map will be used. + + ' + format: int32 + type: integer + permit: + description: 'It allow routes to be advertised or Deny to block the routes + from being advertised. + + ' + type: boolean + set: + $ref: '#/components/schemas/SetClauses' + description: 'The details of the route map set. + + ' + RoutingRouteMapEntryV2N2: + properties: + continue_entry: + description: 'To continue to use the rule that the route matches. ' type: string + match: + $ref: '#/components/schemas/MatchClauses' + description: "The details of route match. \n" + order: + description: 'Enter an order number from 1 to 65535 to define the order + in which this route map will be used. + + ' + format: int32 + type: integer + permit: + description: 'It allow routes to be advertised or Deny to block the routes + from being advertised. + + ' + type: boolean + set: + $ref: '#/components/schemas/SetClauses' + description: 'The details of the route map set. + + ' + RoutingRouteMapQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of route maps that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of route maps deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the route maps for the query. + + ' + items: + description: Group By + type: string + type: array id: - description: 'The ID of the static route. + description: "Lists the route maps by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + RoutingRouteMapQueryFilterV2N1: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. + + ' + type: boolean + description: + description: 'The description of the route map. Max size = 1024. ' + id: + description: "The ID of the route map. \n" type: string name: - description: 'The name of the static route. + description: 'The name of the route map. Max size = 128. + + ' + type: string + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + type: array + tags: + description: 'A information field that can be added to identify the route + map. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + RoutingRouteMapQueryFilterV2N2: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. + + ' + type: boolean + description: + description: 'The description of the route map. Max size = 1024. + + ' + id: + description: "The ID of the route map. \n" + type: string + name: + description: 'The name of the route map. Max size = 128. + + ' + type: string + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N2' + type: array + tags: + description: 'A information field that can be added to identify the route + map. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + RoutingRouteMapScreenV2N1: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. ' + type: boolean + description: + description: 'The description of the route map. Max size = 1024. + + ' + id: + description: "The ID of the route map. \n" + type: string + name: + description: 'The name of the route map. Max size = 128. + + ' + type: string + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + type: array + tags: + description: "A information field that can be added to identify the route\ + \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + RoutingRouteMapScreenV2N2: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. + + ' + type: boolean + description: + description: 'The description of the route map. Max size = 1024. + + ' + id: + description: "The ID of the route map. \n" + type: string + name: + description: 'The name of the route map. Max size = 128. + + ' + type: string + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N2' + type: array + tags: + description: "A information field that can be added to identify the route\ + \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + RoutingRouteMapV2N1: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. + + ' + type: boolean + description: + description: 'The description of the route map. Max size = 1024. + + ' + id: + description: "The ID of the route map. \n" + type: string + name: + description: 'The name of the route map. Max size = 128. + + ' + type: string + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + type: array + tags: + description: "A information field that can be added to identify the route\ + \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + RoutingRouteMapV2N2: + properties: + auto_generated: + description: 'The value true or false for auto-generated route map for an + element. + + ' + type: boolean + description: + description: 'The description of the route map. Max size = 1024. + + ' + id: + description: "The ID of the route map. \n" + type: string + name: + description: 'The name of the route map. Max size = 128. + + ' + type: string + route_map_entries: + description: "The details of the route map entries. \n" + items: + $ref: '#/components/schemas/RoutingRouteMapEntryV2N2' + type: array + tags: + description: "A information field that can be added to identify the route\ + \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name + SecurityPolicy: + properties: + action: + $ref: '#/components/schemas/Action' + description: 'The action to allow, deny, or reject traffic based on the + security intent of the enterprise. + + ' + app_ids: + description: 'The App IDs. + + ' + items: + description: App Ids + type: string + type: array + direction: + $ref: '#/components/schemas/Direction' + description: 'The direction of the traffic. + + ' + SetClauses: + properties: + as_path_prepend: + description: 'The AS path prepend. + + ' + type: string + community: + description: "The community. \n" + type: string + ip_next_hop: + description: Ip Next Hop + type: string + local_preference: + description: 'The local preference. + + ' + format: int64 + type: integer + tag: + description: 'A information field that can be added to identify the set + clause. + + ' + format: int32 + type: integer + weight: + description: 'The weight of the set clause. + + ' + format: int64 + type: integer + StateNextHop: + properties: + nexthop_ip: + description: 'The IP address of the next hop. + + ' + type: string + reachability_status: + description: 'The reachability status. + + ' + type: boolean + StaticRouteStatus: + properties: + id: + description: 'The ID of the static route. + + ' + type: string + nexthops: + description: 'The details of the next hop. + + ' + items: + $ref: '#/components/schemas/StateNextHop' + type: array + required: + - nexthops + StaticRouteStatusV2N2: + properties: + id: + description: 'The ID of the static route. + + ' + type: string + nexthops: + description: 'The details of the next hop. + + ' + items: + $ref: '#/components/schemas/StateNextHop' + type: array + StaticRouteV2N2: + properties: + address_family: + description: "The static route address family. \n" + type: string + description: + description: 'The description of the static route. Max size = 256. + + ' + destination_prefix: + description: 'The IPv4 or IPv6 address mask for next hop Destination Prefix + (IPv4 or IPv6). + + ' + type: string + id: + description: 'The ID of the static route. + + ' + type: string + name: + description: 'The name of the static route. + + ' + type: string + network_context_id: + description: 'The ID of the network context. + + ' + type: string + nexthop_reachability_probe: + description: 'The Next Hop Reachability Probe is enabled. + + ' + type: boolean + nexthops: + description: 'The details of the next hops configured on the static route. + + ' + items: + $ref: '#/components/schemas/NextHop' + type: array + scope: + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' + enum: + - GLOBAL + - LOCAL + type: string + tags: + description: 'A information field that can be added to identify the static + route. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - address_family + - scope + - nexthops + - destination_prefix + StaticRouteV2N3: + properties: + address_family: + description: "The static route address family. \n" + type: string + description: + description: 'The description of the static route. Max size = 256. + + ' + destination_prefix: + description: 'The IPv4 or IPv6 address mask for next hop Destination Prefix + (IPv4 or IPv6). + + ' + type: string + id: + description: 'The ID of the static route. + + ' + type: string + name: + description: 'The name of the static route. + + ' + type: string + network_context_id: + description: 'The ID of the network context. + + ' + type: string + nexthop_reachability_probe: + description: 'The Next Hop Reachability Probe is enabled. + + ' + type: boolean + nexthops: + description: 'The details of the next hops configured on the static route. + + ' + items: + $ref: '#/components/schemas/NextHop' + type: array + scope: + description: 'The scope of the static route = Local or Global. If scope + is local, the device does not advertise the route to other sites and if + scope is global, the device advertises the route to other sites. + + ' + enum: + - GLOBAL + - LOCAL + type: string + tags: + description: 'A information field that can be added to identify the static + route. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + vrf_context_id: + description: 'The VRF (Virtual Routing and Forwarding) ID. + + ' + type: string + required: + - address_family + - scope + - nexthops + - destination_prefix + VRFContext: + properties: + default_vrf_context: + description: "VRF context is enabled by default. True / False. \n" + type: boolean + description: + description: 'Description of the VRF context config. Max size = 256. + + ' + id: + description: 'The VRF context ID. + + ' + type: string + name: + description: 'The name of the VRF context. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + context. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + VRFContextProfile: + properties: + default_vrf_context_profile: + description: "VRF profile is enabled by default. True / False. \n" + type: boolean + description: + description: 'Description of the VRF profile. Max size = 256. + + ' + id: + description: 'The VRF profile ID. + + ' + type: string + name: + description: 'The name of the VRF profile. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + profile. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + vrf_context_ids: + description: 'The VRF context IDs. + + ' + items: + description: Vrf Context Ids + type: string + type: array + vrf_context_route_leak_rules: + description: 'The valid VRF context leak rules. + + ' + items: + $ref: '#/components/schemas/VRFContextRouteLeakRule' + type: array + required: + - name + VRFContextProfileQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of VRF profiles that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number VRF profiles deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the VRF profiles for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the VRF profiles by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + description: 'Query using query parameters. + + ' + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + VRFContextProfileQueryFilter: + properties: + default_vrf_context_profile: + description: "VRF profile is enabled by default. True / False. \n" + type: boolean + description: + description: 'Description of the VRF profile. Max size = 256. + + ' + id: + description: 'The VRF profile ID. + + ' + type: string + name: + description: 'The name of the VRF profile. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + profile. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + vrf_context_ids: + description: 'The VRF context IDs. + + ' + items: + description: Vrf Context Ids + type: string + type: array + vrf_context_route_leak_rules: + description: 'The valid VRF context leak rules. + + ' + items: + $ref: '#/components/schemas/VRFContextRouteLeakRule' + type: array + required: + - name + VRFContextProfileScreen: + properties: + description: + description: 'Description of the VRF profile. Max size = 256. + + ' + id: + description: 'The VRF profile ID. + + ' + type: string + name: + description: 'The name of the VRF profile. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + profile. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + vrf_context_ids: + description: 'The VRF context IDs. + + ' + items: + description: Vrf Context Ids + type: string + type: array + vrf_context_route_leak_rules: + description: 'The valid VRF context leak rules. + + ' + items: + $ref: '#/components/schemas/VRFContextRouteLeakRule' + type: array + required: + - name + VRFContextQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of VRF contexts that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number VRF contexts deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the VRF contexts for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the VRF contexts by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. + + ' + format: int64 + type: integer + limit: + description: 'The query limit. + + ' + format: int32 + type: integer + next_query: + description: 'The limit. + + ' + type: object + query_params: + description: 'Query using query parameters. + + ' + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. + + ' + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. + + ' + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + VRFContextQueryFilter: + properties: + default_vrf_context: + description: "VRF context is enabled by default. True / False. \n" + type: boolean + description: + description: 'Description of the VRF context config. Max size = 256. + + ' + id: + description: 'The VRF context ID. + + ' + type: string + name: + description: 'The name of the VRF context. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + context. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name + VRFContextRouteLeakRule: + properties: + description: + description: 'Description of the Route Leak Rule. Max size = 256. + + ' + dest_vrf_context_id: + description: "The destination VRF ID for the Route Leak Rule. \n" + type: string + ipv4_prefixes: + description: 'The leaked IPv4 prefixes of the Route Leak Rule. The leaked + IPv4 prefix in the route leak rule must match the prefix configured on + the interface. + + ' + items: + description: Ipv4 Prefixes + type: string + type: array + name: + description: 'The name of the Route Leak Rule. Max size = 128. + + ' + type: string + src_vrf_context_id: + description: 'The SRC VRF ID. + + ' + type: string + VRFContextScreen: + properties: + description: + description: 'Description of the VRF context config. Max size = 256. + + ' + id: + description: 'The VRF context ID. + + ' + type: string + name: + description: 'The name of the VRF context. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the VRF + context. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - name +info: + contact: {} + description: List of APIs used to configure all routing contructs like, BGP configs, + static routes, AS paths, VRFs, and community lists. + title: Routing + version: Latest +openapi: 3.0.0 +paths: + /sdwan/v2.0/api/enterpriseprefixset: + get: + description: List the prefix set of a tenant enterprise. + operationId: get-sdwan-v2.0-api-enterpriseprefixset + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EnterprisePrefixSetN' + description: Successful Operation + summary: Get Tenant Enterprise Prefix Set (v2.0) + tags: + - Routing + put: + description: Update the prefix set of a tenant enterprise. + operationId: put-sdwan-v2.0-api-enterpriseprefixset + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnterprisePrefixSetN' + description: Enterprise prefix Set + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EnterprisePrefixSetN' + description: Successful Operation + summary: Update Tenant Enterprise Prefix Set (v2.0) + tags: + - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}/operations: + post: + description: Reset the BGP peer configuration. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id-operations + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the BGP peer. + in: path + name: bgp_peer_id + required: true + schema: + description: Bgp Peer Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerOperations' + description: Details of the BGP peer config to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerOperations' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BGP_PEER_CONFIG_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Reset BGP Peer Config (v2.0) + tags: + - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/advertisedprefixes: + get: + description: List all the BGP peer advertised prefixes. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-config_id-advertisedprefixes + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the BGP peer config. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerAdvertisedPrefixes' + description: Successful Operation + summary: Get BGP Peer Advertised Prefixes (v2.0) + tags: + - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/discoveredprefixes: + get: + description: List all the BGP discovered prefix information. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-config_id-discoveredprefixes + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the BGP peer config. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerDiscoveredPrefixes' + description: Successful Operation + summary: Get BGP Discovered Prefixes (v2.0) + tags: + - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/reachableprefixes: + get: + description: List all the BGP reachable prefix information. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-config_id-reachableprefixes + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the BGP peer config. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerReachablePrefixes' + description: Successful Operation + summary: Get BGP Reachable Prefix (v2.0) + tags: + - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: + get: + description: List all the access lists for the element. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingAccessList' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Access List for Element (v2.0) + tags: + - Routing + post: + description: Create a AS-Path access list. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessListScreen' + description: Details of the as-path access list to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: NOT_SUPPORTED_BY_ELEMENT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create AS-Path Access List (v2.0) + tags: + - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: + post: + description: Queries the DB for limit number of access lists that match query + parameters. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists-query + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessListQuery' + description: Query details for access lists + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingAccessListQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Access Lists (v2.0) + tags: + - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: + delete: + description: Delete the access list. + operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the access list. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ACCESS_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Access List (v2.0) + tags: + - Routing + get: + description: Get a specific access list. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The BGP peer config ID. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessList' + description: Successful Operation + summary: Get Access List (v2.0) + tags: + - Routing + put: + description: Updates the access list. + operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the access list. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessListScreen' + description: Details of the as-path access list to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Access List (v2.0) + tags: + - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists: + get: + description: Get all the community lists for an element. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingCommunityList' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Community List for Element (v2.0) + tags: + - Routing + post: + description: Create an IP community list. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessListScreen' + description: Details of the community list to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingCommunityList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: NOT_SUPPORTED_BY_ELEMENT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_COMMUNITY_LIST_NAME + - code: MAX_LIMIT_FOR_COMMUNITY_LIST_EXCEEDS + - code: COMMUNITY_LIST_ALREADY_DEFINED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create IP Community List (v2.0) + tags: + - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists/query: + post: + description: Queries the DB for limit number of community lists that match the + query parameters. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists-query + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingCommunityListQuery' + description: Query details for Routing Community + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingCommunityListQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Community Lists (v2.0) + tags: + - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists/{config_id}: + delete: + description: Deletes the community list. + operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the IP community list. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingCommunityList' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: COMMUNITY_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_COMMUNITY_LIST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Community List (v2.0) + tags: + - Routing + get: + description: Lists a specific community list. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id type: string - network_context_id: - description: 'The ID of the network context. - - ' + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id type: string - nexthop_reachability_probe: - description: 'The Next Hop Reachability Probe is enabled. - - ' - type: boolean - nexthops: - description: 'The details of the next hops configured on the static route. - - ' - items: - $ref: '#/components/schemas/NextHop' - type: array - scope: - description: 'The scope of the static route = Local or Global. If scope - is local, the device does not advertise the route to other sites and if - scope is global, the device advertises the route to other sites. - - ' - enum: - - GLOBAL - - LOCAL + - description: The BGP peer config ID. + in: path + name: config_id + required: true + schema: + description: Config Id type: string - tags: - description: 'A information field that can be added to identify the static - route. Maximum 10 unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array - required: - - address_family - - scope - - nexthops - - destination_prefix -info: - contact: {} - description: List of APIs used to configure all routing contructs like, BGP configs, - static routes, AS paths, and community lists. - title: Routing - version: Latest -openapi: 3.0.0 -paths: - /sdwan/v2.0/api/enterpriseprefixset: - get: - description: List the prefix set of a tenant enterprise. - operationId: get-sdwan-v2.0-api-enterpriseprefixset responses: '200': content: application/json: schema: - $ref: '#/components/schemas/EnterprisePrefixSetN' + $ref: '#/components/schemas/RoutingCommunityList' description: Successful Operation - summary: Get Tenant Enterprise Prefix Set (v2.0) + summary: Get Community List (v2.0) tags: - Routing put: - description: Update the prefix set of a tenant enterprise. - operationId: put-sdwan-v2.0-api-enterpriseprefixset + description: Updates the community list. + operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the IP community list. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnterprisePrefixSetN' - description: Enterprise prefix Set + $ref: '#/components/schemas/RoutingCommunityListScreen' + description: Details of the community list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/EnterprisePrefixSetN' + $ref: '#/components/schemas/RoutingCommunityList' description: Successful Operation - summary: Update Tenant Enterprise Prefix Set (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: CANNOT_UPDATE_AUTOGENERATED_COMMUNITY_LIST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_COMMUNITY_LIST_NAME + - code: MAX_LIMIT_FOR_COMMUNITY_LIST_EXCEEDS + - code: COMMUNITY_LIST_ALREADY_DEFINED + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Community List (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/status: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_prefixlists: get: - description: List all the BGP peer statuses from NB. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-status + description: Get all the prefix lists for an element. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists parameters: - description: The ID of the site. in: path @@ -2659,17 +4597,26 @@ paths: - properties: items: items: - $ref: '#/components/schemas/BGPPeerStatus' + $ref: '#/components/schemas/RoutingPrefixList' type: array type: object description: Successful Operation - summary: Get BGP Peer Status from NB (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Prefix List for Element (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}/operations: post: - description: Reset the BGP peer configuration. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id-operations + description: Create an IP Prefix List. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists parameters: - description: The ID of the site. in: path @@ -2685,25 +4632,18 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. - in: path - name: bgp_peer_id - required: true - schema: - description: Bgp Peer Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerOperations' - description: Details of the BGP peer config to be created + $ref: '#/components/schemas/RoutingPrefixListScreen' + description: Details of the prefix list to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerOperations' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation '400': content: @@ -2711,17 +4651,21 @@ paths: example: value: _error: - - code: BGP_PEER_CONFIG_NOT_FOUND + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: NOT_SUPPORTED_BY_ELEMENT + - code: INVALID_JSON_EXTRA_ATTRIBUTE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Reset BGP Peer Config (v2.0) + summary: Create IP Prefix List (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/advertisedprefixes: - get: - description: List all the BGP peer advertised prefixes. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-config_id-advertisedprefixes + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_prefixlists/query: + post: + description: Queries the DB for limit number of prefix lists that match the + query parameters. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists-query parameters: - description: The ID of the site. in: path @@ -2737,27 +4681,44 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer config. - in: path - name: config_id - required: true - schema: - description: Config Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessListQuery' + description: Query details for access lists responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerAdvertisedPrefixes' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingPrefixListQueryFilter' + type: array + type: object description: Successful Operation - summary: Get BGP Peer Advertised Prefixes (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Prefix Lists (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/discoveredprefixes: - get: - description: List all the BGP discovered prefix information. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-config_id-discoveredprefixes + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_prefixlists/{config_id}: + delete: + description: Delete a prefix list. + operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists-config_id parameters: - description: The ID of the site. in: path @@ -2773,7 +4734,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer config. + - description: The ID of the prefix list. in: path name: config_id required: true @@ -2785,15 +4746,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerDiscoveredPrefixes' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation - summary: Get BGP Discovered Prefixes (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: PREFIX_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_PREFIX_LIST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Prefix List (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/reachableprefixes: get: - description: List all the BGP reachable prefix information. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-config_id-reachableprefixes + description: Get a specific prefix list. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists-config_id parameters: - description: The ID of the site. in: path @@ -2809,7 +4780,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer config. + - description: The BGP peer config ID. in: path name: config_id required: true @@ -2821,15 +4792,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerReachablePrefixes' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation - summary: Get BGP Reachable Prefix (v2.0) + summary: Get Prefix List (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/status: - get: - description: List the BGP peer status information from NB. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-config_id-status + put: + description: Update a prefix list. + operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists-config_id parameters: - description: The ID of the site. in: path @@ -2845,27 +4815,45 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer config. + - description: The ID of the prefix list. in: path name: config_id required: true schema: description: Config Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingPrefixListScreen' + description: Details of the prefix list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerStatus' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation - summary: Get BGP Peer Status from NB (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: CANNOT_UPDATE_AUTOGENERATED_PREFIX_LIST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Prefix List (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: + /sdwan/v2.0/api/sites/{site_id}/localprefixset: get: - description: List all the access lists for the element. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists + description: List the site local prefix set. + operationId: get-sdwan-v2.0-api-sites-site_id-localprefixset parameters: - description: The ID of the site. in: path @@ -2874,13 +4862,20 @@ paths: schema: description: Site Id type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixSet' + description: Successful Operation + summary: Get Site Local Prefix Set (v2.0) + tags: + - Routing + /sdwan/v2.0/api/vrfcontextprofiles: + get: + description: List all the VRF context profiles. + operationId: get-sdwan-v2.0-api-vrfcontextprofiles responses: '200': content: @@ -2891,53 +4886,28 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/VRFContextProfile' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Access List for Element (v2.0) + summary: Get VRF Context Profiles (v2.0) tags: - Routing post: - description: Create a AS-Path access list. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string + description: Create a new VRF context profile. + operationId: post-sdwan-v2.0-api-vrfcontextprofiles requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListScreen' - description: Details of the as-path access list to be created + $ref: '#/components/schemas/VRFContextProfileScreen' + description: VRF Context Profile Request responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/VRFContextProfile' description: Successful Operation '400': content: @@ -2945,42 +4915,32 @@ paths: example: value: _error: - - code: ELEMENT_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: NOT_SUPPORTED_BY_ELEMENT + - code: VRF_CONTEXT_PROFILE_NAME_INVALID + - code: VRF_CONTEXT_PROFILE_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_PROFILE_DESCRIPTION_INVALID + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_NAME_INVALID + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_DESCRIPTION_INVALID + - code: SOURCE_VRF_CONTEXT_INVALID + - code: DESTINATION_VRF_CONTEXT_INVALID + - code: INVALID_PREFIX - code: INVALID_JSON_EXTRA_ATTRIBUTE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create AS-Path Access List (v2.0) + summary: Create VRF Context Profile (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: + /sdwan/v2.0/api/vrfcontextprofiles/query: post: - description: Queries the DB for limit number of access lists that match query - parameters. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists-query - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string + description: Query VRF context profiles. + operationId: post-sdwan-v2.0-api-vrfcontextprofiles-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListQuery' - description: Query details for access lists + $ref: '#/components/schemas/VRFContextProfileQuery' + description: Query Details for the Vrf Context Profile responses: '200': content: @@ -2991,55 +4951,99 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessListQueryFilter' + $ref: '#/components/schemas/VRFContextProfileQueryFilter' type: array type: object description: Successful Operation - '400': + summary: Query VRF Context Profiles (v2.0) + tags: + - Routing + /sdwan/v2.0/api/vrfcontextprofiles/{vrf_context_profile_id}: + delete: + description: Delete a VRF context profile. + operationId: delete-sdwan-v2.0-api-vrfcontextprofiles-vrf_context_profile_id + parameters: + - description: The ID of the VRF context profile. + in: path + name: vrf_context_profile_id + required: true + schema: + description: Vrf Context Profile Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VRFContextProfile' + description: Successful Operation + '404': content: application/json: example: value: _error: - - code: BAD_REQUEST + - code: VRF_CONTEXT_PROFILE_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for Access Lists (v2.0) + description: NOT FOUND + summary: Delete VRF Context Profile (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: - delete: - description: Delete the access list. - operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + get: + description: Get a VRF context profile. + operationId: get-sdwan-v2.0-api-vrfcontextprofiles-vrf_context_profile_id parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. + - description: The ID of the VRF context profile. in: path - name: element_id + name: vrf_context_profile_id required: true schema: - description: Element Id + description: Vrf Context Profile Id type: string - - description: The ID of the access list. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VRFContextProfile' + description: Successful Operation + '404': + content: + application/json: + example: + value: + _error: + - code: VRF_CONTEXT_PROFILE_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: NOT FOUND + summary: Get VRF Context Profile (v2.0) + tags: + - Routing + put: + description: Update a VRF context profile. + operationId: put-sdwan-v2.0-api-vrfcontextprofiles-vrf_context_profile_id + parameters: + - description: The ID of the VRF context profile. in: path - name: config_id + name: vrf_context_profile_id required: true schema: - description: Config Id + description: Vrf Context Profile Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VRFContextProfileScreen' + description: Details of vrf context profile to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/VRFContextProfile' description: Successful Operation '400': content: @@ -3047,178 +5051,188 @@ paths: example: value: _error: - - code: ACCESS_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST + - code: VRF_CONTEXT_PROFILE_NAME_INVALID + - code: VRF_CONTEXT_PROFILE_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_PROFILE_DESCRIPTION_INVALID + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_NAME_INVALID + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_ROUTE_LEAK_RULE_DESCRIPTION_INVALID + - code: SOURCE_VRF_CONTEXT_INVALID + - code: DESTINATION_VRF_CONTEXT_INVALID + - code: INVALID_PREFIX + - code: INVALID_JSON_EXTRA_ATTRIBUTE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Access List (v2.0) + summary: Update VRF Context Profile (v2.0) tags: - Routing + /sdwan/v2.0/api/vrfcontexts: get: - description: Get a specific access list. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The BGP peer config ID. - in: path - name: config_id - required: true - schema: - description: Config Id - type: string + description: Get a VRF segments. + operationId: get-sdwan-v2.0-api-vrfcontexts responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessList' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/VRFContext' + type: array + type: object description: Successful Operation - summary: Get Access List (v2.0) + summary: Get VRF Segments (v2.0) tags: - Routing - put: - description: Updates the access list. - operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + post: + description: Create a VRF segment. + operationId: post-sdwan-v2.0-api-vrfcontexts + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VRFContextScreen' + description: VRF Context Request + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VRFContext' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: VRF_CONTEXT_CONFIG_DESCRIPTION_INVALID + - code: VRF_CONTEXT_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_NAME_INVALID + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create VRF Segment (v2.0) + tags: + - Routing + /sdwan/v2.0/api/vrfcontexts/query: + post: + description: Query VRF contexts. + operationId: post-sdwan-v2.0-api-vrfcontexts-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VRFContextQuery' + description: Query Details for the Vrf Context + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/VRFContextQueryFilter' + type: array + type: object + description: Successful Operation + summary: Query VRF Contexts (v2.0) + tags: + - Routing + /sdwan/v2.0/api/vrfcontexts/{vrf_context_id}: + delete: + description: Delete a VRF segment. + operationId: delete-sdwan-v2.0-api-vrfcontexts-vrf_context_id parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The ID of the access list. + - description: The ID of the VRF context. in: path - name: config_id + name: vrf_context_id required: true schema: - description: Config Id + description: Vrf Context Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoutingAccessListScreen' - description: Details of the as-path access list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/VRFContext' description: Successful Operation - '400': + '404': content: application/json: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: VRF_CONTEXT_NAME_INVALID schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Access List (v2.0) + description: NOT FOUND + summary: Delete VRF Segment (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists: get: - description: Get all the community lists for an element. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists + description: Get a VRF segment. + operationId: get-sdwan-v2.0-api-vrfcontexts-vrf_context_id parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. + - description: The ID of the VRF context. in: path - name: element_id + name: vrf_context_id required: true schema: - description: Element Id + description: Vrf Context Id type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/RoutingCommunityList' - type: array - type: object + $ref: '#/components/schemas/VRFContext' description: Successful Operation - '400': + '404': content: application/json: example: value: _error: - - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_VRF_CONTEXT_ID schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Community List for Element (v2.0) + description: Not Found + summary: Get VRF Segment (v2.0) tags: - Routing - post: - description: Create an IP community list. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists + put: + description: Update a VRF context. + operationId: put-sdwan-v2.0-api-vrfcontexts-vrf_context_id parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. + - description: The ID of the VRF context. in: path - name: element_id + name: vrf_context_id required: true schema: - description: Element Id + description: Vrf Context Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListScreen' - description: Details of the community list to be created + $ref: '#/components/schemas/VRFContextScreen' + description: Details of vrf segment to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + $ref: '#/components/schemas/VRFContext' description: Successful Operation '400': content: @@ -3226,24 +5240,52 @@ paths: example: value: _error: - - code: ELEMENT_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: NOT_SUPPORTED_BY_ELEMENT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_COMMUNITY_LIST_NAME - - code: MAX_LIMIT_FOR_COMMUNITY_LIST_EXCEEDS - - code: COMMUNITY_LIST_ALREADY_DEFINED + - code: VRF_CONTEXT_CONFIG_DESCRIPTION_INVALID + - code: VRF_CONTEXT_NAME_EXCEEDS_LIMIT + - code: VRF_CONTEXT_NAME_INVALID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create IP Community List (v2.0) + summary: Update VRF Context (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists/query: - post: - description: Queries the DB for limit number of community lists that match the - query parameters. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists-query + /sdwan/v2.1/api/enterpriseprefixset: + get: + description: List the prefix set of a tenant enterprise. + operationId: get-sdwan-v2.1-api-enterpriseprefixset + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' + description: Successful Operation + summary: Get Tenant Enterprise Prefix Set (v2.1) + tags: + - Routing + put: + description: Update the prefix set of a tenant enterprise. + operationId: put-sdwan-v2.1-api-enterpriseprefixset + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' + description: Enterprise prefix Set + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' + description: Successful Operation + summary: Update Tenant Enterprise Prefix Set (v2.1) + tags: + - Routing + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers/status: + get: + description: List all the BGP peer statuses from NB. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-status parameters: - description: The ID of the site. in: path @@ -3259,44 +5301,27 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoutingCommunityListQuery' - description: Query details for Routing Community responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/RoutingCommunityListQueryFilter' + $ref: '#/components/schemas/BGPPeerStatusV2N1' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_REQUEST - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for Community Lists (v2.0) + summary: Get BGP Peer Status from NB (v2.1) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists/{config_id}: - delete: - description: Deletes the community list. - operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_config_id}/advertisedprefixes: + get: + description: List all the BGP peer advertised prefixes. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_config_id-advertisedprefixes parameters: - description: The ID of the site. in: path @@ -3312,37 +5337,63 @@ paths: schema: description: Element Id type: string - - description: The ID of the IP community list. + - description: BGP Peer Config Id in: path - name: config_id + name: bgp_peer_config_id required: true schema: - description: Config Id + description: Bgp Peer Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + $ref: '#/components/schemas/BGPPeerAdvertisedPrefixesV2N1' description: Successful Operation - '400': + summary: Get BGP Peer Advertised Prefixes (v2.0) + tags: + - Routing + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_config_id}/reachableprefixes: + get: + description: List all the BGP reachable prefix information. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_config_id-reachableprefixes + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: BGP Peer Config Id + in: path + name: bgp_peer_config_id + required: true + schema: + description: Bgp Peer Config Id + type: string + responses: + '200': content: application/json: - example: - value: - _error: - - code: COMMUNITY_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_COMMUNITY_LIST schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Community List (v2.0) + $ref: '#/components/schemas/BGPPeerReachablePrefixesV2N1' + description: Successful Operation + summary: Get BGP Reachable Prefix (v2.0) tags: - Routing + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/discoveredprefixes: get: - description: Lists a specific community list. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + description: List all the BGP discovered prefix information. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-config_id-discoveredprefixes parameters: - description: The ID of the site. in: path @@ -3358,7 +5409,7 @@ paths: schema: description: Element Id type: string - - description: The BGP peer config ID. + - description: The ID of the BGP peer config. in: path name: config_id required: true @@ -3370,14 +5421,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + $ref: '#/components/schemas/BGPPeerDiscoveredPrefixesV2N1' description: Successful Operation - summary: Get Community List (v2.0) + summary: Get BGP Discovered Prefixes (v2.0) tags: - Routing - put: - description: Updates the community list. - operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_ipcommunitylists-config_id + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/status: + get: + description: List the BGP peer status information from NB. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-config_id-status parameters: - description: The ID of the site. in: path @@ -3393,48 +5445,27 @@ paths: schema: description: Element Id type: string - - description: The ID of the IP community list. + - description: The ID of the BGP peer config. in: path name: config_id required: true schema: description: Config Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoutingCommunityListScreen' - description: Details of the community list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + $ref: '#/components/schemas/BGPPeerStatusV2N1' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: CANNOT_UPDATE_AUTOGENERATED_COMMUNITY_LIST - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_COMMUNITY_LIST_NAME - - code: MAX_LIMIT_FOR_COMMUNITY_LIST_EXCEEDS - - code: COMMUNITY_LIST_ALREADY_DEFINED - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Community List (v2.0) + summary: Get BGP Peer Status from NB (v2.1) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_prefixlists: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: get: - description: Get all the prefix lists for an element. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists + description: List all the access lists for the element. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists parameters: - description: The ID of the site. in: path @@ -3460,9 +5491,12 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/RoutingAccessListV2N1' type: array type: object + items: + $ref: '#/components/schemas/RoutingAccessListV2N1' + type: array description: Successful Operation '400': content: @@ -3474,12 +5508,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Prefix List for Element (v2.0) + summary: Get Access List for Element (v2.1) tags: - Routing post: - description: Create an IP Prefix List. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists + description: Create a AS-Path access list. + operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists parameters: - description: The ID of the site. in: path @@ -3498,15 +5532,15 @@ paths: requestBody: content: application/json: - schema: - $ref: '#/components/schemas/RoutingPrefixListScreen' - description: Details of the prefix list to be created + schema: + $ref: '#/components/schemas/RoutingAccessListScreenV2N1' + description: Details of the as-path access list to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation '400': content: @@ -3521,14 +5555,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create IP Prefix List (v2.0) + summary: Create AS-Path Access List (v2.1) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_prefixlists/query: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: post: - description: Queries the DB for limit number of prefix lists that match the - query parameters. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists-query + description: Queries the DB for limit number of access lists that match query + parameters. + operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists-query parameters: - description: The ID of the site. in: path @@ -3560,7 +5594,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingPrefixListQueryFilter' + $ref: '#/components/schemas/RoutingAccessListQueryFilterV2N1' type: array type: object description: Successful Operation @@ -3575,13 +5609,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Prefix Lists (v2.0) + summary: Query DB for Access Lists (v2.1) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_prefixlists/{config_id}: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: delete: - description: Delete a prefix list. - operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists-config_id + description: Delete the access list. + operationId: delete-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id parameters: - description: The ID of the site. in: path @@ -3597,7 +5631,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the prefix list. + - description: The ID of the access list. in: path name: config_id required: true @@ -3609,7 +5643,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation '400': content: @@ -3617,17 +5651,17 @@ paths: example: value: _error: - - code: PREFIX_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_PREFIX_LIST + - code: ACCESS_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Prefix List (v2.0) + summary: Delete Access List (v2.1) tags: - Routing get: - description: Get a specific prefix list. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists-config_id + description: Get a specific access list. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id parameters: - description: The ID of the site. in: path @@ -3655,14 +5689,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation - summary: Get Prefix List (v2.0) + summary: Get Access List (v2.1) tags: - Routing put: - description: Update a prefix list. - operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists-config_id + description: Updates the access list. + operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id parameters: - description: The ID of the site. in: path @@ -3678,7 +5712,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the prefix list. + - description: The ID of the access list. in: path name: config_id required: true @@ -3689,14 +5723,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListScreen' - description: Details of the prefix list to be updated + $ref: '#/components/schemas/RoutingAccessListV2N1' + description: Details of the access list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation '400': content: @@ -3704,28 +5738,28 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_PREFIX_LIST + - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Prefix List (v2.0) + summary: Update Access List (v2.1) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_routemaps: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_prefixlists: get: - description: List all the route maps for an element. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_routemaps + description: Get all Prefix List for Element + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_prefixlists parameters: - - description: The ID of the site. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The ID of the element. + - description: Element Id in: path name: element_id required: true @@ -3742,7 +5776,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingRouteMap' + $ref: '#/components/schemas/RoutingPrefixListV2N1' type: array type: object description: Successful Operation @@ -3756,21 +5790,21 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Route Map for Element (v2.0) + summary: Get all Prefix List for Element (v2.1) tags: - Routing post: - description: Create a route map. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_routemaps + description: Create IP Prefix List + operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_prefixlists parameters: - - description: The ID of the site. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The ID of the element. + - description: Element Id in: path name: element_id required: true @@ -3781,14 +5815,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreen' - description: Details of route map to be created + $ref: '#/components/schemas/RoutingPrefixListScreenV2N1' + description: Details of the prefix list to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMap' + $ref: '#/components/schemas/RoutingPrefixListV2N1' description: Successful Operation '400': content: @@ -3800,35 +5834,26 @@ paths: - code: ELEMENT_NOT_ASSIGNED_TO_SITE - code: NOT_SUPPORTED_BY_ELEMENT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_ROUTE_MAP_NAME - - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS - - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER - - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER - - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND - - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND - - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND - - code: BGP_CONFIG_INVALID_AS_NUMBER - - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: PREFIX_LIST_PREFIX_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Route Map (v2.0) + summary: Create IP Prefix List (v2.1) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_routemaps/query: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_prefixlists/query: post: - description: Queries the DB for limit number of route maps that match the query - parameters. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_routemaps-query + description: Queries db for limit number of prefix lists that match query params. + operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_prefixlists-query parameters: - - description: The ID of the site. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The ID of the element. + - description: Element Id in: path name: element_id required: true @@ -3839,8 +5864,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapQuery' - description: Query details for route maps + $ref: '#/components/schemas/RoutingAccessListQuery' + description: Query details for access lists responses: '200': content: @@ -3851,7 +5876,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingRouteMapQueryFilter' + $ref: '#/components/schemas/RoutingPrefixListQueryFilterV2N1' type: array type: object description: Successful Operation @@ -3862,44 +5887,46 @@ paths: value: _error: - code: BAD_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Route Maps (v2.1) + summary: Queries db for limit number of prefix lists that match query params. + (v2.1) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_prefixlists/{routing_prefixlist_id}: delete: - description: Delete a route map. - operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_routemaps-config_id + description: Delete Prefix List + operationId: delete-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id parameters: - - description: The ID of the site. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The ID of the element. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The ID of the route map. + - description: Prefix List Id in: path - name: config_id + name: routing_prefixlist_id required: true schema: - description: Config Id + description: Routing Prefixlist Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMap' + $ref: '#/components/schemas/RoutingPrefixListV2N1' description: Successful Operation '400': content: @@ -3907,86 +5934,86 @@ paths: example: value: _error: - - code: ROUTE_MAP_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP + - code: PREFIX_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_PREFIX_LIST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Route Map (v2.0) + summary: Delete Prefix List (v2.1) tags: - Routing get: - description: Get a specific route map. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_routemaps-config_id + description: Get Specific Prefix List + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id parameters: - - description: The ID of the site. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The ID of the element. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The BGP peer config ID. + - description: Prefix List Id in: path - name: config_id + name: routing_prefixlist_id required: true schema: - description: Config Id + description: Routing Prefixlist Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMap' + $ref: '#/components/schemas/RoutingPrefixListV2N1' description: Successful Operation - summary: Get Route Map (v2.0) + summary: Get Specific Prefix List (v2.1) tags: - Routing put: - description: Update a route map. - operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_routemaps-config_id + description: Updates Prefix List + operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id parameters: - - description: The ID of the site. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The ID of the element. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The ID of the route map. + - description: Prefix List Id in: path - name: config_id + name: routing_prefixlist_id required: true schema: - description: Config Id + description: Routing Prefixlist Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreen' - description: Details of route map to be created + $ref: '#/components/schemas/RoutingPrefixListScreenV2N1' + description: Details of the prefix list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMap' + $ref: '#/components/schemas/RoutingPrefixListV2N1' description: Successful Operation '400': content: @@ -3994,28 +6021,20 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP + - code: CANNOT_UPDATE_AUTOGENERATED_PREFIX_LIST - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_ROUTE_MAP_NAME - - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS - - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER - - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER - - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND - - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND - - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND - - code: BGP_CONFIG_INVALID_AS_NUMBER - - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: PREFIX_LIST_PREFIX_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Route Map (v2.0) + summary: Updates Prefix List (v2.1) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/localprefixset: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_routemaps: get: - description: List the site local prefix set. - operationId: get-sdwan-v2.0-api-sites-site_id-localprefixset + description: List all the route maps for an element. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps parameters: - description: The ID of the site. in: path @@ -4024,53 +6043,156 @@ paths: schema: description: Site Id type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixSet' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + type: array + type: object description: Successful Operation - summary: Get Site Local Prefix Set (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Route Map for Element (v2.1) tags: - Routing - /sdwan/v2.1/api/enterpriseprefixset: - get: - description: List the prefix set of a tenant enterprise. - operationId: get-sdwan-v2.1-api-enterpriseprefixset + post: + description: Create a route map. + operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingRouteMapV2N1' + description: Details of the route map to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation - summary: Get Tenant Enterprise Prefix Set (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: NOT_SUPPORTED_BY_ELEMENT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY + - code: INVALID_ROUTE_MAP_NAME + - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS + - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER + - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER + - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND + - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND + - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND + - code: BGP_CONFIG_INVALID_AS_NUMBER + - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Route Map (v2.1) tags: - Routing - put: - description: Update the prefix set of a tenant enterprise. - operationId: put-sdwan-v2.1-api-enterpriseprefixset + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_routemaps/query: + post: + description: Query the DB for limit number of route maps that match query params. + operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps-query + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' - description: Enterprise prefix Set + $ref: '#/components/schemas/RoutingRouteMapQuery' + description: Query details for route maps responses: '200': content: application/json: schema: - $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingRouteMapQueryFilterV2N1' + type: array + type: object description: Successful Operation - summary: Update Tenant Enterprise Prefix Set (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Route Maps (v2.1) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgpconfigs: - get: - description: List all the BGP configurations from NB. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgpconfigs + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: + delete: + description: Delete a route map. + operationId: delete-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: The ID of the site. in: path @@ -4086,27 +6208,37 @@ paths: schema: description: Element Id type: string + - description: The ID of the route map. + in: path + name: config_id + required: true + schema: + description: Config Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPGlobalConfigV2N1' - type: array - type: object + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation - summary: Get BGP Configs from NB (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: ROUTE_MAP_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Route Map (v2.1) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: get: - description: List a specific BGP configuration from NB. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id + description: Get a specific route map. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: The ID of the site. in: path @@ -4122,26 +6254,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP config. + - description: The BGP peer config ID. in: path - name: bgp_config_id + name: config_id required: true schema: - description: Bgp Config Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation - summary: Get BGP Config from NB (v2.1) + summary: Get Route Map (v2.1) tags: - Routing put: - description: Updates the BGP configuration from NB. - operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id + description: Update a route map. + operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: The ID of the site. in: path @@ -4157,25 +6289,25 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP config. + - description: The ID of the route map. in: path - name: bgp_config_id + name: config_id required: true schema: - description: Bgp Config Id + description: Config Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N1' - description: Details of the bgp config to be updated + $ref: '#/components/schemas/RoutingRouteMapV2N1' + description: Details of the route map to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation '400': content: @@ -4183,26 +6315,30 @@ paths: example: value: _error: - - code: BGP_CONFIG_INVALID_LOCAL_AS_NUM - - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_HOLD_TIME - - code: BGP_CONFIG_INVALID_ADV_INTERVAL - - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME - - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS - - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT - - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME + - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY + - code: INVALID_ROUTE_MAP_NAME + - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS + - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER + - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER + - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND + - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND + - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND + - code: BGP_CONFIG_INVALID_AS_NUMBER + - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update BGP Config from NB (v2.1) + summary: Update Route Map (v2.1) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}/status: get: - description: List all the BGP peer configurations from NB. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers + description: Get the status of the static route. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-staticroutes-static_route_id-status parameters: - description: The ID of the site. in: path @@ -4218,90 +6354,27 @@ paths: schema: description: Element Id type: string - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPPeerConfigEtag' - type: array - type: object - description: Successful Operation - summary: Get BGP Peer Configs from NB (v2.1) - tags: - - Routing - post: - description: Create a BGP peer configuration. - operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. + - description: The ID of the static route. in: path - name: element_id + name: static_route_id required: true schema: - description: Element Id + description: Static Route Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N1' - description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N1' + $ref: '#/components/schemas/StaticRouteStatus' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: PEER_CONFIG_INVALID_PEER_IP - - code: BGP_CONFIG_INVALID_REMOTE_AS_NUM - - code: BGP_CONFIG_INVALID_LOCAL_AS_NUM - - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_HOLD_TIME - - code: BGP_CONFIG_INVALID_ADV_INTERVAL - - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME - - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS - - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT - - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE - - code: BGP_CONFIG_INVALID_PREFIX - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: INVALID_PEER_CONFIG_FOR_SPOKE - - code: PEER_TYPE_NOT_SUPPORTED - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW - - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create BGP Peer Config (v2.1) + summary: Get Static Route Status (v2.1) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers/query: - post: - description: Queries the DB for limit number of BGP peers that match query parameters. - operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-query + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgpconfigs: + get: + description: List all the BGP configurations from NB. + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgpconfigs parameters: - description: The ID of the site. in: path @@ -4317,43 +6390,27 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BGPPeerQuery' - description: Query Details for BGP Peers responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/BGPPeerQueryFilterV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N2' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for BGP Peers (v2.1) + summary: Get BGP Configs from NB (v2.2) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers/status: + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: get: - description: List all the BGP peer statuses from NB. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-status + description: List a specific BGP configuration from NB. + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: The ID of the site. in: path @@ -4369,27 +6426,26 @@ paths: schema: description: Element Id type: string + - description: The ID of the BGP config. + in: path + name: bgp_config_id + required: true + schema: + description: Bgp Config Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPPeerStatusV2N1' - type: array - type: object + $ref: '#/components/schemas/BGPGlobalConfigV2N2' description: Successful Operation - summary: Get BGP Peer Status from NB (v2.1) + summary: Get BGP Config from NB (v2.2) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: - delete: - description: Delete the BGP peer configuration. - operationId: delete-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + put: + description: Update the BGP configuration. + operationId: put-sdwan-v2.2-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: The ID of the site. in: path @@ -4405,26 +6461,54 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. + - description: The ID of the BGP config. in: path - name: bgp_peer_id + name: bgp_config_id required: true schema: - description: Bgp Peer Id + description: Bgp Config Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' + description: Details of the bgp config to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N2' description: Successful Operation - summary: Delete BGP Peer Config (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER + - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_HOLD_TIME + - code: BGP_CONFIG_INVALID_ADV_INTERVAL + - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME + - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS + - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT + - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE + - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update BGP Config (v2.2) tags: - Routing + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgppeers/status: get: - description: Get the BGP peer configuration. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + description: List all the BGP peer statuses from NB. + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers-status parameters: - description: The ID of the site. in: path @@ -4440,26 +6524,27 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. - in: path - name: bgp_peer_id - required: true - schema: - description: Bgp Peer Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N1' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerStatusV2N2' + type: array + type: object description: Successful Operation - summary: Get BGP Peer Config (v2.1) + summary: Get BGP Peer Status from NB (v2.2) tags: - - Routing - put: - description: Update the BGP peer configuration. - operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + - Routing + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_config_id}/discoveredprefixes: + get: + description: Get BGP discovered prefix information. + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_config_id-discoveredprefixes parameters: - description: The ID of the site. in: path @@ -4475,61 +6560,27 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. + - description: The BGP peer config ID. in: path - name: bgp_peer_id + name: bgp_peer_config_id required: true schema: - description: Bgp Peer Id + description: Bgp Peer Config Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N1' - description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N1' + $ref: '#/components/schemas/BGPPeerDiscoveredPrefixesV2N2' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: PEER_CONFIG_INVALID_PEER_IP - - code: BGP_CONFIG_INVALID_REMOTE_AS_NUM - - code: BGP_CONFIG_INVALID_LOCAL_AS_NUM - - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_HOLD_TIME - - code: BGP_CONFIG_INVALID_ADV_INTERVAL - - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME - - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS - - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT - - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE - - code: BGP_CONFIG_INVALID_PREFIX - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: INVALID_PEER_CONFIG_FOR_SPOKE - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW - - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update BGP Peer Config (v2.1) + summary: Get BGP Discovered Prefix Information (v2.2) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/status: + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/status: get: description: List the BGP peer status information from NB. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-config_id-status + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers-config_id-status parameters: - description: The ID of the site. in: path @@ -4557,15 +6608,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerStatusV2N1' + $ref: '#/components/schemas/BGPPeerStatusV2N2' description: Successful Operation - summary: Get BGP Peer Status from NB (v2.1) + summary: Get BGP Peer Status from NB (v2.2) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/routing_routemaps: get: - description: List all the access lists for the element. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists + description: List all the route maps for an element. + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps parameters: - description: The ID of the site. in: path @@ -4591,12 +6642,9 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' type: array type: object - items: - $ref: '#/components/schemas/RoutingAccessListV2N1' - type: array description: Successful Operation '400': content: @@ -4608,12 +6656,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Access List for Element (v2.1) + summary: Get Route Map for Element (v2.2) tags: - Routing post: - description: Create a AS-Path access list. - operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists + description: Create a route map. + operationId: post-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps parameters: - description: The ID of the site. in: path @@ -4633,14 +6681,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListScreenV2N1' - description: Details of the as-path access list to be created + $ref: '#/components/schemas/RoutingRouteMapV2N2' + description: Details of the route map to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' description: Successful Operation '400': content: @@ -4652,17 +6700,29 @@ paths: - code: ELEMENT_NOT_ASSIGNED_TO_SITE - code: NOT_SUPPORTED_BY_ELEMENT - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY + - code: INVALID_ROUTE_MAP_NAME + - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS + - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER + - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER + - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND + - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND + - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND + - code: BGP_CONFIG_INVALID_AS_NUMBER + - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create AS-Path Access List (v2.1) + summary: Create Route Map (v2.2) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/routing_routemaps/query: post: - description: Queries the DB for limit number of access lists that match query + description: Queries the DB for limit number of route maps that match the query parameters. - operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists-query + operationId: post-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps-query parameters: - description: The ID of the site. in: path @@ -4682,8 +6742,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListQuery' - description: Query details for access lists + $ref: '#/components/schemas/RoutingRouteMapQuery' + description: Query details for route maps responses: '200': content: @@ -4694,7 +6754,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessListQueryFilterV2N1' + $ref: '#/components/schemas/RoutingRouteMapQueryFilterV2N2' type: array type: object description: Successful Operation @@ -4709,13 +6769,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Access Lists (v2.1) + summary: Query DB for Route Maps (v2.2) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: delete: - description: Delete the access list. - operationId: delete-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + description: Delete a route map. + operationId: delete-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: The ID of the site. in: path @@ -4731,7 +6791,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the access list. + - description: The ID of the route map. in: path name: config_id required: true @@ -4743,7 +6803,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' description: Successful Operation '400': content: @@ -4751,17 +6811,17 @@ paths: example: value: _error: - - code: ACCESS_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST + - code: ROUTE_MAP_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Access List (v2.1) + summary: Delete Route Map (v2.2) tags: - Routing get: - description: Get a specific access list. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + description: Get a specific route map. + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: The ID of the site. in: path @@ -4789,14 +6849,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' description: Successful Operation - summary: Get Access List (v2.1) + summary: Get Route Map (v2.2) tags: - Routing put: - description: Updates the access list. - operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + description: Update a route map. + operationId: put-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - description: The ID of the site. in: path @@ -4812,7 +6872,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the access list. + - description: The ID of the route map. in: path name: config_id required: true @@ -4823,14 +6883,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' - description: Details of the access list to be updated + $ref: '#/components/schemas/RoutingRouteMapV2N2' + description: Details of the route map to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' description: Successful Operation '400': content: @@ -4838,19 +6898,30 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST + - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED + - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY + - code: INVALID_ROUTE_MAP_NAME + - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS + - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER + - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER + - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND + - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND + - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND + - code: BGP_CONFIG_INVALID_AS_NUMBER + - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Access List (v2.1) + summary: Update Route Map (v2.2) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_routemaps: + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/staticroutes: get: - description: List all the route maps for an element. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps + description: List all the static routes. + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes parameters: - description: The ID of the site. in: path @@ -4876,26 +6947,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRouteV2N2' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Route Map for Element (v2.1) + summary: Get Static Routes (v2.2) tags: - Routing post: - description: Create a route map. - operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps + description: Create a static route. + operationId: post-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes parameters: - description: The ID of the site. in: path @@ -4915,14 +6976,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapV2N1' - description: Details of the route map to be created + $ref: '#/components/schemas/StaticRouteV2N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation '400': content: @@ -4930,65 +6990,64 @@ paths: example: value: _error: - - code: ELEMENT_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: NOT_SUPPORTED_BY_ELEMENT + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED - - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY - - code: INVALID_ROUTE_MAP_NAME - - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS - - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER - - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER - - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND - - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND - - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND - - code: BGP_CONFIG_INVALID_AS_NUMBER - - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX + - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 + - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE + - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE + - code: INVALID_NETWORK_CONTEXT + - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Route Map (v2.1) + summary: Create Static Route (v2.2) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_routemaps/query: - post: - description: Query the DB for limit number of route maps that match query params. - operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps-query + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: + delete: + description: Delete a static route. + operationId: delete-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - - description: The site ID. + - description: The ID of the site. in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: The ID of the element. in: path name: element_id required: true schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoutingRouteMapQuery' - description: Query details for route maps + - description: The ID of the static route. + in: path + name: static_route_id + required: true + schema: + description: Static Route Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/RoutingRouteMapQueryFilterV2N1' - type: array - type: object + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation '400': content: @@ -4996,18 +7055,51 @@ paths: example: value: _error: - - code: BAD_REQUEST - - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: STATICROUTE_CONFIG_INVALID_DEVICE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Static Route (v2.2) + tags: + - Routing + get: + description: Get a specific static route. + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes-static_route_id + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the static route. + in: path + name: static_route_id + required: true + schema: + description: Static Route Id + type: string + responses: + '200': + content: + application/json: schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for Route Maps (v2.1) + $ref: '#/components/schemas/StaticRouteV2N2' + description: Successful Operation + summary: Get Static Route (v2.2) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: - delete: - description: Delete a route map. - operationId: delete-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps-config_id + put: + description: Update a static route. + operationId: put-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - description: The ID of the site. in: path @@ -5023,19 +7115,24 @@ paths: schema: description: Element Id type: string - - description: The ID of the route map. + - description: The ID of the static route. in: path - name: config_id + name: static_route_id required: true schema: - description: Config Id + description: Static Route Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StaticRouteV2N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation '400': content: @@ -5043,17 +7140,36 @@ paths: example: value: _error: - - code: ROUTE_MAP_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX + - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 + - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE + - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE + - code: INVALID_NETWORK_CONTEXT + - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Route Map (v2.1) + summary: Update Static Route (v2.2) tags: - Routing + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}/status: get: - description: Get a specific route map. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps-config_id + description: Get the status of the static route. + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes-static_route_id-status parameters: - description: The ID of the site. in: path @@ -5069,60 +7185,47 @@ paths: schema: description: Element Id type: string - - description: The BGP peer config ID. + - description: The ID of the static route. in: path - name: config_id + name: static_route_id required: true schema: - description: Config Id + description: Static Route Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRouteStatusV2N2' description: Successful Operation - summary: Get Route Map (v2.1) + summary: Get Static Route Status (v2.2) tags: - Routing - put: - description: Update a route map. - operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps-config_id - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The ID of the route map. - in: path - name: config_id - required: true - schema: - description: Config Id - type: string + /sdwan/v2.3/api/bgppeers/query: + post: + description: Queries the DB for limit number of BGP peers that match the query + parameters. + operationId: post-sdwan-v2.3-api-bgppeers-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapV2N1' - description: Details of the route map to be updated + $ref: '#/components/schemas/BGPPeerQuery' + description: Query Details for BGP Peers responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerQueryFilterV2N3' + type: array + type: object description: Successful Operation '400': content: @@ -5130,29 +7233,17 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED - - code: ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY - - code: INVALID_ROUTE_MAP_NAME - - code: MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS - - code: ROUTE_MAP_ENTRY_WITH_SAME_ORDER - - code: ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER - - code: ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND - - code: ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND - - code: ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND - - code: BGP_CONFIG_INVALID_AS_NUMBER - - code: ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP + - code: BAD_QUERY_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Route Map (v2.1) + summary: Query DB for BGP Peers (v2.3) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/staticroutes: + /sdwan/v2.3/api/sites/{site_id}/elements/{element_id}/bgpconfigs: get: - description: List all the static routes. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-staticroutes + description: List all the BGP configurations from NB. + operationId: get-sdwan-v2.3-api-sites-site_id-elements-element_id-bgpconfigs parameters: - description: The ID of the site. in: path @@ -5178,16 +7269,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/StaticRouteV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N3' type: array type: object description: Successful Operation - summary: Get Static Routes (v2.1) + summary: Get BGP Configs from NB (v2.3) tags: - Routing - post: - description: Create a static route. - operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-staticroutes + /sdwan/v2.3/api/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: + get: + description: List a specific BGP configuration from NB. + operationId: get-sdwan-v2.3-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: The ID of the site. in: path @@ -5203,44 +7295,26 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StaticRouteV2N1' + - description: The ID of the BGP config. + in: path + name: bgp_config_id + required: true + schema: + description: Bgp Config Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N3' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: STATICROUTE_CONFIG_INVALID_DEVICE - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP - - code: INTERFACE_NOT_FOUND - - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE - - code: INVALID_NETWORK_CONTEXT - - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Static Route (v2.1) + summary: Get BGP Config from NB (v2.3) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: - delete: - description: Delete a static route. - operationId: delete-sdwan-v2.1-api-sites-site_id-elements-element_id-staticroutes-static_route_id + put: + description: Update the BGP configuration. + operationId: put-sdwan-v2.3-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: The ID of the site. in: path @@ -5256,26 +7330,54 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The ID of the BGP config. in: path - name: static_route_id + name: bgp_config_id required: true schema: - description: Static Route Id + description: Bgp Config Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPGlobalConfigScreenV2N3' + description: Details of the bgp config to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N3' description: Successful Operation - summary: Delete Static Route (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER + - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_HOLD_TIME + - code: BGP_CONFIG_INVALID_ADV_INTERVAL + - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME + - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS + - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT + - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE + - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update BGP Config (v2.3) tags: - Routing + /sdwan/v2.3/api/sites/{site_id}/elements/{element_id}/bgppeers: get: - description: Get a specific static route. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-staticroutes-static_route_id + description: List all the BGP peer configurations from NB. + operationId: get-sdwan-v2.3-api-sites-site_id-elements-element_id-bgppeers parameters: - description: The ID of the site. in: path @@ -5291,26 +7393,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. - in: path - name: static_route_id - required: true - schema: - description: Static Route Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N1' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerConfigV2N3' + type: array + type: object description: Successful Operation - summary: Get Static Route (v2.1) + summary: Get BGP Peer Configs from NB (v2.3) tags: - Routing - put: - description: Update a static route. - operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-staticroutes-static_route_id + post: + description: Create a BGP peer configuration. + operationId: post-sdwan-v2.3-api-sites-site_id-elements-element_id-bgppeers parameters: - description: The ID of the site. in: path @@ -5326,24 +7428,18 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. - in: path - name: static_route_id - required: true - schema: - description: Static Route Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N1' + $ref: '#/components/schemas/BGPPeerConfigScreenV2N3' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N1' + $ref: '#/components/schemas/BGPPeerConfigV2N3' description: Successful Operation '400': content: @@ -5351,26 +7447,37 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: PEER_CONFIG_INVALID_PEER_IP + - code: BGP_CONFIG_INVALID_REMOTE_AS_NUMBER + - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER + - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_HOLD_TIME + - code: BGP_CONFIG_INVALID_ADV_INTERVAL + - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME + - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS + - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT + - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE + - code: BGP_CONFIG_INVALID_PREFIX - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: STATICROUTE_CONFIG_INVALID_DEVICE - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP - - code: INTERFACE_NOT_FOUND - - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE - - code: INVALID_NETWORK_CONTEXT - - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_PEER_CONFIG_FOR_SPOKE + - code: PEER_TYPE_NOT_SUPPORTED + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW + - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW + - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Static Route (v2.1) - tags: - - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}/status: - get: - description: Get the status of the static route. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-staticroutes-static_route_id-status + description: Bad Request + summary: Create BGP Peer Config (v2.3) + tags: + - Routing + /sdwan/v2.3/api/sites/{site_id}/elements/{element_id}/bgppeers/query: + post: + description: Queries the DB for limit number of BGP peers that match query parameters. + operationId: post-sdwan-v2.3-api-sites-site_id-elements-element_id-bgppeers-query parameters: - description: The ID of the site. in: path @@ -5386,28 +7493,6 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. - in: path - name: static_route_id - required: true - schema: - description: Static Route Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/StaticRouteStatus' - description: Successful Operation - summary: Get Static Route Status (v2.1) - tags: - - Routing - /sdwan/v2.2/api/bgppeers/query: - post: - description: Queries the DB for limit number of BGP peers that match the query - parameters. - operationId: post-sdwan-v2.2-api-bgppeers-query requestBody: content: application/json: @@ -5438,13 +7523,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for BGP Peers (v2.2) + summary: Query DB for BGP Peers (v2.3) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgpconfigs: - get: - description: List all the BGP configurations from NB. - operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgpconfigs + /sdwan/v2.3/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: + delete: + description: Delete the BGP peer configuration. + operationId: delete-sdwan-v2.3-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -5460,27 +7545,26 @@ paths: schema: description: Element Id type: string + - description: The ID of the BGP peer. + in: path + name: bgp_peer_id + required: true + schema: + description: Bgp Peer Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPGlobalConfigV2N2' - type: array - type: object + $ref: '#/components/schemas/BGPPeerConfigV2N3' description: Successful Operation - summary: Get BGP Configs from NB (v2.2) + summary: Delete BGP Peer Config (v2.3) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: get: - description: List a specific BGP configuration from NB. - operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id + description: Get the BGP peer configuration. + operationId: get-sdwan-v2.3-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -5496,26 +7580,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP config. + - description: The ID of the BGP peer. in: path - name: bgp_config_id + name: bgp_peer_id required: true schema: - description: Bgp Config Id + description: Bgp Peer Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N3' description: Successful Operation - summary: Get BGP Config from NB (v2.2) + summary: Get BGP Peer Config (v2.3) tags: - Routing put: - description: Update the BGP configuration. - operationId: put-sdwan-v2.2-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id + description: Update the BGP peer configuration. + operationId: put-sdwan-v2.3-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -5531,25 +7615,25 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP config. + - description: The ID of the BGP peer. in: path - name: bgp_config_id + name: bgp_peer_id required: true schema: - description: Bgp Config Id + description: Bgp Peer Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' - description: Details of the bgp config to be updated + $ref: '#/components/schemas/BGPPeerConfigScreenV2N3' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N3' description: Successful Operation '400': content: @@ -5557,6 +7641,8 @@ paths: example: value: _error: + - code: PEER_CONFIG_INVALID_PEER_IP + - code: BGP_CONFIG_INVALID_REMOTE_AS_NUMBER - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME - code: BGP_CONFIG_INVALID_HOLD_TIME @@ -5565,20 +7651,27 @@ paths: - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE + - code: BGP_CONFIG_INVALID_PREFIX - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_PEER_CONFIG_FOR_SPOKE + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW + - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update BGP Config (v2.2) + summary: Update BGP Peer Config (v2.3) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgppeers: + /sdwan/v2.3/api/sites/{site_id}/elements/{element_id}/staticroutes: get: - description: List all the BGP peer configurations from NB. - operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers + description: List all the static routes. + operationId: get-sdwan-v2.3-api-sites-site_id-elements-element_id-staticroutes parameters: - description: The ID of the site. in: path @@ -5604,16 +7697,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/BGPPeerConfigV2N2' + $ref: '#/components/schemas/StaticRouteV2N3' type: array type: object description: Successful Operation - summary: Get BGP Peer Configs from NB (v2.2) + summary: Get Static Routes (v2.3) tags: - Routing post: - description: Create a BGP peer configuration. - operationId: post-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers + description: Create a static route. + operationId: post-sdwan-v2.3-api-sites-site_id-elements-element_id-staticroutes parameters: - description: The ID of the site. in: path @@ -5633,14 +7726,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' - description: Details of the BGP peer config to be created + $ref: '#/components/schemas/StaticRouteV2N3' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N2' + $ref: '#/components/schemas/StaticRouteV2N3' description: Successful Operation '400': content: @@ -5648,37 +7740,36 @@ paths: example: value: _error: - - code: PEER_CONFIG_INVALID_PEER_IP - - code: BGP_CONFIG_INVALID_REMOTE_AS_NUMBER - - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER - - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_HOLD_TIME - - code: BGP_CONFIG_INVALID_ADV_INTERVAL - - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME - - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS - - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT - - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME - - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE - - code: BGP_CONFIG_INVALID_PREFIX + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: INVALID_PEER_CONFIG_FOR_SPOKE - - code: PEER_TYPE_NOT_SUPPORTED - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT - - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW - - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW - - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX + - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 + - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE + - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE + - code: INVALID_NETWORK_CONTEXT + - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create BGP Peer Config (v2.2) + summary: Create Static Route (v2.3) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgppeers/query: - post: - description: Queries the DB for limit number of BGP peers that match query parameters. - operationId: post-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers-query + /sdwan/v2.3/api/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: + delete: + description: Delete a static route. + operationId: delete-sdwan-v2.3-api-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - description: The ID of the site. in: path @@ -5694,25 +7785,19 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BGPPeerQuery' - description: Query Details for BGP Peers + - description: The ID of the static route. + in: path + name: static_route_id + required: true + schema: + description: Static Route Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPPeerQueryFilterV2N2' - type: array - type: object + $ref: '#/components/schemas/StaticRouteV2N3' description: Successful Operation '400': content: @@ -5720,17 +7805,16 @@ paths: example: value: _error: - - code: BAD_QUERY_REQUEST + - code: STATICROUTE_CONFIG_INVALID_DEVICE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for BGP Peers (v2.2) + summary: Delete Static Route (v2.3) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: - delete: - description: Delete the BGP peer configuration. - operationId: delete-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + get: + description: Get a specific static route. + operationId: get-sdwan-v2.3-api-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - description: The ID of the site. in: path @@ -5746,26 +7830,134 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. + - description: The ID of the static route. in: path - name: bgp_peer_id + name: static_route_id required: true schema: - description: Bgp Peer Id + description: Static Route Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StaticRouteV2N3' + description: Successful Operation + summary: Get Static Route (v2.3) + tags: + - Routing + put: + description: Update a static route. + operationId: put-sdwan-v2.3-api-sites-site_id-elements-element_id-staticroutes-static_route_id + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The ID of the static route. + in: path + name: static_route_id + required: true + schema: + description: Static Route Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StaticRouteV2N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StaticRouteV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX + - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 + - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF + - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE + - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE + - code: INVALID_NETWORK_CONTEXT + - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Static Route (v2.3) + tags: + - Routing + /sdwan/v2.4/api/bgppeers/query: + post: + description: Queries the DB for limit number of BGP peers that match the query + parameters. + operationId: post-sdwan-v2.4-api-bgppeers-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerQuery' + description: Query Details for BGP Peers responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N2' - description: Successful Operation - summary: Delete BGP Peer Config (v2.2) + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerQueryFilterV2N4' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for BGP Peers (v2.4) tags: - Routing + /sdwan/v2.4/api/sites/{site_id}/elements/{element_id}/bgppeers: get: - description: Get the BGP peer configuration. - operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + description: List all the BGP peer configurations from NB. + operationId: get-sdwan-v2.4-api-sites-site_id-elements-element_id-bgppeers parameters: - description: The ID of the site. in: path @@ -5781,26 +7973,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. - in: path - name: bgp_peer_id - required: true - schema: - description: Bgp Peer Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N2' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerConfigV2N4' + type: array + type: object description: Successful Operation - summary: Get BGP Peer Config (v2.2) + summary: Get BGP Peer Configs from NB (v2.4) tags: - Routing - put: - description: Update the BGP peer configuration. - operationId: put-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + post: + description: Create a BGP peer configuration. + operationId: post-sdwan-v2.4-api-sites-site_id-elements-element_id-bgppeers parameters: - description: The ID of the site. in: path @@ -5816,25 +8008,18 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer. - in: path - name: bgp_peer_id - required: true - schema: - description: Bgp Peer Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' + $ref: '#/components/schemas/BGPPeerConfigScreenV2N4' description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N4' description: Successful Operation '400': content: @@ -5858,21 +8043,22 @@ paths: - code: INVALID_JSON_COMMON_ATTR_MISMATCH - code: ELEMENT_NOT_ASSIGNED_TO_SITE - code: INVALID_PEER_CONFIG_FOR_SPOKE + - code: PEER_TYPE_NOT_SUPPORTED - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE - - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST + - code: BGP_PEER_IP_CONFIG_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update BGP Peer Config (v2.2) + summary: Create BGP Peer Config (v2.4) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/staticroutes: - get: - description: List all the static routes. - operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes + /sdwan/v2.4/api/sites/{site_id}/elements/{element_id}/bgppeers/query: + post: + description: Queries the DB for limit number of BGP peers that match query parameters. + operationId: post-sdwan-v2.4-api-sites-site_id-elements-element_id-bgppeers-query parameters: - description: The ID of the site. in: path @@ -5888,89 +8074,43 @@ paths: schema: description: Element Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPPeerQuery' + description: Query Details for BGP Peers responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/BGPPeerQueryFilterV2N4' type: array type: object description: Successful Operation - summary: Get Static Routes (v2.2) - tags: - - Routing - post: - description: Create a static route. - operationId: post-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StaticRouteV2N2' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/StaticRouteV2N2' - description: Successful Operation '400': content: application/json: example: value: _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: STATICROUTE_CONFIG_INVALID_DEVICE - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE - - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX - - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 - - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 - - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE - - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP - - code: INTERFACE_NOT_FOUND - - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE - - code: INVALID_NETWORK_CONTEXT - - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE + - code: BAD_QUERY_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Static Route (v2.2) + summary: Query DB for BGP Peers (v2.4) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: + /sdwan/v2.4/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: delete: - description: Delete a static route. - operationId: delete-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes-static_route_id + description: Delete the BGP peer configuration. + operationId: delete-sdwan-v2.4-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -5986,36 +8126,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The ID of the BGP peer. in: path - name: static_route_id + name: bgp_peer_id required: true schema: - description: Static Route Id + description: Bgp Peer Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N4' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: STATICROUTE_CONFIG_INVALID_DEVICE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Static Route (v2.2) + summary: Delete BGP Peer Config (v2.4) tags: - Routing get: - description: Get a specific static route. - operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes-static_route_id + description: Get the BGP peer configuration. + operationId: get-sdwan-v2.4-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -6031,26 +8161,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The ID of the BGP peer. in: path - name: static_route_id + name: bgp_peer_id required: true schema: - description: Static Route Id + description: Bgp Peer Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N4' description: Successful Operation - summary: Get Static Route (v2.2) + summary: Get BGP Peer Config (v2.4) tags: - Routing put: - description: Update a static route. - operationId: put-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes-static_route_id + description: Update the BGP peer configuration. + operationId: put-sdwan-v2.4-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -6066,24 +8196,25 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The ID of the BGP peer. in: path - name: static_route_id + name: bgp_peer_id required: true schema: - description: Static Route Id + description: Bgp Peer Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/BGPPeerConfigScreenV2N4' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N4' description: Successful Operation '400': content: @@ -6091,77 +8222,80 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: PEER_CONFIG_INVALID_PEER_IP + - code: BGP_CONFIG_INVALID_REMOTE_AS_NUMBER + - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER + - code: BGP_CONFIG_INVALID_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_HOLD_TIME + - code: BGP_CONFIG_INVALID_ADV_INTERVAL + - code: BGP_CONFIG_INVALID_PEER_RETRY_TIME + - code: BGP_CONFIG_MD5_LENGTH_EXCEEDS + - code: BGP_CONFIG_INVALID_MULTI_HOP_LIMIT + - code: BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME + - code: BGP_CONFIG_INVALID_PREFIX_ADV_TYPE + - code: BGP_CONFIG_INVALID_PREFIX - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: STATICROUTE_CONFIG_INVALID_DEVICE - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE - - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX - - code: STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6 - - code: STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED - - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6 - - code: STATICROUTE_CONFIG_INVALID_NEXTHOPIP - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF - - code: STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE - - code: STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6 - - code: STATICROUTE_CONFIG_INVALID_NEXTHOP - - code: INTERFACE_NOT_FOUND - - code: STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE - - code: INVALID_NETWORK_CONTEXT - - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_PEER_CONFIG_FOR_SPOKE + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT + - code: BGP_PEER_SCOPE_NOT_SUPPORTED_BY_ELEMENT_SW + - code: BGP_PEER_SHUTDOWN_NOT_SUPPORTED_BY_ELEMENT_SW + - code: BGP_CONFIG_INVALID_PEER_AUTH_TYPE + - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST + - code: BGP_PEER_IP_CONFIG_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Static Route (v2.2) + summary: Update BGP Peer Config (v2.4) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}/status: - get: - description: Get the status of the static route. - operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes-static_route_id-status - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. - in: path - name: element_id - required: true - schema: - description: Element Id - type: string - - description: The ID of the static route. - in: path - name: static_route_id - required: true - schema: - description: Static Route Id - type: string + /sdwan/v3.0/api/prefixes/query: + post: + description: Query the prefix set. + operationId: post-sdwan-v3.0-api-prefixes-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PrefixQueryV3' + description: Query Details for prefixes responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteStatusV2N2' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/PrefixQueryFilterV3' + type: array + type: object description: Successful Operation - summary: Get Static Route Status (v2.2) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Prefix Set (v3.0) tags: - Routing - /sdwan/v3.0/api/prefixes/query: + /sdwan/v3.1/api/prefixes/query: post: description: Query the prefix set. - operationId: post-sdwan-v3.0-api-prefixes-query + operationId: post-sdwan-v3.1-api-prefixes-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/PrefixQueryV3' + $ref: '#/components/schemas/PrefixQueryV3N1' description: Query Details for prefixes responses: '200': @@ -6173,7 +8307,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/PrefixQueryFilterV3' + $ref: '#/components/schemas/PrefixQueryFilterV3N1' type: array type: object description: Successful Operation @@ -6187,7 +8321,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Prefix Set (v3.0) + summary: Query Prefix Set (v3.1) tags: - Routing servers: diff --git a/openapi-specs/sdwan/unified/SNMP.yaml b/openapi-specs/sdwan/unified/SNMP.yaml index 0185dd8a7..2f26df25a 100644 --- a/openapi-specs/sdwan/unified/SNMP.yaml +++ b/openapi-specs/sdwan/unified/SNMP.yaml @@ -15,13 +15,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string diff --git a/openapi-specs/sdwan/unified/SecurityPolicy.yaml b/openapi-specs/sdwan/unified/SecurityPolicy.yaml index 7bf2c0ae7..bc2dc8369 100644 --- a/openapi-specs/sdwan/unified/SecurityPolicy.yaml +++ b/openapi-specs/sdwan/unified/SecurityPolicy.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,11 +44,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view ElementSecurityZone: properties: id: @@ -319,10 +313,6 @@ components: ' type: string - required: - - path - - site - - elements GlobalPrefixQueryFilter: properties: description: @@ -393,10 +383,9 @@ components: ' type: string tags: - description: 'A information field that can be added to identify the priority - policy global prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' + description: "A information field that can be added to identify the priority\ + \ policy global prefix. Maximum 10 unique tags of length 1024 each are\ + \ allowed. \n" items: description: Tags type: string @@ -406,19 +395,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -439,7 +428,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -448,13 +437,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -694,10 +683,9 @@ components: ' type: string tags: - description: 'A information field that can be added to identify the security - policy global prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' + description: "A information field that can be added to identify the security\ + \ policy global prefix. Maximum 10 unique tags of length 1024 each are\ + \ allowed. \n" items: description: Tags type: string @@ -1323,7 +1311,9 @@ components: type: array user_or_group: $ref: '#/components/schemas/UserGroup' - description: "The details of the user or group. \n" + description: 'The details of the user or group. + + ' required: - enabled - action @@ -1331,92 +1321,87 @@ components: SecurityPolicyV2N1RuleScreen: properties: action: - description: 'Action: ValidateEnum(enumClass = classOf[SecurityAction], - message = SECURITY_POLICYRULE_INVALID_ACTION, nullAllowed = false) ' + description: "The action taken for traffic matching this rule. It determine\ + \ how the traffic from the specified source zone to the specified destination\ + \ zone should respond. \n" type: string app_def_ids: - description: 'App Def Ids: ListString(allowDuplicate = false, allowEmpty - = true, allowNull = true, length = 0, listMaxSize = 0, error = DUPLICATE_APP_DEF_IDS: - Duplicate app ids are specified., noTrim = false, regex = , required = - false) Size(max = 16, error = APP_DEF_ID_LIST_SIZE_EXCEEDED_SIZE_16: Maximum - 16 applications can be specified in a rule., min = 0) ' + description: 'The security policy rule application ID. + + ' items: description: App Def Ids type: string type: array description: - description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: - Description length exceeds limit, min = 0) ' - type: string + description: 'The description of the security policy rule. Max size = 256. + + ' destination_prefix_ids: - description: 'Destination Prefix Ids: ListString(allowDuplicate = false, - allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error - = DUPLICATE_DESTINATION_PREFIX_IDS: Duplicate destination prefix IDs found., - noTrim = false, regex = , required = false) Size(max = 16, error = DESTINATION_PREFIX_ID_LIST_SIZE_EXCEEDED: - Too many destination prefix IDs. Max = 16., min = 0) ' + description: 'The destination prefix IDs. Max list of prefix IDs is 16. + + ' items: description: Destination Prefix Ids type: string type: array destination_zone_ids: - description: 'Destination Zone Ids: ListString(allowDuplicate = false, allowEmpty - = true, allowNull = true, length = 0, listMaxSize = 0, error = DUPLICATE_DESTINATION_ZONE_IDS: - Duplicate destination zone IDs found., noTrim = false, regex = , required - = false) Size(max = 16, error = DESTINATION_ZONE_ID_LIST_SIZE_EXCEEDED: - Too many destination zone IDs. Max = 16., min = 0) ' + description: 'The destination zone IDs. Max list of zone IDs is 16. + + ' items: description: Destination Zone Ids type: string type: array enabled: - description: 'Enabled: NotNull ' + description: "The security policy rule, if enabled. \n" type: boolean id: - description: Id + description: 'The security policy rule ID. + + ' type: string name: - description: 'Name: Required(error = NAME_REQD: Please provide resource - name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource - exceeds limit., min = 0) ' + description: 'The name of the security policy rule. Max size = 128. + + ' type: string services: - description: Services + description: "The details of the source and destination ports along with\ + \ the protocol used. \n" items: $ref: '#/components/schemas/Service' type: array source_prefix_ids: - description: 'Source Prefix Ids: ListString(allowDuplicate = false, allowEmpty - = true, allowNull = true, length = 0, listMaxSize = 0, error = DUPLICATE_SOURCE_PREFIX_IDS: - Duplicate source prefix IDs found., noTrim = false, regex = , required - = false) Size(max = 16, error = SOURCE_PREFIX_ID_LIST_SIZE_EXCEEDED: Too - many source prefix IDs. Max = 16., min = 0) ' + description: 'The source prefix IDs. Max list of IDs is 16. + + ' items: description: Source Prefix Ids type: string type: array source_zone_ids: - description: 'Source Zone Ids: ListString(allowDuplicate = false, allowEmpty - = true, allowNull = true, length = 0, listMaxSize = 0, error = DUPLICATE_SOURCE_ZONE_IDS: - Duplicate source zone IDs found., noTrim = false, regex = , required = - false) Size(max = 16, error = SOURCE_ZONE_ID_LIST_SIZE_EXCEEDED: Too many - source zone IDs. Max = 16., min = 0) ' + description: 'The source zone IDs. Max list of IDs is 16. + + ' items: description: Source Zone Ids type: string type: array tags: - description: 'Tags: ListString(allowDuplicate = false, allowEmpty = true, - allowNull = true, length = 128, listMaxSize = 10, error = INVALID_TAG: - Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, - regex = [^,\\s]+, required = false) ' + description: 'A information field that can be added to identify the security + policy rule. Maximum 10 unique tags of length 1024 each are allowed. + + ' items: description: Tags type: string type: array user_or_group: $ref: '#/components/schemas/UserGroup' - description: 'User Or Group: JsonInclude(content = ALWAYS, contentFilter - = classOf[Void], value = NON_NULL, valueFilter = classOf[Void]) Valid ' + description: 'The details of the user or group. + + ' required: - enabled - action @@ -1473,7 +1458,7 @@ components: type: string services: description: "The details of the source and destination ports along with\ - \ the protocol used. \n" + \ the protocol used.. \n" items: $ref: '#/components/schemas/Service' type: array @@ -1563,7 +1548,7 @@ components: type: string services: description: "The details of the source and destination ports along with\ - \ the protocol used. \n" + \ the protocol used.. \n" items: $ref: '#/components/schemas/Service' type: array @@ -1648,7 +1633,7 @@ components: type: string services: description: "The details of the source and destination ports along with\ - \ the protocol used. \n" + \ the protocol used.. \n" items: $ref: '#/components/schemas/Service' type: array @@ -2401,7 +2386,9 @@ components: description: "The IP Prefix ID that associates with a site. \n" type: string site_id: - description: "The site ID binding the prefix. \n" + description: 'The site ID binding the prefix. + + ' type: string tags: description: 'A information field that can be added to identify the site @@ -3479,7 +3466,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Security Policy Set Stack (v2.0) + summary: Delete Security Policy Set Stack tags: - Security Policy get: @@ -3511,7 +3498,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Security Policy Set Stack (v2.0) + summary: Get Security Policy Set Stack tags: - Security Policy put: @@ -3550,7 +3537,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Security Policy Set Stack (v2.0) + summary: Update Security Policy Set Stack tags: - Security Policy /sdwan/v2.0/api/prefixfilters/query: diff --git a/openapi-specs/sdwan/unified/Service&DCGroups.yaml b/openapi-specs/sdwan/unified/Service&DCGroups.yaml index c3bd9e4d4..e3e961a46 100644 --- a/openapi-specs/sdwan/unified/Service&DCGroups.yaml +++ b/openapi-specs/sdwan/unified/Service&DCGroups.yaml @@ -68,11 +68,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -81,11 +76,10 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view Error: properties: _error: @@ -156,19 +150,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -189,7 +183,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -198,13 +192,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -212,7 +206,7 @@ components: Location: properties: description: - description: 'The decsription of the location. + description: 'The description of the location. ' latitude: @@ -652,35 +646,34 @@ components: - type - name ServiceLabel: - description: - description: 'The description of the service label. Max size = 256. - - ' properties: description: - description: 'Description: Size(max = 256, error = DESCRIPTION_SIZE_EXCEEDED: - Description size exceeded., min = 0) Valid ' - type: string + description: 'The description of the service label. Max size = 256. + + ' id: - description: Id + description: 'The ID of the service label. + + ' type: string name: - description: 'Name: Required(error = SERVICELABEL_NAME_REQD: Service label - name required.) Size(max = 128, error = SERVICELABEL_NAME_EXCEEDS_LIMIT: - Service label name exceeds limit., min = 0) Valid ' + description: 'The name of the service label. Max size = 128. + + ' type: string tags: - description: 'Tags: ListString(allowDuplicate = false, allowEmpty = true, - allowNull = true, length = 128, listMaxSize = 10, error = INVALID_TAG: - Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, - regex = [^,\\s]+, required = false) ' + description: 'A information field that can be added to identify the service + label. Maximum 10 unique tags of length 1024 each are allowed. + + ' items: description: Tags type: string type: array type: - description: 'Type: ValidateEnum(enumClass = classOf[NetworkServiceType], - message = Invalid enum string., nullAllowed = false) ' + description: 'The network service type. + + ' enum: - CG_TRANSIT - NON_CG_TRANSIT diff --git a/openapi-specs/sdwan/unified/Services.yaml b/openapi-specs/sdwan/unified/Services.yaml index 9bfe9f736..0bee98e66 100644 --- a/openapi-specs/sdwan/unified/Services.yaml +++ b/openapi-specs/sdwan/unified/Services.yaml @@ -15,13 +15,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -506,7 +506,7 @@ paths: type: array type: object description: Successful Operation - summary: Get Syslog Servers (v2.1) + summary: Get Syslog Servers on Element (v2.1) tags: - Services post: @@ -564,7 +564,7 @@ paths: - Services /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/syslogservers/{syslogserver_id}: delete: - description: Create the syslog server. + description: Delete the syslog server. operationId: delete-sdwan-v2.1-api-sites-site_id-elements-element_id-syslogservers-syslogserver_id parameters: - description: ID of the site. @@ -595,7 +595,7 @@ paths: schema: $ref: '#/components/schemas/SyslogServerV2N1' description: Successful Operation - summary: Create Syslog Server (v2.1) + summary: Delete Syslog Server (v2.1) tags: - Services get: @@ -782,7 +782,7 @@ paths: - Services /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/syslogservers/{syslogserver_id}: delete: - description: Create the syslog server. + description: Delete the syslog server. operationId: delete-sdwan-v2.2-api-sites-site_id-elements-element_id-syslogservers-syslogserver_id parameters: - description: ID of the site. @@ -813,7 +813,7 @@ paths: schema: $ref: '#/components/schemas/SyslogServerScreenV2N2' description: Successful Operation - summary: Create Syslog Server (v2.2) + summary: Delete Syslog Server (v2.2) tags: - Services get: diff --git a/openapi-specs/sdwan/unified/SiteConfiguration.yaml b/openapi-specs/sdwan/unified/SiteConfiguration.yaml index 6ac06854c..8d5ff3372 100644 --- a/openapi-specs/sdwan/unified/SiteConfiguration.yaml +++ b/openapi-specs/sdwan/unified/SiteConfiguration.yaml @@ -80,11 +80,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -93,26 +88,25 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string ClusterEvent: properties: @@ -242,9 +236,9 @@ components: ' type: string subscription_factor: - description: 'Subscription Factor: Digits(fraction = 1, integer = 1, ) ValidateDecimal(allowZero - = false, increment = 5, max = 5, error = INVALID_VALUE_RANGE: Invalid - value range., min = 5) ' + description: 'The subscription factor. + + ' format: float type: number HubClusterElement: @@ -656,19 +650,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -689,7 +683,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -698,13 +692,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -735,7 +729,7 @@ components: Location: properties: description: - description: 'The decsription of the location. + description: 'The description of the location. ' latitude: @@ -942,7 +936,7 @@ components: ' format: int64 type: integer - SiteQueryFilterV4N4: + SiteQueryFilterV4N8: properties: address: $ref: '#/components/schemas/Address' @@ -966,6 +960,13 @@ components: ' type: string + extended_tags: + description: "Extended tags allow operators to add more information into\ + \ the site object. Current extended tags allow for additional configuration\ + \ related to Prisma Access and ZScaler to be added. \n" + items: + $ref: '#/components/schemas/ExtendedTag' + type: array id: description: 'The ID. @@ -976,17 +977,25 @@ components: description: 'The geographical cordinates for the site address. ' + multicast_peer_group_id: + description: 'The multicast peer group ID. + + ' + type: string name: description: 'The site name (Max size = 128). ' type: string nat_policysetstack_id: - description: Nat Policysetstack Id + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. + + ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. ' type: string @@ -1002,10 +1011,235 @@ components: ' type: string + security_policyset_id: + description: Security Policyset Id + type: string + security_policysetstack_id: + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. + + ' + type: string + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. + + ' + type: string + tags: + description: 'A information field that can be added to identify the site. + + ' + items: + description: Tags + type: string + type: array + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string + required: + - element_cluster_role + - admin_state + - name + SiteQueryFilterV4N9: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. + + ' + admin_state: + description: 'The site mode of operation, can be in one of three states: + Active - the site is in Control mode and network policy is applied. Monitor + - the site is in Analytics mode, no network policy is applied. Disabled: + the site is disabled. + + ' + type: string + description: + description: 'Description for the site (Max size = 1024). + + ' + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. + + ' + type: string + extended_tags: + description: 'Extended tags allow operators to add more information into + the site object. Current extended tags allow for additional configuration + related to Prisma Access and ZScaler to be added. + + ' + items: + $ref: '#/components/schemas/ExtendedTag' + type: array + id: + description: 'The ID. + + ' + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' + multicast_peer_group_id: + description: 'The multicast peer group ID. + + ' + type: string + name: + description: 'The site name (Max size = 128). + + ' + type: string + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. + + ' + type: string + network_policysetstack_id: + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. + + ' + type: string + perfmgmt_policysetstack_id: + description: "ID for the Performance Policyset Stack. \n" + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. + + ' + type: string + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. + + ' + type: string security_policyset_id: description: 'The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API. + ' + type: string + security_policysetstack_id: + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. + + ' + type: string + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. + + ' + type: string + tags: + description: 'A information field that can be added to identify the site. + + ' + items: + description: Tags + type: string + type: array + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string + required: + - element_cluster_role + - admin_state + - name + SiteScreenV4N8: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. + + ' + admin_state: + description: 'The site mode of operation, can be in one of three states: + Active - the site is in Control mode and network policy is applied. Monitor + - the site is in Analytics mode, no network policy is applied. Disabled: + the site is disabled. + + ' + type: string + description: + description: 'Description for the site (Max size = 1024). + + ' + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. + + ' + type: string + extended_tags: + description: "Extended tags allow operators to add more information into\ + \ the site object. Current extended tags allow for additional configuration\ + \ related to Prisma Access and ZScaler to be added. \n" + items: + $ref: '#/components/schemas/ExtendedTag' + type: array + id: + description: 'The ID. + + ' + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' + multicast_peer_group_id: + description: 'The multicast peer group ID. + + ' + type: string + name: + description: 'The site name (Max size = 128). + + ' + type: string + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. + + ' + type: string + network_policysetstack_id: + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. + + ' + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. + + ' + type: string + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. + + ' + type: string + security_policyset_id: + description: Security Policyset Id + type: string + security_policysetstack_id: + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. + ' type: string service_binding: @@ -1022,7 +1256,16 @@ components: description: Tags type: string type: array - SiteQueryFilterV4N5: + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string + required: + - element_cluster_role + - admin_state + - name + SiteScreenV4N9: properties: address: $ref: '#/components/schemas/Address' @@ -1047,9 +1290,11 @@ components: ' type: string extended_tags: - description: 'Extended Tags: Valid ListObject(allowDuplicate = false, allowEmpty - = true, allowNull = true, listMaxSize = 10, message = INVALID_EXTENDED_TAG_SIZE_OR_DUPLICATE, - required = false) ' + description: 'Extended tags allow operators to add more information into + the site object. Current extended tags allow for additional configuration + related to Prisma Access and ZScaler to be added. + + ' items: $ref: '#/components/schemas/ExtendedTag' type: array @@ -1063,6 +1308,11 @@ components: description: 'The geographical cordinates for the site address. ' + multicast_peer_group_id: + description: 'The multicast peer group ID. + + ' + type: string name: description: 'The site name (Max size = 128). @@ -1075,11 +1325,14 @@ components: ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. ' type: string + perfmgmt_policysetstack_id: + description: "ID for the Performance Policyset Stack. \n" + type: string policy_set_id: description: 'The ID for the Original Network Policy Set. Can be retrieved using policysets API. @@ -1096,6 +1349,12 @@ components: description: 'The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API. + ' + type: string + security_policysetstack_id: + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. + ' type: string service_binding: @@ -1112,6 +1371,11 @@ components: description: Tags type: string type: array + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string required: - element_cluster_role - admin_state @@ -1162,7 +1426,7 @@ components: type: string required: - site_id - SiteV4N6: + SiteV4N8: properties: address: $ref: '#/components/schemas/Address' @@ -1205,6 +1469,11 @@ components: description: 'The geographical cordinates for the site address. ' + multicast_peer_group_id: + description: 'The multicast peer group ID. + + ' + type: string name: description: 'The site name (Max size = 128). @@ -1217,8 +1486,8 @@ components: ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. ' type: string @@ -1241,7 +1510,10 @@ components: ' type: string security_policysetstack_id: - description: Security Policysetstack Id + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. + + ' type: string service_binding: description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps @@ -1257,11 +1529,16 @@ components: description: Tags type: string type: array + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string required: - element_cluster_role - admin_state - name - SiteV4N7: + SiteV4N9: properties: address: $ref: '#/components/schemas/Address' @@ -1326,6 +1603,9 @@ components: ' type: string + perfmgmt_policysetstack_id: + description: "ID for the Performance Policyset Stack. \n" + type: string policy_set_id: description: 'The ID for the Original Network Policy Set. Can be retrieved using policysets API. @@ -1364,6 +1644,11 @@ components: description: Tags type: string type: array + vrf_context_profile_id: + description: 'The VRF (Virtual Routing and Forwarding) profile ID. + + ' + type: string required: - element_cluster_role - admin_state @@ -1644,8 +1929,7 @@ components: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of WAN interfaces that match the query - parameters. + description: 'The aggregate number of app defs that match the query parameters. ' dest_page: @@ -1655,7 +1939,7 @@ components: format: int32 type: integer getDeleted: - description: 'The number WAN interfaces deleted for a time frame. + description: 'The number app definitions deleted for a time frame. ' type: boolean @@ -1666,7 +1950,7 @@ components: type: string type: array id: - description: "List the WAN interfaces by ID. \n" + description: "List the app definitions by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -1711,83 +1995,115 @@ components: WANInterfaceQueryFilterV2N7: properties: bfd_mode: - description: 'Bfd Mode: ValidateEnum(enumClass = classOf[BfdMode], WAN_CONFIG_INVALID_BFD_MODE, - nullAllowed = false) ' + description: 'Allowed values: aggressive - For fast failure detection of + links. This mode is the default mode and is recommended by Prisma SD-WAN. + non_aggressive - when you want to reduce the amount of probe traffic, + or for links that are subjected to high loss or poor quality. + + ' enum: - aggressive - non_aggressive type: string bw_config_mode: - description: 'Bw Config Mode: ValidateEnum(enumClass = classOf[BWConfigMode], - message = INVALID_BANDWIDTH_CONFIG_MODE, nullAllowed = false) ' + description: 'The bandwidth config mode. + + ' enum: - auto - manual - manual_bwm_disabled type: string bwc_enabled: - description: Bwc Enabled + description: 'The bwc parameters. + + ' type: boolean cost: - description: 'Cost: Range(max = 1024L, error = WANINTERFACE_INVALID_COST_VALUE: - Cost value for site WAN interface should be within range 0-1024, min = - 0L) ' + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' type: integer description: - description: 'Description: Size(max = 256, WANINTERFACE_CONFIG_DESCRIPTION_EXCEEDS_LIMIT, - min = 0) ' - type: string + description: 'The description of the WAN interface config. + + ' id: - description: Id + description: 'The ID. + + ' type: string label_id: - description: 'Label Id: NotEmpty(message = WAN_INTERFACE_INVALID_LABEL) ' + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' type: string link_bw_down: - description: 'Link Bw Down: JsonIgnore(value = true) ' + description: 'The circuit downstream capacity in MB. + + ' format: double type: number link_bw_up: - description: 'Link Bw Up: JsonIgnore(value = true) ' + description: 'The circuit upstream capacity in MB. + + ' format: double type: number lqm_config: $ref: '#/components/schemas/LQMConfig' - description: 'Lqm Config: Valid ' + description: 'The link quality monitoring parameters. + + ' lqm_enabled: - description: Lqm Enabled + description: 'The link quality monitoring parameters. + + ' type: boolean name: - description: 'Name: Size(max = 128, WANINTERFACE_CONFIG_NAME_EXCEEDS_LIMIT, - min = 0) ' + description: 'The name of the WAN interface config. + + ' type: string network_id: - description: 'Network Id: NotEmpty(message = NETWORK_ID_REQD) ' + description: 'The network ID. + + ' type: string site_id: description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull ' type: string tags: - description: 'Tags: ListString(allowDuplicate = false, allowEmpty = true, - allowNull = true, length = 128, listMaxSize = 10, error = INVALID_TAG: - Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, - regex = [^,\\s]+, required = false) ' + description: "An information field that can be added to identify the WAN\ + \ interface. Maximum 10 unique tags of length 1024 each are allowed. \ + \ \n" items: description: Tags type: string type: array type: - description: Type + description: 'WAN type. + + ' enum: - PUBLIC_WAN - PRIVATE_WAN type: string use_for_application_reachability_probes: - description: 'Use For Application Reachability Probes: Valid ' + description: 'Indicates if the use for application reachability probe is + selected. True or False. + + ' type: boolean use_for_controller_connections: - description: 'Use For Controller Connections: Valid ' + description: "Indicates if the use for controller connections is selected.\ + \ True or False.\n\n\n\n \n\n\n\n\n\n\n \n \n\ + \ \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\ + \n\n\n \n\n\n\n\n\n\n\n \n\n\n \n\n\n \n\n\n \ + \ \n\n\n\n\n\n\n\n\n\n\n \n " type: boolean use_lqm_for_non_hub_paths: description: Use Lqm For Non Hub Paths @@ -2309,7 +2625,7 @@ paths: type: array type: object description: Successful Operation - summary: Get Hub Service Endpoints of Tenant (v2.0) + summary: Get HubServiceEndpoints of Tenant (v2.0) tags: - Site Configuration /sdwan/v2.0/api/sites/{site_id}/hubserviceendpoints: @@ -2343,7 +2659,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Hub Service Endpoint for Site of Tenant (v2.0) + summary: Get HubServiceEndpoint for Site of a Tenant (v2.0) tags: - Site Configuration /sdwan/v2.0/api/sites/{site_id}/siteciphers: @@ -2634,6 +2950,7 @@ paths: - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: ADVERTISEMENT_INTERVAL_INVALID_DECIMAL - code: ADVERTISEMENT_INTERVAL_REQD + - code: ADVERTISEMENT_INTERVAL_LOWER_THAN_ONE_SEC_ERR schema: $ref: '#/components/schemas/Error' description: Bad Request @@ -2683,7 +3000,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Handle Operations on Spoke Cluster (v2.0) + summary: Handle Operations on Spokecluster (v2.0) tags: - Site Configuration /sdwan/v2.0/api/sites/{site_id}/spokeclusters/{spoke_cluster_id}/status: @@ -3968,11 +4285,10 @@ paths: - Site Configuration /sdwan/v4.0/api/sites/{site_id}/hubclusters: get: - description: Get all the hub clusters. + description: Get all hub clusters operationId: get-sdwan-v4.0-api-sites-site_id-hubclusters parameters: - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. + - description: Site Id in: path name: site_id required: true @@ -3993,15 +4309,14 @@ paths: type: array type: object description: Successful operation - summary: Get Hub Clusters (v4.0) + summary: Get all hub clusters (v4.0) tags: - Site Configuration post: - description: Create a new hub cluster. + description: Creates a new hub cluster operationId: post-sdwan-v4.0-api-sites-site_id-hubclusters parameters: - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. + - description: Site Id in: path name: site_id required: true @@ -4043,7 +4358,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad request - summary: Create Hub Cluster (v4.0) + summary: Creates a new hub cluster (v4.0) tags: - Site Configuration /sdwan/v4.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}: @@ -4273,96 +4588,42 @@ paths: summary: Get Hub Cluster Status (v4.0) tags: - Site Configuration - /sdwan/v4.4/api/sites/query: - post: - description: Queries the DB for limit number of sites that match the query parameters. - operationId: post-sdwan-v4.4-api-sites-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteQuery' - description: Query Details for the site - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SiteQueryFilterV4N4' - type: array - type: object - description: Successful Operation - summary: Query DB for Number of Sites that Match Query Params (v4.4) - tags: - - Site Configuration - /sdwan/v4.5/api/sites/query: - post: - description: Queries the DB for limit number of sites that match the query parameters. - operationId: post-sdwan-v4.5-api-sites-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteQuery' - description: Query Details for the site - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SiteQueryFilterV4N5' - type: array - type: object - description: Successful Operation - summary: Query DB for Number of Sites that Match Query Params (v4.5) - tags: - - Site Configuration - /sdwan/v4.6/api/sites: + /sdwan/v4.8/api/sites: get: description: Get the sites if a particular tenant. - operationId: get-sdwan-v4.6-api-sites + operationId: get-sdwan-v4.8-api-sites responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/BulkResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/SiteV4N6' + $ref: '#/components/schemas/SiteV4N8' type: array type: object description: Successful Operation - summary: Get Sites of Tenant (v4.6) + summary: Get Sites of Tenant (v4.8) tags: - Site Configuration post: description: Create a new site. - operationId: post-sdwan-v4.6-api-sites + operationId: post-sdwan-v4.8-api-sites requestBody: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' + $ref: '#/components/schemas/SiteScreenV4N8' description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' + $ref: '#/components/schemas/SiteV4N8' description: Successful Operation '400': content: @@ -4375,16 +4636,44 @@ paths: - code: POLICY_NOT_AVAILABLE - code: NGFWSETSTACK_NOT_FOUND - code: SITE_STATE_INVALID + - code: MULTICAST_INVALID_PEER_GROUP_ID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create a New Site (v4.6) + summary: Create a New Site (v4.8) + tags: + - Site Configuration + /sdwan/v4.8/api/sites/query: + post: + description: Queries db for limit number of sites that match query params. + operationId: post-sdwan-v4.8-api-sites-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteQuery' + description: Query Details for the site + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteQueryFilterV4N8' + type: array + type: object + description: Successful Operation + summary: Queries db for limit number of sites that match query params. (v4.8) tags: - Site Configuration - /sdwan/v4.6/api/sites/{site_id}: + /sdwan/v4.8/api/sites/{site_id}: delete: description: Delete a particular site. - operationId: delete-sdwan-v4.6-api-sites-site_id + operationId: delete-sdwan-v4.8-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4399,7 +4688,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' + $ref: '#/components/schemas/SiteV4N8' description: Successful Operation '400': content: @@ -4412,17 +4701,17 @@ paths: - code: DELETE_FORBIDDEN_INVALID_STATE - code: DELETE_FORBIDDEN_SITE_WAN_EXISTS - code: DELETE_FORBIDDEN_SITE_WAN_LQM_CONFIG_EXISTS - - code: DELETE_FORBIDDEN_ELEMENT_EXISTS + - code: DELETE_FORBIDDEN_ELEMENT_OR_ELEMENT_SHELL_EXISTS - code: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete a Site (v4.6) + summary: Delete a Site (v4.8) tags: - Site Configuration get: description: Get the site of a tenant by using the tenant ID and the site ID. - operationId: get-sdwan-v4.6-api-sites-site_id + operationId: get-sdwan-v4.8-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4437,7 +4726,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' + $ref: '#/components/schemas/SiteV4N8' description: Successful Operation '400': content: @@ -4449,12 +4738,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Site of Tenant using Tenant ID (v4.6) + summary: Get Site of Tenant using Tenant ID (v4.8) tags: - Site Configuration put: description: Update an existing site. - operationId: put-sdwan-v4.6-api-sites-site_id + operationId: put-sdwan-v4.8-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4468,14 +4757,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' + $ref: '#/components/schemas/SiteScreenV4N8' description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N6' + $ref: '#/components/schemas/SiteV4N8' description: Successful Operation '400': content: @@ -4500,16 +4789,17 @@ paths: - code: INVALID_POLICYSET - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: MULTICAST_INVALID_PEER_GROUP_ID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update a Site (v4.6) + summary: Update a Site (v4.8) tags: - Site Configuration - /sdwan/v4.7/api/sites: + /sdwan/v4.9/api/sites: get: description: Get the sites if a particular tenant. - operationId: get-sdwan-v4.7-api-sites + operationId: get-sdwan-v4.9-api-sites responses: '200': content: @@ -4520,28 +4810,28 @@ paths: - properties: items: items: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteV4N9' type: array type: object description: Successful Operation - summary: Get Sites of Tenant (v4.7) + summary: Get Sites of Tenant (v4.9) tags: - Site Configuration post: description: Create a new site. - operationId: post-sdwan-v4.7-api-sites + operationId: post-sdwan-v4.9-api-sites requestBody: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteV4N9' description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteScreenV4N9' description: Successful Operation '400': content: @@ -4555,16 +4845,47 @@ paths: - code: NGFWSETSTACK_NOT_FOUND - code: SITE_STATE_INVALID - code: MULTICAST_INVALID_PEER_GROUP_ID + - code: SITE_CONFIG_PERFMGMT_POLICY_NOT_SUPPORTED + - code: SITE_CONFIG_PERFMGMT_POLICYSETSTACK_FORBIDDEN + - code: SITE_CONFIG_PERFMGMT_POLICYSETSTACK_NOT_FOUND + - code: PERFMGMT_DEFAULT_STACK_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create a New Site (v4.7) + summary: Create a New Site (v4.9) + tags: + - Site Configuration + /sdwan/v4.9/api/sites/query: + post: + description: Queries db for limit number of sites that match query params. + operationId: post-sdwan-v4.9-api-sites-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteQuery' + description: Query Details for the site + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteQueryFilterV4N9' + type: array + type: object + description: Successful Operation + summary: Queries db for limit number of sites that match query params. (v4.9) tags: - Site Configuration - /sdwan/v4.7/api/sites/{site_id}: + /sdwan/v4.9/api/sites/{site_id}: delete: description: Delete a particular site. - operationId: delete-sdwan-v4.7-api-sites-site_id + operationId: delete-sdwan-v4.9-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4579,7 +4900,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteV4N9' description: Successful Operation '400': content: @@ -4592,17 +4913,17 @@ paths: - code: DELETE_FORBIDDEN_INVALID_STATE - code: DELETE_FORBIDDEN_SITE_WAN_EXISTS - code: DELETE_FORBIDDEN_SITE_WAN_LQM_CONFIG_EXISTS - - code: DELETE_FORBIDDEN_ELEMENT_EXISTS + - code: DELETE_FORBIDDEN_ELEMENT_OR_ELEMENT_SHELL_EXISTS - code: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete a Site (v4.7) + summary: Delete a Site (v4.9) tags: - Site Configuration get: description: Get the site of a tenant by using the tenant ID and the site ID. - operationId: get-sdwan-v4.7-api-sites-site_id + operationId: get-sdwan-v4.9-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4617,7 +4938,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteV4N9' description: Successful Operation '400': content: @@ -4629,12 +4950,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Site of Tenant using Tenant ID (v4.7) + summary: Get Site of Tenant using Tenant ID (v4.9) tags: - Site Configuration put: description: Update an existing site. - operationId: put-sdwan-v4.7-api-sites-site_id + operationId: put-sdwan-v4.9-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4648,14 +4969,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteScreenV4N9' description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N7' + $ref: '#/components/schemas/SiteV4N9' description: Successful Operation '400': content: @@ -4681,10 +5002,14 @@ paths: - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH - code: MULTICAST_INVALID_PEER_GROUP_ID + - code: SITE_CONFIG_PERFMGMT_POLICY_NOT_SUPPORTED + - code: SITE_CONFIG_PERFMGMT_POLICYSETSTACK_FORBIDDEN + - code: SITE_CONFIG_PERFMGMT_POLICYSETSTACK_NOT_FOUND + - code: SITE_CONFIG_PERFMGMT_POLICYSETSTACK_REMOVED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update a Site (v4.7) + summary: Update a Site (v4.9) tags: - Site Configuration servers: diff --git a/openapi-specs/sdwan/unified/SoftwareManagement.yaml b/openapi-specs/sdwan/unified/SoftwareManagement.yaml index 53d2b0517..44f3fd976 100644 --- a/openapi-specs/sdwan/unified/SoftwareManagement.yaml +++ b/openapi-specs/sdwan/unified/SoftwareManagement.yaml @@ -36,11 +36,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -49,26 +44,25 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view BulkResponse: properties: count: - description: 'The total number of responses. + description: 'The total number. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string type: - description: "The type of response. \n" + description: "The type. \n" type: string ElementImageV2N1: properties: @@ -146,19 +140,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -179,7 +173,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -188,13 +182,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string diff --git a/openapi-specs/sdwan/unified/SystemAdministration.yaml b/openapi-specs/sdwan/unified/SystemAdministration.yaml index eeff562a2..b6725ba0c 100644 --- a/openapi-specs/sdwan/unified/SystemAdministration.yaml +++ b/openapi-specs/sdwan/unified/SystemAdministration.yaml @@ -703,7 +703,7 @@ components: description: "The name of the extension. Max size = 128. \n" type: string namespace: - description: "The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$.\ + description: "The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$\ \ \n" type: string required: @@ -1025,19 +1025,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -1058,7 +1058,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -1067,13 +1067,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -1502,10 +1502,9 @@ components: type: array migration_state: $ref: '#/components/schemas/MigrationState' - description: "The migration state. \n\n \n\n\n\n\n\n \ - \ \n\n\n\n\n \n\n\n\n\n\n\n\n \n\n \n\n\n\n\n\n\n\n\n \ - \ \n\n\n\n\n\n \n\n\n\n\n\n\n\n \n\n\n \n\n\n \ - \ \n\n\n \n\n\n\n\n\n\n\n\n\n\n \n " + description: 'The migration state. + + ' phone_numbers: description: 'The details of the phone numbers. Maximum of twenty phones can be specified. @@ -1797,6 +1796,41 @@ components: security: description: Security type: string + SamlRequest: + properties: + LoginHint: + description: LoginHint + type: string + RelayState: + description: RelayState + type: string + SAMLRequest: + description: SAMLRequest + type: string + api_endpoint: + description: Api Endpoint + type: string + id: + description: Id + type: string + login_region: + description: Login Region + type: string + method: + description: Method + type: string + requestId: + description: RequestId + type: string + url: + description: Url + type: string + urlpath: + description: Urlpath + type: string + username: + description: Username + type: string SamlResponse: properties: relayState: @@ -2077,7 +2111,10 @@ components: ' type: string - TenantV2N4: + tsg_id: + description: Tsg Id + type: string + TenantV2N5: properties: address: $ref: '#/components/schemas/Address' @@ -2135,6 +2172,9 @@ components: ' type: boolean + is_pa_iot_security_license: + description: Is Pa Iot Security License + type: boolean is_support: description: Is Support type: boolean @@ -2203,8 +2243,16 @@ components: ' type: string - TenantV2N5: + tsg_instances: + description: "The details of the TSG instances. \n" + items: + $ref: '#/components/schemas/TsgInstance' + type: array + TenantV2N7: properties: + ? '' + : description: X Panw Region + type: string address: $ref: '#/components/schemas/Address' description: 'The address of the site. @@ -2259,10 +2307,22 @@ components: is_esp: description: 'If the tenant is ESP. + ' + type: boolean + is_oneapp_ready: + description: 'True or False for oneapp. + + ' + type: boolean + is_pa_iot_security_license: + description: 'True or False for PA IoT security license. + ' type: boolean is_support: - description: Is Support + description: 'True or False for support. + + ' type: boolean name: description: 'The name of the tenant. Max size = 512. @@ -2330,7 +2390,9 @@ components: ' type: string tsg_instances: - description: "The details of the TSG instances. \n" + description: 'The details of the TSG instances. + + ' items: $ref: '#/components/schemas/TsgInstance' type: array @@ -2363,7 +2425,9 @@ components: ' type: string region: - description: "The region of the TSG instance. \n" + description: 'The region of the TSG instance. + + ' type: string Type: properties: @@ -2375,12 +2439,69 @@ components: name: description: 'The name of the user agent. + ' + type: string + UserIdentity: + properties: + disabled: + description: 'List the users in a disabled state. + + ' + type: boolean + disabled_reason: + description: 'List the reason for the disabled state. + + ' + type: string + first_name: + description: 'The first name of the user. Max size = 100. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + inactive: + description: 'Lists if the user is inactive. + + ' + type: boolean + inactive_reason: + description: 'Reason the user is inactive. + + ' + type: string + last_name: + description: 'The last name of the user. + + ' + type: string + middle_name: + description: 'The middle name of the user. + + ' + type: string + region: + description: 'The region. + + ' + type: string + user_dn: + description: 'The user dn. + + ' + type: string + user_fqn: + description: 'The user fqn. + ' type: string info: contact: {} description: List of APIs used to manage the operators, IDPs, users, base roles, - base permissions, password change, sign up, and client roles, base roles. + base permissions, password change, sign up, client roles, and base roles. title: System Administration version: Latest openapi: 3.0.0 @@ -4003,6 +4124,36 @@ paths: summary: Create SSO Session (v2.0) tags: - System Administration + /sdwan/v2.0/api/saml_idp: + post: + description: Process SAMLRequest from SP + operationId: post-sdwan-v2.0-api-saml_idp + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SamlRequest' + description: SAMLRequest + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthResource' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Process SAMLRequest from SP (v2.0) + tags: + - System Administration /sdwan/v2.0/api/signup: post: description: Sign up new operators. @@ -4081,6 +4232,166 @@ paths: summary: Sign Out API for MSP Client (v2.0) tags: - System Administration + /sdwan/v2.0/api/users: + get: + description: List all the users. + operationId: get-sdwan-v2.0-api-users + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/UserIdentity' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Users (v2.0) + tags: + - System Administration + post: + description: Create an user identity. + operationId: post-sdwan-v2.0-api-users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Create an user identity + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create an user identity. (v2.0) + tags: + - System Administration + /sdwan/v2.0/api/users/{user_id}: + delete: + description: Delete an user identity. + operationId: delete-sdwan-v2.0-api-users-user_id + parameters: + - description: The user ID. + in: path + name: user_id + required: true + schema: + description: User Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete User Identity (v2.0) + tags: + - System Administration + get: + description: Get an user identity. + operationId: get-sdwan-v2.0-api-users-user_id + parameters: + - description: The user ID. + in: path + name: user_id + required: true + schema: + description: User Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get User Identity (v2.0) + tags: + - System Administration + put: + description: Update an user identity. + operationId: put-sdwan-v2.0-api-users-user_id + parameters: + - description: The user ID. + in: path + name: user_id + required: true + schema: + description: User Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Details of the site Network Policy local prefix to be associated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserIdentity' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update User Identity (v2.0) + tags: + - System Administration /sdwan/v2.1/api/clients/{client_id}/roles: get: description: List all the client custom roles. @@ -5286,16 +5597,16 @@ paths: summary: Update Tenant Operator (v2.2) tags: - System Administration - /sdwan/v2.4/api/: + /sdwan/v2.6/api/: get: - description: Get all the tenant information for a tenant ID. - operationId: get-sdwan-v2.4-api- + description: Get tenant details for a tenant ID. + operationId: get-sdwan-v2.6-api- responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N4' + $ref: '#/components/schemas/TenantV2N5' description: Successful Operation '400': content: @@ -5308,24 +5619,24 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Information (v2.4) + summary: Get Tenant Details for Tenant ID (v2.6) tags: - System Administration put: - description: Update all the tenant information for a tenant ID. - operationId: put-sdwan-v2.4-api- + description: Update a tenant. + operationId: put-sdwan-v2.6-api- requestBody: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N4' + $ref: '#/components/schemas/TenantV2N5' description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N4' + $ref: '#/components/schemas/TenantV2N5' description: Successful Operation '400': content: @@ -5341,19 +5652,19 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Information (v2.4) + summary: Update a tenant (v2.6) tags: - System Administration - /sdwan/v2.5/api/: + /sdwan/v2.7/api/: get: - description: Get all the tenant information for a tenant ID. - operationId: get-sdwan-v2.5-api- + description: Get tenant details for a tenant ID. + operationId: get-sdwan-v2.7-api- responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' + $ref: '#/components/schemas/TenantV2N7' description: Successful Operation '400': content: @@ -5366,24 +5677,24 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Information (v2.5) + summary: Get Tenant Details for Tenant ID (v2.7) tags: - System Administration put: - description: Update all the tenant information for a tenant ID. - operationId: put-sdwan-v2.5-api- + description: Update a tenant. + operationId: put-sdwan-v2.7-api- requestBody: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' + $ref: '#/components/schemas/TenantV2N7' description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' + $ref: '#/components/schemas/TenantV2N7' description: Successful Operation '400': content: @@ -5399,7 +5710,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Information (v2.5) + summary: Update a tenant (v2.7) tags: - System Administration /sdwan/v3.2/api/idps: diff --git a/openapi-specs/sdwan/unified/Topology.yaml b/openapi-specs/sdwan/unified/Topology.yaml index 14ba06a35..2a6403ef5 100644 --- a/openapi-specs/sdwan/unified/Topology.yaml +++ b/openapi-specs/sdwan/unified/Topology.yaml @@ -1,5 +1,37 @@ components: schemas: + Address: + properties: + city: + description: 'The name of the city. Max size = 100. + + ' + type: string + country: + description: 'The name of the country. Max size = 100. + + ' + type: string + post_code: + description: 'The postal code. Max size = 100. + + ' + type: string + state: + description: 'The name of the state. Max size = 100. + + ' + type: string + street: + description: 'The name of the street. Max size = 100. + + ' + type: string + street2: + description: 'The name of the street. Max size = 100. + + ' + type: string Aggregate: properties: data: @@ -7,123 +39,990 @@ components: ' items: - $ref: '#/components/schemas/AggregateData' + $ref: '#/components/schemas/AggregateData' + type: array + field: + description: Field + type: string + name: + description: 'The name of the query response. + + ' + type: string + operator: + description: Operator + enum: + - max + - count + - min + - avg + - sum + type: string + statistic: + description: 'QoS application aggregate statistics. + + ' + type: string + unit: + description: 'The unit. + + ' + type: string + AggregateData: + properties: + value: + description: 'Value of the aggregate data. + + ' + type: number + view: + description: 'View the aggregate date. + + ' + type: object + AnynetLinkV3N3: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + description: + description: 'The anynet link description. Max size = 256. + + ' + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_wan_if_id: + description: Ep1 Wan If Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_wan_if_id: + description: Ep2 Wan If Id + type: string + forced: + description: Forced + type: boolean + id: + description: 'The anynet link ID. + + ' + type: string + name: + description: 'The anynet link name. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the anynet + link. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'Anynet link type. + + ' + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + AnynetLinkV3N4: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + description: + description: 'The anynet link description. Max size = 256. + + ' + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_wan_if_id: + description: Ep1 Wan If Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_wan_if_id: + description: Ep2 Wan If Id + type: string + forced: + description: Forced + type: boolean + id: + description: 'The anynet link ID. + + ' + type: string + name: + description: 'The anynet link name. Max size = 128. + + ' + type: string + tags: + description: 'A information field that can be added to identify the anynet + link. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'Anynet link type. + + ' + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + Anynetlink: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + description: + description: 'The anynet link description. Max size = 256. + + ' + disabled: + description: Disabled + type: boolean + disabled_reason: + description: 'Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, + min = 0) ' + type: string + ep1_site_id: + description: Ep1 Site Id + type: string + ep1_site_role: + description: Ep1 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep1_wan_interface_id: + description: Ep1 Wan Interface Id + type: string + ep2_site_id: + description: Ep2 Site Id + type: string + ep2_site_role: + description: Ep2 Site Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + ep2_wan_interface_id: + description: Ep2 Wan Interface Id + type: string + id: + description: 'The anynet link ID. + + ' + type: string + inactive: + description: Inactive + type: boolean + inactive_reason: + description: 'Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, + min = 0) ' + type: string + name: + description: 'The anynet link name. Max size = 128. + + ' + type: string + region: + description: Region + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + tags: + description: 'A information field that can be added to identify the anynet + link. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + target_serviceendpoint_id: + description: Target Serviceendpoint Id + type: string + type: + description: 'Anynet link type. + + ' + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - site_id + BfdSession: + properties: + element_id: + description: "The element ID. \n" + type: string + peers: + description: 'The peers details. + + ' + items: + description: Peers + type: string + type: array + BfdUnderlay: + properties: + bfd_sessions: + description: "The element and peers information of the BFD sessions. \ + \ \n" + items: + $ref: '#/components/schemas/BfdSession' + type: array + site_id: + description: 'The site ID. + + ' + type: string + required: + - site_id + BulkResponse: + properties: + count: + description: 'The total number. + + ' + format: int32 + type: integer + id: + description: 'The ID. + + ' + type: string + type: + description: "The type. \n" + type: string + Error: + properties: + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + type: string + message: + type: string + ListQueryResponse: + properties: + count: + description: 'The actual count. + + ' + format: int32 + type: integer + deleted_count: + description: 'The deleted number. + + ' + format: int64 + type: integer + deleted_ids: + description: 'The deleted IDs. + + ' + items: + type: string + type: array + description: + description: 'Description of the query. Max size = 256. + + ' + id: + description: 'The ID. + + ' + type: string + next_query: + description: 'Details of the next query. + + ' + type: object + total_count: + description: 'Total number. + + ' + format: int64 + type: integer + type: object + Location: + properties: + description: + description: 'The description of the location. + + ' + latitude: + description: 'The latitude of the location. Max range = 90. + + ' + format: float + type: number + longitude: + description: 'The longitude of the location. Max range = 180. + + ' + format: float + type: number + NetworkLinkV2: + properties: + anynet_link_id: + description: 'The anynet link ID.. + + ' + type: string + description: + description: 'The anynet link description. Max size = 256. + + ' + id: + description: 'The ID. + + ' + type: string + network: + description: Network + type: string + path_id: + description: Path Id + type: string + source_node_id: + description: 'The source node ID. + + ' + type: string + source_wan_network: + description: 'The source WAN network. + + ' + type: string + source_wan_nw_id: + description: 'The The source WAN network ID. + + ' + type: string + source_wan_path_id: + description: Source Wan Path Id + type: string + state: + description: State + type: string + status: + description: 'The status of the link. + + ' + type: string + sub_type: + description: Sub Type + type: string + target_node_id: + description: 'The target node ID. + + ' + type: string + target_wan_network: + description: 'The target WAN network. + + ' + type: string + target_wan_nw_id: + description: 'The The target WAN network ID. + + ' + type: string + target_wan_path_id: + description: Target Wan Path Id + type: string + type: + description: 'Anynet link type. + + ' + type: string + vpnlinks: + description: 'The VPN links info. + + ' + items: + description: Vpnlinks + type: string + type: array + wan_nw_id: + description: 'The WAN network ID. + + ' + type: string + NetworkLinkV3N3: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + anynet_link_id: + description: 'The anynet link ID.. + + ' + type: string + cost: + description: Cost + format: int32 + type: integer + description: + description: 'The anynet link description. Max size = 256. + + ' + elem_interface_id: + description: 'The element interface ID. + + ' + type: string + element_id: + description: 'The element ID. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + in_use: + description: In Use + type: boolean + name: + description: 'The anynet link name. Max size = 128. + + ' + type: string + network: + description: Network + type: string + path_id: + description: Path Id + type: string + sep_id: + description: Sep Id + type: string + sep_name: + description: Sep Name + type: string + source_circuit_name: + description: 'The name of the source circuit. + + ' + type: string + source_elem_if_id: + description: 'The source element ID. + + ' + type: string + source_node_id: + description: 'The source node ID. + + ' + type: string + source_site_name: + description: 'The source site name. + + ' + type: string + source_wan_if_id: + description: 'The source WAN ID. + + ' + type: string + source_wan_network: + description: 'The source WAN network. + + ' + type: string + source_wan_nw_id: + description: 'The The source WAN network ID. + + ' + type: string + status: + description: 'The status of the link. + + ' + type: string + sub_type: + description: Sub Type + type: string + tags: + description: 'A information field that can be added to identify the anynet + link. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string type: array - field: - description: Field + target_circuit_name: + description: 'The target circuit name. + + ' type: string - name: - description: 'The name of the query response. + target_elem_if_id: + description: 'The target element ID. ' type: string - operator: - description: Operator - enum: - - max - - count - - min - - avg - - sum + target_node_id: + description: 'The target node ID. + + ' type: string - statistic: - description: 'QoS application aggregate statistics. + target_site_name: + description: 'The target site name. ' type: string - unit: - description: 'The unit. + target_wan_if_id: + description: 'The target WAN ID. ' type: string - required: - - statistic - - unit - - name - - data - AggregateData: - properties: - value: - description: 'Value of the aggregate data. + target_wan_network: + description: 'The target WAN network. ' - type: number - view: - description: "View the aggregate date. \n" - type: object - required: - - value - - view - BulkResponse: + type: string + target_wan_nw_id: + description: 'The The target WAN network ID. + + ' + type: string + type: + description: 'Anynet link type. + + ' + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + vpnlinks: + description: 'The VPN links info. + + ' + items: + description: Vpnlinks + type: string + type: array + wan_if_id: + description: 'The WAN ID. + + ' + type: string + wan_nw_id: + description: 'The WAN network ID. + + ' + type: string + wan_nw_name: + description: 'The WAN network name. + + ' + type: string + NetworkLinkV3N4: properties: - count: - description: 'The total number of responses. + admin_up: + description: 'The interface admin state. + + ' + type: boolean + anynet_link_id: + description: 'The anynet link ID.. ' + type: string + cost: + description: Cost format: int32 type: integer + description: + description: 'The anynet link description. Max size = 256. + + ' + elem_interface_id: + description: 'The element interface ID. + + ' + type: string + element_id: + description: 'The element ID. + + ' + type: string id: - description: 'The ID of the response. + description: 'The ID. + + ' + type: string + in_use: + description: In Use + type: boolean + name: + description: 'The anynet link name. Max size = 128. + + ' + type: string + network: + description: Network + type: string + path_id: + description: Path Id + type: string + sep_id: + description: Sep Id + type: string + sep_name: + description: Sep Name + type: string + source_circuit_name: + description: 'The name of the source circuit. + + ' + type: string + source_elem_if_id: + description: 'The source element ID. + + ' + type: string + source_node_id: + description: 'The source node ID. + + ' + type: string + source_site_name: + description: 'The source site name. + + ' + type: string + source_wan_if_id: + description: 'The source WAN ID. + + ' + type: string + source_wan_network: + description: 'The source WAN network. + + ' + type: string + source_wan_nw_id: + description: 'The The source WAN network ID. + + ' + type: string + status: + description: 'The status of the link. + + ' + type: string + sub_type: + description: Sub Type + type: string + tags: + description: 'A information field that can be added to identify the anynet + link. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + target_circuit_name: + description: 'The target circuit name. + + ' + type: string + target_elem_if_id: + description: 'The target element ID. + + ' + type: string + target_node_id: + description: 'The target node ID. + + ' + type: string + target_serviceendpoint_id: + description: Target Serviceendpoint Id + type: string + target_serviceendpoint_name: + description: Target Serviceendpoint Name + type: string + target_site_name: + description: 'The target site name. + + ' + type: string + target_wan_if_id: + description: 'The target WAN ID. + + ' + type: string + target_wan_network: + description: 'The target WAN network. + + ' + type: string + target_wan_nw_id: + description: 'The The target WAN network ID. ' type: string type: - description: "The type of response. \n" + description: 'Anynet link type. + + ' type: string - Error: - properties: - _error: + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + vpnlinks: + description: 'The VPN links info. + + ' items: - $ref: '#/components/schemas/ErrorResponse' + description: Vpnlinks + type: string type: array - ErrorResponse: + wan_if_id: + description: 'The WAN ID. + + ' + type: string + wan_nw_id: + description: 'The WAN network ID. + + ' + type: string + wan_nw_name: + description: "The WAN network name. \n" + type: string + NetworkNode: properties: - code: + address: + $ref: '#/components/schemas/Address' + description: 'The network address details. + + ' + elem_hw_id: + description: 'The element hardware ID. + + ' type: string - message: + id: + description: 'The ID. + + ' type: string - ListQueryResponse: + location: + $ref: '#/components/schemas/Location' + description: 'The network node location. + + ' + name: + description: 'The network name. Max size = 128. + + ' + type: string + role: + description: Role + type: string + site_id: + description: "The site ID. \n" + type: string + spoke_cluster_elem_status: + description: "The spoke cluster element status. \n" + type: string + state: + description: State + type: string + type: + description: 'Anynet link type. + + ' + type: string + NetworkTopologyV3N3: properties: - count: - description: 'The count of the query list. + links: + description: 'Query the anynet links. ' - format: int32 - type: integer - deleted_count: - description: 'The deleted number of queries. + items: + $ref: '#/components/schemas/NetworkLinkV3N3' + type: array + nodes: + description: Nodes + items: + $ref: '#/components/schemas/NetworkNode' + type: array + type: + description: 'Anynet link type. ' - format: int64 - type: integer - deleted_ids: - description: 'The deleted query IDs. + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string + NetworkTopologyV3N4: + properties: + links: + description: 'Query the anynet links. + + ' + items: + $ref: '#/components/schemas/NetworkLinkV3N4' + type: array + nodes: + description: Nodes + items: + $ref: '#/components/schemas/NetworkNode' + type: array + type: + description: 'Anynet link type. + + ' + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string + SiteEndpoints: + properties: + ep1_id: + description: Ep1 Id + type: string + ep2_id: + description: Ep2 Id + type: string + SiteLocation: + properties: + end: + $ref: '#/components/schemas/Location' + description: End + start: + $ref: '#/components/schemas/Location' + description: Start + TopologyQueryV3N1: + properties: + links: + description: 'Query the anynet links. ' items: + description: Links type: string type: array - description: - description: 'Description of the query. Max size = 256. + links_only: + description: 'The anynet link ID. True/False. ' - id: - description: 'The ID. + type: boolean + location: + $ref: '#/components/schemas/SiteLocation' + description: 'The anynet link start and end location. + + ' + nodes: + description: Nodes + items: + description: Nodes + type: string + type: array + servicelinks: + description: 'Servicelinks present. True/False. ' + type: boolean + site_id: + description: "The site ID. \n" type: string - next_query: - description: 'Details of the next query. + sites: + $ref: '#/components/schemas/SiteEndpoints' + description: 'The site endpoints. ' - type: object - total_count: - description: 'Total number of queries. + stub_links: + description: Stub Links + type: boolean + type: + description: 'Anynet link type. ' - format: int64 - type: integer - type: object + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string VPLAdminState: properties: al_id: @@ -252,6 +1151,21 @@ components: usable: description: Usable type: boolean + VPNLinkConfiguration: + properties: + keep_alive_failure_count: + description: 'The VPN keep alive failure count (must be between 3 and 30). + + ' + type: integer + keep_alive_interval: + description: 'The VPN keep alive timeout interval (must be between 100ms-1740,000ms). + + ' + type: integer + required: + - keep_alive_failure_count + - keep_alive_interval VPNLinkQuery: properties: aggregate: @@ -352,6 +1266,37 @@ info: version: Latest openapi: 3.0.0 paths: + /sdwan/v2.0/api/sites/{site_id}/anynetlinks/{anynet_id}: + get: + description: Get the anynet link. + operationId: get-sdwan-v2.0-api-sites-site_id-anynetlinks-anynet_id + parameters: + - description: ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The AnynetID. + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkLinkV2' + description: Successful Operation + '404': + description: not found + summary: Get Anynet Link (v2.0) + tags: + - Topology /sdwan/v2.0/api/vpnlinks/query: post: description: Query DB for VPN links that match query parameters. @@ -731,6 +1676,353 @@ paths: summary: Get VPN Link Status (v2.1) tags: - Topology + /sdwan/v3.0/api/sites/{site_id}/bfdpeers: + get: + description: Get the BFD peers. + operationId: get-sdwan-v3.0-api-sites-site_id-bfdpeers + parameters: + - description: ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BfdUnderlay' + type: array + type: object + description: Successful Operation + summary: Get BFD Peers (v2.0) + tags: + - Topology + /sdwan/v3.3/api/anynetlinks: + post: + description: Create an anynet link. + operationId: post-sdwan-v3.3-api-anynetlinks + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV3N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Anynetlink' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: TOPOLOGY_REBUILD_IN_PROGRESS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Anynet Link (v3.3) + tags: + - Topology + /sdwan/v3.3/api/anynetlinks/{anynet_id}: + delete: + description: Delete the anynet link. + operationId: delete-sdwan-v3.3-api-anynetlinks-anynet_id + parameters: + - description: The anynet ID. + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Anynetlink' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TOPOLOGY_REBUILD_IN_PROGRESS + - code: NO_ANYNETLINK_FOUND + - code: INVALID_ANYNETLINK_TYPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Anynet Link (v3.3) + tags: + - Topology + get: + description: Get the anynet link. + operationId: get-sdwan-v3.3-api-anynetlinks-anynet_id + parameters: + - description: The anynet ID. + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkLinkV3N3' + description: Successful Operation + '404': + description: not found + summary: Get Anynet Link (v3.3) + tags: + - Topology + put: + description: Update the anynet link. + operationId: put-sdwan-v3.3-api-anynetlinks-anynet_id + parameters: + - description: The anynet ID. + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV3N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Anynetlink' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: TOPOLOGY_REBUILD_IN_PROGRESS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Anynet Link (v3.3) + tags: + - Topology + /sdwan/v3.3/api/topology: + post: + description: Query the topology elements of the tenant. + operationId: post-sdwan-v3.3-api-topology + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TopologyQueryV3N1' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkTopologyV3N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_TOPO_QUERY + - code: INVALID_TOPOLOGY_STUB_LINKS_OPTION + - code: TOPOLOGY_REBUILD_IN_PROGRESS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Topology (v3.3) + tags: + - Topology + /sdwan/v3.4/api/anynetlinks: + post: + description: Create an anynet link. + operationId: post-sdwan-v3.4-api-anynetlinks + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV3N4' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Anynetlink' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: TOPOLOGY_REBUILD_IN_PROGRESS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Anynet Link (v3.4) + tags: + - Topology + /sdwan/v3.4/api/anynetlinks/{anynet_id}: + delete: + description: Delete the anynet link. + operationId: delete-sdwan-v3.4-api-anynetlinks-anynet_id + parameters: + - description: The anynet ID. + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Anynetlink' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TOPOLOGY_REBUILD_IN_PROGRESS + - code: NO_ANYNETLINK_FOUND + - code: INVALID_ANYNETLINK_TYPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Anynet Link (v3.4) + tags: + - Topology + get: + description: Get the anynet link. + operationId: get-sdwan-v3.4-api-anynetlinks-anynet_id + parameters: + - description: The anynet ID. + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkLinkV3N4' + description: Successful Operation + '404': + description: not found + summary: Get Anynet Link (v3.4) + tags: + - Topology + put: + description: Update the anynet link. + operationId: put-sdwan-v3.4-api-anynetlinks-anynet_id + parameters: + - description: The anynet ID. + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV3N4' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Anynetlink' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: TOPOLOGY_REBUILD_IN_PROGRESS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Anynet Link (v3.4) + tags: + - Topology + /sdwan/v3.4/api/topology: + post: + description: Query the topology elements of the tenant. + operationId: post-sdwan-v3.4-api-topology + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TopologyQueryV3N1' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkTopologyV3N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_TOPO_QUERY + - code: INVALID_TOPOLOGY_STUB_LINKS_OPTION + - code: TOPOLOGY_REBUILD_IN_PROGRESS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Topology (v3.4) + tags: + - Topology servers: - url: https://api.sase.paloaltonetworks.com tags: diff --git a/openapi-specs/sdwan/unified/UserGroups.yaml b/openapi-specs/sdwan/unified/UserGroups.yaml index e3f94d0dc..c5d34d405 100644 --- a/openapi-specs/sdwan/unified/UserGroups.yaml +++ b/openapi-specs/sdwan/unified/UserGroups.yaml @@ -141,7 +141,9 @@ components: ' type: string valid_until: - description: "The active user valid value. \n" + description: 'The active user valid value. + + ' format: int64 type: integer required: @@ -184,11 +186,6 @@ components: ' type: string - required: - - statistic - - unit - - name - - data AggregateData: properties: value: @@ -197,11 +194,15 @@ components: ' type: number view: - description: "View the aggregate date. \n" + description: 'View the aggregate date. + + ' type: object - required: - - value - - view + Base: + properties: + id: + description: Id + type: string DirectoryGroupAttribute: properties: email: @@ -216,9 +217,7 @@ components: - USER_PRINCIPAL_NAME type: string primary_name: - description: 'The primary name. - - ' + description: "The primary name. \n" enum: - SAM_ACCOUNT_NAME - EMAIL @@ -555,9 +554,9 @@ components: description: Stale type: boolean tags: - description: "Filter with the tag which is an information field that can\ - \ be added to identify the user or group. Maximum 10 unique tags of length\ - \ 1024 each are allowed. \n" + description: 'Filter with the tag which is an information. + + ' items: description: Tags type: string @@ -693,19 +692,19 @@ components: ListQueryResponse: properties: count: - description: 'The count of the query list. + description: 'The actual count. ' format: int32 type: integer deleted_count: - description: 'The deleted number of queries. + description: 'The deleted number. ' format: int64 type: integer deleted_ids: - description: 'The deleted query IDs. + description: 'The deleted IDs. ' items: @@ -726,7 +725,7 @@ components: ' type: object total_count: - description: 'Total number of queries. + description: 'Total number. ' format: int64 @@ -735,13 +734,13 @@ components: ListResponse: properties: count: - description: 'The number of responses. + description: 'The actual count. ' format: int32 type: integer id: - description: 'The ID of the response. + description: 'The ID. ' type: string @@ -814,7 +813,7 @@ components: description: Collector Secret type: string collector_secret_encrypted: - description: 'Collector Secret Encrypted: JsonIgnore(value = true) ' + description: Collector Secret Encrypted type: string local_certificate: description: Local Certificate @@ -1022,63 +1021,6 @@ components: - port - name - site_id - UserIdentity: - properties: - disabled: - description: 'List the users in a disabled state. - - ' - type: boolean - disabled_reason: - description: 'List the reason for the disabled state. - - ' - type: string - first_name: - description: 'The first name of the user. Max size = 100. - - ' - type: string - id: - description: 'The ID. - - ' - type: string - inactive: - description: 'Lists if the user is inactive. - - ' - type: boolean - inactive_reason: - description: 'Reason the user is inactive. - - ' - type: string - last_name: - description: 'The last name of the user. - - ' - type: string - middle_name: - description: 'The middle name of the user. - - ' - type: string - region: - description: 'The region. - - ' - type: string - user_dn: - description: 'The user dn. - - ' - type: string - user_fqn: - description: 'The user fqn. - - ' - type: string info: contact: {} description: List of APIs used to retrieve details about User & Group identity @@ -1160,6 +1102,42 @@ paths: summary: Create Directory Service (v2.0) tags: - User Groups + /sdwan/v2.0/api/directoryservices/deltasync: + post: + description: Force delta sync. Delta sync can be forced if sync is not in progress + for a provided domain. + operationId: post-sdwan-v2.0-api-directoryservices-deltasync + requestBody: + content: + application/json: + schema: + nullable: true + type: object + description: Details of Delta Sync + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Base' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_INPUT + - code: DIRECTORY_SYNC_IN_PROGRESS + - code: DELTA_SYNC_FAILED + - code: FULL_SYNC_REQUIRED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Force Delta Sync (v2.0) + tags: + - User Groups /sdwan/v2.0/api/directoryservices/status: get: description: List the domain status. @@ -1181,6 +1159,41 @@ paths: summary: Get Domain Status (v2.0) tags: - User Groups + /sdwan/v2.0/api/directoryservices/sync: + post: + description: Force full sync. Full sync can be forced if sync is not in progress + for a provided domain. + operationId: post-sdwan-v2.0-api-directoryservices-sync + requestBody: + content: + application/json: + schema: + nullable: true + type: object + description: Details of Full Sync + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Base' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_INPUT + - code: DIRECTORY_SYNC_IN_PROGRESS + - code: FULL_SYNC_FAILED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Force Full Sync (v2.0) + tags: + - User Groups /sdwan/v2.0/api/directoryservices/{directory_service_id}: delete: description: Delete a directory service. @@ -1657,166 +1670,6 @@ paths: summary: Update User ID Agent (v2.0) tags: - User Groups - /sdwan/v2.0/api/users: - get: - description: List all the users. - operationId: get-sdwan-v2.0-api-users - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/UserIdentity' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Users (v2.0) - tags: - - User Groups - post: - description: Create an user identity. - operationId: post-sdwan-v2.0-api-users - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UserIdentity' - description: Create an user identity - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UserIdentity' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create User Identity (v2.0) - tags: - - User Groups - /sdwan/v2.0/api/users/{user_id}: - delete: - description: Delete an user identity. - operationId: delete-sdwan-v2.0-api-users-user_id - parameters: - - description: The user ID. - in: path - name: user_id - required: true - schema: - description: User Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UserIdentity' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete User Identity (v2.0) - tags: - - User Groups - get: - description: Get an user identity. - operationId: get-sdwan-v2.0-api-users-user_id - parameters: - - description: The user ID. - in: path - name: user_id - required: true - schema: - description: User Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UserIdentity' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get User Identity (v2.0) - tags: - - User Groups - put: - description: Update an user identity. - operationId: put-sdwan-v2.0-api-users-user_id - parameters: - - description: The user ID. - in: path - name: user_id - required: true - schema: - description: User Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UserIdentity' - description: Details of the site Network Policy local prefix to be associated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UserIdentity' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update User Identity (v2.0) - tags: - - User Groups servers: - url: https://api.sase.paloaltonetworks.com tags: